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

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


Classes
-------

.. autoapisummary::

   election_day.models.mixins.DomainOfInfluenceMixin
   election_day.models.mixins.StatusMixin
   election_day.models.mixins.TitleTranslationsMixin
   election_day.models.mixins.IdFromTitlesMixin
   election_day.models.mixins.LastModifiedMixin
   election_day.models.mixins.ExplanationsPdfMixin


Functions
---------

.. autoapisummary::

   election_day.models.mixins.summarized_property


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

.. py:class:: DomainOfInfluenceMixin

   Defines the scope of a principal, an election, an election compound
   or a vote.

   The following domains of influence are supported:
   - federation: The vote or election is nation wide.
   - canton: The vote or election takes place in one canton only.
   - region: The election takes place in one region of a canton only.
   - district: The election takes place in one district of a canton only.
   - municipality: The vote or election takes place in one municipality only.
   - none: The election takes place in certain municipalities only.



   .. py:property:: domain
      :type: sqlalchemy.Column[onegov.election_day.types.DomainOfInfluence]



.. py:class:: StatusMixin

   Mixin providing status indication for votes and elections. 


   .. py:property:: status
      :type: sqlalchemy.Column[onegov.election_day.types.Status | None]



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


      Returns True, if the election or vote is completed.

      The status is evaluated in the first place. If the status is not known,
      it is guessed from the progress / counted fields.




.. py:class:: TitleTranslationsMixin

   Adds a helper to return the translation of the title without depending
   on the locale of the request.



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


   .. py:method:: get_title(locale: str, default_locale: str | None = None) -> str | None

      Returns the requested translation of the title, falls back to the
      given default locale if provided.




.. py:class:: IdFromTitlesMixin

   .. py:property:: session_manager
      :type: onegov.core.orm.SessionManager | None



   .. py:property:: polymorphic_base
      :type: type[Any]

      :abstractmethod:



   .. py:method:: get_short_title(locale: str, default_locale: str | None = None) -> str | None

      Returns the requested translation of the short title, falls back
      to the full title.




   .. py:method:: id_from_title(session: sqlalchemy.orm.Session) -> str

      Returns a unique, user friendly id derived from the title. 



.. py:function:: summarized_property(name: str) -> sqlalchemy.Column[int]

   Adds an attribute as hybrid_property which returns the sum of the
   underlying results if called.

   Requires the class to define two aggregation functions.

   Usage::

       class Model():
           votes = summarized_property('votes')

           results = relationship('Result', ...)

           def aggregate_results(self, attribute):
               return sum(getattr(res, attribute) for res in self.results)

           @classmethod
           def aggregate_results_expression(cls, attribute):
               expr = select([func.sum(getattr(Result, attribute))])
               expr = expr.where(Result.xxx_id == cls.id)
               expr = expr.label(attribute)
               return expr



.. py:class:: LastModifiedMixin

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


   Mixin providing created/modified timestamps for all records.

   The columns are deferred loaded as this is primarily for logging and future
   forensics.



   .. py:property:: last_result_change
      :type: sqlalchemy.Column[datetime.datetime | None]



   .. py:method:: last_modified() -> datetime.datetime | None


.. py:class:: ExplanationsPdfMixin

   .. py:attribute:: files
      :value: None



   .. py:attribute:: explanations_pdf