jinja2.utils

Pass the context as the first argument to the decorated function.

Pass the environment as the first argument to the decorated function.

Undocumented

Pass the eval context as the first argument to the decorated function.

Serialize an object to a string of JSON with json.dumps, then replace HTML-unsafe characters with Unicode escapes and mark the result safe with ~markupsafe.Markup.

This is available in templates as the |tojson filter.

The following characters are escaped: <, >, &, '.

The returned string is safe to render in HTML documents and <script> tags. The exception is in HTML attributes that are double quoted; either use single quotes or the |forceescape filter.

Imports an object based on a string. This is useful if you want to use import paths as endpoints or something similar. An import path can be specified either in dotted notation (xml.sax.saxutils.escape) or with a colon as object delimiter (xml.sax.saxutils:escape).

If the silent is True the return value will be None if the import fails.

Check if the object passed is undefined. This does nothing more than performing an instance check against Undefined but looks nicer. This can be used for custom filters or tests that want to react to undefined variables. For example a custom default filter can look like this:

def default(var, default=''):
    if is_undefined(var):
        return default
    return var

Pass the ~jinja2.runtime.Context as the first argument to the decorated function when called while rendering a template.

Can be used on functions, filters, and tests.

If only Context.eval_context is needed, use pass_eval_context. If only Context.environment is needed, use pass_environment.

Pass the ~jinja2.Environment as the first argument to the decorated function when called while rendering a template.

Can be used on functions, filters, and tests.

Pass the ~jinja2.nodes.EvalContext as the first argument to the decorated function when called while rendering a template. See :ref:`eval-context`.

Can be used on functions, filters, and tests.

If only EvalContext.environment is needed, use pass_environment.

Intelligently sets the initial value of autoescaping based on the filename of the template. This is the recommended way to configure autoescaping if you do not want to write a custom function yourself.

If you want to enable it for all templates created from strings or for all templates with .html and .xml extensions:

from jinja2 import Environment, select_autoescape
env = Environment(autoescape=select_autoescape(
    enabled_extensions=('html', 'xml'),
    default_for_string=True,
))

Example configuration to turn it on at all times except if the template ends with .txt:

from jinja2 import Environment, select_autoescape
env = Environment(autoescape=select_autoescape(
    disabled_extensions=('txt',),
    default_for_string=True,
    default=True,
))

The enabled_extensions is an iterable of all the extensions that autoescaping should be enabled for. Likewise disabled_extensions is a list of all templates it should be disabled for. If a template is loaded from a string then the default from default_for_string is used. If nothing matches then the initial value of autoescaping is set to the value of default.

For security reasons this function operates case insensitive.

Undocumented

Convert URLs in text into clickable links.

This may not recognize links in some situations. Usually, a more comprehensive formatter, such as a Markdown library, is a better choice.

Works on http://, https://, www., mailto:, and email addresses. Links with trailing punctuation (periods, commas, closing parentheses) and leading punctuation (opening parentheses) are recognized excluding the punctuation. Email addresses that include header fields are not recognized (for example, mailto:address@example.com?cc=copy@example.com).