directory.collections.directory

Attributes

DirectoryT

Classes

DirectoryCollection	Abstract base class for generic types.
EntryRecipientCollection

Module Contents

directory.collections.directory.DirectoryT

class directory.collections.directory.DirectoryCollection(session: sqlalchemy.orm.Session, type: Literal['*', 'generic'] = '*')

class directory.collections.directory.DirectoryCollection(session: sqlalchemy.orm.Session, type: str)

Bases: onegov.core.collection.GenericCollection[DirectoryT]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

type = '*'

property model_class: type[DirectoryT]

query() → Query[DirectoryT]

add(**kwargs: Any) → DirectoryT

unique_name(title: str) → str

by_name(name: str) → DirectoryT | None

class directory.collections.directory.EntryRecipientCollection(session: sqlalchemy.orm.Session)

session

query() → Query[EntryRecipient]

by_id(id: str | UUID) → onegov.directory.models.directory.EntryRecipient | None

add(address: str, directory_id: uuid.UUID, confirmed: bool = False) → onegov.directory.models.directory.EntryRecipient

delete(recipient: onegov.directory.models.directory.EntryRecipient) → None