agency.collections.agencies

Classes

FilterParams	dict() -> new empty dictionary
ExtendedAgencyCollection	A base class for collections working with AdjacencyList.
PaginatedAgencyCollection	Abstract base class for generic types.

Module Contents

class agency.collections.agencies.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)

title: str | None

updated_gt: str | None

updated_ge: str | None

updated_eq: str | None

updated_le: str | None

updated_lt: str | None

class agency.collections.agencies.ExtendedAgencyCollection(session: sqlalchemy.orm.Session, root_pdf_modified: str | None = None, browse: str | None = None)

Bases: onegov.core.orm.abstract.AdjacencyListCollection[onegov.agency.models.ExtendedAgency]

A base class for collections working with AdjacencyList.

__listclass__

The list class this collection handles. Must inherit from AdjacencyList.

root_pdf_modified

browse

class agency.collections.agencies.PaginatedAgencyCollection(session: sqlalchemy.orm.Session, page: int = 0, parent: str | Literal[False] | None = None, exclude_hidden: bool = True, joinedload: Collection[str] | None = None, title: str | None = None, updated_gt: str | None = None, updated_ge: str | None = None, updated_eq: str | None = None, updated_le: str | None = None, updated_lt: str | None = None, undefer: Collection[str] | None = None)

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

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

parent

title

updated_gt

updated_ge

updated_eq

updated_le

updated_lt

exclude_hidden

joinedload

undefer

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

__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() → Query[ExtendedAgency]

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: Unpack[FilterParams]) → Self

query() → Query[ExtendedAgency]