Skip to content

Identified

identified

Protocol for domain objects that carry an identifier.

Identified

Bases: Protocol

Protocol for objects that expose an id property.

Satisfied by any object whose id returns the object's identity,
which may be None for draft/unpersisted instances.

Example 
class User(Identified[int]):
    def __init__(self, user_id: int, name: str) -> None:
        self._id = user_id
        self.name = name

    @property
    def id(self) -> int | None:
        return self._id


user = User(42, "Alice")
assert user.id == 42
Source code in src/forging_blocks/foundation/identified.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class Identified[IdentityType](Protocol):
    """Protocol for objects that expose an ``id`` property.

    Satisfied by any object whose ``id`` returns the object's identity,
    which may be ``None`` for draft/unpersisted instances.

    Example:
        ```python
        class User(Identified[int]):
            def __init__(self, user_id: int, name: str) -> None:
                self._id = user_id
                self.name = name

            @property
            def id(self) -> int | None:
                return self._id


        user = User(42, "Alice")
        assert user.id == 42
        ```
    """

    @property
    def id(self) -> IdentityType | None: ...