election_day.collections.data_sources

Module Contents

Classes

DataSourceCollection	Provides collections with pagination, if they implement a few
DataSourceItemCollection	Provides collections with pagination, if they implement a few

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

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

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

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

by_id(id: uuid.UUID) → onegov.election_day.models.DataSource | None

add(source: onegov.election_day.models.DataSource) → None

delete(source: onegov.election_day.models.DataSource) → None

class election_day.collections.data_sources.DataSourceItemCollection(session: sqlalchemy.orm.Session, id: UUID | None = None, page: int = 0)

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

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

property source: onegov.election_day.models.DataSource | None

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

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

by_id(id: uuid.UUID) → onegov.election_day.models.DataSourceItem | None

add(item: onegov.election_day.models.DataSourceItem) → None

delete(item: onegov.election_day.models.DataSourceItem) → None