Skip to content

Mixin's

Mixin's are used to add functionality to the base class.

In particular:

  • ParserMixin: implements the parsing methods from different types (from_* methods)
  • ConverterMixin: implements the conversion methods to different types (to_* methods)
  • ComparatorMixin: implements the comparison operators (==, !=, <, <=, >, >=)

iso_week_date.mixin.ParserMixin

Bases: IsoWeekProtocol

Mixin that handles conversion from types.

ParserMixin implements from_* (class) methods to parse from:

  • str: string matching pattern, will be validated.
  • str: string matching compact_pattern, will be validated.
  • date: casted to ISO Week _date_format using .strftime() method after applying offset_.
  • datetime:casted to ISO Week _date_format using .strftime() method after applying offset_.

Additionally, it implements ._cast() class method that automatically casts to ISOWeek-like type from the by calling the appropriate method for parsing.

Source code in iso_week_date/mixin.py 
 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
class ParserMixin(IsoWeekProtocol):
    """Mixin that handles conversion from types.

    `ParserMixin` implements `from_*` (class) methods to parse from:

    - `str`: string matching `pattern`, will be validated.
    - `str`: string matching `compact_pattern`, will be validated.
    - `date`: casted to ISO Week `_date_format` using `.strftime()` method after applying `offset_`.
    - `datetime`:casted to ISO Week `_date_format` using `.strftime()` method after applying `offset_`.

    Additionally, it implements `._cast()` class method that automatically casts to ISOWeek-like type from the by
    calling the appropriate method for parsing.
    """

    @classmethod
    def from_string(cls: Type[Self], _str: str) -> Self:
        """Parse a string object in `_pattern` format."""
        if not isinstance(_str, str):
            msg = f"Expected `str` type, found {type(_str)}"
            raise TypeError(msg)
        return cls(_str)

    @classmethod
    def from_compact(cls: Type[Self], _str: str) -> Self:
        """Parse a string object in `_compact_format` format.

        Since values are validated in the initialization method, our goal in this method is to "add" the dashes in the
        appropriate places. To achieve this we:

        - First check that the length of the string is correct (either 7 or 8).
        - Split the string in 3 parts.
        - Remove (filter) empty values.
        - Finally join them with a dash in between.
        """
        if not isinstance(_str, str):
            msg = f"Expected `str` type, found {type(_str)}"
            raise TypeError(msg)

        if len(_str) != len(cls._compact_format):
            raise ValueError(format_err_msg(cls._compact_format, _str))

        split_idx = (0, 4, 7, None)
        value = "-".join(filter(None, (_str[i:j] for i, j in zip(split_idx[:-1], split_idx[1:]))))
        return cls(value)

    @classmethod
    def from_date(cls: Type[Self], _date: date) -> Self:
        """Parse a date object to `_date_format` after adjusting by `offset_`."""
        if not isinstance(_date, date):
            msg = f"Expected `date` type, found {type(_date)}"
            raise TypeError(msg)
        return cls((_date - cls.offset_).strftime(cls._date_format))

    @classmethod
    def from_datetime(cls: Type[Self], _datetime: datetime) -> Self:
        """Parse a datetime object to `_date_format` after adjusting by `offset_`."""
        if not isinstance(_datetime, datetime):
            msg = f"Expected `datetime` type, found {type(_datetime)}"
            raise TypeError(msg)

        return cls((_datetime - cls.offset_).strftime(cls._date_format))

    @classmethod
    def from_today(cls: Type[Self]) -> Self:  # pragma: no cover
        """Instantiates class from today's date."""
        return cls.from_date(date.today())

    @classmethod
    def from_values(cls: Type[Self], year: int, week: int, weekday: int = 1) -> Self:
        """Parse year, week and weekday values to `_format` format."""
        value = (
            cls._format.replace("YYYY", str(year).zfill(4))
            .replace("NN", str(week).zfill(2))
            .replace("D", str(weekday).zfill(1))
        )
        return cls(value)

    @classmethod
    def _cast(cls: Type[Self], value: IsoWeek_T_contra) -> Self:
        """Tries to cast from different types.

        - `str`: string matching `_pattern`.
        - `date`: casted to ISO Week by calling `.from_date()` method.
        - `datetime`: casted to ISO Week by calling `.from_datetime()` method.
        - `ISOWeek`-like: value will be returned as is.

        Arguments:
            value: Value to be casted to ISO Week object.

        Returns:
            `ISOWeek`-like object

        Raises:
            NotImplementedError: If `value` is not of type `str`, `date`, `datetime` or `ISOWeek`-like.

        Examples:
        ```py
        from datetime import date
        from iso_week_date import IsoWeek

        IsoWeek._cast("2023-W01")  # IsoWeek("2023-W01")
        ```
        """
        if isinstance(value, str):
            return cls.from_string(value)
        elif isinstance(value, datetime):
            return cls.from_datetime(value)
        elif isinstance(value, date):
            return cls.from_date(value)
        elif isinstance(value, cls):
            return value
        else:
            msg = f"Cannot cast type {type(value)} into {cls.__name__}"
            raise NotImplementedError(msg)

