election_day.collections.screens

Module Contents

Classes

ScreenCollection

Provides collections with pagination, if they implement a few

class election_day.collections.screens.ScreenCollection(session: sqlalchemy.orm.Session, page: int = 0)

Bases: onegov.core.collection.Pagination[onegov.election_day.models.Screen]

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

See onegov.ticket.TicketCollection for an example.

property page_index: int

Returns the current page index (starting at 0).

page: int

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

subset() → Query[Screen]

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.

query() → Query[Screen]

by_id(id: int) → onegov.election_day.models.Screen | None

by_number(number: int) → onegov.election_day.models.Screen | None

add(screen: onegov.election_day.models.Screen) → None

delete(screen: onegov.election_day.models.Screen) → None

export() → list[dict[str, Any]]