feriennet.models.notification_template

Module Contents

Classes

BoundCallable

Base class for protocol classes.

NotificationTemplate

Mixin providing a meta/content JSON pair. Meta is a JSON column loaded

TemplateVariables

Functions

as_paragraphs(→ Iterator[Markup])

Attributes

MISSING

TOKEN

class feriennet.models.notification_template.BoundCallable[source]

Bases: 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:
        ...
__doc__: str[source]
__call__() → str[source]
feriennet.models.notification_template.MISSING[source]
feriennet.models.notification_template.TOKEN = '[{}]'[source]
class feriennet.models.notification_template.NotificationTemplate[source]

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, 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).

__tablename__ = 'notification_templates'[source]
period_id: uuid.UUID | None[source]
id: Column[uuid.UUID][source]
subject: Column[str][source]
text: Column[str][source]
last_sent: Column[datetime | None][source]
for_period(period: onegov.activity.models.Period) → typing_extensions.Self[source]

Implements the required interface for the ‘periods’ macro in onegov.feriennet.

feriennet.models.notification_template.as_paragraphs(text: str) → Iterator[Markup][source]
class feriennet.models.notification_template.TemplateVariables(request: onegov.feriennet.request.FeriennetRequest, period: Period | None)[source]
bound: dict[str, BoundCallable][source]
expanded: dict[str, str][source]
bind(name: str, description: str, method: Callable[[], str]) → None[source]
render(text: str) → markupsafe.Markup[source]

Searches the text for storage links /storage/0w8dj98rgn93… and uses the title of the referenced files to improve the readability of the link.

expand_with_cache(match: re.Match[str], id: str) → str[source]
period_title() → str[source]