`duck.utils.safemarkup`¶

Module for creating safe strings compatible with both Jinja2 and Django template engines.

This module provides a utility class SafeMarkup that subclasses both markupsafe.Markup and Django’s SafeString classes. This ensures that strings marked as safe using this class will be considered safe in both Jinja2 and Django templates.

Additionally, the module includes an example usage of the MarkupSafeString class to demonstrate how to create and use safe strings in both template engines.

The function mark_safe can also be used to mark strings safe as a decorator to the function which returns a string or to a mere string.

Usage Example:

safe_string = mark_safe("<h1>Hello world</h1>")

# or using as a decorator
@mark_safe
def my_func():
    return "<h2>Hello world</h2>"

Module Contents¶

Classes¶

MarkupSafeString

A class that subclasses both markupsafe.Markup and Django’s SafeString.

Functions¶

mark_safe

Decorator and function to mark string as safe for inserting in html templates

API¶

class duck.utils.safemarkup.MarkupSafeString[source]¶

Bases: django.utils.safestring.SafeString, markupsafe.Markup

A class that subclasses both markupsafe.Markup and Django’s SafeString.

This class ensures that strings marked as safe using this class will be considered safe in both Jinja2 and Django template engines.

Parameters:: value – The string to mark as safe.

Example Usage:

safe_string = MarkupSafeString('<strong>bold</strong>')
# You can use the safe string in templates.

Initialization

Initialize self. See help(type(self)) for accurate signature.

duck.utils.safemarkup.mark_safe(func_or_str) → duck.utils.safemarkup.MarkupSafeString[source]¶