Skip to content

Room

Represents a room in a hotel with specific attributes, price, type, and scheduling availability.

Attributes:

Name Type Description
instance_count int

Counter to assign unique room numbers.
number int

The unique identifier of the room instance.
_type RoomTypeEnum

Type of the room, defined by RoomTypeEnum.
_price float

Base price for the room.
_multiplier_factor_price float

Multiplier for the room rate based on room type.
_schedules List[Schedule]

List of scheduled bookings for the room.
Source code in hazbin_hotel/src/room.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
class Room:
    """Represents a room in a hotel with specific attributes, price, type, and scheduling availability.

    Attributes:
        instance_count (int): Counter to assign unique room numbers.
        number (int): The unique identifier of the room instance.
        _type (RoomTypeEnum): Type of the room, defined by RoomTypeEnum.
        _price (float): Base price for the room.
        _multiplier_factor_price (float): Multiplier for the room rate based on room type.
        _schedules (List[Schedule]): List of scheduled bookings for the room.
    """

    instance_count = 1

    def __init__(self, room_type: RoomTypeEnum, price: float, schedules: List[Schedule]) -> None:
        """Initializes the Room with a type, price, and existing schedules.

        Args:
            room_type (RoomTypeEnum): Type of the room.
            price (float): Base price of the room.
            schedules (List[Schedule]): Initial list of schedules associated with the room.

        Raises:
            InvalidRoomType: If the room type is invalid.
            ValueError: If the price is negative.
        """
        self._validate_room_type(room_type)
        self._validate_room_price(price)

        self.number = Room.instance_count
        self._type = room_type
        self._price = price
        self._multiplier_factor_price = 0
        self._schedules = schedules

        self._set_multiplier_factor(room_type)
        Room.instance_count += 1

    @property
    def price(self) -> float:
        """float: Gets or sets the base price of the room."""
        return self._price

    @price.setter
    def price(self, new_price: float):
        self.update_price(new_price)

    @property
    def type(self) -> RoomTypeEnum:
        """RoomTypeEnum: Gets or sets the type of the room."""
        return self._type

    @type.setter
    def type(self, new_type: RoomTypeEnum):
        self._validate_room_type(new_type)
        if self._type == new_type:
            print(f"{Fore.YELLOW}[WARNING]: Same type was set!!{Style.RESET_ALL}")
        self._type = new_type

    @property
    def multiplier_factor_price(self) -> float:
        """float: Gets the multiplier factor for the room price based on room type."""
        return self._multiplier_factor_price

    @property
    def schedules(self) -> List[Schedule]:
        """List[Schedule]: Gets the list of schedules associated with the room."""
        return self._schedules

    def add_schedule(self, schedule: Schedule):
        """Adds a schedule to the room if the period is available.

        Args:
            schedule (Schedule): The schedule to add.

        Raises:
            ValueError: If the period is not available.
        """
        if not self.is_period_available(schedule.period):
            raise ValueError("The period is not available.")
        self._schedules.append(schedule)

    def is_period_available(
        self,
        period: Period,
        *,
        ignore_schedule: bool = False,
        schedule_id: int = None,
    ) -> bool:
        """Checks if a given period is available for scheduling.

        Args:
            period (Period): The period to check.
            ignore_schedule (bool, optional): Whether to ignore a specific schedule. Defaults to False.
            schedule_id (int, optional): ID of the schedule to ignore if `ignore_schedule` is True.

        Returns:
            bool: True if the period is available, False otherwise.

        Raises:
            ValueError: If `ignore_schedule` is True but `schedule_id` is None.
        """
        if ignore_schedule and schedule_id is None:
            raise ValueError("Schedule ID is missing")

        for scheduled in self._schedules:
            if ignore_schedule and scheduled.id == schedule_id:
                continue

            if (
                (scheduled.period.start <= period.start <= scheduled.period.end)
                or (scheduled.period.start <= period.end <= scheduled.period.end)
                or (period.start <= scheduled.period.start <= period.end)
            ):
                return False
        return True

    def update_price(self, new_price: float):
        """Updates the room price.

        Args:
            new_price (float): The new price to set.

        Raises:
            ValueError: If the new price is negative.
        """
        self._validate_room_price(new_price)
        self._price = new_price

    def update_schedule(self, schedule: Schedule, schedule_id: int):
        """Updates an existing schedule if the period is available.

        Args:
            schedule (Schedule): New schedule details.
            schedule_id (int): ID of the schedule to update.

        Raises:
            ScheduleCannotBeOverwritten: If the period is not available for update.
        """
        if not self.is_period_available(schedule.period, ignore_schedule=True, schedule_id=schedule_id):
            raise ScheduleCannotBeOverwritten("The schedule cannot be overwritten")

        schedule_index_to_update = -1
        for schedule_index, scheduled in enumerate(self._schedules):
            if scheduled.id == schedule_id:
                schedule_index_to_update = schedule_index

        self._schedules[schedule_index_to_update] = schedule

    def _set_multiplier_factor(self, room_type: RoomTypeEnum) -> None:
        """Sets the multiplier factor for room price based on the room type.

        Args:
            room_type (RoomTypeEnum): The type of the room.

        Raises:
            InvalidRoomType: If the room type is invalid.
        """
        if room_type in ROOM_MULTIPLIERS:
            self._multiplier_factor_price = ROOM_MULTIPLIERS[room_type]
            return
        raise InvalidRoomType(f'Invalid room type, please check type "{room_type.value}"')

    @staticmethod
    def _validate_room_type(room_type: RoomTypeEnum) -> None:
        """Validates if the room type is recognized.

        Args:
            room_type (RoomTypeEnum): The room type to validate.

        Raises:
            InvalidRoomType: If the room type is invalid.
        """
        if room_type not in RoomTypeEnum:
            raise InvalidRoomType(f'Invalid room type, please check type "{room_type.value}"')

    @staticmethod
    def _validate_room_price(price: float) -> None:
        """Validates the room price.

        Args:
            price (float): The room price to validate.

        Raises:
            ValueError: If the price is negative.
        """
        if price < 0:
            raise ValueError("Price cannot be negative.")

