swissvotes.collections.votes

Module Contents

Classes

SwissVoteCollection

A collection of votes.

Attributes

T

swissvotes.collections.votes.T

class swissvotes.collections.votes.SwissVoteCollection(app: onegov.swissvotes.app.SwissvotesApp, page: int = 0, from_date: datetime.date | None = None, to_date: datetime.date | None = None, legal_form: list[int] | None = None, result: list[int] | None = None, policy_area: list[str] | None = None, term: str | None = None, full_text: bool | None = None, position_federal_council: list[int] | None = None, position_national_council: list[int] | None = None, position_council_of_states: list[int] | None = None, sort_by: str | None = None, sort_order: str | None = None)

Bases: onegov.core.collection.Pagination[onegov.swissvotes.models.SwissVote]

A collection of votes.

Supports pagination, filtering, sorting, exporting (CSV/XLSX) and batch adding/updating.

property page_index: int

The current page.

property current_sort_by: str

Returns the currently used sorting key.

Defaults to a reasonable value.

property current_sort_order: str

Returns the currently used sorting order.

Defaults to a reasonable value.

property order_by: ColumnElement[Any]

Returns an SqlAlchemy expression for ordering queries based on the current sorting key and ordering.

property offset: int

The current position in the batch.

property previous: Self | None

The previous page.

property next: Self | None

The next page.

property term_filter_numeric: list[ColumnElement[bool]]

Returns a list of SqlAlchemy filter statements matching possible numeric attributes based on the term.

property term_filter_text: list[ColumnElement[bool]]

Returns a list of SqlAlchemy filter statements matching possible fulltext attributes based on the term.

property term_filter: list[ColumnElement[bool]]

Returns a list of SqlAlchemy filter statements based on the search term.

property last_modified: datetime | None

Returns the last change of any votes.

page: int | None

batch_size = 20

initial_sort_by = 'date'

initial_sort_order = 'descending'

default_sort_order = 'ascending'

SORT_BYS = ('date', 'legal_form', 'result', 'result_people_yeas_p', 'title', 'result_turnout')

SORT_ORDERS = ('ascending', 'descending')

add(**kwargs: Any) → onegov.swissvotes.models.SwissVote

subset() → Query[SwissVote]

Returns an SQLAlchemy query containing all records that should be considered for pagination.

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

default() → typing_extensions.Self

Returns the votes unfiltered and ordered by default.

page_by_index(page: int) → typing_extensions.Self

Returns the requested page.

sort_order_by_key(sort_by: str | None) → str

Returns the sort order by key.

Defaults to ‘unsorted’.

by_order(sort_by: str | None) → typing_extensions.Self

Returns the votes ordered by the given key.

query() → Query[SwissVote]

Returns the votes matching to the current filters and order.

by_bfs_number(bfs_number: decimal.Decimal | str) → onegov.swissvotes.models.SwissVote | None

Returns the vote with the given BFS number.

available_descriptors() → list[set[decimal.Decimal]]

Returns a list of the used descriptor values (level 1-3).

update(votes: Iterable[SwissVote]) → tuple[int, int]

Adds or updates the given votes.

update_metadata(metadata: dict[decimal.Decimal, dict[str, dict[str, Any]]]) → tuple[int, int]

export_csv(file: IO[str]) → None

Exports all votes according to the code book.

export_xlsx(file: IO[str]) → None

Exports all votes according to the code book.