from_compact(_str) classmethod

Parse a string object in _compact_format format.

Since values are validated in the initialization method, our goal in this method is to "add" the dashes in the appropriate places. To achieve this we:

  • First check that the length of the string is correct (either 7 or 8).
  • Split the string in 3 parts.
  • Remove (filter) empty values.
  • Finally join them with a dash in between.
Source code in iso_week_date/mixin.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@classmethod
def from_compact(cls: Type[Self], _str: str) -> Self:
    """Parse a string object in `_compact_format` format.

    Since values are validated in the initialization method, our goal in this method is to "add" the dashes in the
    appropriate places. To achieve this we:

    - First check that the length of the string is correct (either 7 or 8).
    - Split the string in 3 parts.
    - Remove (filter) empty values.
    - Finally join them with a dash in between.
    """
    if not isinstance(_str, str):
        msg = f"Expected `str` type, found {type(_str)}"
        raise TypeError(msg)

    if len(_str) != len(cls._compact_format):
        raise ValueError(format_err_msg(cls._compact_format, _str))

    split_idx = (0, 4, 7, None)
    value = "-".join(filter(None, (_str[i:j] for i, j in zip(split_idx[:-1], split_idx[1:]))))
    return cls(value)

from_date(_date) classmethod

Parse a date object to _date_format after adjusting by offset_.

Source code in iso_week_date/mixin.py 
113
114
115
116
117
118
119
@classmethod
def from_date(cls: Type[Self], _date: date) -> Self:
    """Parse a date object to `_date_format` after adjusting by `offset_`."""
    if not isinstance(_date, date):
        msg = f"Expected `date` type, found {type(_date)}"
        raise TypeError(msg)
    return cls((_date - cls.offset_).strftime(cls._date_format))

from_datetime(_datetime) classmethod

Parse a datetime object to _date_format after adjusting by offset_.

Source code in iso_week_date/mixin.py 
121
122
123
124
125
126
127
128
@classmethod
def from_datetime(cls: Type[Self], _datetime: datetime) -> Self:
    """Parse a datetime object to `_date_format` after adjusting by `offset_`."""
    if not isinstance(_datetime, datetime):
        msg = f"Expected `datetime` type, found {type(_datetime)}"
        raise TypeError(msg)

    return cls((_datetime - cls.offset_).strftime(cls._date_format))

from_string(_str) classmethod

Parse a string object in _pattern format.

Source code in iso_week_date/mixin.py 
82
83
84
85
86
87
88
@classmethod
def from_string(cls: Type[Self], _str: str) -> Self:
    """Parse a string object in `_pattern` format."""
    if not isinstance(_str, str):
        msg = f"Expected `str` type, found {type(_str)}"
        raise TypeError(msg)
    return cls(_str)

from_today() classmethod

Instantiates class from today's date.

Source code in iso_week_date/mixin.py 
130
131
132
133
@classmethod
def from_today(cls: Type[Self]) -> Self:  # pragma: no cover
    """Instantiates class from today's date."""
    return cls.from_date(date.today())

from_values(year, week, weekday=1) classmethod

Parse year, week and weekday values to _format format.

