election_day.utils.election_compound.candidates
===============================================

.. py:module:: election_day.utils.election_compound.candidates


Classes
-------

.. autoapisummary::

   election_day.utils.election_compound.candidates.ElectedCandidateRow


Functions
---------

.. autoapisummary::

   election_day.utils.election_compound.candidates.get_elected_candidates
   election_day.utils.election_compound.candidates.get_candidate_statistics


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

.. py:class:: ElectedCandidateRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: family_name
      :type:  str


   .. py:attribute:: first_name
      :type:  str


   .. py:attribute:: party
      :type:  str | None


   .. py:attribute:: gender
      :type:  onegov.election_day.types.Gender | None


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


   .. py:attribute:: list
      :type:  str | None


   .. py:attribute:: list_id
      :type:  str | None


   .. py:attribute:: election_id
      :type:  str | None


.. py:function:: get_elected_candidates(election_compound: onegov.election_day.models.ElectionCompound | onegov.election_day.models.ElectionCompoundPart, session: sqlalchemy.orm.Session) -> sqlalchemy.orm.Query[ElectedCandidateRow]

   Returns the elected candidates of an election compound. 


.. py:function:: get_candidate_statistics(election_compound: onegov.election_day.models.ElectionCompound | onegov.election_day.models.ElectionCompoundPart, elected_candidates: collections.abc.Iterable[ElectedCandidateRow] | None = None) -> dict[str, CandidateStatistics]