agency.collections.people

Classes

FilterParams	dict() -> new empty dictionary
ExtendedPersonCollection	Extends the common person collection by the ability to filter by

Module Contents

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

letter: str | None

agency: str | None

first_name: str | None

last_name: str | None

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.people.ExtendedPersonCollection(session: sqlalchemy.orm.Session, page: int = 0, letter: str | None = None, agency: str | None = None, first_name: str | None = None, last_name: 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, xlsx_modified: str | None = None)

Bases: onegov.people.collections.people.BasePersonCollection[onegov.agency.models.ExtendedPerson], onegov.core.collection.Pagination[onegov.agency.models.ExtendedPerson]

Extends the common person collection by the ability to filter by the first letter of the last name, by the organization, by first or last name. Adds pagination.

batch_size = 20

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

session

page = 0

letter = None

agency = None

first_name = None

last_name = None

updated_gt = None

updated_ge = None

updated_eq = None

updated_le = None

updated_lt = None

exclude_hidden = False

xlsx_modified = None

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

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

__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.

page_by_index(page: 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.ExtendedPerson]

property used_letters: list[str]

Returns a list of all the distinct first letters of people’s last names.

property used_agencies: list[str]

Returns a list of all the agencies people are members of.