directory.collections.directory_entry

Module Contents

Classes

DirectorySearchWidget
DirectoryEntryCollection	Provides a view on a directory's entries.

Attributes

T
DirectoryEntryT

class directory.collections.directory_entry.DirectorySearchWidget

Bases: Protocol[DirectoryEntryT]

property name: str

property search_query: sqlalchemy.orm.Query[DirectoryEntryT]

adapt(query: sqlalchemy.orm.Query[DirectoryEntryT]) → sqlalchemy.orm.Query[DirectoryEntryT]

directory.collections.directory_entry.T

directory.collections.directory_entry.DirectoryEntryT

class directory.collections.directory_entry.DirectoryEntryCollection(directory: onegov.directory.models.Directory, type: str = '*', keywords: Mapping[str, list[str]] | None = None, page: int = 0, search_widget: DirectorySearchWidget[DirectoryEntryT] | None = None)

Bases: onegov.core.collection.GenericCollection[DirectoryEntryT], onegov.core.collection.Pagination[DirectoryEntryT]

Provides a view on a directory’s entries.

The directory itself might be a natural place for lots of these methods to reside, but ultimately we want to avoid mixing the concerns of the directory model and this view-supporting collection.

property search: str | None

property search_query: Query[DirectoryEntryT] | None

property page_index: int

Returns the current page index (starting at 0).

property directory_name: str

property model_class: type[DirectoryEntryT]

__eq__(other: object) → bool

Return self==value.

subset() → Query[DirectoryEntryT]

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

page_by_index(index: 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.

by_name(name: str) → DirectoryEntryT | None

query() → Query[DirectoryEntryT]

valid_keywords(parameters: Mapping[str, T]) → dict[str, T]

available_filters(sort_choices: bool = False, sortfunc: Callable[[str], SupportsRichComparison] | None = None) → Iterable[tuple[str, str, list[str]]]

Retrieve the filters with their choices.

By default the choices are returned in the same order as defined in the structrue. To filter alphabetically, set sort_choices=True.

for_keywords(singular: bool = False, **keywords: list[str]) → typing_extensions.Self

for_toggled_keyword_value(keyword: str, value: str, singular: bool = False) → typing_extensions.Self

without_keywords() → typing_extensions.Self