ballot.collections.elections

Module Contents

Classes

ElectionCollection

Provides collections with pagination, if they implement a few

class ballot.collections.elections.ElectionCollection(session: sqlalchemy.orm.Session, page: int = 0, year: int | None = None)

Bases: onegov.core.collection.Pagination[onegov.ballot.models.Election]

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[Election]

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.

for_year(year: int | None) → typing_extensions.Self

query() → Query[Election]

get_latest() → list[onegov.ballot.models.Election] | None

Returns the elections with the latest date.

get_years() → list[int]

Returns a list of years for which there are elections.

by_date(date: ElectionCollection.by_date.date) → list[onegov.ballot.models.Election]

Returns the elections on the given date.

by_year(year: int | None = None) → list[onegov.ballot.models.Election]

Returns the elections for the current/given year.

by_id(id: str) → onegov.ballot.models.Election | None

Returns the election by id.