value-object-pattern 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.4.0'
+__version__ = '0.5.0'
 
 from .decorators import process, validation
 from .models import EnumerationValueObject, ValueObject

value_object_pattern/usables/dates/__init__.py

@@ -1,9 +1,12 @@
 from .date import DateValueObject, StringDateValueObject
 from .datetime import DatetimeValueObject, StringDatetimeValueObject
+from .timezone import StringTimezoneValueObject, TimezoneValueObject
 
 __all__ = (
     'DateValueObject',
     'DatetimeValueObject',
     'StringDateValueObject',
     'StringDatetimeValueObject',
+    'StringTimezoneValueObject',
+    'TimezoneValueObject',
 )

value_object_pattern/usables/dates/timezone/__init__.py

@@ -0,0 +1,7 @@
+from .string_timezone_value_object import StringTimezoneValueObject
+from .timezone_value_object import TimezoneValueObject
+
+__all__ = (
+    'StringTimezoneValueObject',
+    'TimezoneValueObject',
+)

value_object_pattern/usables/dates/timezone/string_timezone_value_object.py

@@ -0,0 +1,66 @@
+"""
+StringTimezoneValueObject value object.
+"""
+
+from typing import Any, NoReturn
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
+
+from value_object_pattern.decorators import process, validation
+from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
+
+
+class StringTimezoneValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    StringTimezoneValueObject value object ensures the provided value is a string timezone.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.dates import StringTimezoneValueObject
+
+    timezone = StringTimezoneValueObject(value='UTC')
+
+    print(repr(timezone))
+    # >>> StringTimezoneValueObject(value='UTC')
+    ```
+    """
+
+    @process(order=0)
+    def _ensure_value_is_normalized(self, value: str) -> str:
+        """
+        Ensures the value object `value` is normalized timezone string (uppercase).
+
+        Args:
+            value (str): The provided value.
+
+        Returns:
+            str: The normalized timezone string.
+        """
+        return value.upper()
+
+    @validation(order=0)
+    def _ensure_value_is_timezone(self, value: str) -> None:
+        """
+        Ensures the value object `value` is a string timezone.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a timezone.
+        """
+        try:
+            ZoneInfo(value)
+        except ZoneInfoNotFoundError:
+            self._raise_value_is_not_timezone(value=value)
+
+    def _raise_value_is_not_timezone(self, value: Any) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a timezone.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a timezone.
+        """
+        raise ValueError(f'StringTimezoneValueObject value <<<{value}>>> must be a timezone.')

value_object_pattern/usables/dates/timezone/timezone_value_object.py

@@ -0,0 +1,53 @@
+"""
+TimezoneValueObject value object.
+"""
+
+from datetime import tzinfo
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.models import ValueObject
+
+
+class TimezoneValueObject(ValueObject[tzinfo]):
+    """
+    TimezoneValueObject value object ensures the provided value is a timezone.
+
+    Example:
+    ```python
+    from datetime import UTC
+
+    from value_object_pattern.usables import TimezoneValueObject
+
+    timezone = TimezoneValueObject(value=UTC)
+
+    print(repr(timezone))
+    # >>> TimezoneValueObject(value=UTC)
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_timezone(self, value: tzinfo) -> None:
+        """
+        Ensures the value object `value` is a timezone.
+
+        Args:
+            value (tzinfo): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a timezone.
+        """
+        if not isinstance(value, tzinfo):
+            self._raise_value_is_not_timezone(value=value)
+
+    def _raise_value_is_not_timezone(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is not a timezone.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is not a timezone.
+        """
+        raise TypeError(f'TimezoneValueObject value <<<{value}>>> must be a timezone. Got <<<{type(value).__name__}>>> type.')  # noqa: E501  # fmt: skip

{value_object_pattern-0.4.0.dist-info → value_object_pattern-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 0.4.0
+Version: 0.5.0
 Summary: The Value Object Pattern is a Python package that streamlines the creation and management of value objects in your projects.
 Project-URL: Homepage, https://github.com/adriamontoto/value-object-pattern
 Project-URL: Repository, https://github.com/adriamontoto/value-object-pattern

{value_object_pattern-0.4.0.dist-info → value_object_pattern-0.5.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-value_object_pattern/__init__.py,sha256=12VKCLbhT9Cz8m58ucw8UJ4NhO2G0YY6TZjcEWF7MWA,220
+value_object_pattern/__init__.py,sha256=-eQ-LpAiKLoF5jLg7DGL_FL-k-ZO3Jlp7XBdn616kCI,220
 value_object_pattern/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 value_object_pattern/decorators/__init__.py,sha256=Ze0c0z3x5sdmV-KB7nljPsybpoTXAgjJDGfR8FCIxUQ,138
 value_object_pattern/decorators/value_object_process.py,sha256=Q_0w26XolcfZOE6avveA5OGs1yIMNAVC_AxsBV8F5D0,2621
@@ -7,13 +7,16 @@ value_object_pattern/models/__init__.py,sha256=1BsXKFnX_0EufuHurfgdpbMUvnrjF8HLz
 value_object_pattern/models/enumeration_value_object.py,sha256=6ih7GlohDcA3Lknk6SaIsve2Udaco8iHTPkRCrhvYJo,4886
 value_object_pattern/models/value_object.py,sha256=-xXCk_qwCj_VBIzNJfUflM4vD7M0bicJdlprFYh2_Uw,13627
 value_object_pattern/usables/__init__.py,sha256=LsHh5uSECizrDXPogZC3zRMzcBIBPyiWXpqSrG2qHrg,1483
-value_object_pattern/usables/dates/__init__.py,sha256=x4MafCtJ1S9WN36cVGOfPdXeKgfptlg4QkcH9fPV4tA,253
+value_object_pattern/usables/dates/__init__.py,sha256=fGcL0u-dpxruMAWP-As1-ZUr-982SK1vb3sjnYyJh5g,382
 value_object_pattern/usables/dates/date/__init__.py,sha256=rSifr41n8gmqW80e0Ygzoj221dpVsZy7m4TecC_VJus,174
 value_object_pattern/usables/dates/date/date_value_object.py,sha256=f2JuxEJlZaMRMPq53qtDnFLxNC-uJLZJwt31_lVetqo,5054
 value_object_pattern/usables/dates/date/string_date_value_object.py,sha256=yT60yG4dTK8tffkzom05OcLpP7jHTzc0OqhU5fjTbvU,6327
 value_object_pattern/usables/dates/datetime/__init__.py,sha256=5WY9lBtGPf3p7Kb_0v7plLFrq4GzZCj8kw3cU7qHZjk,198
 value_object_pattern/usables/dates/datetime/datetime_value_object.py,sha256=-HvQz1ixAesh9HVafzejSOti88eORJ3aH8502kgqXhY,6759
 value_object_pattern/usables/dates/datetime/string_datetime_value_object.py,sha256=fm9t4N1oxfHPUgmw2RwVWq3W_NaOkpqwvSJapfNgjNM,8334
+value_object_pattern/usables/dates/timezone/__init__.py,sha256=_InzUzzIoSWusLcMwq8SaT-M0LkJUtAPA1wgFgnQlj4,198
+value_object_pattern/usables/dates/timezone/string_timezone_value_object.py,sha256=0O2gJJu39IF70e6V0GZWTVoZBL89jjfOA5i_Bp33nQ4,1927
+value_object_pattern/usables/dates/timezone/timezone_value_object.py,sha256=nzy63t5ffJyiAVfbaLHRkXn3mE6c0-qmVDOAvchdwWs,1466
 value_object_pattern/usables/identifiers/__init__.py,sha256=0-JdvoXEqs_Y-XwVc-Jl2ak5wF4fp3XJXjUp0Z0qOxs,174
 value_object_pattern/usables/identifiers/string_uuid_value_object.py,sha256=l5itu12JycSS8qQKg-Fou6Sj0mKxKFZEQx3Zq4iAZtE,1852
 value_object_pattern/usables/identifiers/uuid_value_object.py,sha256=BxvvSQXrHngExB8opsxZC8bgcYGLlpNeCug7iOg2IoQ,1402
@@ -62,7 +65,7 @@ value_object_pattern/usables/primitives/string/printable_string_value_object.py,
 value_object_pattern/usables/primitives/string/string_value_object.py,sha256=6u98oMzz5qsVNEWna-UpziDmzFhaLFW7J5NBoJnbKWk,1370
 value_object_pattern/usables/primitives/string/trimmed_string_value_object.py,sha256=WMp4IBA74cEli-N_9Q7qU_oMszHtk5tgCr6o2y99HMs,1435
 value_object_pattern/usables/primitives/string/uppercase_string_value_object.py,sha256=yZajkdq09zb56_UHs4nc0sIeTV4K74ek26JcoHYhM64,1457
-value_object_pattern-0.4.0.dist-info/METADATA,sha256=4wEChHY3T0DNwarqKoc9_gGhl4hsomvd86r1bN7W1sI,4018
-value_object_pattern-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-value_object_pattern-0.4.0.dist-info/licenses/LICENSE.md,sha256=6E0wpVdiB-k3oJ9cvVG9BPZ07yIevD3IuOECHKveFkM,1076
-value_object_pattern-0.4.0.dist-info/RECORD,,
+value_object_pattern-0.5.0.dist-info/METADATA,sha256=0BdI5ht5bc2zuT_53nZAyC565OA99ZP5ccRUnR7Izm4,4018
+value_object_pattern-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+value_object_pattern-0.5.0.dist-info/licenses/LICENSE.md,sha256=6E0wpVdiB-k3oJ9cvVG9BPZ07yIevD3IuOECHKveFkM,1076
+value_object_pattern-0.5.0.dist-info/RECORD,,