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

value_object_pattern/__init__.py

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

value_object_pattern/usables/__init__.py

@@ -11,7 +11,9 @@ from .primitives import (
     LowercaseStringValueObject,
     NegativeFloatValueObject,
     NegativeIntegerValueObject,
+    NoneValueObject,
     NotEmptyStringValueObject,
+    NotNoneValueObject,
     OddIntegerValueObject,
     PositiveFloatValueObject,
     PositiveIntegerValueObject,
@@ -37,8 +39,10 @@ __all__ = (
     'LowercaseStringValueObject',
     'NegativeFloatValueObject',
     'NegativeIntegerValueObject',
+    'NoneValueObject',
     'NotEmptyStringValueObject',
     'NotEmptyStringValueObject',
+    'NotNoneValueObject',
     'OddIntegerValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',

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/usables/primitives/__init__.py

@@ -8,6 +8,7 @@ from .integer import (
     OddIntegerValueObject,
     PositiveIntegerValueObject,
 )
+from .none import NoneValueObject, NotNoneValueObject
 from .string import (
     AlphaStringValueObject,
     AlphanumericStringValueObject,
@@ -33,7 +34,9 @@ __all__ = (
     'LowercaseStringValueObject',
     'NegativeFloatValueObject',
     'NegativeIntegerValueObject',
+    'NoneValueObject',
     'NotEmptyStringValueObject',
+    'NotNoneValueObject',
     'OddIntegerValueObject',
     'PositiveFloatValueObject',
     'PositiveIntegerValueObject',

value_object_pattern/usables/primitives/none/__init__.py

@@ -0,0 +1,7 @@
+from .none_value_object import NoneValueObject
+from .not_none_value_object import NotNoneValueObject
+
+__all__ = (
+    'NoneValueObject',
+    'NotNoneValueObject',
+)

value_object_pattern/usables/primitives/none/none_value_object.py

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

value_object_pattern/usables/primitives/none/not_none_value_object.py

@@ -0,0 +1,50 @@
+"""
+NotNoneValueObject value object.
+"""
+
+from typing import Any, NoReturn
+
+from value_object_pattern.decorators import validation
+from value_object_pattern.models import ValueObject
+
+
+class NotNoneValueObject(ValueObject[Any]):
+    """
+    NotNoneValueObject value object ensures the provided value is not None.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import NotNoneValueObject
+
+    none = NotNoneValueObject(value='test')
+
+    print(repr(none))
+    # >>> NotNoneValueObject(value=test)
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_not_none(self, value: Any) -> None:
+        """
+        Ensures the value object `value` is not None.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is None.
+        """
+        if value is None:
+            self._raise_value_is_not_none(value=value)
+
+    def _raise_value_is_not_none(self, value: Any) -> NoReturn:
+        """
+        Raises a TypeError if the value object `value` is None.
+
+        Args:
+            value (Any): The provided value.
+
+        Raises:
+            TypeError: If the `value` is None.
+        """
+        raise TypeError(f'NotNoneValueObject value <<<{value}>>> must be not None.')

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 0.4.0
+Version: 0.6.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.6.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-value_object_pattern/__init__.py,sha256=12VKCLbhT9Cz8m58ucw8UJ4NhO2G0YY6TZjcEWF7MWA,220
+value_object_pattern/__init__.py,sha256=sWOpV8M7-tNpRZ7NiKDbKg9p67qEM149u-VLic9sKUg,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
@@ -6,14 +6,17 @@ value_object_pattern/decorators/value_object_validation.py,sha256=ENAQuOLalc-dDz
 value_object_pattern/models/__init__.py,sha256=1BsXKFnX_0EufuHurfgdpbMUvnrjF8HLz46saTcmNr4,163
 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/__init__.py,sha256=-VuuKrTyD8X0ImNexe3S6zcrf24o17_p1ghdb9bEyqs,1577
+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
@@ -35,7 +38,7 @@ value_object_pattern/usables/internet/uri/http_https_url_value_object.py,sha256=
 value_object_pattern/usables/internet/uri/http_url_value_object.py,sha256=nU1IjKRmYAV2JWe-Fvji_PGti5qM540OWHf_qtDLiGw,1033
 value_object_pattern/usables/internet/uri/https_url_value_object.py,sha256=SpbIvKHn2kgXVSsxpa7dk5FEr7RwDsgjpSGqPfxl7rU,1048
 value_object_pattern/usables/internet/uri/url_value_object.py,sha256=03jHtGBCPjqhbGkSXtb8qoIv5QUF3ze-cC27-kEIWqA,12419
-value_object_pattern/usables/primitives/__init__.py,sha256=j4AatSdlRIUyQlwZuKMtGhtzgTI4F3lQXw1cC38--2w,1304
+value_object_pattern/usables/primitives/__init__.py,sha256=qA0M7r8cFRbe-eX756KYmHKp8OAaGVBqdDVAQeWYKzo,1407
 value_object_pattern/usables/primitives/boolean/__init__.py,sha256=WhOVH2JAoQnhevx9pW1OsJh-nUF9qKpB4ZGybfSI0U4,237
 value_object_pattern/usables/primitives/boolean/boolean_value_object.py,sha256=CV8UWwQwxcMXOPfuWouePA2ce17_t0S6YxE3gH8mVj8,1380
 value_object_pattern/usables/primitives/boolean/false_value_object.py,sha256=bQRyyjYrjcAXTlStiJSC2aKpTUFWG3foASOfkMk3Kwo,1264
@@ -52,6 +55,9 @@ value_object_pattern/usables/primitives/integer/integer_value_object.py,sha256=J
 value_object_pattern/usables/primitives/integer/negative_integer_value_object.py,sha256=2dYhMs421Oxmt73Hmd8wa2_Er9fNTlGdiuLtf3JasNM,1410
 value_object_pattern/usables/primitives/integer/odd_integer_value_object.py,sha256=fiFJlPJf4aG9CDfyUpxkGqsBPMQuRQuKA7bAZUDz8Fo,1345
 value_object_pattern/usables/primitives/integer/positive_integer_value_object.py,sha256=PDaGwCnGWnARbrYfCIHcLFKJAqSQ90A_8q-6HG91L0I,1432
+value_object_pattern/usables/primitives/none/__init__.py,sha256=2dTbYS2HgP5AO6ps3HzzYmpM2zteLl0wzrmtpA0mxcw,165
+value_object_pattern/usables/primitives/none/none_value_object.py,sha256=Wjg8rojYjoYL30fZVGzFA1E68fuDA0n5v-rCUFWDXqQ,1308
+value_object_pattern/usables/primitives/none/not_none_value_object.py,sha256=8DC8ezGrm9K1aPbhXzjsbb90dzYoOA3mkqvYYorlzSQ,1262
 value_object_pattern/usables/primitives/string/__init__.py,sha256=exdLDLKtfF4QNl5XdA916JqJd-5whAVDQfQcrRrDTzc,879
 value_object_pattern/usables/primitives/string/alpha_value_object.py,sha256=-wB24ZG3LlZjKmlVZt3tfkTeDeFqdlV9cGmYpVkYgKc,1383
 value_object_pattern/usables/primitives/string/alphanumeric_value_object.py,sha256=rXDAgezOC57hPcIcZWmsleIuWPh5XNvjjr7vi02kwUw,1503
@@ -62,7 +68,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.6.0.dist-info/METADATA,sha256=af5HBo3Pmr0pyagjcT_0kcsRtoT3Z_g_7ogxWupJAb4,4018
+value_object_pattern-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+value_object_pattern-0.6.0.dist-info/licenses/LICENSE.md,sha256=6E0wpVdiB-k3oJ9cvVG9BPZ07yIevD3IuOECHKveFkM,1076
+value_object_pattern-0.6.0.dist-info/RECORD,,