translator_directory.collections.language

Module Contents

Classes

LanguageCollection

Abstract base class for generic types.

class translator_directory.collections.language.LanguageCollection(session: sqlalchemy.orm.Session, page: int = 0, letter: str | None = None)

Bases: onegov.core.collection.GenericCollection[onegov.translator_directory.models.language.Language], onegov.core.collection.Pagination[onegov.translator_directory.models.language.Language]

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

property model_class: type[onegov.translator_directory.models.language.Language]

property page_index: int

Returns the current page index (starting at 0).

batch_size = 20

query() → Query[Language]

__eq__(other: object) → bool

Return self==value.

subset() → Query[Language]

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.

used_letters() → list[str]

Returns a list of all the distinct first letters of the peoples last names.

by_letter(letter: str | None) → typing_extensions.Self