Source code in iso_week_date/mixin.py 
135
136
137
138
139
140
141
142
143
@classmethod
def from_values(cls: Type[Self], year: int, week: int, weekday: int = 1) -> Self:
    """Parse year, week and weekday values to `_format` format."""
    value = (
        cls._format.replace("YYYY", str(year).zfill(4))
        .replace("NN", str(week).zfill(2))
        .replace("D", str(weekday).zfill(1))
    )
    return cls(value)

iso_week_date.mixin.ConverterMixin

Bases: IsoWeekProtocol

Mixin that handles conversion to types.

ConverterMixin implements to_* methods to convert to the following types:

  • str
  • date
  • datetime
Source code in iso_week_date/mixin.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
class ConverterMixin(IsoWeekProtocol):
    """Mixin that handles conversion to types.

    `ConverterMixin` implements `to_*` methods to convert to the following types:

    - `str`
    - `date`
    - `datetime`
    """

    def to_string(self: Self) -> str:
        """Returns as a string in the classical format."""
        return self.value_

    def to_compact(self: Self) -> str:
        """Returns as a string in the compact format."""
        return self.value_.replace("-", "")

    def _to_datetime(self: Self, value: str) -> datetime:
        """Converts `value` to `datetime` object and adds the `offset_`.

        !!! warning
            `value` must be in "%G-W%V-%u" format.

            In general this is not always the case and we need to manipulate `value_` attribute before passing it to
            `datetime.strptime` method.
        """
        return datetime.strptime(value, "%G-W%V-%u") + self.offset_

    def _to_date(self: Self, value: str) -> date:  # pragma: no cover
        """Converts `value` to `date` object and adds the `offset_`.

        !!! warning
            `value` must be in "%G-W%V-%u" format.

            In general this is not always the case and we need to manipulate `value_` attribute before passing it to
            `datetime.strptime` method.
        """
        return self._to_datetime(value).date()

    def to_values(self: Self) -> Tuple[int, ...]:
        """Converts `value_` to a tuple of integers (year, week, [weekday])."""
        return tuple(int(v.replace("W", "")) for v in self.value_.split("-"))

to_compact()

Returns as a string in the compact format.

Source code in iso_week_date/mixin.py 
198
199
200
def to_compact(self: Self) -> str:
    """Returns as a string in the compact format."""
    return self.value_.replace("-", "")

to_string()

Returns as a string in the classical format.

Source code in iso_week_date/mixin.py 
194
195
196
def to_string(self: Self) -> str:
    """Returns as a string in the classical format."""
    return self.value_

to_values()

Converts value_ to a tuple of integers (year, week, [weekday]).

Source code in iso_week_date/mixin.py 
224
225
226
def to_values(self: Self) -> Tuple[int, ...]:
    """Converts `value_` to a tuple of integers (year, week, [weekday])."""
    return tuple(int(v.replace("W", "")) for v in self.value_.split("-"))

iso_week_date.mixin.ComparatorMixin

Bases: IsoWeekProtocol

Mixin that implements comparison operators ("==", "!=", "<", "<=", ">", ">=") between two ISO Week objects.

