election_day.models.archived_result
===================================

.. py:module:: election_day.models.archived_result


Attributes
----------

.. autoapisummary::

   election_day.models.archived_result.ResultType
   election_day.models.archived_result.meta_local_property


Classes
-------

.. autoapisummary::

   election_day.models.archived_result.ArchivedResult


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

.. py:type:: ResultType
   :canonical: Literal['election', 'election_compound', 'vote']


.. py:data:: meta_local_property

.. py:class:: ArchivedResult

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.election_day.models.mixins.DomainOfInfluenceMixin`, :py:obj:`onegov.election_day.models.mixins.TitleTranslationsMixin`


   Stores the result of an election or vote. 


   .. py:attribute:: __tablename__
      :value: 'archived_results'



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


   .. py:attribute:: date
      :type:  sqlalchemy.Column[datetime.date]


   .. py:attribute:: last_modified
      :type:  sqlalchemy.Column[datetime.datetime | None]


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


   .. py:attribute:: type
      :type:  sqlalchemy.Column[ResultType]


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


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


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


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


   .. py:property:: progress
      :type: tuple[int, int]



   .. py:attribute:: has_results
      :type:  sqlalchemy.Column[bool | None]


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


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


   .. py:attribute:: title


   .. py:method:: title_prefix(request: onegov.election_day.request.ElectionDayRequest) -> str


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


   .. py:attribute:: external_id
      :type:  onegov.core.orm.mixins.dict_property[str | None]


   .. py:attribute:: elected_candidates
      :type:  onegov.core.orm.mixins.dict_property[list[tuple[str, str]]]


   .. py:attribute:: elections
      :type:  onegov.core.orm.mixins.dict_property[list[str]]


   .. py:attribute:: answer
      :type:  onegov.core.orm.mixins.dict_property[str]


   .. py:attribute:: nays_percentage
      :type:  onegov.core.orm.mixins.dict_property[float]


   .. py:attribute:: yeas_percentage
      :type:  onegov.core.orm.mixins.dict_property[float]


   .. py:attribute:: counted
      :type:  onegov.core.orm.mixins.dict_property[bool]


   .. py:attribute:: completed
      :type:  onegov.core.orm.mixins.dict_property[bool]


   .. py:attribute:: turnout
      :type:  onegov.core.orm.mixins.dict_property[float | None]


   .. py:attribute:: direct
      :type:  onegov.core.orm.mixins.dict_property[bool]


   .. py:attribute:: local
      :type:  onegov.core.orm.mixins.dict_property[dict[str, Any] | None]


   .. py:attribute:: local_answer
      :type:  onegov.core.orm.mixins.dict_property[str]


   .. py:attribute:: local_nays_percentage
      :type:  onegov.core.orm.mixins.dict_property[float]


   .. py:attribute:: local_yeas_percentage
      :type:  onegov.core.orm.mixins.dict_property[float]


   .. py:property:: type_class
      :type: type[onegov.election_day.models.election.Election | onegov.election_day.models.election_compound.ElectionCompound | onegov.election_day.models.vote.Vote]



   .. py:method:: is_fetched(request: onegov.election_day.request.ElectionDayRequest) -> bool

      Returns True, if this results has been fetched from another
      instance.




   .. py:method:: is_fetched_by_municipality(request: onegov.election_day.request.ElectionDayRequest) -> bool

      Returns True, if this results has been fetched from another
      instance by a communal instance.




   .. py:method:: adjusted_url(request: onegov.election_day.request.ElectionDayRequest) -> str

      Returns the url adjusted to the current host. Needed if the
      instance is accessible under different hosts at the same time.




   .. py:method:: display_answer(request: onegov.election_day.request.ElectionDayRequest) -> str

      Returns the answer (depending on the current instance). 



   .. py:method:: display_nays_percentage(request: onegov.election_day.request.ElectionDayRequest) -> float

      Returns the nays rate (depending on the current instance). 



   .. py:method:: display_yeas_percentage(request: onegov.election_day.request.ElectionDayRequest) -> float

      Returns the yeas rate (depending on the current instance). 



   .. py:method:: copy_from(source: Self) -> None