election_day.collections.data_sources

Classes

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

Module Contents

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

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.

page: int[source]

session[source]

__eq__(other: object) → bool[source]: Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

subset() → sqlalchemy.orm.Query[onegov.election_day.models.DataSource][source]: Returns an SQLAlchemy query containing all records that should be considered for pagination.

property page_index: int[source]: Returns the current page index (starting at 0).

page_by_index(index: int) → Self[source]: Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.

query() → sqlalchemy.orm.Query[onegov.election_day.models.DataSource][source]

by_id(id: uuid.UUID) → onegov.election_day.models.DataSource | None[source]

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

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

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

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.

page: int[source]

session[source]

id = None[source]

__eq__(other: object) → bool[source]: Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

subset() → sqlalchemy.orm.Query[onegov.election_day.models.DataSourceItem][source]: Returns an SQLAlchemy query containing all records that should be considered for pagination.

property page_index: int[source]: Returns the current page index (starting at 0).

page_by_index(index: int) → Self[source]: Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.

query() → sqlalchemy.orm.Query[onegov.election_day.models.DataSourceItem][source]

by_id(id: uuid.UUID) → onegov.election_day.models.DataSourceItem | None[source]

property source: onegov.election_day.models.DataSource | None[source]

add(item: onegov.election_day.models.DataSourceItem) → None[source]

delete(item: onegov.election_day.models.DataSourceItem) → None[source]