election_day.models.election_compound.mixins
============================================

.. py:module:: election_day.models.election_compound.mixins


Attributes
----------

.. autoapisummary::

   election_day.models.election_compound.mixins.Elections


Classes
-------

.. autoapisummary::

   election_day.models.election_compound.mixins.ResultRow
   election_day.models.election_compound.mixins.TotalRow
   election_day.models.election_compound.mixins.DerivedAttributesMixin


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

.. py:type:: Elections
   :canonical: relationship[list[Election]] | list['Election']


.. py:class:: ResultRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: domain_segment
      :type:  str


   .. py:attribute:: domain_supersegment
      :type:  str


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


   .. py:attribute:: turnout
      :type:  float


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


   .. py:attribute:: expats
      :type:  int


   .. py:attribute:: received_ballots
      :type:  int


   .. py:attribute:: accounted_ballots
      :type:  int


   .. py:attribute:: blank_ballots
      :type:  int


   .. py:attribute:: invalid_ballots
      :type:  int


   .. py:attribute:: accounted_votes
      :type:  int


.. py:class:: TotalRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: turnout
      :type:  float


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


   .. py:attribute:: expats
      :type:  int


   .. py:attribute:: received_ballots
      :type:  int


   .. py:attribute:: accounted_ballots
      :type:  int


   .. py:attribute:: blank_ballots
      :type:  int


   .. py:attribute:: invalid_ballots
      :type:  int


   .. py:attribute:: accounted_votes
      :type:  int


.. py:class:: DerivedAttributesMixin

   A simple mixin to add commonly used functions to election compounds
   and parts.

   Requires an elections and session attribute.


   .. py:property:: session
      :type: sqlalchemy.orm.Session



   .. py:property:: number_of_mandates
      :type: int


      The (total) number of mandates. 



   .. py:property:: allocated_mandates
      :type: int


      Number of already allocated mandates/elected candidates. 



   .. py:property:: completed
      :type: bool


      Returns True, if all elections are completed. 



   .. py:property:: counted
      :type: bool


      True if all elections have been counted. 



   .. py:property:: counted_entities
      :type: list[str | None]



   .. py:property:: results
      :type: list[ResultRow]



   .. py:property:: totals
      :type: TotalRow