Skip to content

Value Object

Domain value objects module.

Re-exports the ValueObject base class from the foundation layer
so that domain code can import from a natural location.

value_object

Domain value objects module.

Re-exports the ValueObject base class from the foundation layer
so that domain code can import from a natural location.

ValueObject

Bases: ABC

Base class for all domain value objects.

Value objects are immutable objects defined entirely by their attributes
rather than by an identity. Two value objects with the same attributes
are considered equal.

Concrete subclasses are automatically frozen after __init__ completes.
Intermediate abstract classes remain unfrozen so their concrete leaf
subclasses can finish setting up via super().__init__().

Example 
class Email(ValueObject[str]):
    __slots__ = ("_value",)

    def __init__(self, value: str):
        super().__init__()
        if "@" not in value:
            raise ValueError("Invalid email format")
        self._value = value

    @property
    def value(self) -> str:
        return self._value

    @property
    def _equality_components(self) -> tuple[Hashable, ...]:
        return (self._value,)
Source code in src/forging_blocks/foundation/value_object.py 
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 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
@auto_freeze
class ValueObject[RawValueType](ABC):
    """Base class for all domain value objects.

    Value objects are immutable objects defined entirely by their attributes
    rather than by an identity. Two value objects with the same attributes
    are considered equal.

    Concrete subclasses are automatically frozen after ``__init__`` completes.
    Intermediate abstract classes remain unfrozen so their concrete leaf
    subclasses can finish setting up via ``super().__init__()``.

    Example:
        ```python
        class Email(ValueObject[str]):
            __slots__ = ("_value",)

            def __init__(self, value: str):
                super().__init__()
                if "@" not in value:
                    raise ValueError("Invalid email format")
                self._value = value

            @property
            def value(self) -> str:
                return self._value

            @property
            def _equality_components(self) -> tuple[Hashable, ...]:
                return (self._value,)
        ```
    """

    __is_frozen: bool = False

    def __init_subclass__(cls, **kwargs: Any) -> None:
        """Automatically freeze concrete subclasses after __init__ completes."""
        super().__init_subclass__(**kwargs)
        if not inspect.isabstract(cls):
            auto_freeze(cls)

    def __init__(self) -> None:
        object.__setattr__(self, "_ValueObject__is_frozen", False)

    def __setattr__(self, name: str, value: Any) -> None:
        if getattr(self, "_ValueObject__is_frozen", False):
            raise CantModifyImmutableAttributeError(
                class_name=self.__class__.__name__,
                attribute_name=name,
            )
        object.__setattr__(self, name, value)

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, self.__class__):
            return False
        return self._equality_components == other._equality_components

    def __hash__(self) -> int:
        return hash(self._equality_components)

    def __str__(self) -> str:
        components = self._equality_components
        if len(components) == 1:
            return f"{self.__class__.__name__}({components[0]!r})"
        return f"{self.__class__.__name__}{components!r}"

    def __repr__(self) -> str:
        return self.__str__()

    @property
    @abstractmethod
    def value(self) -> RawValueType:
        """Return the primary raw value encapsulated by the ValueObject."""

    @property
    @abstractmethod
    def _equality_components(self) -> tuple[Hashable, ...]:
        """Return the components used for equality and hashing."""

    @classmethod
    def should_use_internal_freezing(cls) -> bool:
        """Return True for concrete classes, False for abstract ones.

        Abstract classes (like ValueObject itself) must not auto-freeze
        because their ``__init__`` is called mid-way through subclass
        ``__init__`` via ``super().__init__()``.
        """
        return not inspect.isabstract(cls)

    def freeze_instance(self) -> None:
        """Make the instance immutable. Raises CantModifyImmutableAttributeError on attr set."""
        object.__setattr__(self, "_ValueObject__is_frozen", True)

    def unfreeze_instance(self) -> None:
        """Make the instance mutable again."""
        object.__setattr__(self, "_ValueObject__is_frozen", False)

    def _freeze(self) -> None:
        """Freeze the object. Delegates to freeze_instance()."""
        self.freeze_instance()

value: RawValueType abstractmethod property

Return the primary raw value encapsulated by the ValueObject.

__init_subclass__(**kwargs: Any) -> None

Automatically freeze concrete subclasses after init completes.

Source code in src/forging_blocks/foundation/value_object.py 
53
54
55
56
57
def __init_subclass__(cls, **kwargs: Any) -> None:
    """Automatically freeze concrete subclasses after __init__ completes."""
    super().__init_subclass__(**kwargs)
    if not inspect.isabstract(cls):
        auto_freeze(cls)

should_use_internal_freezing() -> bool classmethod

Return True for concrete classes, False for abstract ones.

Abstract classes (like ValueObject itself) must not auto-freeze
because their __init__ is called mid-way through subclass
__init__ via super().__init__().

Source code in src/forging_blocks/foundation/value_object.py 
 97
 98
 99
100
101
102
103
104
105
@classmethod
def should_use_internal_freezing(cls) -> bool:
    """Return True for concrete classes, False for abstract ones.

    Abstract classes (like ValueObject itself) must not auto-freeze
    because their ``__init__`` is called mid-way through subclass
    ``__init__`` via ``super().__init__()``.
    """
    return not inspect.isabstract(cls)

freeze_instance() -> None

Make the instance immutable. Raises CantModifyImmutableAttributeError on attr set.

Source code in src/forging_blocks/foundation/value_object.py 
107
108
109
def freeze_instance(self) -> None:
    """Make the instance immutable. Raises CantModifyImmutableAttributeError on attr set."""
    object.__setattr__(self, "_ValueObject__is_frozen", True)

unfreeze_instance() -> None

Make the instance mutable again.

Source code in src/forging_blocks/foundation/value_object.py 
111
112
113
def unfreeze_instance(self) -> None:
    """Make the instance mutable again."""
    object.__setattr__(self, "_ValueObject__is_frozen", False)