feriennet.models.notification_template
======================================

.. py:module:: feriennet.models.notification_template


Attributes
----------

.. autoapisummary::

   feriennet.models.notification_template.MISSING
   feriennet.models.notification_template.TOKEN


Classes
-------

.. autoapisummary::

   feriennet.models.notification_template.BoundCallable
   feriennet.models.notification_template.NotificationTemplate
   feriennet.models.notification_template.TemplateVariables


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

.. py:class:: BoundCallable

   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:: __doc__
      :type:  str


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


.. py:data:: MISSING

.. py:data:: TOKEN
   :value: '[{}]'


.. py:class:: NotificationTemplate

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __tablename__
      :value: 'notification_templates'



   .. py:attribute:: period_id
      :type:  uuid.UUID | None
      :value: None



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


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


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


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


   .. py:method:: for_period(period: onegov.activity.models.Period) -> Self

      Implements the required interface for the 'periods' macro in
      onegov.feriennet.




.. py:class:: TemplateVariables(request: onegov.feriennet.request.FeriennetRequest, period: onegov.activity.models.Period | None)

   .. py:attribute:: bound
      :type:  dict[str, BoundCallable]


   .. py:attribute:: expanded
      :type:  dict[str, str]


   .. py:attribute:: request


   .. py:attribute:: period


   .. py:method:: bind(name: str, description: str, method: collections.abc.Callable[[], str]) -> None


   .. py:method:: render(text: markupsafe.Markup) -> markupsafe.Markup

      Replaces the tokens with the corresponding internal links.




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


   .. py:method:: bookings_link() -> markupsafe.Markup


   .. py:method:: invoices_link() -> markupsafe.Markup


   .. py:method:: activities_link() -> markupsafe.Markup


   .. py:method:: homepage_link() -> markupsafe.Markup