election_day.collections.elections
==================================

.. py:module:: election_day.collections.elections


Classes
-------

.. autoapisummary::

   election_day.collections.elections.ElectionCollection


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

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

   Bases: :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.election_day.models.Election`\ ]


   Provides collections with pagination, if they implement a few
   documented properties and methods.

   See :class:`onegov.ticket.TicketCollection` for an example.



   .. py:attribute:: page
      :type:  int


   .. py:attribute:: session


   .. py:attribute:: year
      :value: None



   .. 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:: subset() -> sqlalchemy.orm.Query[onegov.election_day.models.Election]

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




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


      Returns the current page index (starting at 0). 



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

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:method:: for_year(year: int | None) -> Self


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


   .. py:method:: get_latest() -> list[onegov.election_day.models.Election] | None

      Returns the elections with the latest date. 



   .. py:method:: get_years() -> list[int]

      Returns a list of years for which there are elections. 



   .. py:method:: by_date(date: ElectionCollection.by_date.date) -> list[onegov.election_day.models.Election]

      Returns the elections on the given date. 



   .. py:method:: by_year(year: int | None = None) -> list[onegov.election_day.models.Election]

      Returns the elections for the current/given year. 



   .. py:method:: by_id(id: str) -> onegov.election_day.models.Election | None

      Returns the election by id.