translator_directory.collections.translator

Attributes

order_cols

Classes

TranslatorCollection

Provides collections with pagination, if they implement a few

Module Contents

translator_directory.collections.translator.order_cols = ('last_name', 'drive_distance')

class translator_directory.collections.translator.TranslatorCollection(app: onegov.translator_directory.app.TranslatorDirectoryApp, page: int = 0, written_langs: list[str] | None = None, spoken_langs: list[str] | None = None, monitor_langs: list[str] | None = None, order_by: str | None = None, order_desc: bool = False, user_role: str | None = None, search: str | None = None, guilds: list[str] | None = None, interpret_types: list[str] | None = None, state: str | None = 'published', admissions: list[str] | None = None, genders: list[str] | None = None, include_hidden: bool = False, show_all_including_hidden: bool = False)

Bases: onegov.core.collection.GenericCollection[onegov.translator_directory.models.translator.Translator], onegov.core.collection.Pagination[onegov.translator_directory.models.translator.Translator]

Provides collections with pagination, if they implement a few documented properties and methods.

See onegov.ticket.TicketCollection for an example.

batch_size = 10

app

page = 0

user_role = None

search

guilds = []

interpret_types = []

state = 'published'

admissions = []

genders = []

include_hidden = False

show_all_including_hidden = False

written_langs = None

spoken_langs = None

monitor_langs = None

order_by = None

order_desc = False

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

add(update_user: bool = True, **kwargs: Any) → onegov.translator_directory.models.translator.Translator

delete(item: onegov.translator_directory.models.translator.Translator) → None

confirm_current_data(item: onegov.translator_directory.models.translator.Translator) → None

update_user(item: onegov.translator_directory.models.translator.Translator, new_email: str | None) → None

Keep the translator and its user account in sync.

• Creates a new user account if an email address is set (if not already existing).

• Disable user accounts if an email has been deleted.

• Change usernames if an email has changed.

• Make sure used user accounts have the right role.

• Make sure used user accounts are activated.

• Make sure the password is changed if activated or disabled.

static truncate(text: str | None, maxchars: int = 25) → str | None

property model_class: type[onegov.translator_directory.models.translator.Translator]

subset() → sqlalchemy.orm.Query[onegov.translator_directory.models.translator.Translator]

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

property order_expression: sqlalchemy.sql.elements.ColumnElement[Any]

property by_spoken_lang_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_written_lang_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_monitor_lang_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_search_term_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

Search for any word in any field of the search columns

property by_professional_guilds_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_interpreting_types_expression: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_admission: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

property by_gender: tuple[sqlalchemy.sql.elements.ColumnElement[bool], Ellipsis]

by_lastname(lastname: str) → onegov.translator_directory.models.translator.Translator | None

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.

property search_columns: list[sqlalchemy.sql.elements.SQLCoreOperations[str | None]]

The columns used for text search.

query() → sqlalchemy.orm.Query[onegov.translator_directory.models.translator.Translator]

by_form(form: onegov.translator_directory.forms.translator.TranslatorSearchForm) → Self

property available_additional_professional_guilds: list[str]