prefect.server.utilities.user_templates

Utilities to support safely rendering user-supplied templates

Functions

register_user_template_filters ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L80" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

register_user_template_filters(filters: dict[str, Any]) -> None

Register additional filters that will be available to user templates

validate_user_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_user_template(template: str) -> None

matching_types_in_templates ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L123" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

matching_types_in_templates(templates: list[str], types: set[str]) -> list[str]

maybe_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L135" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

maybe_template(possible: str) -> bool

render_user_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L139" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

render_user_template(template: str, context: dict[str, Any]) -> str

render_user_template_sync ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L151" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

render_user_template_sync(template: str, context: dict[str, Any]) -> str

Classes

UserTemplateEnvironment ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L32" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

TemplateSecurityError ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L60" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Raised when extended validation of a template fails.

TemplateRenderError ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/utilities/user_templates.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Raised when a user-supplied template fails to render.