Updatable

Bases: Protocol

Updatable interface for updating domain models.

Source code in src/alpha/interfaces/updatable.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
class Updatable(Protocol):
    """Updatable interface for updating domain models."""

    def update(self, obj: DomainModel) -> DomainModel:
        """Update a domain model object.

        Parameters
        ----------
        obj
            The domain model object to be updated.

        Returns
        -------
            The updated domain model object.
        """
        ...

Methods:

update 

update(obj)

Update a domain model object.

Parameters:
  • obj (DomainModel) –

    The domain model object to be updated.
Returns:
  • The updated domain model object. –
Source code in src/alpha/interfaces/updatable.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
def update(self, obj: DomainModel) -> DomainModel:
    """Update a domain model object.

    Parameters
    ----------
    obj
        The domain model object to be updated.

    Returns
    -------
        The updated domain model object.
    """
    ...