election_day.utils.common
=========================

.. py:module:: election_day.utils.common


Attributes
----------

.. autoapisummary::

   election_day.utils.common._T
   election_day.utils.common._KT
   election_day.utils.common._VT
   election_day.utils.common._ParamT


Classes
-------

.. autoapisummary::

   election_day.utils.common.HasNotifications
   election_day.utils.common.LastUpdatedOrderedDict


Functions
---------

.. autoapisummary::

   election_day.utils.common.sublist_name_from_connection_id
   election_day.utils.common.add_last_modified_header
   election_day.utils.common.add_cors_header
   election_day.utils.common.add_local_results
   election_day.utils.common.get_parameter
   election_day.utils.common.get_entity_filter
   election_day.utils.common.replace_url


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

.. py:class:: HasNotifications

   Bases: :py:obj:`Protocol`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto(Protocol[T]):
           def meth(self) -> T:
               ...


   .. py:attribute:: notifications
      :type:  sqlalchemy.orm.relationship[onegov.core.types.AppenderQuery[onegov.election_day.models.Notification]]


.. py:data:: _T

.. py:data:: _KT

.. py:data:: _VT

.. py:data:: _ParamT

.. py:function:: sublist_name_from_connection_id(conn_name: str, subconn_name: str) -> str

   Removes prefixed parent_connection_id from connection_id as introduced by
   sesam 2019.09

   :param conn_name: list connection name aka parent_connection_id
   :param subconn_name: subconnection name aka connection_id


.. py:class:: LastUpdatedOrderedDict

   Bases: :py:obj:`collections.OrderedDict`\ [\ :py:obj:`_KT`\ , :py:obj:`_VT`\ ]


   Stores items in the order the keys were last added.


   .. py:method:: __setitem__(key: _KT, value: _VT) -> None

      Set self[key] to value.



.. py:function:: add_last_modified_header(response: webob.response.Response, last_modified: datetime.datetime | None) -> None

   Adds the give date to the response as Last-Modified header. 


.. py:function:: add_cors_header(response: webob.response.Response) -> None

   Adds a header allowing the response being used in scripts. 


.. py:function:: add_local_results(source: onegov.election_day.models.ArchivedResult, target: onegov.election_day.models.ArchivedResult, principal: onegov.election_day.models.Canton | onegov.election_day.models.Municipality, session: sqlalchemy.orm.Session) -> None

   Adds the result of the principal.

   Municipalities are interested in their own result rather than the
   cantonal end result of votes. We query the result of the municipality
   within the given vote (source) and add it to the target.



.. py:function:: get_parameter(request: onegov.election_day.request.ElectionDayRequest, name: str, type_: type[_ParamT], default: _T) -> _ParamT | _T

.. py:function:: get_entity_filter(request: onegov.election_day.request.ElectionDayRequest, item: onegov.election_day.models.Election, view: str, selected: str | None) -> list[tuple[str, bool, str]]

.. py:function:: replace_url(url: str, start: str | None) -> str