election_day.models.election.list
=================================

.. py:module:: election_day.models.election.list


Classes
-------

.. autoapisummary::

   election_day.models.election.list.List


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

.. py:class:: List

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   A list. 


   .. py:attribute:: __tablename__
      :value: 'lists'



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


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


   .. py:attribute:: number_of_mandates
      :type:  sqlalchemy.Column[int]


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


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


   .. py:attribute:: election
      :type:  sqlalchemy.orm.relationship[onegov.election_day.models.ProporzElection]


   .. py:attribute:: connection_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: connection
      :type:  sqlalchemy.orm.relationship[onegov.election_day.models.ListConnection]


   .. py:attribute:: candidates
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.Candidate]]


   .. py:attribute:: results
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.election.list_result.ListResult]]


   .. py:attribute:: panachage_results
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.ListPanachageResult]]


   .. py:attribute:: panachage_results_lost
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.ListPanachageResult]]


   .. py:attribute:: candidate_panachage_results
      :type:  sqlalchemy.orm.relationship[list[onegov.election_day.models.CandidatePanachageResult]]


   .. py:attribute:: votes


   .. 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:property:: percentage_by_entity
      :type: dict[int, onegov.election_day.types.EntityPercentage]


      Returns the percentage of votes by the entity. Includes uncounted
      entities and entities with no results available.




   .. py:property:: percentage_by_district
      :type: dict[str, onegov.election_day.types.DistrictPercentage]


      Returns the percentage of votes aggregated by the distict. Includes
      uncounted districts and districts with no results available.