value-object-pattern 1.28.0__tar.gz → 1.29.1__tar.gz

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.28.0
+Version: 1.29.1
 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-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.28.0'
+__version__ = '1.29.1'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, UnionValueObject, ValueObject

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/models/collections/list_value_object.py

@@ -204,7 +204,15 @@ class ListValueObject(ValueObject[list[T]], Generic[T]):  # noqa: UP046
             elif isinstance(item, Enum):
                 list_to_return.append(item.value)
 
-            elif isinstance(item, ValueObject) or hasattr(item, 'value'):
+            elif isinstance(item, ValueObject):
+                value = item._value_for_display()
+
+                if isinstance(value, Enum):
+                    value = value.value
+
+                list_to_return.append(repr(value))
+
+            elif hasattr(item, 'value'):
                 value = item.value
 
                 if isinstance(value, Enum):
@@ -256,7 +264,15 @@ class ListValueObject(ValueObject[list[T]], Generic[T]):  # noqa: UP046
             elif isinstance(item, Enum):
                 list_to_return.append(item.value)
 
-            elif isinstance(item, ValueObject) or hasattr(item, 'value'):
+            elif isinstance(item, ValueObject):
+                value = item._value_for_display()
+
+                if isinstance(value, Enum):
+                    value = value.value
+
+                list_to_return.append(str(object=value))
+
+            elif hasattr(item, 'value'):
                 value = item.value
 
                 if isinstance(value, Enum):

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/models/primitive_conversion.py

@@ -101,7 +101,14 @@ def _convert_with_value_attribute(*, value: Any) -> Any:
     Returns:
         Any: Converted value or sentinel when the branch does not apply.
     """
-    if not (isinstance(value, ValueObject) or hasattr(value, 'value')):
+    if isinstance(value, ValueObject):
+        nested_value = value._value_for_display()
+        if nested_value is value:
+            return str(object=value)
+
+        return to_primitive(value=nested_value)
+
+    if not hasattr(value, 'value'):
         return _MISSING
 
     nested_value = getattr(value, 'value', value)

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/models/value_object.py

@@ -136,7 +136,7 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         # >>> IntegerValueObject(value=10)
         ```
         """
-        return f'{self.__class__.__name__}(value={self.value!r})'
+        return f'{self.__class__.__name__}(value={self._value_for_display()!r})'
 
     @override
     def __str__(self) -> str:
@@ -160,7 +160,7 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         # >>> 10
         ```
         """
-        return str(object=self.value)
+        return str(object=self._value_for_display())
 
     @override
     def __hash__(self) -> int:
@@ -367,6 +367,15 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
 
             raise error
 
+    def _value_for_display(self) -> Any:
+        """
+        Returns the value used by display-oriented representations.
+
+        Returns:
+            Any: Value safe for string, repr, and primitive display paths.
+        """
+        return self.value
+
     def _post_order_dfs_mro(self, cls: type, visited: set[type] | None = None, cut_off: type = object) -> list[type]:
         """
         Computes the Post-Order Depth-First Search (DFS) Method Resolution Order (MRO) of a class.

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/usables/__init__.py

@@ -26,6 +26,7 @@ from .primitives import (
     PositiveOrZeroIntegerValueObject,
     PrintableStringValueObject,
     ScreamingSnakeCaseStringValueObject,
+    SecretStringValueObject,
     SnakeCaseStringValueObject,
     StringValueObject,
     TrimmedStringValueObject,
@@ -64,6 +65,7 @@ __all__ = (
     'PrintableStringValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'StringValueObject',

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/usables/primitives/__init__.py

@@ -28,6 +28,7 @@ from .string import (
     PascalCaseStringValueObject,
     PrintableStringValueObject,
     ScreamingSnakeCaseStringValueObject,
+    SecretStringValueObject,
     SnakeCaseStringValueObject,
     StringValueObject,
     TrimmedStringValueObject,
@@ -62,6 +63,7 @@ __all__ = (
     'PositiveOrZeroIntegerValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'TrimmedStringValueObject',

{value_object_pattern-1.28.0 → value_object_pattern-1.29.1}/value_object_pattern/usables/primitives/string/__init__.py

@@ -8,6 +8,7 @@ from .non_empty_string_value_object import NotEmptyStringValueObject
 from .pascal_case_string_value_object import PascalCaseStringValueObject
 from .printable_string_value_object import PrintableStringValueObject
 from .screaming_snake_case_string_value_object import ScreamingSnakeCaseStringValueObject
+from .secret_string_value_object import SecretStringValueObject
 from .snake_case_string_value_object import SnakeCaseStringValueObject
 from .string_value_object import StringValueObject
 from .trimmed_string_value_object import TrimmedStringValueObject
@@ -24,6 +25,7 @@ __all__ = (
     'PascalCaseStringValueObject',
     'PrintableStringValueObject',
     'ScreamingSnakeCaseStringValueObject',
+    'SecretStringValueObject',
     'SnakeCaseStringValueObject',
     'StringValueObject',
     'TrimmedStringValueObject',

value_object_pattern-1.29.1/value_object_pattern/usables/primitives/string/secret_string_value_object.py

@@ -0,0 +1,40 @@
+"""
+SecretStringValueObject value object.
+"""
+
+from sys import version_info
+
+if version_info >= (3, 12):
+    from typing import override  # pragma: no cover
+else:
+    from typing_extensions import override  # pragma: no cover
+
+from .string_value_object import StringValueObject
+
+
+class SecretStringValueObject(StringValueObject):
+    """
+    SecretStringValueObject stores a string that is redacted in display-oriented output.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import SecretStringValueObject
+
+    secret = SecretStringValueObject(value='hidden-value')
+
+    print(secret)
+    # >>> ********
+    ```
+    """
+
+    _MASK: str = '********'
+
+    @override
+    def _value_for_display(self) -> str:
+        """
+        Returns the display-safe representation of the secret value.
+
+        Returns:
+            str: The redacted secret value.
+        """
+        return self._MASK