election_day.layouts.default
============================

.. py:module:: election_day.layouts.default


Classes
-------

.. autoapisummary::

   election_day.layouts.default.HasName
   election_day.layouts.default.DefaultLayout


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

.. py:class:: HasName

   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:property:: name
      :type: str



.. py:class:: DefaultLayout(model: Any, request: onegov.election_day.request.ElectionDayRequest)

   Bases: :py:obj:`onegov.core.layout.ChameleonLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:attribute:: day_long_format
      :value: 'skeleton:MMMMd'



   .. py:attribute:: date_long_format
      :value: 'long'



   .. py:attribute:: datetime_long_format
      :value: 'medium'



   .. py:attribute:: docs_base_url
      :value: 'https://github.com/OneGov/onegov-cloud/blob/master/src/onegov/election_day/static/docs/api'



   .. py:attribute:: app
      :type:  onegov.election_day.app.ElectionDayApp

      Returns the application behind the request. 



   .. py:attribute:: request
      :type:  onegov.election_day.request.ElectionDayRequest


   .. py:method:: title() -> str


   .. py:property:: principal
      :type: onegov.election_day.models.Canton | onegov.election_day.models.Municipality



   .. py:method:: label(value: str) -> str


   .. py:property:: has_districts
      :type: bool



   .. py:property:: has_regions
      :type: bool



   .. py:property:: has_superregions
      :type: bool



   .. py:property:: homepage_link
      :type: str



   .. py:method:: get_opendata_link(lang: str) -> str


   .. py:property:: opendata_link
      :type: str



   .. py:property:: terms_icon
      :type: str



   .. py:property:: terms_link
      :type: str



   .. py:property:: format_description_link
      :type: str



   .. py:property:: font_awesome_path
      :type: str



   .. py:property:: sentry_init_path
      :type: str



   .. py:method:: get_topojson_link(id: str, year: int) -> str


   .. py:property:: copyright_year
      :type: int



   .. py:property:: manage_link
      :type: str



   .. py:property:: login_link
      :type: str | None



   .. py:property:: logout_link
      :type: str | None



   .. py:property:: archive
      :type: onegov.election_day.collections.ArchivedResultCollection



   .. py:property:: archive_search_link
      :type: str



   .. py:property:: locales
      :type: list[tuple[str, str]]



   .. py:method:: format_name(item: HasName) -> str


   .. py:property:: logo_alt_text
      :type: str



   .. py:property:: archive_download
      :type: str



   .. py:property:: last_archive_modification
      :type: datetime.datetime | None