election_day.models.vote.ballot
===============================

.. py:module:: election_day.models.vote.ballot


Classes
-------

.. autoapisummary::

   election_day.models.vote.ballot.ResultsByDistrictRow
   election_day.models.vote.ballot.Ballot


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

.. py:class:: ResultsByDistrictRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: counted
      :type:  bool


   .. py:attribute:: accepted
      :type:  bool


   .. py:attribute:: yeas
      :type:  int


   .. py:attribute:: nays
      :type:  int


   .. py:attribute:: yeas_percentage
      :type:  float


   .. py:attribute:: nays_percentage
      :type:  float


   .. py:attribute:: empty
      :type:  int


   .. py:attribute:: invalid
      :type:  int


   .. py:attribute:: eligible_voters
      :type:  int


   .. py:attribute:: entity_ids
      :type:  list[int]


.. py:class:: Ballot

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.election_day.models.mixins.TitleTranslationsMixin`, :py:obj:`onegov.election_day.models.vote.mixins.DerivedAttributesMixin`, :py:obj:`onegov.election_day.models.vote.mixins.DerivedBallotsCountMixin`


   A ballot contains a single question asked for a vote.

   Usually each vote has exactly one ballot, but it's possible for votes to
   have multiple ballots.

   In the latter case there are usually two options that are mutually
   exclusive and a third option that acts as a tie breaker between
   the frist two options.

   The type of the ballot indicates this. Standard ballots only contain
   one question, variant ballots contain multiple questions.



   .. py:attribute:: __tablename__
      :value: 'ballots'



   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: external_id
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: type
      :type:  sqlalchemy.Column[onegov.election_day.types.BallotType]


   .. py:attribute:: vote_id
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: title_translations
      :type:  sqlalchemy.Column[collections.abc.Mapping[str, str] | None]


   .. py:attribute:: title


   .. py:attribute:: results
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.vote.ballot_result.BallotResult]]


   .. py:attribute:: vote
      :type:  sqlalchemy.orm.relationship[onegov.election_day.models.Vote]


   .. py:property:: results_by_district
      :type: sqlalchemy.orm.Query[ResultsByDistrictRow]


      Returns the results aggregated by the distict.  



   .. py:attribute:: counted
      :type:  sqlalchemy.Column[bool]


   .. py:property:: progress
      :type: tuple[int, int]


      Returns a tuple with the first value being the number of counted
      ballot results and the second value being the number of total ballot
      results.




   .. py:property:: answer
      :type: str | None



   .. py:attribute:: yeas


   .. py:attribute:: nays


   .. py:attribute:: empty


   .. py:attribute:: invalid


   .. py:attribute:: eligible_voters


   .. py:attribute:: expats


   .. py:method:: aggregate_results(attribute: str) -> int

      Gets the sum of the given attribute from the results. 



   .. py:method:: aggregate_results_expression(attribute: str) -> sqlalchemy.sql.ColumnElement[int]
      :classmethod:


      Gets the sum of the given attribute from the results,
      as SQL expression.




   .. py:method:: clear_results(clear_all: bool = False) -> None

      Clear all the results.