agency.models.move

Classes

SupportsById	Base class for protocol classes.
Move	Base class for moving things.
AgencyMove	Represents a single move of a suborganization.
AgencyMembershipMoveWithinAgency	Represents a single move of a membership with respect to a Agency.
AgencyMembershipMoveWithinPerson	Represents a single move of a membership with respect to a Person.

Module Contents

class agency.models.move.SupportsById[M_co, IdT_contra]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

by_id(id: IdT_contra, /) → M_co | None

class agency.models.move.Move[M: onegov.core.orm.Base, IdT_contra: uuid.UUID | int](session: sqlalchemy.orm.Session, subject_id: IdT_contra, target_id: IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

Base class for moving things.

session

subject_id

target_id

direction

property collection: SupportsById[M, IdT_contra]

Abstractmethod:

property subject: M | None

property target: M | None

abstractmethod execute() → None

class agency.models.move.AgencyMove(session: sqlalchemy.orm.Session, subject_id: IdT_contra, target_id: IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

Bases: Move[onegov.agency.models.ExtendedAgency, int]

Represents a single move of a suborganization.

property collection: onegov.agency.collections.ExtendedAgencyCollection

execute() → None

class agency.models.move.AgencyMembershipMoveWithinAgency(session: sqlalchemy.orm.Session, subject_id: IdT_contra, target_id: IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

Bases: Move[onegov.people.AgencyMembership, uuid.UUID]

Represents a single move of a membership with respect to a Agency.

property collection: onegov.people.AgencyMembershipCollection

execute() → None

class agency.models.move.AgencyMembershipMoveWithinPerson(session: sqlalchemy.orm.Session, subject_id: IdT_contra, target_id: IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

Bases: Move[onegov.people.AgencyMembership, uuid.UUID]

Represents a single move of a membership with respect to a Person.

property collection: onegov.people.AgencyMembershipCollection

execute() → None