Skip to content

Period

Represents a period with a start and end date.

Attributes:

Name Type Description
start datetime

The start date of the period.
end datetime

The end date of the period.
Source code in hazbin_hotel/src/period.py 
  6
  7
  8
  9
 10
 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
class Period:
    """
    Represents a period with a start and end date.

    Attributes:
        start (datetime): The start date of the period.
        end (datetime): The end date of the period.
    """

    def __init__(self, start: datetime, end: datetime):
        """
        Initializes a Period object with a start and end date.

        Args:
            start (datetime): The start date of the period.
            end (datetime): The end date of the period.

        Raises:
            ValueError: If the start date is after the end date.
        """
        if start > end:
            raise InvalidPeriodError("Start date must be before end date.")
        self._start = start
        self._end = end

    def change_start(self, start: datetime) -> bool:
        """
        Changes the start date of the period.

        Args:
            start (datetime): The new start date.

        Returns:
            bool: True if the start date was successfully changed, False otherwise.

        Examples:
            >>> from datetime import datetime
            >>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
            >>> period.change_start(datetime(2023, 1, 3))
            False
            >>> period.change_start(datetime(2023, 1, 2))
            True
            >>> print(period.start)
            2023-01-02 00:00:00
        """
        if start > self._end:
            return False
        self._start = start
        return True

    def change_end(self, end: datetime) -> bool:
        """
        Changes the end date of the period.

        Args:
            end (datetime): The new end date.

        Returns:
            bool: True if the end date was successfully changed, False otherwise.

        Examples:
            >>> from datetime import datetime
            >>> period = Period(datetime(2023, 1, 2), datetime(2023, 1, 3))
            >>> period.change_end(datetime(2023, 1, 1))
            False
            >>> period.change_end(datetime(2023, 1, 4))
            True
            >>> print(period.end)
            2023-01-04 00:00:00
        """
        if self._start > end:
            return False
        self._end = end
        return True

    @property
    def start(self) -> datetime:
        """
        Gets the start date of the period.

        Returns:
            datetime: The start date of the period.

        Examples:
            >>> from datetime import datetime
            >>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
            >>> print(period.start)
            2023-01-01 00:00:00
        """
        return self._start

    @property
    def end(self) -> datetime:
        """
        Gets the end date of the period.

        Returns:
            datetime: The end date of the period.

        Examples:
            >>> from datetime import datetime
            >>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
            >>> print(period.end)
            2023-01-02 00:00:00
        """
        return self._end

    def __str__(self) -> str:
        return f"START: {self.start} | END: {self.end}"

end: datetime property

Gets the end date of the period.

Returns:

Name Type Description
datetime datetime

The end date of the period.

Examples:

>>> from datetime import datetime
>>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
>>> print(period.end)
2023-01-02 00:00:00

start: datetime property

Gets the start date of the period.

Returns:

Name Type Description
datetime datetime

The start date of the period.

Examples:

>>> from datetime import datetime
>>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
>>> print(period.start)
2023-01-01 00:00:00

__init__(start, end)

Initializes a Period object with a start and end date.

Parameters:

Name Type Description Default
start datetime

The start date of the period.

 required
end datetime

The end date of the period.

 required

Raises:

Type Description
ValueError

If the start date is after the end date.
Source code in hazbin_hotel/src/period.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def __init__(self, start: datetime, end: datetime):
    """
    Initializes a Period object with a start and end date.

    Args:
        start (datetime): The start date of the period.
        end (datetime): The end date of the period.

    Raises:
        ValueError: If the start date is after the end date.
    """
    if start > end:
        raise InvalidPeriodError("Start date must be before end date.")
    self._start = start
    self._end = end

change_end(end)

Changes the end date of the period.

Parameters:

Name Type Description Default
end datetime

The new end date.

 required

Returns:

Name Type Description
bool bool

True if the end date was successfully changed, False otherwise.

Examples:

>>> from datetime import datetime
>>> period = Period(datetime(2023, 1, 2), datetime(2023, 1, 3))
>>> period.change_end(datetime(2023, 1, 1))
False
>>> period.change_end(datetime(2023, 1, 4))
True
>>> print(period.end)
2023-01-04 00:00:00
Source code in hazbin_hotel/src/period.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def change_end(self, end: datetime) -> bool:
    """
    Changes the end date of the period.

    Args:
        end (datetime): The new end date.

    Returns:
        bool: True if the end date was successfully changed, False otherwise.

    Examples:
        >>> from datetime import datetime
        >>> period = Period(datetime(2023, 1, 2), datetime(2023, 1, 3))
        >>> period.change_end(datetime(2023, 1, 1))
        False
        >>> period.change_end(datetime(2023, 1, 4))
        True
        >>> print(period.end)
        2023-01-04 00:00:00
    """
    if self._start > end:
        return False
    self._end = end
    return True

change_start(start)

Changes the start date of the period.

Parameters:

Name Type Description Default
start datetime

The new start date.

 required

Returns:

Name Type Description
bool bool

True if the start date was successfully changed, False otherwise.

Examples:

>>> from datetime import datetime
>>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
>>> period.change_start(datetime(2023, 1, 3))
False
>>> period.change_start(datetime(2023, 1, 2))
True
>>> print(period.start)
2023-01-02 00:00:00
Source code in hazbin_hotel/src/period.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def change_start(self, start: datetime) -> bool:
    """
    Changes the start date of the period.

    Args:
        start (datetime): The new start date.

    Returns:
        bool: True if the start date was successfully changed, False otherwise.

    Examples:
        >>> from datetime import datetime
        >>> period = Period(datetime(2023, 1, 1), datetime(2023, 1, 2))
        >>> period.change_start(datetime(2023, 1, 3))
        False
        >>> period.change_start(datetime(2023, 1, 2))
        True
        >>> print(period.start)
        2023-01-02 00:00:00
    """
    if start > self._end:
        return False
    self._start = start
    return True