agency.collections.people

Module Contents

Classes

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

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: str | None

updated_ge: str | None

updated_eq: str | None

updated_le: str | None

updated_lt: 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: str | None = None, updated_ge: str | None = None, updated_eq: str | None = None, updated_le: str | None = None, updated_lt: 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.

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

batch_size = 20

subset() → Query[ExtendedPerson]

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

__eq__(other: object) → bool

Return self==value.

page_by_index(page: int) → typing_extensions.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]) → typing_extensions.Self

query() → Query[ExtendedPerson]

used_letters() → list[str]

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

used_agencies() → list[str]

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