winterthur.app
==============

.. py:module:: winterthur.app


Classes
-------

.. autoapisummary::

   winterthur.app.WinterthurApp


Functions
---------

.. autoapisummary::

   winterthur.app.enable_iframes_tween_factory
   winterthur.app.get_template_directory
   winterthur.app.get_static_directory
   winterthur.app.get_theme
   winterthur.app.get_create_new_organisation_factory
   winterthur.app.get_default_directory_search_widget
   winterthur.app.get_default_event_search_widget
   winterthur.app.get_i18n_localedirs
   winterthur.app.get_js_path
   winterthur.app.get_webasset_output
   winterthur.app.get_search_asset
   winterthur.app.get_iframe_resizer
   winterthur.app.get_iframe_enhancements
   winterthur.app.get_common_asset


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

.. py:class:: WinterthurApp

   Bases: :py:obj:`onegov.org.OrgApp`


   Baseclass for Morepath OneGov applications. 


   .. py:attribute:: serve_static_files
      :value: True


      Returns True if ``/static`` files should be served. Needs to be
      enabled manually.

      Note that even if the static files are not served, ``/static`` path
      is still served, it just won't return anything but a 404.

      Note also that static files are served **publicly**. You can override
      this in your application, but doing that and testing for it is on you!

      See also: :mod:`onegov.core.static`. 



   .. py:attribute:: frame_ancestors


   .. py:attribute:: same_site_cookie_policy
      :value: None



   .. py:method:: configure_organisation(*, enable_user_registration: bool = False, enable_yubikey: bool = False, disable_password_reset: bool = False, **cfg: Any) -> None


   .. py:method:: enable_iframes(request: onegov.winterthur.request.WinterthurRequest) -> None


   .. py:property:: roadwork_cache
      :type: onegov.core.cache.RedisCacheRegion



   .. py:property:: roadwork_client
      :type: onegov.winterthur.roadwork.RoadworkClient



   .. py:property:: mission_report_legend
      :type: markupsafe.Markup



   .. py:property:: hide_civil_defence_field
      :type: bool



   .. py:method:: static_file(path: str) -> onegov.core.static.StaticFile


   .. py:method:: get_shift_schedule_image() -> io.BytesIO | None

      Gets or creates an image of the latest public pdf.

      We store the image using the last modified timestamp - this way, we
      have a version of past images. Note that we don't delete any old
      images of shift schedules.




.. py:function:: enable_iframes_tween_factory(app: WinterthurApp, handler: collections.abc.Callable[[onegov.winterthur.request.WinterthurRequest], webob.Response]) -> collections.abc.Callable[[onegov.winterthur.request.WinterthurRequest], webob.Response]

.. py:function:: get_template_directory() -> str

.. py:function:: get_static_directory() -> str

.. py:function:: get_theme() -> onegov.winterthur.theme.WinterthurTheme

.. py:function:: get_create_new_organisation_factory() -> collections.abc.Callable[[WinterthurApp, str], onegov.org.models.Organisation]

.. py:function:: get_default_directory_search_widget() -> str

.. py:function:: get_default_event_search_widget() -> str

.. py:function:: get_i18n_localedirs() -> list[str]

.. py:function:: get_js_path() -> str

.. py:function:: get_webasset_output() -> str

.. py:function:: get_search_asset() -> collections.abc.Iterator[str]

.. py:function:: get_iframe_resizer() -> collections.abc.Iterator[str]

.. py:function:: get_iframe_enhancements() -> collections.abc.Iterator[str]

.. py:function:: get_common_asset() -> collections.abc.Iterator[str]