agency.collections.memberships

Classes

FilterParams	dict() -> new empty dictionary
PaginatedMembershipCollection	Abstract base class for generic types.

Module Contents

class agency.collections.memberships.FilterParams

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

updated_gt: datetime.datetime | str | None

updated_ge: datetime.datetime | str | None

updated_eq: datetime.datetime | str | None

updated_le: datetime.datetime | str | None

updated_lt: datetime.datetime | str | None

class agency.collections.memberships.PaginatedMembershipCollection(session: sqlalchemy.orm.Session, page: int = 0, agency: str | None = None, person: str | None = None, updated_gt: datetime.datetime | str | None = None, updated_ge: datetime.datetime | str | None = None, updated_eq: datetime.datetime | str | None = None, updated_le: datetime.datetime | str | None = None, updated_lt: datetime.datetime | str | None = None, exclude_hidden: bool = True)

Bases: onegov.core.collection.GenericCollection[onegov.agency.models.ExtendedAgencyMembership], onegov.core.collection.Pagination[onegov.agency.models.ExtendedAgencyMembership]

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

page = 0

agency = None

person = None

updated_gt = None

updated_ge = None

updated_eq = None

updated_le = None

updated_lt = None

exclude_hidden = True

property model_class: type[onegov.agency.models.ExtendedAgencyMembership]

__eq__(other: object) → bool

Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

subset() → sqlalchemy.orm.Query[onegov.agency.models.ExtendedAgencyMembership]

Returns an SQLAlchemy query containing all records that should be considered for pagination.

property page_index: int

Returns the current page index (starting at 0).

page_by_index(index: int) → Self

Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.

for_filter(**kwargs: typing_extensions.Unpack[FilterParams]) → Self

query() → sqlalchemy.orm.Query[onegov.agency.models.ExtendedAgencyMembership]