election_day.models.election.candidate
======================================

.. py:module:: election_day.models.election.candidate


Attributes
----------

.. autoapisummary::

   election_day.models.election.candidate.list_t


Classes
-------

.. autoapisummary::

   election_day.models.election.candidate.Candidate


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

.. py:data:: list_t

.. py:class:: Candidate

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


   A candidate. 


   .. py:attribute:: __tablename__
      :value: 'candidates'



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


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


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


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


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


   .. py:attribute:: gender
      :type:  sqlalchemy.Column[onegov.election_day.types.Gender | None]


   .. py:attribute:: year_of_birth
      :type:  sqlalchemy.Column[int | None]


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


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


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


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


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


   .. py:attribute:: results
      :type:  sqlalchemy.orm.relationship[list_t[onegov.election_day.models.election.candidate_result.CandidateResult]]


   .. py:attribute:: panachage_results
      :type:  sqlalchemy.orm.relationship[list_t[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.