Source code in iso_week_date/mixin.py 
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
class ComparatorMixin(IsoWeekProtocol):
    """Mixin that implements comparison operators ("==", "!=", "<", "<=", ">", ">=") between two ISO Week objects."""

    def __eq__(self: Self, other: object) -> bool:
        """Equality operator.

        Two ISO Week objects are considered equal if and only if they have the same `offset_` and the same `value_`.

        Arguments:
            other: Object to compare with.

        Returns:
            `True` if objects are equal, `False` otherwise.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") == IsoWeek("2023-W01")  # True
        IsoWeek("2023-W01") == IsoWeek("2023-W02")  # False


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") == CustomIsoWeek("2023-W01")  # False
        ```
        """
        if isinstance(other, self.__class__):
            return (self.offset_ == other.offset_) and (self.value_ == other.value_)
        else:
            return False

    def __ne__(self: Self, other: object) -> bool:
        """Inequality operator.

        Two ISO Week objects are considered equal if and only if they have the same `offset_` and the same `value_`.

        Arguments:
            other: Object to compare with.

        Returns:
            `True` if objects are _not_ equal, `False` otherwise.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") != IsoWeek("2023-W01")  # False
        IsoWeek("2023-W01") != IsoWeek("2023-W02")  # True


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") != CustomIsoWeek("2023-W01")  # True
        ```
        """
        return not self.__eq__(other)

    def __lt__(self: Self, other: Self) -> bool:
        """Less than operator.

        Comparing two ISO Week objects is only possible if they have the same `offset_`.

        If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

        Arguments:
            other: Object to compare with.

        Returns:
            `True` if self is less than other, `False` otherwise.

        Raises:
            TypeError: If `other` is not of same type or it has a different offset.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") < IsoWeek("2023-W02")  # True
        IsoWeek("2023-W02") < IsoWeek("2023-W01")  # False


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") < CustomIsoWeek("2023-W01")  # TypeError
        IsoWeek("2023-W01") < "2023-W01"  # TypeError
        ```
        """
        if isinstance(other, self.__class__):
            if self.offset_ == other.offset_:
                return self.value_ < other.value_
            else:
                msg = f"Cannot compare `{self.name}`'s with different offsets"
                raise TypeError(msg)
        else:
            msg = (
                f"Cannot compare `{self.name}` with type `{type(other)}`, comparison is supported only with other "
                f"`{self.name}` objects"
            )
            raise TypeError(msg)

    def __le__(self: Self, other: Self) -> bool:
        """Less than or equal operator.

        Comparing two ISO Week objects is only possible if they have the same `offset_`.

        If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

        Arguments:
            other: Object to compare with.

        Returns:
            `True` if self is less than or equal to other, `False` otherwise.

        Raises:
            TypeError: If `other` is not of same type or it has a different offset.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") <= IsoWeek("2023-W01")  # True
        IsoWeek("2023-W02") <= IsoWeek("2023-W01")  # False


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") <= CustomIsoWeek("2023-W01")  # TypeError
        IsoWeek("2023-W01") <= "2023-W01"  # TypeError
        ```
        """
        return self.__lt__(other) or self.__eq__(other)

    def __gt__(self: Self, other: Self) -> bool:
        """Greater than operator.

        Comparing two ISO Week objects is only possible if they have the same `offset_`.

        If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

        Arguments:
            other: Object to compare with.

        Returns:
            `True` if self is greater than other, `False` otherwise.

        Raises:
            TypeError: If `other` is not of same type or it has a different offset.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") >= IsoWeek("2023-W02")  # False
        IsoWeek("2023-W01") >= IsoWeek("2023-W01")  # True


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") >= CustomIsoWeek("2023-W01")  # TypeError
        IsoWeek("2023-W01") >= "2023-W01"  # TypeError
        ```
        """
        return not self.__le__(other)

    def __ge__(self: Self, other: Self) -> bool:
        """Greater than or equal operator.

        Comparing two ISO Week objects is only possible if they have the same `offset_`.

        If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

        Arguments:
           other: Object to compare with.

        Returns:
            `True` if self is greater than or equal to `other`, `False` otherwise.

        Raises:
            TypeError: If `other` is not of same type or it has a different offset.

        Examples:
        ```py
        from datetime import timedelta
        from iso_week_date import IsoWeek

        IsoWeek("2023-W01") > IsoWeek("2023-W02")  # False
        IsoWeek("2023-W02") > IsoWeek("2023-W01")  # True


        class CustomIsoWeek(IsoWeek):
            offset_ = timedelta(days=1)


        IsoWeek("2023-W01") > CustomIsoWeek("2023-W01")  # TypeError
        IsoWeek("2023-W01") > "2023-W01"  # TypeError
        ```
        """
        return not self.__lt__(other)

__eq__(other)

Equality operator.

Two ISO Week objects are considered equal if and only if they have the same offset_ and the same value_.

Parameters:

Name Type Description Default
other object

Object to compare with.

 required

Returns:

Type Description
bool

True if objects are equal, False otherwise.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") == IsoWeek("2023-W01")  # True
IsoWeek("2023-W01") == IsoWeek("2023-W02")  # False


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") == CustomIsoWeek("2023-W01")  # False

