jinja2

Imports

import jinja2
from jinja2 import (
    Environment,
    FileSystemLoader,
    PackageLoader,
    Template,
    Undefined,
    pass_context,
    pass_environment,
    pass_eval_context,
)
from jinja2.filters import attr, int, select, unique, urlize, xmlattr
from importlib.metadata import version

Core Patterns

Create an Environment with a loader and render a template ✅ Current

from __future__ import annotations

from pathlib import Path

from jinja2 import Environment, FileSystemLoader


def main() -> None:
    templates_dir = Path("templates")
    templates_dir.mkdir(parents=True, exist_ok=True)

    # Ensure the file ends with exactly one trailing newline.
    (templates_dir / "hello.txt.jinja").write_text(
        "Hello {{ name }}!\nItems: {{ items|join(', ') }}\n",
        encoding="utf-8",
        newline="\n",
    )

    env = Environment(
        loader=FileSystemLoader(str(templates_dir)),
        autoescape=False,
        trim_blocks=True,
        lstrip_blocks=True,
        keep_trailing_newline=True,  # preserve the final "\n" from the template source
    )

    template = env.get_template("hello.txt.jinja")
    out = template.render(name="Ada", items=["a", "b", "c"])

    # Print without adding an extra newline (the template already ends with one).
    print(out, end="")


if __name__ == "__main__":
    main()

• Use Environment(loader=...) + env.get_template(name) for file-based templates.
• trim_blocks and lstrip_blocks are common whitespace controls for text/HTML output.

Render from an in-memory Template ✅ Current

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    # Use an Environment so rendering behavior (like trailing newlines) is explicit.
    env = Environment(keep_trailing_newline=True)
    template = env.from_string("2 + 2 = {{ 2 + 2 }}\n")

    out = template.render()
    print(out, end="")


if __name__ == "__main__":
    main()

• Use Template(source) for short, in-memory templates (no loader required).
• Prefer Environment.from_string(...) when you need consistent environment configuration.

Add custom filters using pass_* decorators ✅ Current

from __future__ import annotations

from typing import Any

from jinja2 import Environment, pass_context


@pass_context
def is_defined(ctx: Any, name: str) -> bool:
    # ctx is a jinja2.runtime.Context at runtime; treat as Any for stable typing here.
    return ctx.resolve_or_missing(name) is not ctx.environment.undefined


def main() -> None:
    env = Environment()
    env.filters["is_defined"] = is_defined

    template = env.from_string(
        "{% if 'x'|is_defined %}x is defined{% else %}x is missing{% endif %}\n"
    )
    print(template.render(x=123))
    print(template.render())


if __name__ == "__main__":
    main()

• Use @pass_context, @pass_environment, @pass_eval_context instead of removed legacy decorators.
• Context.resolve_or_missing(name) is the supported way to check for missing variables.

Overlay an Environment for per-request configuration ✅ Current

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    base_env = Environment(autoescape=False, keep_trailing_newline=True)
    html_env = base_env.overlay(autoescape=True)

    # Use a variable so the template behavior is explicit and easy to test.
    t = "{{ value }}\n"
    out_base = base_env.from_string(t).render(value="<b>x</b>")
    out_html = html_env.from_string(t).render(value="<b>x</b>")

    # base_env does not autoescape; html_env does.
    assert out_base == "<b>x</b>\n"
    assert out_html == "&lt;b&gt;x&lt;/b&gt;\n"

    # Print without adding extra newlines; each render already ends with "\n".
    print(out_base, end="")
    print(out_html, end="")


if __name__ == "__main__":
    main()

• Environment.overlay(...) creates a derived environment that shares caches but can override options.
• Useful for toggling autoescape, adding request-specific globals/filters, etc.

Async template generation with generate_async ✅ Current

from __future__ import annotations

import asyncio
from typing import List

from jinja2 import Environment


async def main() -> None:
    env = Environment(enable_async=True)
    template = env.from_string("Hello {{ name }}!\n")

    chunks: List[str] = []
    async for piece in template.generate_async(name="Async"):
        chunks.append(piece)

    print("".join(chunks), end="")


if __name__ == "__main__":
    asyncio.run(main())