multiplier_factor_price: float property

float: Gets the multiplier factor for the room price based on room type.

price: float property writable

float: Gets or sets the base price of the room.

schedules: List[Schedule] property

List[Schedule]: Gets the list of schedules associated with the room.

type: RoomTypeEnum property writable

RoomTypeEnum: Gets or sets the type of the room.

__init__(room_type, price, schedules)

Initializes the Room with a type, price, and existing schedules.

Parameters:

Name Type Description Default
room_type RoomTypeEnum

Type of the room.

 required
price float

Base price of the room.

 required
schedules List[Schedule]

Initial list of schedules associated with the room.

 required

Raises:

Type Description
InvalidRoomType

If the room type is invalid.
ValueError

If the price is negative.
Source code in hazbin_hotel/src/room.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(self, room_type: RoomTypeEnum, price: float, schedules: List[Schedule]) -> None:
    """Initializes the Room with a type, price, and existing schedules.

    Args:
        room_type (RoomTypeEnum): Type of the room.
        price (float): Base price of the room.
        schedules (List[Schedule]): Initial list of schedules associated with the room.

    Raises:
        InvalidRoomType: If the room type is invalid.
        ValueError: If the price is negative.
    """
    self._validate_room_type(room_type)
    self._validate_room_price(price)

    self.number = Room.instance_count
    self._type = room_type
    self._price = price
    self._multiplier_factor_price = 0
    self._schedules = schedules

    self._set_multiplier_factor(room_type)
    Room.instance_count += 1

add_schedule(schedule)

Adds a schedule to the room if the period is available.

Parameters:

Name Type Description Default
schedule Schedule

The schedule to add.

 required

Raises:

Type Description
ValueError

If the period is not available.
Source code in hazbin_hotel/src/room.py 
80
81
82
83
84
85
86
87
88
89
90
91
def add_schedule(self, schedule: Schedule):
    """Adds a schedule to the room if the period is available.

    Args:
        schedule (Schedule): The schedule to add.

    Raises:
        ValueError: If the period is not available.
    """
    if not self.is_period_available(schedule.period):
        raise ValueError("The period is not available.")
    self._schedules.append(schedule)

is_period_available(period, *, ignore_schedule=False, schedule_id=None)

Checks if a given period is available for scheduling.

Parameters:

Name Type Description Default
period Period

The period to check.

 required
ignore_schedule bool

Whether to ignore a specific schedule. Defaults to False.

 False
schedule_id int

ID of the schedule to ignore if ignore_schedule is True.

 None

Returns:

Name Type Description
bool bool

True if the period is available, False otherwise.

Raises:

Type Description
ValueError

If ignore_schedule is True but schedule_id is None.
Source code in hazbin_hotel/src/room.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def is_period_available(
    self,
    period: Period,
    *,
    ignore_schedule: bool = False,
    schedule_id: int = None,
) -> bool:
    """Checks if a given period is available for scheduling.

    Args:
        period (Period): The period to check.
        ignore_schedule (bool, optional): Whether to ignore a specific schedule. Defaults to False.
        schedule_id (int, optional): ID of the schedule to ignore if `ignore_schedule` is True.

    Returns:
        bool: True if the period is available, False otherwise.

    Raises:
        ValueError: If `ignore_schedule` is True but `schedule_id` is None.
    """
    if ignore_schedule and schedule_id is None:
        raise ValueError("Schedule ID is missing")

    for scheduled in self._schedules:
        if ignore_schedule and scheduled.id == schedule_id:
            continue

        if (
            (scheduled.period.start <= period.start <= scheduled.period.end)
            or (scheduled.period.start <= period.end <= scheduled.period.end)
            or (period.start <= scheduled.period.start <= period.end)
        ):
            return False
    return True

update_price(new_price)

Updates the room price.

Parameters:

Name Type Description Default
new_price float

The new price to set.

 required

Raises:

Type Description
ValueError

If the new price is negative.
Source code in hazbin_hotel/src/room.py 
128
129
130
131
132
133
134
135
136
137
138
def update_price(self, new_price: float):
    """Updates the room price.

    Args:
        new_price (float): The new price to set.

    Raises:
        ValueError: If the new price is negative.
    """
    self._validate_room_price(new_price)
    self._price = new_price

update_schedule(schedule, schedule_id)

Updates an existing schedule if the period is available.

Parameters:

Name Type Description Default
schedule Schedule

New schedule details.

 required
schedule_id int

ID of the schedule to update.

 required

Raises:

Type Description
ScheduleCannotBeOverwritten

If the period is not available for update.
Source code in hazbin_hotel/src/room.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def update_schedule(self, schedule: Schedule, schedule_id: int):
    """Updates an existing schedule if the period is available.

    Args:
        schedule (Schedule): New schedule details.
        schedule_id (int): ID of the schedule to update.

    Raises:
        ScheduleCannotBeOverwritten: If the period is not available for update.
    """
    if not self.is_period_available(schedule.period, ignore_schedule=True, schedule_id=schedule_id):
        raise ScheduleCannotBeOverwritten("The schedule cannot be overwritten")

    schedule_index_to_update = -1
    for schedule_index, scheduled in enumerate(self._schedules):
        if scheduled.id == schedule_id:
            schedule_index_to_update = schedule_index

    self._schedules[schedule_index_to_update] = schedule