Source code in iso_week_date/mixin.py 
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def __eq__(self: Self, other: object) -> bool:
    """Equality operator.

    Two ISO Week objects are considered equal if and only if they have the same `offset_` and the same `value_`.

    Arguments:
        other: Object to compare with.

    Returns:
        `True` if objects are equal, `False` otherwise.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") == IsoWeek("2023-W01")  # True
    IsoWeek("2023-W01") == IsoWeek("2023-W02")  # False


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") == CustomIsoWeek("2023-W01")  # False
    ```
    """
    if isinstance(other, self.__class__):
        return (self.offset_ == other.offset_) and (self.value_ == other.value_)
    else:
        return False

__ge__(other)

Greater than or equal operator.

Comparing two ISO Week objects is only possible if they have the same offset_.

If that's the case than it's enough to compare their values (as str) due to its lexicographical order.

Parameters:

Name Type Description Default
other Self

Object to compare with.

 required

Returns:

Type Description
bool

True if self is greater than or equal to other, False otherwise.

Raises:

Type Description
TypeError

If other is not of same type or it has a different offset.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") > IsoWeek("2023-W02")  # False
IsoWeek("2023-W02") > IsoWeek("2023-W01")  # True


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") > CustomIsoWeek("2023-W01")  # TypeError
IsoWeek("2023-W01") > "2023-W01"  # TypeError

Source code in iso_week_date/mixin.py 
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
def __ge__(self: Self, other: Self) -> bool:
    """Greater than or equal operator.

    Comparing two ISO Week objects is only possible if they have the same `offset_`.

    If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

    Arguments:
       other: Object to compare with.

    Returns:
        `True` if self is greater than or equal to `other`, `False` otherwise.

    Raises:
        TypeError: If `other` is not of same type or it has a different offset.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") > IsoWeek("2023-W02")  # False
    IsoWeek("2023-W02") > IsoWeek("2023-W01")  # True


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") > CustomIsoWeek("2023-W01")  # TypeError
    IsoWeek("2023-W01") > "2023-W01"  # TypeError
    ```
    """
    return not self.__lt__(other)

__gt__(other)

Greater than operator.

Comparing two ISO Week objects is only possible if they have the same offset_.

If that's the case than it's enough to compare their values (as str) due to its lexicographical order.

Parameters:

Name Type Description Default
other Self

Object to compare with.

 required

Returns:

Type Description
bool

True if self is greater than other, False otherwise.

Raises:

Type Description
TypeError

If other is not of same type or it has a different offset.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") >= IsoWeek("2023-W02")  # False
IsoWeek("2023-W01") >= IsoWeek("2023-W01")  # True


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") >= CustomIsoWeek("2023-W01")  # TypeError
IsoWeek("2023-W01") >= "2023-W01"  # TypeError

Source code in iso_week_date/mixin.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
def __gt__(self: Self, other: Self) -> bool:
    """Greater than operator.

    Comparing two ISO Week objects is only possible if they have the same `offset_`.

    If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

    Arguments:
        other: Object to compare with.

    Returns:
        `True` if self is greater than other, `False` otherwise.

    Raises:
        TypeError: If `other` is not of same type or it has a different offset.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") >= IsoWeek("2023-W02")  # False
    IsoWeek("2023-W01") >= IsoWeek("2023-W01")  # True


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") >= CustomIsoWeek("2023-W01")  # TypeError
    IsoWeek("2023-W01") >= "2023-W01"  # TypeError
    ```
    """
    return not self.__le__(other)

__le__(other)

Less than or equal operator.

Comparing two ISO Week objects is only possible if they have the same offset_.

If that's the case than it's enough to compare their values (as str) due to its lexicographical order.

Parameters:

Name Type Description Default
other Self

Object to compare with.

 required

Returns:

Type Description
bool

True if self is less than or equal to other, False otherwise.

Raises:

Type Description
TypeError

If other is not of same type or it has a different offset.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") <= IsoWeek("2023-W01")  # True
IsoWeek("2023-W02") <= IsoWeek("2023-W01")  # False


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") <= CustomIsoWeek("2023-W01")  # TypeError
IsoWeek("2023-W01") <= "2023-W01"  # TypeError