• When enable_async=True, use async-aware APIs like Template.generate_async(...).
• Consume the async generator fully (or ensure it's properly closed) to avoid resource leaks.

Configuration

• Template loading
  • FileSystemLoader("templates") for filesystem templates (common project convention: templates/ directory).
  • PackageLoader("your_pkg", "templates") for templates shipped inside a Python package.
• Whitespace control
  • Environment(trim_blocks=True, lstrip_blocks=True) for cleaner output.
  • In templates, use {%- ... -%} to strip adjacent whitespace; + can disable configured stripping for a specific tag.
• Autoescaping
  • Configure via Environment(autoescape=...) or use automatic selection with select_autoescape() helper.
• Bytecode caching
  • FileSystemBytecodeCache(directory="...") can speed up template compilation in some deployments.
• Undefined handling
  • Environment(undefined=Undefined) (default) produces Undefined objects; configure a different undefined type if you need stricter behavior.
  • Available undefined types: Undefined, DebugUndefined, StrictUndefined, ChainableUndefined.
• Line statements/comments
  • If using line statements/comments, set line_statement_prefix / line_comment_prefix on Environment.

Pitfalls

Wrong: Content before {% extends %} renders unexpectedly

from __future__ import annotations

from jinja2 import Environment, DictLoader


def main() -> None:
    env = Environment(loader=DictLoader({
        "base.html": "<body>{% block content %}BASE{% endblock %}</body>",
        "child.html": "Hello!\n{% extends 'base.html' %}{% block content %}CHILD{% endblock %}",
    }))
    print(env.get_template("child.html").render())


if __name__ == "__main__":
    main()

Right: Keep {% extends %} as the first tag

from __future__ import annotations

from jinja2 import Environment, DictLoader


def main() -> None:
    env = Environment(loader=DictLoader({
        "base.html": "<body>{% block content %}BASE{% endblock %}</body>",
        "child.html": "{% extends 'base.html' %}{% block content %}CHILD{% endblock %}",
    }))
    print(env.get_template("child.html").render())


if __name__ == "__main__":
    main()

Wrong: Block inside a loop can't see loop variables (missing scoped)

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment()
    template = env.from_string(
        "{% for item in seq %}"
        "<li>{% block loop_item %}{{ item }}{% endblock %}</li>"
        "{% endfor %}\n"
    )
    print(template.render(seq=[1, 2]))


if __name__ == "__main__":
    main()

Right: Mark the block scoped to access loop variables

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment()
    template = env.from_string(
        "{% for item in seq %}"
        "<li>{% block loop_item scoped %}{{ item }}{% endblock %}</li>"
        "{% endfor %}\n"
    )
    print(template.render(seq=[1, 2]))


if __name__ == "__main__":
    main()

Wrong: Invalid whitespace control syntax (- must touch the delimiters)

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment()
    # This template will raise a TemplateSyntaxError due to "{% - if foo - %}".
    template = env.from_string("{% - if foo - %}X{% endif %}\n")
    print(template.render(foo=True))


if __name__ == "__main__":
    main()

Right: Use {%- ... -%} (minus adjacent to delimiters)

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment()
    template = env.from_string("{%- if foo -%}X{%- endif -%}\n")
    print(template.render(foo=True))


if __name__ == "__main__":
    main()

Wrong: Untrusted keys passed to xmlattr can cause injection/malformed output

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment(autoescape=True)
    template = env.from_string("<a{{ attrs|xmlattr }}>link</a>\n")

    # Simulating untrusted input: keys should be validated/whitelisted in Python.
    user_attrs = {"onmouseover": "alert(1)", "href": "https://example.com"}
    print(template.render(attrs=user_attrs))


if __name__ == "__main__":
    main()

Right: Whitelist keys in Python before rendering xmlattr

from __future__ import annotations

from jinja2 import Environment


def main() -> None:
    env = Environment(autoescape=True)
    template = env.from_string("<a{{ attrs|xmlattr }}>link</a>\n")

    user_attrs = {"onmouseover": "alert(1)", "href": "https://example.com"}
    allowed = {"href", "title", "rel", "class", "id"}
    safe_attrs = {k: v for k, v in user_attrs.items() if k in allowed}

    print(template.render(attrs=safe_attrs))


if __name__ == "__main__":
    main()

References

• Donate
• Documentation
• Changes
• Source
• Chat

Migration from v3.1.5

Jinja2 3.1.6 contains a security fix for the |attr filter behavior in sandboxed environments.

|attr filter in sandboxed environments (security fix)

• Changed in: 3.1.6
• Impact: The |attr filter now respects the sandbox environment's attribute lookup checks (via is_safe_attribute).
• Migration guidance: Review sandboxed templates using the |attr filter to ensure they comply with sandbox security policies. Previously, |attr could bypass sandbox restrictions on attribute access.

Migration from v3.1.x

• Python support: 3.1.6 supports Python 3.7+ (same as 3.1.0).
• Dependency minimums: MarkupSafe >= 2.0.
• Security updates: xmlattr filter disallows keys with spaces, /, >, or = (since 3.1.4); |attr respects sandbox policies (3.1.6).

Legacy decorator aliases (contextfilter, etc.) 🗑️ Removed

• Removed since: 3.1.0
• Modern alternatives: pass_context, pass_eval_context, pass_environment
• Migration guidance (example):

from __future__ import annotations

from jinja2 import Environment, pass_environment


@pass_environment
def env_name(env: Environment, value: str) -> str:
    return f"{value} (autoescape={env.autoescape})"


def main() -> None:
    env = Environment()
    env.filters["env_name"] = env_name
    print(env.from_string("{{ 'x'|env_name }}\n").render())


if __name__ == "__main__":
    main()

API Reference

• Environment(...) - Central configuration object; key params include loader, autoescape, trim_blocks, lstrip_blocks, undefined, enable_async, line_statement_prefix, line_comment_prefix.
• Environment.init(...) - Constructs an environment; use to configure loaders, escaping, async, whitespace.
• Environment.overlay(...) - Create a derived environment that shares internal state/caches but overrides selected options.
• Environment.from_string(source) - Create a template from a string source.
• Environment.get_template(name) - Load a template by name from the configured loader.
• Template(...) - In-memory compiled template from source text.
• Template.render(...) - Render synchronously with context variables (template.render(**vars)).
• Template.render_async(...) - Async render method; requires Environment(enable_async=True).
• Template.generate_async(...) - Async generator yielding rendered chunks; requires Environment(enable_async=True).
• FileSystemLoader(searchpath, encoding='utf-8', followlinks=False) - Load templates from directories on disk.
• PackageLoader(package_name, package_path='templates', encoding='utf-8') - Load templates from a Python package's resources.
• DictLoader(mapping) - Load templates from a dictionary mapping template names to source strings.
• FunctionLoader(load_func) - Load templates using a callable function.
• PrefixLoader(mapping, delimiter='/') - Load templates with namespace prefixes.
• ChoiceLoader(loaders) - Try multiple loaders in order.
• ModuleLoader(path) - Load precompiled template modules.
• FileSystemBytecodeCache(directory, pattern) - Persist compiled template bytecode to the filesystem.
• MemcachedBytecodeCache(client, prefix, timeout, ignore_memcache_errors) - Memcached-based bytecode cache.
• Undefined - Default undefined value type used for missing variables.
• DebugUndefined - Undefined that prints debug information.
• StrictUndefined - Undefined that raises errors on access.
• ChainableUndefined - Undefined that allows attribute/item access.
• make_logging_undefined(logger, base) - Factory for creating logging undefined classes.
• select_autoescape(enabled_extensions, disabled_extensions, default_for_string, default) - Create autoescape function for Environment based on file extensions.
• is_undefined(obj) - Check if object is undefined.
• clear_caches() - Clear all internal caches.
• pass_context - Decorator to pass the active Context as first argument to a filter/test/global.
• pass_eval_context - Decorator to pass the evaluation context (e.g., autoescape state) to a callable.
• pass_environment - Decorator to pass the active Environment to a callable.
• Context.resolve_or_missing(name) - Resolve a variable name or return a sentinel indicating it is missing (preferred override point for custom Context behavior).
• jinja2.filters.attr(value, name) - Filter to fetch an attribute; respects environment attribute lookup/sandbox rules (security fix in 3.1.6).
• jinja2.filters.xmlattr(mapping) - Convert a dict of attributes to XML/HTML attribute syntax; validate/whitelist keys before use (disallows spaces, /, >, = since 3.1.4).
• jinja2.filters.unique(seq) - Filter to yield unique items from a sequence.
• jinja2.filters.int(value, default=0, base=10) - Convert to int with defaults.
• jinja2.filters.urlize(value) - Convert URLs in text into clickable links (HTML output).
• **jinja2.filters.select(seq, test_name=None, kwargs) - Select items from a sequence based on a test.
• TemplateError - Base exception for all template errors.
• TemplateNotFound - Raised when template cannot be found.
• TemplatesNotFound - Raised when multiple templates cannot be found.
• TemplateSyntaxError - Raised on template syntax errors.
• TemplateRuntimeError - Raised on runtime template errors.
• TemplateAssertionError - Raised on template assertion errors.
• UndefinedError - Raised when accessing undefined variables.

Current Library Conventions

• Use {% ... %} for statements/control structures
• Use {{ ... }} for expressions to print to template output
• Use {# ... #} for comments not included in template output
• Template files can have any extension (.html, .xml, .jinja, etc.)
• Adding .jinja extension (like user.html.jinja) may help IDEs but is not required
• Common pattern: place templates in a templates folder
• Use dot notation (.) to access attributes: {{ foo.bar }}
• Use subscript syntax ([]) for items: {{ foo['bar'] }}
• Filters are chained with pipe symbol (|): {{ name|striptags|title }}
• The {% extends %} tag should be the first tag in a child template
• Block names can be added after {% endblock %} for readability: {% endblock sidebar %}
• Mark blocks as scoped to access outer variables: {% block loop_item scoped %}
• Mark blocks as required to enforce overriding in child templates
• Use {{ super() }} to render parent block content
• Chain super references for multi-level inheritance: {{ super.super() }}
• Use minus sign (-) for manual whitespace control: {%- ... -%}
• Use plus sign (+) to disable automatic whitespace stripping: {%+ ... +%}
• No whitespace allowed between tag and minus/plus signs
• Use {% raw %} blocks to output literal Jinja syntax
• For async templates, use asyncio.run when calling sync render
• Decorate async filter/test variants with @async_variant for picklability
• Never use user input as keys to the xmlattr filter without separate validation
• Import Markup and escape from MarkupSafe, not Jinja2