swissvotes.collections.votes
============================

.. py:module:: swissvotes.collections.votes


Attributes
----------

.. autoapisummary::

   swissvotes.collections.votes.T


Classes
-------

.. autoapisummary::

   swissvotes.collections.votes.SwissVoteCollection


Module Contents
---------------

.. py:data:: T

.. py:class:: 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: :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.swissvotes.models.SwissVote`\ ]


   A collection of votes.

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



   .. py:attribute:: page
      :type:  int | None


   .. py:attribute:: batch_size
      :value: 20



   .. py:attribute:: initial_sort_by
      :value: 'date'



   .. py:attribute:: initial_sort_order
      :value: 'descending'



   .. py:attribute:: default_sort_order
      :value: 'ascending'



   .. py:attribute:: SORT_BYS
      :value: ('date', 'legal_form', 'result', 'result_people_yeas_p', 'title', 'result_turnout')



   .. py:attribute:: SORT_ORDERS
      :value: ('ascending', 'descending')



   .. py:attribute:: app


   .. py:attribute:: session


   .. py:attribute:: from_date
      :value: None



   .. py:attribute:: to_date
      :value: None



   .. py:attribute:: legal_form
      :value: None



   .. py:attribute:: result
      :value: None



   .. py:attribute:: policy_area
      :value: None



   .. py:attribute:: term
      :value: None



   .. py:attribute:: full_text
      :value: None



   .. py:attribute:: position_federal_council
      :value: None



   .. py:attribute:: position_national_council
      :value: None



   .. py:attribute:: position_council_of_states
      :value: None



   .. py:attribute:: sort_by
      :value: None



   .. py:attribute:: sort_order
      :value: None



   .. py:method:: add(**kwargs: Any) -> onegov.swissvotes.models.SwissVote


   .. py:method:: subset() -> sqlalchemy.orm.Query[onegov.swissvotes.models.SwissVote]

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




   .. py:method:: __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.




   .. py:method:: default() -> Self

      Returns the votes unfiltered and ordered by default. 



   .. py:property:: page_index
      :type: int


      The current page. 



   .. py:method:: page_by_index(page: int) -> Self

      Returns the requested page. 



   .. py:property:: current_sort_by
      :type: str


      Returns the currently used sorting key.

      Defaults to a reasonable value.




   .. py:property:: current_sort_order
      :type: str


      Returns the currently used sorting order.

      Defaults to a reasonable value.




   .. py:method:: sort_order_by_key(sort_by: str | None) -> str

      Returns the sort order by key.

      Defaults to 'unsorted'.




   .. py:method:: by_order(sort_by: str | None) -> Self

      Returns the votes ordered by the given key. 



   .. py:property:: order_by
      :type: sqlalchemy.sql.ColumnElement[Any]


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




   .. py:property:: offset
      :type: int


      The current position in the batch. 



   .. py:property:: previous
      :type: Self | None


      The previous page. 



   .. py:property:: next
      :type: Self | None


      The next page. 



   .. py:property:: term_filter_numeric
      :type: list[sqlalchemy.sql.ColumnElement[bool]]


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




   .. py:property:: term_filter_text
      :type: list[sqlalchemy.sql.ColumnElement[bool]]


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




   .. py:property:: term_filter
      :type: list[sqlalchemy.sql.ColumnElement[bool]]


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




   .. py:method:: query() -> sqlalchemy.orm.Query[onegov.swissvotes.models.SwissVote]

      Returns the votes matching to the current filters and order. 



   .. py:method:: by_bfs_number(bfs_number: decimal.Decimal | str) -> onegov.swissvotes.models.SwissVote | None

      Returns the vote with the given BFS number. 



   .. py:method:: by_bfs_numbers(bfs_numbers: collections.abc.Iterable[decimal.Decimal | str]) -> dict[decimal.Decimal | str, onegov.swissvotes.models.SwissVote]

      Returns the votes with the given BFS numbers. 



   .. py:property:: available_descriptors
      :type: list[set[decimal.Decimal]]


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



   .. py:method:: update(votes: collections.abc.Iterable[onegov.swissvotes.models.SwissVote]) -> tuple[int, int]

      Adds or updates the given votes. 



   .. py:method:: update_metadata(metadata: dict[decimal.Decimal, dict[str, dict[str, Any]]]) -> tuple[int, int]


   .. py:property:: last_modified
      :type: datetime.datetime | None


      Returns the last change of any votes. 



   .. py:method:: export_csv(file: IO[str]) -> None

      Exports all votes according to the code book. 



   .. py:method:: export_xlsx(file: IO[str]) -> None

      Exports all votes according to the code book.