Source code in iso_week_date/mixin.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
def __le__(self: Self, other: Self) -> bool:
    """Less than or equal operator.

    Comparing two ISO Week objects is only possible if they have the same `offset_`.

    If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

    Arguments:
        other: Object to compare with.

    Returns:
        `True` if self is less than or equal to other, `False` otherwise.

    Raises:
        TypeError: If `other` is not of same type or it has a different offset.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") <= IsoWeek("2023-W01")  # True
    IsoWeek("2023-W02") <= IsoWeek("2023-W01")  # False


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") <= CustomIsoWeek("2023-W01")  # TypeError
    IsoWeek("2023-W01") <= "2023-W01"  # TypeError
    ```
    """
    return self.__lt__(other) or self.__eq__(other)

__lt__(other)

Less than operator.

Comparing two ISO Week objects is only possible if they have the same offset_.

If that's the case than it's enough to compare their values (as str) due to its lexicographical order.

Parameters:

Name Type Description Default
other Self

Object to compare with.

 required

Returns:

Type Description
bool

True if self is less than other, False otherwise.

Raises:

Type Description
TypeError

If other is not of same type or it has a different offset.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") < IsoWeek("2023-W02")  # True
IsoWeek("2023-W02") < IsoWeek("2023-W01")  # False


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") < CustomIsoWeek("2023-W01")  # TypeError
IsoWeek("2023-W01") < "2023-W01"  # TypeError

Source code in iso_week_date/mixin.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
def __lt__(self: Self, other: Self) -> bool:
    """Less than operator.

    Comparing two ISO Week objects is only possible if they have the same `offset_`.

    If that's the case than it's enough to compare their values (as `str`) due to its lexicographical order.

    Arguments:
        other: Object to compare with.

    Returns:
        `True` if self is less than other, `False` otherwise.

    Raises:
        TypeError: If `other` is not of same type or it has a different offset.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") < IsoWeek("2023-W02")  # True
    IsoWeek("2023-W02") < IsoWeek("2023-W01")  # False


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") < CustomIsoWeek("2023-W01")  # TypeError
    IsoWeek("2023-W01") < "2023-W01"  # TypeError
    ```
    """
    if isinstance(other, self.__class__):
        if self.offset_ == other.offset_:
            return self.value_ < other.value_
        else:
            msg = f"Cannot compare `{self.name}`'s with different offsets"
            raise TypeError(msg)
    else:
        msg = (
            f"Cannot compare `{self.name}` with type `{type(other)}`, comparison is supported only with other "
            f"`{self.name}` objects"
        )
        raise TypeError(msg)

__ne__(other)

Inequality operator.

Two ISO Week objects are considered equal if and only if they have the same offset_ and the same value_.

Parameters:

Name Type Description Default
other object

Object to compare with.

 required

Returns:

Type Description
bool

True if objects are not equal, False otherwise.

Examples: 

from datetime import timedelta
from iso_week_date import IsoWeek

IsoWeek("2023-W01") != IsoWeek("2023-W01")  # False
IsoWeek("2023-W01") != IsoWeek("2023-W02")  # True


class CustomIsoWeek(IsoWeek):
    offset_ = timedelta(days=1)


IsoWeek("2023-W01") != CustomIsoWeek("2023-W01")  # True

Source code in iso_week_date/mixin.py 
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
def __ne__(self: Self, other: object) -> bool:
    """Inequality operator.

    Two ISO Week objects are considered equal if and only if they have the same `offset_` and the same `value_`.

    Arguments:
        other: Object to compare with.

    Returns:
        `True` if objects are _not_ equal, `False` otherwise.

    Examples:
    ```py
    from datetime import timedelta
    from iso_week_date import IsoWeek

    IsoWeek("2023-W01") != IsoWeek("2023-W01")  # False
    IsoWeek("2023-W01") != IsoWeek("2023-W02")  # True


    class CustomIsoWeek(IsoWeek):
        offset_ = timedelta(days=1)


    IsoWeek("2023-W01") != CustomIsoWeek("2023-W01")  # True
    ```
    """
    return not self.__eq__(other)