value-object-pattern 0.3.0__tar.gz → 0.5.0__tar.gz

{value_object_pattern-0.3.0 → value_object_pattern-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 0.3.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.3.0 → value_object_pattern-0.5.0}/pyproject.toml

@@ -63,7 +63,7 @@ release = ['build>=1.2.2', 'python-semantic-release>=10.0.2']
 test = [
     'pytest>=8.0.0',
     'pytest-randomly>=3.0.0',
-    'object-mother-pattern>=1.0.0',
+    'object-mother-pattern>=2.1.0',
     { include-group = 'coverage' },
 ]
 types = ['types-python-dateutil>=2.9.0.20241206']

{value_object_pattern-0.3.0 → value_object_pattern-0.5.0}/value_object_pattern/__init__.py

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

{value_object_pattern-0.3.0 → value_object_pattern-0.5.0}/value_object_pattern/models/enumeration_value_object.py

@@ -18,7 +18,7 @@ from value_object_pattern.models.value_object import ValueObject
 E = TypeVar('E', bound=Enum)
 
 
-class EnumerationValueObject(ValueObject[str | E], Generic[E]):
+class EnumerationValueObject(ValueObject[str | E], Generic[E]):  # noqa: UP046
     """
     EnumerationValueObject is a value object that ensures the provided value is from an enumeration.
 

{value_object_pattern-0.3.0 → value_object_pattern-0.5.0}/value_object_pattern/models/value_object.py

@@ -15,7 +15,7 @@ else:
 T = TypeVar('T')
 
 
-class ValueObject(ABC, Generic[T]):
+class ValueObject(ABC, Generic[T]):  # noqa: UP046
     """
     ValueObject generic type.
 
@@ -34,13 +34,14 @@ class ValueObject(ABC, Generic[T]):
     ```
     """
 
-    __slots__ = ('_title', '_value')
-    __match_args__ = ('_title', '_value')
+    __slots__ = ('_parameter', '_title', '_value')
+    __match_args__ = ('_parameter', '_title', '_value')
 
     _value: T
     _title: str
+    _parameter: str
 
-    def __init__(self, *, value: T, title: str | None = None) -> None:
+    def __init__(self, *, value: T, title: str | None = None, parameter: str | None = None) -> None:
         """
         ValueObject value object constructor.
 
@@ -48,10 +49,16 @@ class ValueObject(ABC, Generic[T]):
             value (T): The value to store in the value object.
             title (str | None, optional): The title of the value object when raising exceptions, if title is None, the
             class name is used instead. Defaults to None.
+            parameter (str | None, optional): The parameter name of the value object when raising exceptions, if
+            parameter is None, the string "value" is used instead. Defaults to None.
 
         Raises:
             TypeError: If the title is not a string.
+            ValueError: If the title is an empty string.
             ValueError: If the title contains leading or trailing whitespaces.
+            TypeError: If the parameter is not a string.
+            ValueError: If the parameter is an empty string.
+            ValueError: If the parameter contains leading or trailing whitespaces.
 
         Example:
         ```python
@@ -71,12 +78,28 @@ class ValueObject(ABC, Generic[T]):
             title = self.__class__.__name__
 
         if type(title) is not str:
-            raise TypeError(f'ValueObject value <<<{title}>>> must be a string. Got <<<{type(title).__name__}>>> instead.')  # noqa: E501  # fmt: skip
+            raise TypeError(f'ValueObject title <<<{title}>>> must be a string. Got <<<{type(title).__name__}>>> instead.')  # noqa: E501  # fmt: skip
+
+        if title == '':
+            raise ValueError(f'ValueObject title <<<{title}>>> must not be an empty string.')  # noqa: E501  # fmt: skip
 
         if title.strip() != title:
             raise ValueError(f'ValueObject title <<<{title}>>> contains leading or trailing whitespaces. Only trimmed values are allowed.')  # noqa: E501  # fmt: skip
 
+        if parameter is None:
+            parameter = 'value'
+
+        if type(parameter) is not str:
+            raise TypeError(f'ValueObject parameter <<<{parameter}>>> must be a string. Got <<<{type(parameter).__name__}>>> instead.')  # noqa: E501  # fmt: skip
+
+        if parameter == '':
+            raise ValueError(f'ValueObject parameter <<<{parameter}>>> must not be an empty string.')  # noqa: E501  # fmt: skip
+
+        if parameter.strip() != parameter:
+            raise ValueError(f'ValueObject parameter <<<{parameter}>>> contains leading or trailing whitespaces. Only trimmed values are allowed.')  # noqa: E501  # fmt: skip
+
         object.__setattr__(self, '_title', title)
+        object.__setattr__(self, '_parameter', parameter)
 
         self._validate(value=value)
         value = self._process(value=value)
@@ -247,6 +270,8 @@ class ValueObject(ABC, Generic[T]):
             for class_name in {cls.__name__ for cls in classes}:
                 error.args = (str(object=error.args[0]).replace(class_name, self.title),)
 
+            error.args = (str(object=error.args[0]).replace('value', self.parameter, 1),)
+
             raise error
 
     def _post_order_dfs_mro(self, cls: type, visited: set[type] | None = None, cut_off: type = object) -> list[type]:
@@ -381,3 +406,27 @@ class ValueObject(ABC, Generic[T]):
         ```
         """
         return self._title
+
+    @property
+    def parameter(self) -> str:
+        """
+        Returns the value object parameter name.
+
+        Returns:
+            str: The value object parameter name.
+
+        Example:
+        ```python
+        from value_object_pattern import ValueObject
+
+
+        class IntegerValueObject(ValueObject[int]):
+            pass
+
+
+        integer = IntegerValueObject(value=10)
+        print(integer.parameter)
+        # >>> value
+        ```
+        """
+        return self._parameter

{value_object_pattern-0.3.0 → value_object_pattern-0.5.0}/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-0.5.0/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-0.5.0/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-0.5.0/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