[
{
"path": ".devcontainer/devcontainer.json",
"content": "{\n \"name\": \"pallets/jinja\",\n \"image\": \"mcr.microsoft.com/devcontainers/python:3\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"python.defaultInterpreterPath\": \"${workspaceFolder}/.venv\",\n \"python.terminal.activateEnvInCurrentTerminal\": true,\n \"python.terminal.launchArgs\": [\n \"-X\",\n \"dev\"\n ]\n }\n }\n },\n \"onCreateCommand\": \".devcontainer/on-create-command.sh\"\n}\n"
},
{
"path": ".devcontainer/on-create-command.sh",
"content": "#!/bin/bash\nset -e\n\n# Install uv if not already installed\nif ! command -v uv &> /dev/null; then\n echo \"Installing uv...\"\n curl -LsSf https://astral.sh/uv/install.sh | sh\n export PATH=\"$HOME/.cargo/bin:$PATH\"\nfi\n\n# Create venv using uv and install dependencies\necho \"Creating virtual environment and installing dependencies...\"\nuv sync\n\n# Install pre-commit hooks\necho \"Installing pre-commit hooks...\"\npre-commit install --install-hooks\n"
},
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nindent_style = space\nindent_size = 4\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nend_of_line = lf\ncharset = utf-8\nmax_line_length = 88\n\n[*.{css,html,js,json,jsx,scss,ts,tsx,yaml,yml}]\nindent_size = 2\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug-report.md",
"content": "---\nname: Bug report\nabout: Report a bug in Jinja (not other projects which depend on Jinja)\n---\n\n\n\n\n\n\n\nEnvironment:\n\n- Python version:\n- Jinja version:\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "blank_issues_enabled: false\ncontact_links:\n - name: Questions on Discussions\n url: https://github.com/pallets/jinja/discussions/\n about: Ask questions about your own code on the Discussions tab.\n - name: Questions on Chat\n url: https://discord.gg/pallets\n about: Ask questions about your own code on our Discord chat.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature-request.md",
"content": "---\nname: Feature request\nabout: Suggest a new feature for Jinja\n---\n\n\n\n\n"
},
{
"path": ".github/pull_request_template.md",
"content": "\n\n\n\n\n"
},
{
"path": ".github/workflows/lock.yaml",
"content": "name: Lock inactive closed issues\n# Lock closed issues that have not received any further activity for two weeks.\n# This does not close open issues, only humans may do that. It is easier to\n# respond to new issues with fresh examples rather than continuing discussions\n# on old issues.\n\non:\n schedule:\n - cron: '0 0 * * *'\npermissions:\n issues: write\n pull-requests: write\n discussions: write\nconcurrency:\n group: lock\njobs:\n lock:\n runs-on: ubuntu-latest\n steps:\n - uses: dessant/lock-threads@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771 # v5.0.1\n with:\n issue-inactive-days: 14\n pr-inactive-days: 14\n discussion-inactive-days: 14\n"
},
{
"path": ".github/workflows/pre-commit.yaml",
"content": "name: pre-commit\non:\n pull_request:\n push:\n branches: [main, stable]\njobs:\n main:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n - uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6.1.0\n with:\n enable-cache: true\n prune-cache: false\n - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0\n id: setup-python\n with:\n python-version-file: pyproject.toml\n - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3\n with:\n path: ~/.cache/pre-commit\n key: pre-commit|${{ hashFiles('pyproject.toml', '.pre-commit-config.yaml') }}\n - run: uv run --locked --group pre-commit pre-commit run --show-diff-on-failure --color=always --all-files\n - uses: pre-commit-ci/lite-action@5d6cc0eb514c891a40562a58a8e71576c5c7fb43 # v1.1.0\n if: ${{ !cancelled() }}\n"
},
{
"path": ".github/workflows/publish.yaml",
"content": "name: Publish\non:\n push:\n tags: ['*']\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n - uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6.1.0\n with:\n enable-cache: true\n prune-cache: false\n - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0\n with:\n python-version-file: pyproject.toml\n - run: echo \"SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)\" >> $GITHUB_ENV\n - run: uv build\n - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2\n with:\n path: ./dist\n create-release:\n needs: [build]\n runs-on: ubuntu-latest\n permissions:\n contents: write\n steps:\n - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0\n - name: create release\n run: >\n gh release create --draft --repo ${{ github.repository }}\n ${{ github.ref_name }} artifact/*\n env:\n GH_TOKEN: ${{ github.token }}\n publish-pypi:\n needs: [build]\n environment:\n name: publish\n url: https://pypi.org/project/Jinja2/${{ github.ref_name }}\n runs-on: ubuntu-latest\n permissions:\n id-token: write\n steps:\n - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0\n - uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4\n with:\n packages-dir: artifact/\n"
},
{
"path": ".github/workflows/tests.yaml",
"content": "name: Tests\non:\n pull_request:\n paths-ignore: ['docs/**', 'README.md']\n push:\n branches: [main, stable]\n paths-ignore: ['docs/**', 'README.md']\njobs:\n tests:\n name: ${{ matrix.name || matrix.python }}\n runs-on: ${{ matrix.os || 'ubuntu-latest' }}\n strategy:\n fail-fast: false\n matrix:\n include:\n - {python: '3.13'}\n - {name: Windows, python: '3.13', os: windows-latest}\n - {name: Mac, python: '3.13', os: macos-latest}\n - {python: '3.12'}\n - {python: '3.11'}\n - {python: '3.10'}\n - {name: PyPy, python: 'pypy-3.11', tox: pypy3.11}\n steps:\n - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n - uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6.1.0\n with:\n enable-cache: true\n prune-cache: false\n - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0\n with:\n python-version: ${{ matrix.python }}\n - run: uv run --locked tox run -e ${{ matrix.tox || format('py{0}', matrix.python) }}\n typing:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2\n - uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v6.1.0\n with:\n enable-cache: true\n prune-cache: false\n - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0\n with:\n python-version-file: pyproject.toml\n - name: cache mypy\n uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3\n with:\n path: ./.mypy_cache\n key: mypy|${{ hashFiles('pyproject.toml') }}\n - run: uv run --locked tox run -e typing\n"
},
{
"path": ".gitignore",
"content": ".idea/\n.vscode/\n__pycache__/\ndist/\n.coverage*\nhtmlcov/\n.tox/\ndocs/_build/\n"
},
{
"path": ".pre-commit-config.yaml",
"content": "repos:\n - repo: https://github.com/astral-sh/ruff-pre-commit\n rev: 76e47323a83cd9795e4ff9a1de1c0d2eef610f17 # frozen: v0.11.11\n hooks:\n - id: ruff\n - id: ruff-format\n - repo: https://github.com/astral-sh/uv-pre-commit\n rev: 648bdbfd6bb1a82f132ecc2c666e0d1b2e4b0d94 # frozen: 0.7.8\n hooks:\n - id: uv-lock\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # frozen: v5.0.0\n hooks:\n - id: check-merge-conflict\n - id: debug-statements\n - id: fix-byte-order-marker\n - id: trailing-whitespace\n - id: end-of-file-fixer\n"
},
{
"path": ".readthedocs.yaml",
"content": "version: 2\nbuild:\n os: ubuntu-24.04\n tools:\n python: '3.13'\n commands:\n - asdf plugin add uv\n - asdf install uv latest\n - asdf global uv latest\n - uv run --group docs sphinx-build -W -b dirhtml docs $READTHEDOCS_OUTPUT/html\n"
},
{
"path": "CHANGES.rst",
"content": ".. currentmodule:: jinja2\n\nVersion 3.2.0\n-------------\n\nUnreleased\n\n- Drop support for Python 3.7, 3.8, and 3.9.\n- Update minimum MarkupSafe version to >= 3.0.\n- Update minimum Babel version to >= 2.17.\n- Deprecate the ``__version__`` attribute. Use feature detection or\n ``importlib.metadata.version(\"jinja2\")`` instead.\n- Use modern packaging metadata with ``pyproject.toml`` instead of ``setup.cfg``.\n :pr:`1793`\n- Use ``flit_core`` instead of ``setuptools`` as build backend.\n\n\nVersion 3.1.6\n-------------\n\nReleased 2025-03-05\n\n- The ``|attr`` filter does not bypass the environment's attribute lookup,\n allowing the sandbox to apply its checks. :ghsa:`cpwx-vrp4-4pq7`\n\n\nVersion 3.1.5\n-------------\n\nReleased 2024-12-21\n\n- The sandboxed environment handles indirect calls to ``str.format``, such as\n by passing a stored reference to a filter that calls its argument.\n :ghsa:`q2x7-8rv6-6q7h`\n- Escape template name before formatting it into error messages, to avoid\n issues with names that contain f-string syntax.\n :issue:`1792`, :ghsa:`gmj6-6f8f-6699`\n- Sandbox does not allow ``clear`` and ``pop`` on known mutable sequence\n types. :issue:`2032`\n- Calling sync ``render`` for an async template uses ``asyncio.run``.\n :pr:`1952`\n- Avoid unclosed ``auto_aiter`` warnings. :pr:`1960`\n- Return an ``aclose``-able ``AsyncGenerator`` from\n ``Template.generate_async``. :pr:`1960`\n- Avoid leaving ``root_render_func()`` unclosed in\n ``Template.generate_async``. :pr:`1960`\n- Avoid leaving async generators unclosed in blocks, includes and extends.\n :pr:`1960`\n- The runtime uses the correct ``concat`` function for the current environment\n when calling block references. :issue:`1701`\n- Make ``|unique`` async-aware, allowing it to be used after another\n async-aware filter. :issue:`1781`\n- ``|int`` filter handles ``OverflowError`` from scientific notation.\n :issue:`1921`\n- Make compiling deterministic for tuple unpacking in a ``{% set ... %}``\n call. :issue:`2021`\n- Fix dunder protocol (`copy`/`pickle`/etc) interaction with ``Undefined``\n objects. :issue:`2025`\n- Fix `copy`/`pickle` support for the internal ``missing`` object.\n :issue:`2027`\n- ``Environment.overlay(enable_async)`` is applied correctly. :pr:`2061`\n- The error message from ``FileSystemLoader`` includes the paths that were\n searched. :issue:`1661`\n- ``PackageLoader`` shows a clearer error message when the package does not\n contain the templates directory. :issue:`1705`\n- Improve annotations for methods returning copies. :pr:`1880`\n- ``urlize`` does not add ``mailto:`` to values like `@a@b`. :pr:`1870`\n- Tests decorated with `@pass_context`` can be used with the ``|select``\n filter. :issue:`1624`\n- Using ``set`` for multiple assignment (``a, b = 1, 2``) does not fail when the\n target is a namespace attribute. :issue:`1413`\n- Using ``set`` in all branches of ``{% if %}{% elif %}{% else %}`` blocks\n does not cause the variable to be considered initially undefined.\n :issue:`1253`\n\n\nVersion 3.1.4\n-------------\n\nReleased 2024-05-05\n\n- The ``xmlattr`` filter does not allow keys with ``/`` solidus, ``>``\n greater-than sign, or ``=`` equals sign, in addition to disallowing spaces.\n Regardless of any validation done by Jinja, user input should never be used\n as keys to this filter, or must be separately validated first.\n :ghsa:`h75v-3vvj-5mfj`\n\n\nVersion 3.1.3\n-------------\n\nReleased 2024-01-10\n\n- Fix compiler error when checking if required blocks in parent templates are\n empty. :pr:`1858`\n- ``xmlattr`` filter does not allow keys with spaces. :ghsa:`h5c8-rqwp-cp95`\n- Make error messages stemming from invalid nesting of ``{% trans %}`` blocks\n more helpful. :pr:`1918`\n\n\nVersion 3.1.2\n-------------\n\nReleased 2022-04-28\n\n- Add parameters to ``Environment.overlay`` to match ``__init__``.\n :issue:`1645`\n- Handle race condition in ``FileSystemBytecodeCache``. :issue:`1654`\n\n\nVersion 3.1.1\n-------------\n\nReleased 2022-03-25\n\n- The template filename on Windows uses the primary path separator.\n :issue:`1637`\n\n\nVersion 3.1.0\n-------------\n\nReleased 2022-03-24\n\n- Drop support for Python 3.6. :pr:`1534`\n- Remove previously deprecated code. :pr:`1544`\n\n - ``WithExtension`` and ``AutoEscapeExtension`` are built-in now.\n - ``contextfilter`` and ``contextfunction`` are replaced by\n ``pass_context``. ``evalcontextfilter`` and\n ``evalcontextfunction`` are replaced by ``pass_eval_context``.\n ``environmentfilter`` and ``environmentfunction`` are replaced\n by ``pass_environment``.\n - ``Markup`` and ``escape`` should be imported from MarkupSafe.\n - Compiled templates from very old Jinja versions may need to be\n recompiled.\n - Legacy resolve mode for ``Context`` subclasses is no longer\n supported. Override ``resolve_or_missing`` instead of\n ``resolve``.\n - ``unicode_urlencode`` is renamed to ``url_quote``.\n\n- Add support for native types in macros. :issue:`1510`\n- The ``{% trans %}`` tag can use ``pgettext`` and ``npgettext`` by\n passing a context string as the first token in the tag, like\n ``{% trans \"title\" %}``. :issue:`1430`\n- Update valid identifier characters from Python 3.6 to 3.7.\n :pr:`1571`\n- Filters and tests decorated with ``@async_variant`` are pickleable.\n :pr:`1612`\n- Add ``items`` filter. :issue:`1561`\n- Subscriptions (``[0]``, etc.) can be used after filters, tests, and\n calls when the environment is in async mode. :issue:`1573`\n- The ``groupby`` filter is case-insensitive by default, matching\n other comparison filters. Added the ``case_sensitive`` parameter to\n control this. :issue:`1463`\n- Windows drive-relative path segments in template names will not\n result in ``FileSystemLoader`` and ``PackageLoader`` loading from\n drive-relative paths. :pr:`1621`\n\n\nVersion 3.0.3\n-------------\n\nReleased 2021-11-09\n\n- Fix traceback rewriting internals for Python 3.10 and 3.11.\n :issue:`1535`\n- Fix how the native environment treats leading and trailing spaces\n when parsing values on Python 3.10. :pr:`1537`\n- Improve async performance by avoiding checks for common types.\n :issue:`1514`\n- Revert change to ``hash(Node)`` behavior. Nodes are hashed by id\n again :issue:`1521`\n- ``PackageLoader`` works when the package is a single module file.\n :issue:`1512`\n\n\nVersion 3.0.2\n-------------\n\nReleased 2021-10-04\n\n- Fix a loop scoping bug that caused assignments in nested loops\n to still be referenced outside of it. :issue:`1427`\n- Make ``compile_templates`` deterministic for filter and import\n names. :issue:`1452, 1453`\n- Revert an unintended change that caused ``Undefined`` to act like\n ``StrictUndefined`` for the ``in`` operator. :issue:`1448`\n- Imported macros have access to the current template globals in async\n environments. :issue:`1494`\n- ``PackageLoader`` will not include a current directory (.) path\n segment. This allows loading templates from the root of a zip\n import. :issue:`1467`\n\n\nVersion 3.0.1\n-------------\n\nReleased 2021-05-18\n\n- Update MarkupSafe dependency to >= 2.0. :pr:`1418`\n- Mark top-level names as exported so type checking understands\n imports in user projects. :issue:`1426`\n- Fix some types that weren't available in Python 3.6.0. :issue:`1433`\n- The deprecation warning for unneeded ``autoescape`` and ``with_``\n extensions shows more relevant context. :issue:`1429`\n- Fixed calling deprecated ``jinja2.Markup`` without an argument.\n Use ``markupsafe.Markup`` instead. :issue:`1438`\n- Calling sync ``render`` for an async template uses ``asyncio.new_event_loop``\n This fixes a deprecation that Python 3.10 introduces. :issue:`1443`\n\n\nVersion 3.0.0\n-------------\n\nReleased 2021-05-11\n\n- Drop support for Python 2.7 and 3.5.\n- Bump MarkupSafe dependency to >=1.1.\n- Bump Babel optional dependency to >=2.1.\n- Remove code that was marked deprecated.\n- Add type hinting. :pr:`1412`\n- Use :pep:`451` API to load templates with\n :class:`~loaders.PackageLoader`. :issue:`1168`\n- Fix a bug that caused imported macros to not have access to the\n current template's globals. :issue:`688`\n- Add ability to ignore ``trim_blocks`` using ``+%}``. :issue:`1036`\n- Fix a bug that caused custom async-only filters to fail with\n constant input. :issue:`1279`\n- Fix UndefinedError incorrectly being thrown on an undefined variable\n instead of ``Undefined`` being returned on\n ``NativeEnvironment`` on Python 3.10. :issue:`1335`\n- Blocks can be marked as ``required``. They must be overridden at\n some point, but not necessarily by the direct child. :issue:`1147`\n- Deprecate the ``autoescape`` and ``with`` extensions, they are\n built-in to the compiler. :issue:`1203`\n- The ``urlize`` filter recognizes ``mailto:`` links and takes\n ``extra_schemes`` (or ``env.policies[\"urlize.extra_schemes\"]``) to\n recognize other schemes. It tries to balance parentheses within a\n URL instead of ignoring trailing characters. The parsing in general\n has been updated to be more efficient and match more cases. URLs\n without a scheme are linked as ``https://`` instead of ``http://``.\n :issue:`522, 827, 1172`, :pr:`1195`\n- Filters that get attributes, such as ``map`` and ``groupby``, can\n use a false or empty value as a default. :issue:`1331`\n- Fix a bug that prevented variables set in blocks or loops from\n being accessed in custom context functions. :issue:`768`\n- Fix a bug that caused scoped blocks from accessing special loop\n variables. :issue:`1088`\n- Update the template globals when calling\n ``Environment.get_template(globals=...)`` even if the template was\n already loaded. :issue:`295`\n- Do not raise an error for undefined filters in unexecuted\n if-statements and conditional expressions. :issue:`842`\n- Add ``is filter`` and ``is test`` tests to test if a name is a\n registered filter or test. This allows checking if a filter is\n available in a template before using it. Test functions can be\n decorated with ``@pass_environment``, ``@pass_eval_context``,\n or ``@pass_context``. :issue:`842`, :pr:`1248`\n- Support ``pgettext`` and ``npgettext`` (message contexts) in i18n\n extension. :issue:`441`\n- The ``|indent`` filter's ``width`` argument can be a string to\n indent by. :pr:`1167`\n- The parser understands hex, octal, and binary integer literals.\n :issue:`1170`\n- ``Undefined.__contains__`` (``in``) raises an ``UndefinedError``\n instead of a ``TypeError``. :issue:`1198`\n- ``Undefined`` is iterable in an async environment. :issue:`1294`\n- ``NativeEnvironment`` supports async mode. :issue:`1362`\n- Template rendering only treats ``\\n``, ``\\r\\n`` and ``\\r`` as line\n breaks. Other characters are left unchanged. :issue:`769, 952, 1313`\n- ``|groupby`` filter takes an optional ``default`` argument.\n :issue:`1359`\n- The function and filter decorators have been renamed and unified.\n The old names are deprecated. :issue:`1381`\n\n - ``pass_context`` replaces ``contextfunction`` and\n ``contextfilter``.\n - ``pass_eval_context`` replaces ``evalcontextfunction`` and\n ``evalcontextfilter``\n - ``pass_environment`` replaces ``environmentfunction`` and\n ``environmentfilter``.\n\n- Async support no longer requires Jinja to patch itself. It must\n still be enabled with ``Environment(enable_async=True)``.\n :issue:`1390`\n- Overriding ``Context.resolve`` is deprecated, override\n ``resolve_or_missing`` instead. :issue:`1380`\n\n\nVersion 2.11.3\n--------------\n\nReleased 2021-01-31\n\n- Improve the speed of the ``urlize`` filter by reducing regex\n backtracking. Email matching requires a word character at the start\n of the domain part, and only word characters in the TLD. :pr:`1343`\n\n\nVersion 2.11.2\n--------------\n\nReleased 2020-04-13\n\n- Fix a bug that caused callable objects with ``__getattr__``, like\n :class:`~unittest.mock.Mock` to be treated as a\n :func:`contextfunction`. :issue:`1145`\n- Update ``wordcount`` filter to trigger :class:`Undefined` methods\n by wrapping the input in :func:`soft_str`. :pr:`1160`\n- Fix a hang when displaying tracebacks on Python 32-bit.\n :issue:`1162`\n- Showing an undefined error for an object that raises\n ``AttributeError`` on access doesn't cause a recursion error.\n :issue:`1177`\n- Revert changes to :class:`~loaders.PackageLoader` from 2.10 which\n removed the dependency on setuptools and pkg_resources, and added\n limited support for namespace packages. The changes caused issues\n when using Pytest. Due to the difficulty in supporting Python 2 and\n :pep:`451` simultaneously, the changes are reverted until 3.0.\n :pr:`1182`\n- Fix line numbers in error messages when newlines are stripped.\n :pr:`1178`\n- The special ``namespace()`` assignment object in templates works in\n async environments. :issue:`1180`\n- Fix whitespace being removed before tags in the middle of lines when\n ``lstrip_blocks`` is enabled. :issue:`1138`\n- :class:`~nativetypes.NativeEnvironment` doesn't evaluate\n intermediate strings during rendering. This prevents early\n evaluation which could change the value of an expression.\n :issue:`1186`\n\n\nVersion 2.11.1\n--------------\n\nReleased 2020-01-30\n\n- Fix a bug that prevented looking up a key after an attribute\n (``{{ data.items[1:] }}``) in an async template. :issue:`1141`\n\n\nVersion 2.11.0\n--------------\n\nReleased 2020-01-27\n\n- Drop support for Python 2.6, 3.3, and 3.4. This will be the last\n version to support Python 2.7 and 3.5.\n- Added a new ``ChainableUndefined`` class to support getitem and\n getattr on an undefined object. :issue:`977`\n- Allow ``{%+`` syntax (with NOP behavior) when ``lstrip_blocks`` is\n disabled. :issue:`748`\n- Added a ``default`` parameter for the ``map`` filter. :issue:`557`\n- Exclude environment globals from\n :func:`meta.find_undeclared_variables`. :issue:`931`\n- Float literals can be written with scientific notation, like\n 2.56e-3. :issue:`912`, :pr:`922`\n- Int and float literals can be written with the '_' separator for\n legibility, like 12_345. :pr:`923`\n- Fix a bug causing deadlocks in ``LRUCache.setdefault``. :pr:`1000`\n- The ``trim`` filter takes an optional string of characters to trim.\n :pr:`828`\n- A new ``jinja2.ext.debug`` extension adds a ``{% debug %}`` tag to\n quickly dump the current context and available filters and tests.\n :issue:`174`, :pr:`798, 983`\n- Lexing templates with large amounts of whitespace is much faster.\n :issue:`857`, :pr:`858`\n- Parentheses around comparisons are preserved, so\n ``{{ 2 * (3 < 5) }}`` outputs \"2\" instead of \"False\".\n :issue:`755`, :pr:`938`\n- Add new ``boolean``, ``false``, ``true``, ``integer`` and ``float``\n tests. :pr:`824`\n- The environment's ``finalize`` function is only applied to the\n output of expressions (constant or not), not static template data.\n :issue:`63`\n- When providing multiple paths to ``FileSystemLoader``, a template\n can have the same name as a directory. :issue:`821`\n- Always return :class:`Undefined` when omitting the ``else`` clause\n in a ``{{ 'foo' if bar }}`` expression, regardless of the\n environment's ``undefined`` class. Omitting the ``else`` clause is a\n valid shortcut and should not raise an error when using\n :class:`StrictUndefined`. :issue:`710`, :pr:`1079`\n- Fix behavior of ``loop`` control variables such as ``length`` and\n ``revindex0`` when looping over a generator. :issue:`459, 751, 794`,\n :pr:`993`\n- Async support is only loaded the first time an environment enables\n it, in order to avoid a slow initial import. :issue:`765`\n- In async environments, the ``|map`` filter will await the filter\n call if needed. :pr:`913`\n- In for loops that access ``loop`` attributes, the iterator is not\n advanced ahead of the current iteration unless ``length``,\n ``revindex``, ``nextitem``, or ``last`` are accessed. This makes it\n less likely to break ``groupby`` results. :issue:`555`, :pr:`1101`\n- In async environments, the ``loop`` attributes ``length`` and\n ``revindex`` work for async iterators. :pr:`1101`\n- In async environments, values from attribute/property access will\n be awaited if needed. :pr:`1101`\n- :class:`~loader.PackageLoader` doesn't depend on setuptools or\n pkg_resources. :issue:`970`\n- ``PackageLoader`` has limited support for :pep:`420` namespace\n packages. :issue:`1097`\n- Support :class:`os.PathLike` objects in\n :class:`~loader.FileSystemLoader` and :class:`~loader.ModuleLoader`.\n :issue:`870`\n- :class:`~nativetypes.NativeTemplate` correctly handles quotes\n between expressions. ``\"'{{ a }}', '{{ b }}'\"`` renders as the tuple\n ``('1', '2')`` rather than the string ``'1, 2'``. :issue:`1020`\n- Creating a :class:`~nativetypes.NativeTemplate` directly creates a\n :class:`~nativetypes.NativeEnvironment` instead of a default\n :class:`Environment`. :issue:`1091`\n- After calling ``LRUCache.copy()``, the copy's queue methods point to\n the correct queue. :issue:`843`\n- Compiling templates always writes UTF-8 instead of defaulting to the\n system encoding. :issue:`889`\n- ``|wordwrap`` filter treats existing newlines as separate paragraphs\n to be wrapped individually, rather than creating short intermediate\n lines. :issue:`175`\n- Add ``break_on_hyphens`` parameter to ``|wordwrap`` filter.\n :issue:`550`\n- Cython compiled functions decorated as context functions will be\n passed the context. :pr:`1108`\n- When chained comparisons of constants are evaluated at compile time,\n the result follows Python's behavior of returning ``False`` if any\n comparison returns ``False``, rather than only the last one.\n :issue:`1102`\n- Tracebacks for exceptions in templates show the correct line numbers\n and source for Python >= 3.7. :issue:`1104`\n- Tracebacks for template syntax errors in Python 3 no longer show\n internal compiler frames. :issue:`763`\n- Add a ``DerivedContextReference`` node that can be used by\n extensions to get the current context and local variables such as\n ``loop``. :issue:`860`\n- Constant folding during compilation is applied to some node types\n that were previously overlooked. :issue:`733`\n- ``TemplateSyntaxError.source`` is not empty when raised from an\n included template. :issue:`457`\n- Passing an ``Undefined`` value to ``get_template`` (such as through\n ``extends``, ``import``, or ``include``), raises an\n ``UndefinedError`` consistently. ``select_template`` will show the\n undefined message in the list of attempts rather than the empty\n string. :issue:`1037`\n- ``TemplateSyntaxError`` can be pickled. :pr:`1117`\n\n\nVersion 2.10.3\n--------------\n\nReleased 2019-10-04\n\n- Fix a typo in Babel entry point in ``setup.py`` that was preventing\n installation.\n\n\nVersion 2.10.2\n--------------\n\nReleased 2019-10-04\n\n- Fix Python 3.7 deprecation warnings.\n- Using ``range`` in the sandboxed environment uses ``xrange`` on\n Python 2 to avoid memory use. :issue:`933`\n- Use Python 3.7's better traceback support to avoid a core dump when\n using debug builds of Python 3.7. :issue:`1050`\n\n\nVersion 2.10.1\n--------------\n\nReleased 2019-04-06\n\n- ``SandboxedEnvironment`` securely handles ``str.format_map`` in\n order to prevent code execution through untrusted format strings.\n The sandbox already handled ``str.format``.\n\n\nVersion 2.10\n------------\n\nReleased 2017-11-08\n\n- Added a new extension node called ``OverlayScope`` which can be used\n to create an unoptimized scope that will look up all variables from\n a derived context.\n- Added an ``in`` test that works like the in operator. This can be\n used in combination with ``reject`` and ``select``.\n- Added ``previtem`` and ``nextitem`` to loop contexts, providing\n access to the previous/next item in the loop. If such an item does\n not exist, the value is undefined.\n- Added ``changed(*values)`` to loop contexts, providing an easy way\n of checking whether a value has changed since the last iteration (or\n rather since the last call of the method)\n- Added a ``namespace`` function that creates a special object which\n allows attribute assignment using the ``set`` tag. This can be used\n to carry data across scopes, e.g. from a loop body to code that\n comes after the loop.\n- Added a ``trimmed`` modifier to ``{% trans %}`` to strip linebreaks\n and surrounding whitespace. Also added a new policy to enable this\n for all ``trans`` blocks.\n- The ``random`` filter is no longer incorrectly constant folded and\n will produce a new random choice each time the template is rendered.\n :pr:`478`\n- Added a ``unique`` filter. :pr:`469`\n- Added ``min`` and ``max`` filters. :pr:`475`\n- Added tests for all comparison operators: ``eq``, ``ne``, ``lt``,\n ``le``, ``gt``, ``ge``. :pr:`665`\n- ``import`` statement cannot end with a trailing comma. :pr:`617`,\n :pr:`618`\n- ``indent`` filter will not indent blank lines by default. :pr:`685`\n- Add ``reverse`` argument for ``dictsort`` filter. :pr:`692`\n- Add a ``NativeEnvironment`` that renders templates to native Python\n types instead of strings. :pr:`708`\n- Added filter support to the block ``set`` tag. :pr:`489`\n- ``tojson`` filter marks output as safe to match documented behavior.\n :pr:`718`\n- Resolved a bug where getting debug locals for tracebacks could\n modify template context.\n- Fixed a bug where having many ``{% elif ... %}`` blocks resulted in\n a \"too many levels of indentation\" error. These blocks now compile\n to native ``elif ..:`` instead of ``else: if ..:`` :issue:`759`\n\n\nVersion 2.9.6\n-------------\n\nReleased 2017-04-03\n\n- Fixed custom context behavior in fast resolve mode :issue:`675`\n\n\nVersion 2.9.5\n-------------\n\nReleased 2017-01-28\n\n- Restored the original repr of the internal ``_GroupTuple`` because\n this caused issues with ansible and it was an unintended change.\n :issue:`654`\n- Added back support for custom contexts that override the old\n ``resolve`` method since it was hard for people to spot that this\n could cause a regression.\n- Correctly use the buffer for the else block of for loops. This\n caused invalid syntax errors to be caused on 2.x and completely\n wrong behavior on Python 3 :issue:`669`\n- Resolve an issue where the ``{% extends %}`` tag could not be used\n with async environments. :issue:`668`\n- Reduce memory footprint slightly by reducing our unicode database\n dump we use for identifier matching on Python 3 :issue:`666`\n- Fixed autoescaping not working for macros in async compilation mode.\n :issue:`671`\n\n\nVersion 2.9.4\n-------------\n\nReleased 2017-01-10\n\n- Solved some warnings for string literals. :issue:`646`\n- Increment the bytecode cache version which was not done due to an\n oversight before.\n- Corrected bad code generation and scoping for filtered loops.\n :issue:`649`\n- Resolved an issue where top-level output silencing after known\n extend blocks could generate invalid code when blocks where\n contained in if statements. :issue:`651`\n- Made the ``truncate.leeway`` default configurable to improve\n compatibility with older templates.\n\n\nVersion 2.9.3\n-------------\n\nReleased 2017-01-08\n\n- Restored the use of blocks in macros to the extend that was possible\n before. On Python 3 it would render a generator repr instead of the\n block contents. :issue:`645`\n- Set a consistent behavior for assigning of variables in inner scopes\n when the variable is also read from an outer scope. This now sets\n the intended behavior in all situations however it does not restore\n the old behavior where limited assignments to outer scopes was\n possible. For more information and a discussion see :issue:`641`\n- Resolved an issue where ``block scoped`` would not take advantage of\n the new scoping rules. In some more exotic cases a variable\n overridden in a local scope would not make it into a block.\n- Change the code generation of the ``with`` statement to be in line\n with the new scoping rules. This resolves some unlikely bugs in edge\n cases. This also introduces a new internal ``With`` node that can be\n used by extensions.\n\n\nVersion 2.9.2\n-------------\n\nReleased 2017-01-08\n\n- Fixed a regression that caused for loops to not be able to use the\n same variable for the target as well as source iterator.\n :issue:`640`\n- Add support for a previously unknown behavior of macros. It used to\n be possible in some circumstances to explicitly provide a caller\n argument to macros. While badly buggy and unintended it turns out\n that this is a common case that gets copy pasted around. To not\n completely break backwards compatibility with the most common cases\n it's now possible to provide an explicit keyword argument for caller\n if it's given an explicit default. :issue:`642`\n\n\nVersion 2.9.1\n-------------\n\nReleased 2017-01-07\n\n- Resolved a regression with call block scoping for macros. Nested\n caller blocks that used the same identifiers as outer macros could\n refer to the wrong variable incorrectly.\n\n\nVersion 2.9\n-----------\n\nReleased 2017-01-07, codename Derivation\n\n- Change cache key definition in environment. This fixes a performance\n regression introduced in 2.8.\n- Added support for ``generator_stop`` on supported Python versions\n (Python 3.5 and later)\n- Corrected a long standing issue with operator precedence of math\n operations not being what was expected.\n- Added support for Python 3.6 async iterators through a new async\n mode.\n- Added policies for filter defaults and similar things.\n- Urlize now sets \"rel noopener\" by default.\n- Support attribute fallback for old-style classes in 2.x.\n- Support toplevel set statements in extend situations.\n- Restored behavior of Cycler for Python 3 users.\n- Subtraction now follows the same behavior as other operators on\n undefined values.\n- ``map`` and friends will now give better error messages if you\n forgot to quote the parameter.\n- Depend on MarkupSafe 0.23 or higher.\n- Improved the ``truncate`` filter to support better truncation in\n case the string is barely truncated at all.\n- Change the logic for macro autoescaping to be based on the runtime\n autoescaping information at call time instead of macro define time.\n- Ported a modified version of the ``tojson`` filter from Flask to\n Jinja and hooked it up with the new policy framework.\n- Block sets are now marked ``safe`` by default.\n- On Python 2 the asciification of ASCII strings can now be disabled\n with the ``compiler.ascii_str`` policy.\n- Tests now no longer accept an arbitrary expression as first argument\n but a restricted one. This means that you can now properly use\n multiple tests in one expression without extra parentheses. In\n particular you can now write ``foo is divisibleby 2 or foo is\n divisibleby 3`` as you would expect.\n- Greatly changed the scoping system to be more consistent with what\n template designers and developers expect. There is now no more magic\n difference between the different include and import constructs.\n Context is now always propagated the same way. The only remaining\n differences is the defaults for ``with context`` and ``without\n context``.\n- The ``with`` and ``autoescape`` tags are now built-in.\n- Added the new ``select_autoescape`` function which helps configuring\n better autoescaping easier.\n- Fixed a runtime error in the sandbox when attributes of async\n generators were accessed.\n\n\nVersion 2.8.1\n-------------\n\nReleased 2016-12-29\n\n- Fixed the ``for_qs`` flag for ``urlencode``.\n- Fixed regression when applying ``int`` to non-string values.\n- SECURITY: if the sandbox mode is used format expressions are now\n sandboxed with the same rules as in Jinja. This solves various\n information leakage problems that can occur with format strings.\n\n\nVersion 2.8\n-----------\n\nReleased 2015-07-26, codename Replacement\n\n- Added ``target`` parameter to urlize function.\n- Added support for ``followsymlinks`` to the file system loader.\n- The truncate filter now counts the length.\n- Added equalto filter that helps with select filters.\n- Changed cache keys to use absolute file names if available instead\n of load names.\n- Fixed loop length calculation for some iterators.\n- Changed how Jinja enforces strings to be native strings in Python 2\n to work when people break their default encoding.\n- Added ``make_logging_undefined`` which returns an undefined\n object that logs failures into a logger.\n- If unmarshalling of cached data fails the template will be reloaded\n now.\n- Implemented a block ``set`` tag.\n- Default cache size was increased to 400 from a low 50.\n- Fixed ``is number`` test to accept long integers in all Python\n versions.\n- Changed ``is number`` to accept Decimal as a number.\n- Added a check for default arguments followed by non-default\n arguments. This change makes ``{% macro m(x, y=1, z) %}`` a syntax\n error. The previous behavior for this code was broken anyway\n (resulting in the default value being applied to ``y``).\n- Add ability to use custom subclasses of\n ``jinja2.compiler.CodeGenerator`` and ``jinja2.runtime.Context`` by\n adding two new attributes to the environment\n (``code_generator_class`` and ``context_class``). :pr:`404`\n- Added support for context/environment/evalctx decorator functions on\n the finalize callback of the environment.\n- Escape query strings for urlencode properly. Previously slashes were\n not escaped in that place.\n- Add 'base' parameter to 'int' filter.\n\n\nVersion 2.7.3\n-------------\n\nReleased 2014-06-06\n\n- Security issue: Corrected the security fix for the cache folder.\n This fix was provided by RedHat.\n\n\nVersion 2.7.2\n-------------\n\nReleased 2014-01-10\n\n- Prefix loader was not forwarding the locals properly to inner\n loaders. This is now fixed.\n- Security issue: Changed the default folder for the filesystem cache\n to be user specific and read and write protected on UNIX systems.\n See `Debian bug 734747`_ for more information.\n\n.. _Debian bug 734747: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=734747\n\n\nVersion 2.7.1\n-------------\n\nReleased 2013-08-07\n\n- Fixed a bug with ``call_filter`` not working properly on environment\n and context filters.\n- Fixed lack of Python 3 support for bytecode caches.\n- Reverted support for defining blocks in included templates as this\n broke existing templates for users.\n- Fixed some warnings with hashing of undefineds and nodes if Python\n is run with warnings for Python 3.\n- Added support for properly hashing undefined objects.\n- Fixed a bug with the title filter not working on already uppercase\n strings.\n\n\nVersion 2.7\n-----------\n\nReleased 2013-05-20, codename Translation\n\n- Choice and prefix loaders now dispatch source and template lookup\n separately in order to work in combination with module loaders as\n advertised.\n- Fixed filesizeformat.\n- Added a non-silent option for babel extraction.\n- Added ``urlencode`` filter that automatically quotes values for URL\n safe usage with utf-8 as only supported encoding. If applications\n want to change this encoding they can override the filter.\n- Added ``keep-trailing-newline`` configuration to environments and\n templates to optionally preserve the final trailing newline.\n- Accessing ``last`` on the loop context no longer causes the iterator\n to be consumed into a list.\n- Python requirement changed: 2.6, 2.7 or >= 3.3 are required now,\n supported by same source code, using the \"six\" compatibility\n library.\n- Allow ``contextfunction`` and other decorators to be applied to\n ``__call__``.\n- Added support for changing from newline to different signs in the\n ``wordwrap`` filter.\n- Added support for ignoring memcache errors silently.\n- Added support for keeping the trailing newline in templates.\n- Added finer grained support for stripping whitespace on the left\n side of blocks.\n- Added ``map``, ``select``, ``reject``, ``selectattr`` and\n ``rejectattr`` filters.\n- Added support for ``loop.depth`` to figure out how deep inside a\n recursive loop the code is.\n- Disabled py_compile for pypy and python 3.\n\n\nVersion 2.6\n-----------\n\nReleased 2011-07-24, codename Convolution\n\n- Internal attributes now raise an internal attribute error now\n instead of returning an undefined. This fixes problems when passing\n undefined objects to Python semantics expecting APIs.\n- Traceback support now works properly for PyPy. (Tested with 1.4)\n- Implemented operator intercepting for sandboxed environments. This\n allows application developers to disable builtin operators for\n better security. (For instance limit the mathematical operators to\n actual integers instead of longs)\n- Groupby filter now supports dotted notation for grouping by\n attributes of attributes.\n- Scoped blocks now properly treat toplevel assignments and imports.\n Previously an import suddenly \"disappeared\" in a scoped block.\n- Automatically detect newer Python interpreter versions before\n loading code from bytecode caches to prevent segfaults on invalid\n opcodes. The segfault in earlier Jinja versions here was not a\n Jinja bug but a limitation in the underlying Python interpreter. If\n you notice Jinja segfaulting in earlier versions after an upgrade\n of the Python interpreter you don't have to upgrade, it's enough to\n flush the bytecode cache. This just no longer makes this necessary,\n Jinja will automatically detect these cases now.\n- The sum filter can now sum up values by attribute. This is a\n backwards incompatible change. The argument to the filter previously\n was the optional starting index which defaults to zero. This now\n became the second argument to the function because it's rarely used.\n- Like sum, sort now also makes it possible to order items by\n attribute.\n- Like sum and sort, join now also is able to join attributes of\n objects as string.\n- The internal eval context now has a reference to the environment.\n- Added a mapping test to see if an object is a dict or an object with\n a similar interface.\n\n\nVersion 2.5.5\n-------------\n\nReleased 2010-10-18\n\n- Built documentation is no longer part of release.\n\n\nVersion 2.5.4\n-------------\n\nReleased 2010-10-17\n\n- Fixed extensions not loading properly with overlays.\n- Work around a bug in cpython for the debugger that causes segfaults\n on 64bit big-endian architectures.\n\n\nVersion 2.5.3\n-------------\n\nReleased 2010-10-17\n\n- Fixed an operator precedence error introduced in 2.5.2. Statements\n like \"-foo.bar\" had their implicit parentheses applied around the\n first part of the expression (\"(-foo).bar\") instead of the more\n correct \"-(foo.bar)\".\n\n\nVersion 2.5.2\n-------------\n\nReleased 2010-08-18\n\n- Improved setup.py script to better work with assumptions people\n might still have from it (``--with-speedups``).\n- Fixed a packaging error that excluded the new debug support.\n\n\nVersion 2.5.1\n-------------\n\nReleased 2010-08-17\n\n- StopIteration exceptions raised by functions called from templates\n are now intercepted and converted to undefineds. This solves a lot\n of debugging grief. (StopIteration is used internally to abort\n template execution)\n- Improved performance of macro calls slightly.\n- Babel extraction can now properly extract newstyle gettext calls.\n- Using the variable ``num`` in newstyle gettext for something else\n than the pluralize count will no longer raise a :exc:`KeyError`.\n- Removed builtin markup class and switched to markupsafe. For\n backwards compatibility the pure Python implementation still exists\n but is pulled from markupsafe by the Jinja developers. The debug\n support went into a separate feature called \"debugsupport\" and is\n disabled by default because it is only relevant for Python 2.4\n- Fixed an issue with unary operators having the wrong precedence.\n\n\nVersion 2.5\n-----------\n\nReleased 2010-05-29, codename Incoherence\n\n- Improved the sort filter (should have worked like this for a long\n time) by adding support for case insensitive searches.\n- Fixed a bug for getattribute constant folding.\n- Support for newstyle gettext translations which result in a nicer\n in-template user interface and more consistent catalogs.\n- It's now possible to register extensions after an environment was\n created.\n\n\nVersion 2.4.1\n-------------\n\nReleased 2010-04-20\n\n- Fixed an error reporting bug for undefined.\n\n\nVersion 2.4\n-----------\n\nReleased 2010-04-13, codename Correlation\n\n- The environment template loading functions now transparently pass\n through a template object if it was passed to it. This makes it\n possible to import or extend from a template object that was passed\n to the template.\n- Added a ``ModuleLoader`` that can load templates from\n precompiled sources. The environment now features a method to\n compile the templates from a configured loader into a zip file or\n folder.\n- The _speedups C extension now supports Python 3.\n- Added support for autoescaping toggling sections and support for\n evaluation contexts.\n- Extensions have a priority now.\n\n\nVersion 2.3.1\n-------------\n\nReleased 2010-02-19\n\n- Fixed an error reporting bug on all python versions\n- Fixed an error reporting bug on Python 2.4\n\n\nVersion 2.3\n-----------\n\nReleased 2010-02-10, codename 3000 Pythons\n\n- Fixes issue with code generator that causes unbound variables to be\n generated if set was used in if-blocks and other small identifier\n problems.\n- Include tags are now able to select between multiple templates and\n take the first that exists, if a list of templates is given.\n- Fixed a problem with having call blocks in outer scopes that have an\n argument that is also used as local variable in an inner frame\n :issue:`360`.\n- Greatly improved error message reporting :pr:`339`\n- Implicit tuple expressions can no longer be totally empty. This\n change makes ``{% if %}`` a syntax error now. :issue:`364`\n- Added support for translator comments if extracted via babel.\n- Added with-statement extension.\n- Experimental Python 3 support.\n\n\nVersion 2.2.1\n-------------\n\nReleased 2009-09-14\n\n- Fixes some smaller problems for Jinja on Jython.\n\n\nVersion 2.2\n-----------\n\nReleased 2009-09-13, codename Kong\n\n- Include statements can now be marked with ``ignore missing`` to skip\n non existing templates.\n- Priority of ``not`` raised. It's now possible to write ``not foo in\n bar`` as an alias to ``foo not in bar`` like in python. Previously\n the grammar required parentheses (``not (foo in bar)``) which was\n odd.\n- Fixed a bug that caused syntax errors when defining macros or using\n the ``{% call %}`` tag inside loops.\n- Fixed a bug in the parser that made ``{{ foo[1, 2] }}`` impossible.\n- Made it possible to refer to names from outer scopes in included\n templates that were unused in the callers frame :issue:`327`\n- Fixed a bug that caused internal errors if names where used as\n iteration variable and regular variable *after* the loop if that\n variable was unused *before* the loop. :pr:`331`\n- Added support for optional ``scoped`` modifier to blocks.\n- Added support for line-comments.\n- Added the ``meta`` module.\n- Renamed (undocumented) attribute \"overlay\" to \"overlayed\" on the\n environment because it was clashing with a method of the same name.\n- Speedup extension is now disabled by default.\n\n\nVersion 2.1.1\n-------------\n\nReleased 2008-12-25\n\n- Fixed a translation error caused by looping over empty recursive\n loops.\n\n\nVersion 2.1\n-----------\n\nReleased 2008-11-23, codename Yasuzō\n\n- Fixed a bug with nested loops and the special loop variable. Before\n the change an inner loop overwrote the loop variable from the outer\n one after iteration.\n- Fixed a bug with the i18n extension that caused the explicit\n pluralization block to look up the wrong variable.\n- Fixed a limitation in the lexer that made ``{{ foo.0.0 }}``\n impossible.\n- Index based subscribing of variables with a constant value returns\n an undefined object now instead of raising an index error. This was\n a bug caused by eager optimizing.\n- The i18n extension looks up ``foo.ugettext`` now followed by\n ``foo.gettext`` if an translations object is installed. This makes\n dealing with custom translations classes easier.\n- Fixed a confusing behavior with conditional extending. loops were\n partially executed under some conditions even though they were not\n part of a visible area.\n- Added ``sort`` filter that works like ``dictsort`` but for arbitrary\n sequences.\n- Fixed a bug with empty statements in macros.\n- Implemented a bytecode cache system.\n- The template context is now weakref-able\n- Inclusions and imports \"with context\" forward all variables now, not\n only the initial context.\n- Added a cycle helper called ``cycler``.\n- Added a joining helper called ``joiner``.\n- Added a ``compile_expression`` method to the environment that allows\n compiling of Jinja expressions into callable Python objects.\n- Fixed an escaping bug in urlize\n\n\nVersion 2.0\n-----------\n\nReleased 2008-07-17, codename Jinjavitus\n\n- The subscribing of objects (looking up attributes and items) changed\n from slightly. It's now possible to give attributes or items a\n higher priority by either using dot-notation lookup or the bracket\n syntax. This also changed the AST slightly. ``Subscript`` is gone\n and was replaced with ``Getitem`` and ``Getattr``.\n- Added support for preprocessing and token stream filtering for\n extensions. This would allow extensions to allow simplified gettext\n calls in template data and something similar.\n- Added ``TemplateStream.dump``.\n- Added missing support for implicit string literal concatenation.\n ``{{ \"foo\" \"bar\" }}`` is equivalent to ``{{ \"foobar\" }}``\n- ``else`` is optional for conditional expressions. If not given it\n evaluates to ``false``.\n- Improved error reporting for undefined values by providing a\n position.\n- ``filesizeformat`` filter uses decimal prefixes now by default and\n can be set to binary mode with the second parameter.\n- Fixed bug in finalizer\n\n\nVersion 2.0rc1\n--------------\n\nReleased 2008-06-09\n\n- First release of Jinja 2.\n"
},
{
"path": "LICENSE.txt",
"content": "Copyright 2007 Pallets\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n1. Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "README.md",
"content": "
\n\n# Jinja\n\nJinja is a fast, expressive, extensible templating engine. Special\nplaceholders in the template allow writing code similar to Python\nsyntax. Then the template is passed data to render the final document.\n\nIt includes:\n\n- Template inheritance and inclusion.\n- Define and import macros within templates.\n- HTML templates can use autoescaping to prevent XSS from untrusted\n user input.\n- A sandboxed environment can safely render untrusted templates.\n- AsyncIO support for generating templates and calling async\n functions.\n- I18N support with Babel.\n- Templates are compiled to optimized Python code just-in-time and\n cached, or can be compiled ahead-of-time.\n- Exceptions point to the correct line in templates to make debugging\n easier.\n- Extensible filters, tests, functions, and even syntax.\n\nJinja's philosophy is that while application logic belongs in Python if\npossible, it shouldn't make the template designer's job difficult by\nrestricting functionality too much.\n\n\n## In A Nutshell\n\n```jinja\n{% extends \"base.html\" %}\n{% block title %}Members{% endblock %}\n{% block content %}\n
\n{% endblock %}\n```\n\n## Donate\n\nThe Pallets organization develops and supports Jinja and other popular\npackages. In order to grow the community of contributors and users, and\nallow the maintainers to devote more time to the projects, [please\ndonate today][].\n\n[please donate today]: https://palletsprojects.com/donate\n\n## Contributing\n\nSee our [detailed contributing documentation][contrib] for many ways to\ncontribute, including reporting issues, requesting features, asking or answering\nquestions, and making PRs.\n\n[contrib]: https://palletsprojects.com/contributing/\n"
},
{
"path": "docs/Makefile",
"content": "# Minimal makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nSOURCEDIR = .\nBUILDDIR = _build\n\n# Put it first so that \"make\" without argument is like \"make help\".\nhelp:\n\t@$(SPHINXBUILD) -M help \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n\n.PHONY: help Makefile\n\n# Catch-all target: route all unknown targets to Sphinx using the new\n# \"make mode\" option. $(O) is meant as a shortcut for $(SPHINXOPTS).\n%: Makefile\n\t@$(SPHINXBUILD) -M $@ \"$(SOURCEDIR)\" \"$(BUILDDIR)\" $(SPHINXOPTS) $(O)\n"
},
{
"path": "docs/api.rst",
"content": "API\n===\n\n.. module:: jinja2\n :noindex:\n :synopsis: public Jinja API\n\nThis document describes the API to Jinja and not the template language\n(for that, see :doc:`/templates`). It will be most useful as reference\nto those implementing the template interface to the application and not\nthose who are creating Jinja templates.\n\nBasics\n------\n\nJinja uses a central object called the template :class:`Environment`.\nInstances of this class are used to store the configuration and global objects,\nand are used to load templates from the file system or other locations.\nEven if you are creating templates from strings by using the constructor of\n:class:`Template` class, an environment is created automatically for you,\nalbeit a shared one.\n\nMost applications will create one :class:`Environment` object on application\ninitialization and use that to load templates. In some cases however, it's\nuseful to have multiple environments side by side, if different configurations\nare in use.\n\nThe simplest way to configure Jinja to load templates for your\napplication is to use :class:`~loaders.PackageLoader`.\n\n.. code-block:: python\n\n from jinja2 import Environment, PackageLoader, select_autoescape\n env = Environment(\n loader=PackageLoader(\"yourapp\"),\n autoescape=select_autoescape()\n )\n\nThis will create a template environment with a loader that looks up\ntemplates in the ``templates`` folder inside the ``yourapp`` Python\npackage (or next to the ``yourapp.py`` Python module). It also enables\nautoescaping for HTML files. This loader only requires that ``yourapp``\nis importable, it figures out the absolute path to the folder for you.\n\nDifferent loaders are available to load templates in other ways or from\nother locations. They're listed in the `Loaders`_ section below. You can\nalso write your own if you want to load templates from a source that's\nmore specialized to your project.\n\nTo load a template from this environment, call the :meth:`get_template`\nmethod, which returns the loaded :class:`Template`.\n\n.. code-block:: python\n\n template = env.get_template(\"mytemplate.html\")\n\nTo render it with some variables, call the :meth:`render` method.\n\n.. code-block:: python\n\n print(template.render(the=\"variables\", go=\"here\"))\n\nUsing a template loader rather than passing strings to :class:`Template`\nor :meth:`Environment.from_string` has multiple advantages. Besides being\na lot easier to use it also enables template inheritance.\n\n.. admonition:: Notes on Autoescaping\n\n In future versions of Jinja we might enable autoescaping by default\n for security reasons. As such you are encouraged to explicitly\n configure autoescaping now instead of relying on the default.\n\n\nHigh Level API\n--------------\n\nThe high-level API is the API you will use in the application to load and\nrender Jinja templates. The :ref:`low-level-api` on the other side is only\nuseful if you want to dig deeper into Jinja or :ref:`develop extensions\n`.\n\n.. autoclass:: Environment([options])\n :members: from_string, get_template, select_template,\n get_or_select_template, join_path, extend, compile_expression,\n compile_templates, list_templates, add_extension\n\n .. attribute:: shared\n\n If a template was created by using the :class:`Template` constructor\n an environment is created automatically. These environments are\n created as shared environments which means that multiple templates\n may have the same anonymous environment. For all shared environments\n this attribute is `True`, else `False`.\n\n .. attribute:: sandboxed\n\n If the environment is sandboxed this attribute is `True`. For the\n sandbox mode have a look at the documentation for the\n :class:`~jinja2.sandbox.SandboxedEnvironment`.\n\n .. attribute:: filters\n\n A dict of filters for this environment. As long as no template was\n loaded it's safe to add new filters or remove old. For custom filters\n see :ref:`writing-filters`. For valid filter names have a look at\n :ref:`identifier-naming`.\n\n .. attribute:: tests\n\n A dict of test functions for this environment. As long as no\n template was loaded it's safe to modify this dict. For custom tests\n see :ref:`writing-tests`. For valid test names have a look at\n :ref:`identifier-naming`.\n\n .. attribute:: globals\n\n A dict of variables that are available in every template loaded\n by the environment. As long as no template was loaded it's safe\n to modify this. For more details see :ref:`global-namespace`.\n For valid object names see :ref:`identifier-naming`.\n\n .. attribute:: policies\n\n A dictionary with :ref:`policies`. These can be reconfigured to\n change the runtime behavior or certain template features. Usually\n these are security related.\n\n .. attribute:: code_generator_class\n\n The class used for code generation. This should not be changed\n in most cases, unless you need to modify the Python code a\n template compiles to.\n\n .. attribute:: context_class\n\n The context used for templates. This should not be changed\n in most cases, unless you need to modify internals of how\n template variables are handled. For details, see\n :class:`~jinja2.runtime.Context`.\n\n .. automethod:: overlay([options])\n\n .. method:: undefined([hint, obj, name, exc])\n\n Creates a new :class:`Undefined` object for `name`. This is useful\n for filters or functions that may return undefined objects for\n some operations. All parameters except of `hint` should be provided\n as keyword parameters for better readability. The `hint` is used as\n error message for the exception if provided, otherwise the error\n message will be generated from `obj` and `name` automatically. The exception\n provided as `exc` is raised if something with the generated undefined\n object is done that the undefined object does not allow. The default\n exception is :exc:`UndefinedError`. If a `hint` is provided the\n `name` may be omitted.\n\n The most common way to create an undefined object is by providing\n a name only::\n\n return environment.undefined(name='some_name')\n\n This means that the name `some_name` is not defined. If the name\n was from an attribute of an object it makes sense to tell the\n undefined object the holder object to improve the error message::\n\n if not hasattr(obj, 'attr'):\n return environment.undefined(obj=obj, name='attr')\n\n For a more complex example you can provide a hint. For example\n the :func:`first` filter creates an undefined object that way::\n\n return environment.undefined('no first item, sequence was empty')\n\n If it the `name` or `obj` is known (for example because an attribute\n was accessed) it should be passed to the undefined object, even if\n a custom `hint` is provided. This gives undefined objects the\n possibility to enhance the error message.\n\n.. autoclass:: Template\n :members: module, make_module\n\n .. attribute:: globals\n\n A dict of variables that are available every time the template\n is rendered, without needing to pass them during render. This\n should not be modified, as depending on how the template was\n loaded it may be shared with the environment and other\n templates.\n\n Defaults to :attr:`Environment.globals` unless extra values are\n passed to :meth:`Environment.get_template`.\n\n Globals are only intended for data that is common to every\n render of the template. Specific data should be passed to\n :meth:`render`.\n\n See :ref:`global-namespace`.\n\n .. attribute:: name\n\n The loading name of the template. If the template was loaded from a\n string this is `None`.\n\n .. attribute:: filename\n\n The filename of the template on the file system if it was loaded from\n there. Otherwise this is `None`.\n\n .. automethod:: render([context])\n\n .. automethod:: generate([context])\n\n .. automethod:: stream([context])\n\n .. automethod:: render_async([context])\n\n .. automethod:: generate_async([context])\n\n\n.. autoclass:: jinja2.environment.TemplateStream()\n :members: disable_buffering, enable_buffering, dump\n\n\nAutoescaping\n------------\n\n.. versionchanged:: 2.4\n\nJinja now comes with autoescaping support. As of Jinja 2.9 the\nautoescape extension is removed and built-in. However autoescaping is\nnot yet enabled by default though this will most likely change in the\nfuture. It's recommended to configure a sensible default for\nautoescaping. This makes it possible to enable and disable autoescaping\non a per-template basis (HTML versus text for instance).\n\n.. autofunction:: jinja2.select_autoescape\n\nHere a recommended setup that enables autoescaping for templates ending\nin ``'.html'``, ``'.htm'`` and ``'.xml'`` and disabling it by default\nfor all other extensions. You can use the :func:`~jinja2.select_autoescape`\nfunction for this::\n\n from jinja2 import Environment, PackageLoader, select_autoescape\n env = Environment(autoescape=select_autoescape(['html', 'htm', 'xml']),\n loader=PackageLoader('mypackage'))\n\nThe :func:`~jinja.select_autoescape` function returns a function that\nworks roughly like this::\n\n def autoescape(template_name):\n if template_name is None:\n return False\n if template_name.endswith(('.html', '.htm', '.xml'))\n\nWhen implementing a guessing autoescape function, make sure you also\naccept `None` as valid template name. This will be passed when generating\ntemplates from strings. You should always configure autoescaping as\ndefaults in the future might change.\n\nInside the templates the behaviour can be temporarily changed by using\nthe `autoescape` block (see :ref:`autoescape-overrides`).\n\n\n.. _identifier-naming:\n\nNotes on Identifiers\n--------------------\n\nJinja uses Python naming rules. Valid identifiers can be any combination\nof characters accepted by Python.\n\nFilters and tests are looked up in separate namespaces and have slightly\nmodified identifier syntax. Filters and tests may contain dots to group\nfilters and tests by topic. For example it's perfectly valid to add a\nfunction into the filter dict and call it `to.str`. The regular\nexpression for filter and test identifiers is\n``[a-zA-Z_][a-zA-Z0-9_]*(\\.[a-zA-Z_][a-zA-Z0-9_]*)*``.\n\n\nUndefined Types\n---------------\n\nThese classes can be used as undefined types. The :class:`Environment`\nconstructor takes an `undefined` parameter that can be one of those classes\nor a custom subclass of :class:`Undefined`. Whenever the template engine is\nunable to look up a name or access an attribute one of those objects is\ncreated and returned. Some operations on undefined values are then allowed,\nothers fail.\n\nThe closest to regular Python behavior is the :class:`StrictUndefined` which\ndisallows all operations beside testing if it's an undefined object.\n\n.. autoclass:: jinja2.Undefined()\n\n .. attribute:: _undefined_hint\n\n Either `None` or a string with the error message for the\n undefined object.\n\n .. attribute:: _undefined_obj\n\n Either `None` or the owner object that caused the undefined object\n to be created (for example because an attribute does not exist).\n\n .. attribute:: _undefined_name\n\n The name for the undefined variable / attribute or just `None`\n if no such information exists.\n\n .. attribute:: _undefined_exception\n\n The exception that the undefined object wants to raise. This\n is usually one of :exc:`UndefinedError` or :exc:`SecurityError`.\n\n .. method:: _fail_with_undefined_error(\\*args, \\**kwargs)\n\n When called with any arguments this method raises\n :attr:`_undefined_exception` with an error message generated\n from the undefined hints stored on the undefined object.\n\n.. autoclass:: jinja2.ChainableUndefined()\n\n.. autoclass:: jinja2.DebugUndefined()\n\n.. autoclass:: jinja2.StrictUndefined()\n\nThere is also a factory function that can decorate undefined objects to\nimplement logging on failures:\n\n.. autofunction:: jinja2.make_logging_undefined\n\nUndefined objects are created by calling :attr:`undefined`.\n\n.. admonition:: Implementation\n\n :class:`Undefined` is implemented by overriding the special\n ``__underscore__`` methods. For example the default\n :class:`Undefined` class implements ``__str__`` to returns an empty\n string, while ``__int__`` and others fail with an exception. To\n allow conversion to int by returning ``0`` you can implement your\n own subclass.\n\n .. code-block:: python\n\n class NullUndefined(Undefined):\n def __int__(self):\n return 0\n\n def __float__(self):\n return 0.0\n\n To disallow a method, override it and raise\n :attr:`~Undefined._undefined_exception`. Because this is very\n common there is the helper method\n :meth:`~Undefined._fail_with_undefined_error` that raises the error\n with the correct information. Here's a class that works like the\n regular :class:`Undefined` but fails on iteration::\n\n class NonIterableUndefined(Undefined):\n def __iter__(self):\n self._fail_with_undefined_error()\n\n\nThe Context\n-----------\n\n.. autoclass:: jinja2.runtime.Context()\n :members: get, resolve, resolve_or_missing, get_exported, get_all\n\n .. attribute:: parent\n\n A dict of read only, global variables the template looks up. These\n can either come from another :class:`Context`, from the\n :attr:`Environment.globals` or :attr:`Template.globals` or points\n to a dict created by combining the globals with the variables\n passed to the render function. It must not be altered.\n\n .. attribute:: vars\n\n The template local variables. This list contains environment and\n context functions from the :attr:`parent` scope as well as local\n modifications and exported variables from the template. The template\n will modify this dict during template evaluation but filters and\n context functions are not allowed to modify it.\n\n .. attribute:: environment\n\n The environment that loaded the template.\n\n .. attribute:: exported_vars\n\n This set contains all the names the template exports. The values for\n the names are in the :attr:`vars` dict. In order to get a copy of the\n exported variables as dict, :meth:`get_exported` can be used.\n\n .. attribute:: name\n\n The load name of the template owning this context.\n\n .. attribute:: blocks\n\n A dict with the current mapping of blocks in the template. The keys\n in this dict are the names of the blocks, and the values a list of\n blocks registered. The last item in each list is the current active\n block (latest in the inheritance chain).\n\n .. attribute:: eval_ctx\n\n The current :ref:`eval-context`.\n\n .. automethod:: jinja2.runtime.Context.call(callable, \\*args, \\**kwargs)\n\n\nThe context is immutable, it prevents modifications, and if it is\nmodified somehow despite that those changes may not show up. For\nperformance, Jinja does not use the context as data storage for, only as\na primary data source. Variables that the template does not define are\nlooked up in the context, but variables the template does define are\nstored locally.\n\nInstead of modifying the context directly, a function should return\na value that can be assigned to a variable within the template itself.\n\n.. code-block:: jinja\n\n {% set comments = get_latest_comments() %}\n\n\n.. _loaders:\n\nLoaders\n-------\n\nLoaders are responsible for loading templates from a resource such as the\nfile system. The environment will keep the compiled modules in memory like\nPython's `sys.modules`. Unlike `sys.modules` however this cache is limited in\nsize by default and templates are automatically reloaded.\nAll loaders are subclasses of :class:`BaseLoader`. If you want to create your\nown loader, subclass :class:`BaseLoader` and override `get_source`.\n\n.. autoclass:: jinja2.BaseLoader\n :members: get_source, load\n\nHere a list of the builtin loaders Jinja provides:\n\n.. autoclass:: jinja2.FileSystemLoader\n\n.. autoclass:: jinja2.PackageLoader\n\n.. autoclass:: jinja2.DictLoader\n\n.. autoclass:: jinja2.FunctionLoader\n\n.. autoclass:: jinja2.PrefixLoader\n\n.. autoclass:: jinja2.ChoiceLoader\n\n.. autoclass:: jinja2.ModuleLoader\n\n\n.. _bytecode-cache:\n\nBytecode Cache\n--------------\n\nJinja 2.1 and higher support external bytecode caching. Bytecode caches make\nit possible to store the generated bytecode on the file system or a different\nlocation to avoid parsing the templates on first use.\n\nThis is especially useful if you have a web application that is initialized on\nthe first request and Jinja compiles many templates at once which slows down\nthe application.\n\nTo use a bytecode cache, instantiate it and pass it to the :class:`Environment`.\n\n.. autoclass:: jinja2.BytecodeCache\n :members: load_bytecode, dump_bytecode, clear\n\n.. autoclass:: jinja2.bccache.Bucket\n :members: write_bytecode, load_bytecode, bytecode_from_string,\n bytecode_to_string, reset\n\n .. attribute:: environment\n\n The :class:`Environment` that created the bucket.\n\n .. attribute:: key\n\n The unique cache key for this bucket\n\n .. attribute:: code\n\n The bytecode if it's loaded, otherwise `None`.\n\n\nBuiltin bytecode caches:\n\n.. autoclass:: jinja2.FileSystemBytecodeCache\n\n.. autoclass:: jinja2.MemcachedBytecodeCache\n\n\nAsync Support\n-------------\n\n.. versionadded:: 2.9\n\nJinja supports the Python ``async`` and ``await`` syntax. For the\ntemplate designer, this support (when enabled) is entirely transparent,\ntemplates continue to look exactly the same. However, developers should\nbe aware of the implementation as it affects what types of APIs you can\nuse.\n\nBy default, async support is disabled. Enabling it will cause the\nenvironment to compile different code behind the scenes in order to\nhandle async and sync code in an asyncio event loop. This has the\nfollowing implications:\n\n- The compiled code uses ``await`` for functions and attributes, and\n uses ``async for`` loops. In order to support using both async and\n sync functions in this context, a small wrapper is placed around\n all calls and access, which adds overhead compared to purely async\n code.\n- Sync methods and filters become wrappers around their corresponding\n async implementations where needed. For example, ``render`` invokes\n ``async_render``, and ``|map`` supports async iterables.\n\nAwaitable objects can be returned from functions in templates and any\nfunction call in a template will automatically await the result. The\n``await`` you would normally add in Python is implied. For example, you\ncan provide a method that asynchronously loads data from a database, and\nfrom the template designer's point of view it can be called like any\nother function.\n\n\n.. _policies:\n\nPolicies\n--------\n\nStarting with Jinja 2.9 policies can be configured on the environment\nwhich can slightly influence how filters and other template constructs\nbehave. They can be configured with the\n:attr:`~jinja2.Environment.policies` attribute.\n\nExample::\n\n env.policies['urlize.rel'] = 'nofollow noopener'\n\n``truncate.leeway``:\n Configures the leeway default for the `truncate` filter. Leeway as\n introduced in 2.9 but to restore compatibility with older templates\n it can be configured to `0` to get the old behavior back. The default\n is `5`.\n\n``urlize.rel``:\n A string that defines the items for the `rel` attribute of generated\n links with the `urlize` filter. These items are always added. The\n default is `noopener`.\n\n``urlize.target``:\n The default target that is issued for links from the `urlize` filter\n if no other target is defined by the call explicitly.\n\n``urlize.extra_schemes``:\n Recognize URLs that start with these schemes in addition to the\n default ``http://``, ``https://``, and ``mailto:``.\n\n``json.dumps_function``:\n If this is set to a value other than `None` then the `tojson` filter\n will dump with this function instead of the default one. Note that\n this function should accept arbitrary extra arguments which might be\n passed in the future from the filter. Currently the only argument\n that might be passed is `indent`. The default dump function is\n ``json.dumps``.\n\n``json.dumps_kwargs``:\n Keyword arguments to be passed to the dump function. The default is\n ``{'sort_keys': True}``.\n\n.. _ext-i18n-trimmed:\n\n``ext.i18n.trimmed``:\n If this is set to `True`, ``{% trans %}`` blocks of the\n :ref:`i18n-extension` will always unify linebreaks and surrounding\n whitespace as if the `trimmed` modifier was used.\n\n\nUtilities\n---------\n\nThese helper functions and classes are useful if you add custom filters or\nfunctions to a Jinja environment.\n\n.. autofunction:: jinja2.pass_context\n\n.. autofunction:: jinja2.pass_eval_context\n\n.. autofunction:: jinja2.pass_environment\n\n.. autofunction:: jinja2.clear_caches\n\n.. autofunction:: jinja2.is_undefined\n\n\nExceptions\n----------\n\n.. autoexception:: jinja2.TemplateError\n\n.. autoexception:: jinja2.UndefinedError\n\n.. autoexception:: jinja2.TemplateNotFound\n\n.. autoexception:: jinja2.TemplatesNotFound\n\n.. autoexception:: jinja2.TemplateSyntaxError\n\n .. attribute:: message\n\n The error message.\n\n .. attribute:: lineno\n\n The line number where the error occurred.\n\n .. attribute:: name\n\n The load name for the template.\n\n .. attribute:: filename\n\n The filename that loaded the template in the encoding of the\n file system (most likely utf-8, or mbcs on Windows systems).\n\n.. autoexception:: jinja2.TemplateRuntimeError\n\n.. autoexception:: jinja2.TemplateAssertionError\n\n\n.. _writing-filters:\n\nCustom Filters\n--------------\n\nFilters are Python functions that take the value to the left of the\nfilter as the first argument and produce a new value. Arguments passed\nto the filter are passed after the value.\n\nFor example, the filter ``{{ 42|myfilter(23) }}`` is called behind the\nscenes as ``myfilter(42, 23)``.\n\nJinja comes with some :ref:`built-in filters `. To use\na custom filter, write a function that takes at least a ``value``\nargument, then register it in :attr:`Environment.filters`.\n\nHere's a filter that formats datetime objects:\n\n.. code-block:: python\n\n def datetime_format(value, format=\"%H:%M %d-%m-%y\"):\n return value.strftime(format)\n\n environment.filters[\"datetime_format\"] = datetime_format\n\nNow it can be used in templates:\n\n.. sourcecode:: jinja\n\n {{ article.pub_date|datetime_format }}\n {{ article.pub_date|datetime_format(\"%B %Y\") }}\n\nSome decorators are available to tell Jinja to pass extra information to\nthe filter. The object is passed as the first argument, making the value\nbeing filtered the second argument.\n\n- :func:`pass_environment` passes the :class:`Environment`.\n- :func:`pass_eval_context` passes the :ref:`eval-context`.\n- :func:`pass_context` passes the current\n :class:`~jinja2.runtime.Context`.\n\nHere's a filter that converts line breaks into HTML `` `` and ``
``\ntags. It uses the eval context to check if autoescape is currently\nenabled before escaping the input and marking the output safe.\n\n.. code-block:: python\n\n import re\n from jinja2 import pass_eval_context\n from markupsafe import Markup, escape\n\n @pass_eval_context\n def nl2br(eval_ctx, value):\n br = \" \\n\"\n\n if eval_ctx.autoescape:\n value = escape(value)\n br = Markup(br)\n\n result = \"\\n\\n\".join(\n f\"
{br.join(p.splitlines())}
\"\n for p in re.split(r\"(?:\\r\\n|\\r(?!\\n)|\\n){2,}\", value)\n )\n return Markup(result) if eval_ctx.autoescape else result\n\n\n.. _writing-tests:\n\nCustom Tests\n------------\n\nTest are Python functions that take the value to the left of the test as\nthe first argument, and return ``True`` or ``False``. Arguments passed\nto the test are passed after the value.\n\nFor example, the test ``{{ 42 is even }}`` is called behind the scenes\nas ``is_even(42)``.\n\nJinja comes with some :ref:`built-in tests `. To use a\ncustom tests, write a function that takes at least a ``value`` argument,\nthen register it in :attr:`Environment.tests`.\n\nHere's a test that checks if a value is a prime number:\n\n.. code-block:: python\n\n import math\n\n def is_prime(n):\n if n == 2:\n return True\n\n for i in range(2, int(math.ceil(math.sqrt(n))) + 1):\n if n % i == 0:\n return False\n\n return True\n\n environment.tests[\"prime\"] = is_prime\n\nNow it can be used in templates:\n\n.. sourcecode:: jinja\n\n {% if value is prime %}\n {{ value }} is a prime number\n {% else %}\n {{ value }} is not a prime number\n {% endif %}\n\nSome decorators are available to tell Jinja to pass extra information to\nthe test. The object is passed as the first argument, making the value\nbeing tested the second argument.\n\n- :func:`pass_environment` passes the :class:`Environment`.\n- :func:`pass_eval_context` passes the :ref:`eval-context`.\n- :func:`pass_context` passes the current\n :class:`~jinja2.runtime.Context`.\n\n\n.. _eval-context:\n\nEvaluation Context\n------------------\n\nThe evaluation context (short eval context or eval ctx) makes it\npossible to activate and deactivate compiled features at runtime.\n\nCurrently it is only used to enable and disable automatic escaping, but\nit can be used by extensions as well.\n\nThe ``autoescape`` setting should be checked on the evaluation context,\nnot the environment. The evaluation context will have the computed value\nfor the current template.\n\nInstead of ``pass_environment``:\n\n.. code-block:: python\n\n @pass_environment\n def filter(env, value):\n result = do_something(value)\n\n if env.autoescape:\n result = Markup(result)\n\n return result\n\nUse ``pass_eval_context`` if you only need the setting:\n\n.. code-block:: python\n\n @pass_eval_context\n def filter(eval_ctx, value):\n result = do_something(value)\n\n if eval_ctx.autoescape:\n result = Markup(result)\n\n return result\n\nOr use ``pass_context`` if you need other context behavior as well:\n\n.. code-block:: python\n\n @pass_context\n def filter(context, value):\n result = do_something(value)\n\n if context.eval_ctx.autoescape:\n result = Markup(result)\n\n return result\n\nThe evaluation context must not be modified at runtime. Modifications\nmust only happen with a :class:`nodes.EvalContextModifier` and\n:class:`nodes.ScopedEvalContextModifier` from an extension, not on the\neval context object itself.\n\n.. autoclass:: jinja2.nodes.EvalContext\n\n .. attribute:: autoescape\n\n `True` or `False` depending on if autoescaping is active or not.\n\n .. attribute:: volatile\n\n `True` if the compiler cannot evaluate some expressions at compile\n time. At runtime this should always be `False`.\n\n\n.. _global-namespace:\n\nThe Global Namespace\n--------------------\n\nThe global namespace stores variables and functions that should be\navailable without needing to pass them to :meth:`Template.render`. They\nare also available to templates that are imported or included without\ncontext. Most applications should only use :attr:`Environment.globals`.\n\n:attr:`Environment.globals` are intended for data that is common to all\ntemplates loaded by that environment. :attr:`Template.globals` are\nintended for data that is common to all renders of that template, and\ndefault to :attr:`Environment.globals` unless they're given in\n:meth:`Environment.get_template`, etc. Data that is specific to a\nrender should be passed as context to :meth:`Template.render`.\n\nOnly one set of globals is used during any specific rendering. If\ntemplates A and B both have template globals, and B extends A, then\nonly B's globals are used for both when using ``b.render()``.\n\nEnvironment globals should not be changed after loading any templates,\nand template globals should not be changed at any time after loading the\ntemplate. Changing globals after loading a template will result in\nunexpected behavior as they may be shared between the environment and\nother templates.\n\n\n.. _low-level-api:\n\nLow Level API\n-------------\n\nThe low level API exposes functionality that can be useful to understand some\nimplementation details, debugging purposes or advanced :ref:`extension\n` techniques. Unless you know exactly what you are doing we\ndon't recommend using any of those.\n\n.. automethod:: Environment.lex\n\n.. automethod:: Environment.parse\n\n.. automethod:: Environment.preprocess\n\n.. automethod:: Template.new_context\n\n.. method:: Template.root_render_func(context)\n\n This is the low level render function. It's passed a :class:`Context`\n that has to be created by :meth:`new_context` of the same template or\n a compatible template. This render function is generated by the\n compiler from the template code and returns a generator that yields\n strings.\n\n If an exception in the template code happens the template engine will\n not rewrite the exception but pass through the original one. As a\n matter of fact this function should only be called from within a\n :meth:`render` / :meth:`generate` / :meth:`stream` call.\n\n.. attribute:: Template.blocks\n\n A dict of block render functions. Each of these functions works exactly\n like the :meth:`root_render_func` with the same limitations.\n\n.. attribute:: Template.is_up_to_date\n\n This attribute is `False` if there is a newer version of the template\n available, otherwise `True`.\n\n.. admonition:: Note\n\n The low-level API is fragile. Future Jinja versions will try not to\n change it in a backwards incompatible way but modifications in the Jinja\n core may shine through. For example if Jinja introduces a new AST node\n in later versions that may be returned by :meth:`~Environment.parse`.\n\nThe Meta API\n------------\n\n.. versionadded:: 2.2\n\nThe meta API returns some information about abstract syntax trees that\ncould help applications to implement more advanced template concepts. All\nthe functions of the meta API operate on an abstract syntax tree as\nreturned by the :meth:`Environment.parse` method.\n\n.. autofunction:: jinja2.meta.find_undeclared_variables\n\n.. autofunction:: jinja2.meta.find_referenced_templates\n"
},
{
"path": "docs/changes.rst",
"content": "Changes\n=======\n\n.. include:: ../CHANGES.rst\n"
},
{
"path": "docs/conf.py",
"content": "from pallets_sphinx_themes import get_version\nfrom pallets_sphinx_themes import ProjectLink\n\n# Project --------------------------------------------------------------\n\nproject = \"Jinja\"\ncopyright = \"2007 Pallets\"\nauthor = \"Pallets\"\nrelease, version = get_version(\"Jinja2\")\n\n# General --------------------------------------------------------------\n\ndefault_role = \"code\"\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.extlinks\",\n \"sphinx.ext.intersphinx\",\n \"sphinxcontrib.log_cabinet\",\n \"pallets_sphinx_themes\",\n]\nautodoc_member_order = \"bysource\"\nautodoc_typehints = \"description\"\nautodoc_preserve_defaults = True\nextlinks = {\n \"issue\": (\"https://github.com/pallets/jinja/issues/%s\", \"#%s\"),\n \"pr\": (\"https://github.com/pallets/jinja/pull/%s\", \"#%s\"),\n \"ghsa\": (\"https://github.com/pallets/jinja/security/advisories/GHSA-%s\", \"GHSA-%s\"),\n}\nintersphinx_mapping = {\n \"python\": (\"https://docs.python.org/3/\", None),\n}\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = \"jinja\"\nhtml_theme_options = {\"index_sidebar_logo\": False}\nhtml_context = {\n \"project_links\": [\n ProjectLink(\"Donate\", \"https://palletsprojects.com/donate\"),\n ProjectLink(\"PyPI Releases\", \"https://pypi.org/project/Jinja2/\"),\n ProjectLink(\"Source Code\", \"https://github.com/pallets/jinja/\"),\n ProjectLink(\"Issue Tracker\", \"https://github.com/pallets/jinja/issues/\"),\n ProjectLink(\"Chat\", \"https://discord.gg/pallets\"),\n ]\n}\nhtml_sidebars = {\n \"index\": [\"project.html\", \"localtoc.html\", \"searchbox.html\", \"ethicalads.html\"],\n \"**\": [\"localtoc.html\", \"relations.html\", \"searchbox.html\", \"ethicalads.html\"],\n}\nsinglehtml_sidebars = {\"index\": [\"project.html\", \"localtoc.html\", \"ethicalads.html\"]}\nhtml_static_path = [\"_static\"]\nhtml_favicon = \"_static/jinja-icon.svg\"\nhtml_logo = \"_static/jinja-logo.svg\"\nhtml_title = f\"Jinja Documentation ({version})\"\nhtml_show_sourcelink = False\n"
},
{
"path": "docs/examples/cache_extension.py",
"content": "from jinja2 import nodes\nfrom jinja2.ext import Extension\n\n\nclass FragmentCacheExtension(Extension):\n # a set of names that trigger the extension.\n tags = {\"cache\"}\n\n def __init__(self, environment):\n super().__init__(environment)\n\n # add the defaults to the environment\n environment.extend(fragment_cache_prefix=\"\", fragment_cache=None)\n\n def parse(self, parser):\n # the first token is the token that started the tag. In our case\n # we only listen to ``'cache'`` so this will be a name token with\n # `cache` as value. We get the line number so that we can give\n # that line number to the nodes we create by hand.\n lineno = next(parser.stream).lineno\n\n # now we parse a single expression that is used as cache key.\n args = [parser.parse_expression()]\n\n # if there is a comma, the user provided a timeout. If not use\n # None as second parameter.\n if parser.stream.skip_if(\"comma\"):\n args.append(parser.parse_expression())\n else:\n args.append(nodes.Const(None))\n\n # now we parse the body of the cache block up to `endcache` and\n # drop the needle (which would always be `endcache` in that case)\n body = parser.parse_statements([\"name:endcache\"], drop_needle=True)\n\n # now return a `CallBlock` node that calls our _cache_support\n # helper method on this extension.\n return nodes.CallBlock(\n self.call_method(\"_cache_support\", args), [], [], body\n ).set_lineno(lineno)\n\n def _cache_support(self, name, timeout, caller):\n \"\"\"Helper callback.\"\"\"\n key = self.environment.fragment_cache_prefix + name\n\n # try to load the block from the cache\n # if there is no fragment in the cache, render it and store\n # it in the cache.\n rv = self.environment.fragment_cache.get(key)\n if rv is not None:\n return rv\n rv = caller()\n self.environment.fragment_cache.add(key, rv, timeout)\n return rv\n"
},
{
"path": "docs/examples/inline_gettext_extension.py",
"content": "import re\n\nfrom jinja2.exceptions import TemplateSyntaxError\nfrom jinja2.ext import Extension\nfrom jinja2.lexer import count_newlines\nfrom jinja2.lexer import Token\n\n_outside_re = re.compile(r\"\\\\?(gettext|_)\\(\")\n_inside_re = re.compile(r\"\\\\?[()]\")\n\n\nclass InlineGettext(Extension):\n \"\"\"This extension implements support for inline gettext blocks::\n\n
_(Welcome)
\n
_(This is a paragraph)
\n\n Requires the i18n extension to be loaded and configured.\n \"\"\"\n\n def filter_stream(self, stream):\n paren_stack = 0\n\n for token in stream:\n if token.type != \"data\":\n yield token\n continue\n\n pos = 0\n lineno = token.lineno\n\n while True:\n if not paren_stack:\n match = _outside_re.search(token.value, pos)\n else:\n match = _inside_re.search(token.value, pos)\n if match is None:\n break\n new_pos = match.start()\n if new_pos > pos:\n preval = token.value[pos:new_pos]\n yield Token(lineno, \"data\", preval)\n lineno += count_newlines(preval)\n gtok = match.group()\n if gtok[0] == \"\\\\\":\n yield Token(lineno, \"data\", gtok[1:])\n elif not paren_stack:\n yield Token(lineno, \"block_begin\", None)\n yield Token(lineno, \"name\", \"trans\")\n yield Token(lineno, \"block_end\", None)\n paren_stack = 1\n else:\n if gtok == \"(\" or paren_stack > 1:\n yield Token(lineno, \"data\", gtok)\n paren_stack += -1 if gtok == \")\" else 1\n if not paren_stack:\n yield Token(lineno, \"block_begin\", None)\n yield Token(lineno, \"name\", \"endtrans\")\n yield Token(lineno, \"block_end\", None)\n pos = match.end()\n\n if pos < len(token.value):\n yield Token(lineno, \"data\", token.value[pos:])\n\n if paren_stack:\n raise TemplateSyntaxError(\n \"unclosed gettext expression\",\n token.lineno,\n stream.name,\n stream.filename,\n )\n"
},
{
"path": "docs/extensions.rst",
"content": ".. _jinja-extensions:\n\nExtensions\n==========\n\nJinja supports extensions that can add extra filters, tests, globals or even\nextend the parser. The main motivation of extensions is to move often used\ncode into a reusable class like adding support for internationalization.\n\n\nAdding Extensions\n-----------------\n\nExtensions are added to the Jinja environment at creation time. To add an\nextension pass a list of extension classes or import paths to the\n``extensions`` parameter of the :class:`~jinja2.Environment` constructor. The following\nexample creates a Jinja environment with the i18n extension loaded::\n\n jinja_env = Environment(extensions=['jinja2.ext.i18n'])\n\nTo add extensions after creation time, use the :meth:`~jinja2.Environment.add_extension` method::\n\n jinja_env.add_extension('jinja2.ext.debug')\n\n\n.. _i18n-extension:\n\ni18n Extension\n--------------\n\n**Import name:** ``jinja2.ext.i18n``\n\nThe i18n extension can be used in combination with `gettext`_ or\n`Babel`_. When it's enabled, Jinja provides a ``trans`` statement that\nmarks a block as translatable and calls ``gettext``.\n\nAfter enabling, an application has to provide functions for ``gettext``,\n``ngettext``, and optionally ``pgettext`` and ``npgettext``, either\nglobally or when rendering. A ``_()`` function is added as an alias to\nthe ``gettext`` function.\n\nA convenient way to provide these functions is to call one of the below\nmethods depending on the translation system in use. If you do not require\nactual translation, use ``Environment.install_null_translations`` to\ninstall no-op functions.\n\nEnvironment Methods\n~~~~~~~~~~~~~~~~~~~\n\nAfter enabling the extension, the environment provides the following\nadditional methods:\n\n.. method:: jinja2.Environment.install_gettext_translations(translations, newstyle=False)\n\n Installs a translation globally for the environment. The\n ``translations`` object must implement ``gettext``, ``ngettext``,\n and optionally ``pgettext`` and ``npgettext``.\n :class:`gettext.NullTranslations`, :class:`gettext.GNUTranslations`,\n and `Babel`_\\s ``Translations`` are supported.\n\n .. versionchanged:: 3.0\n Added ``pgettext`` and ``npgettext``.\n\n .. versionchanged:: 2.5\n Added new-style gettext support.\n\n.. method:: jinja2.Environment.install_null_translations(newstyle=False)\n\n Install no-op gettext functions. This is useful if you want to\n prepare the application for internationalization but don't want to\n implement the full system yet.\n\n .. versionchanged:: 2.5 Added new-style gettext support.\n\n.. method:: jinja2.Environment.install_gettext_callables(gettext, ngettext, newstyle=False, pgettext=None, npgettext=None)\n\n Install the given ``gettext``, ``ngettext``, ``pgettext``, and\n ``npgettext`` callables into the environment. They should behave\n exactly like :func:`gettext.gettext`, :func:`gettext.ngettext`,\n :func:`gettext.pgettext` and :func:`gettext.npgettext`.\n\n If ``newstyle`` is activated, the callables are wrapped to work like\n newstyle callables. See :ref:`newstyle-gettext` for more information.\n\n .. versionchanged:: 3.0\n Added ``pgettext`` and ``npgettext``.\n\n .. versionadded:: 2.5\n Added new-style gettext support.\n\n.. method:: jinja2.Environment.uninstall_gettext_translations()\n\n Uninstall the environment's globally installed translation.\n\n.. method:: jinja2.Environment.extract_translations(source)\n\n Extract localizable strings from the given template node or source.\n\n For every string found this function yields a ``(lineno, function,\n message)`` tuple, where:\n\n - ``lineno`` is the number of the line on which the string was\n found.\n - ``function`` is the name of the ``gettext`` function used (if\n the string was extracted from embedded Python code).\n - ``message`` is the string itself, or a tuple of strings for\n functions with multiple arguments.\n\n If `Babel`_ is installed, see :ref:`babel-integration` to extract\n the strings.\n\nFor a web application that is available in multiple languages but gives\nall the users the same language (for example, multilingual forum\nsoftware installed for a French community), the translation may be\ninstalled when the environment is created.\n\n.. code-block:: python\n\n translations = get_gettext_translations()\n env = Environment(extensions=[\"jinja2.ext.i18n\"])\n env.install_gettext_translations(translations)\n\nThe ``get_gettext_translations`` function would return the translator\nfor the current configuration, for example by using ``gettext.find``.\n\nThe usage of the ``i18n`` extension for template designers is covered in\n:ref:`the template documentation `.\n\n.. _gettext: https://docs.python.org/3/library/gettext.html\n.. _Babel: https://babel.pocoo.org/\n\n\nWhitespace Trimming\n~~~~~~~~~~~~~~~~~~~\n\n.. versionadded:: 2.10\n\nWithin ``{% trans %}`` blocks, it can be useful to trim line breaks and\nwhitespace so that the block of text looks like a simple string with\nsingle spaces in the translation file.\n\nLinebreaks and surrounding whitespace can be automatically trimmed by\nenabling the ``ext.i18n.trimmed`` :ref:`policy `.\n\n\n.. _newstyle-gettext:\n\nNew Style Gettext\n~~~~~~~~~~~~~~~~~\n\n.. versionadded:: 2.5\n\nNew style gettext calls are less to type, less error prone, and support\nautoescaping better.\n\nYou can use \"new style\" gettext calls by setting\n``env.newstyle_gettext = True`` or passing ``newstyle=True`` to\n``env.install_translations``. They are fully supported by the Babel\nextraction tool, but might not work as expected with other extraction\ntools.\n\nWith standard ``gettext`` calls, string formatting is a separate step\ndone with the ``|format`` filter. This requires duplicating work for\n``ngettext`` calls.\n\n.. sourcecode:: jinja\n\n {{ gettext(\"Hello, World!\") }}\n {{ gettext(\"Hello, %(name)s!\")|format(name=name) }}\n {{ ngettext(\n \"%(num)d apple\", \"%(num)d apples\", apples|count\n )|format(num=apples|count) }}\n {{ pgettext(\"greeting\", \"Hello, World!\") }}\n {{ npgettext(\n \"fruit\", \"%(num)d apple\", \"%(num)d apples\", apples|count\n )|format(num=apples|count) }}\n\nNew style ``gettext`` make formatting part of the call, and behind the\nscenes enforce more consistency.\n\n.. sourcecode:: jinja\n\n {{ gettext(\"Hello, World!\") }}\n {{ gettext(\"Hello, %(name)s!\", name=name) }}\n {{ ngettext(\"%(num)d apple\", \"%(num)d apples\", apples|count) }}\n {{ pgettext(\"greeting\", \"Hello, World!\") }}\n {{ npgettext(\"fruit\", \"%(num)d apple\", \"%(num)d apples\", apples|count) }}\n\nThe advantages of newstyle gettext are:\n\n- There's no separate formatting step, you don't have to remember to\n use the ``|format`` filter.\n- Only named placeholders are allowed. This solves a common problem\n translators face because positional placeholders can't switch\n positions meaningfully. Named placeholders always carry semantic\n information about what value goes where.\n- String formatting is used even if no placeholders are used, which\n makes all strings use a consistent format. Remember to escape any\n raw percent signs as ``%%``, such as ``100%%``.\n- The translated string is marked safe, formatting performs escaping\n as needed. Mark a parameter as ``|safe`` if it has already been\n escaped.\n\n\nExpression Statement\n--------------------\n\n**Import name:** ``jinja2.ext.do``\n\nThe \"do\" aka expression-statement extension adds a simple ``do`` tag to the\ntemplate engine that works like a variable expression but ignores the\nreturn value.\n\n.. _loopcontrols-extension:\n\nLoop Controls\n-------------\n\n**Import name:** ``jinja2.ext.loopcontrols``\n\nThis extension adds support for ``break`` and ``continue`` in loops. After\nenabling, Jinja provides those two keywords which work exactly like in\nPython.\n\n.. _with-extension:\n\nWith Statement\n--------------\n\n**Import name:** ``jinja2.ext.with_``\n\n.. versionchanged:: 2.9\n\n This extension is now built-in and no longer does anything.\n\n.. _autoescape-extension:\n\nAutoescape Extension\n--------------------\n\n**Import name:** ``jinja2.ext.autoescape``\n\n.. versionchanged:: 2.9\n\n This extension was removed and is now built-in. Enabling the\n extension no longer does anything.\n\n\n.. _debug-extension:\n\nDebug Extension\n---------------\n\n**Import name:** ``jinja2.ext.debug``\n\nAdds a ``{% debug %}`` tag to dump the current context as well as the\navailable filters and tests. This is useful to see what's available to\nuse in the template without setting up a debugger.\n\n\n.. _writing-extensions:\n\nWriting Extensions\n------------------\n\n.. module:: jinja2.ext\n\nBy writing extensions you can add custom tags to Jinja. This is a non-trivial\ntask and usually not needed as the default tags and expressions cover all\ncommon use cases. The i18n extension is a good example of why extensions are\nuseful. Another one would be fragment caching.\n\nWhen writing extensions you have to keep in mind that you are working with the\nJinja template compiler which does not validate the node tree you are passing\nto it. If the AST is malformed you will get all kinds of compiler or runtime\nerrors that are horrible to debug. Always make sure you are using the nodes\nyou create correctly. The API documentation below shows which nodes exist and\nhow to use them.\n\n\nExample Extensions\n------------------\n\nCache\n~~~~~\n\nThe following example implements a ``cache`` tag for Jinja by using the\n`cachelib`_ library:\n\n.. literalinclude:: examples/cache_extension.py\n :language: python\n\nAnd here is how you use it in an environment::\n\n from jinja2 import Environment\n from cachelib import SimpleCache\n\n env = Environment(extensions=[FragmentCacheExtension])\n env.fragment_cache = SimpleCache()\n\nInside the template it's then possible to mark blocks as cacheable. The\nfollowing example caches a sidebar for 300 seconds:\n\n.. sourcecode:: html+jinja\n\n {% cache 'sidebar', 300 %}\n
\n ...\n
\n {% endcache %}\n\n.. _cachelib: https://github.com/pallets/cachelib\n\n\nInline ``gettext``\n~~~~~~~~~~~~~~~~~~\n\nThe following example demonstrates using :meth:`Extension.filter_stream`\nto parse calls to the ``_()`` gettext function inline with static data\nwithout needing Jinja blocks.\n\n.. code-block:: html\n\n
_(Welcome)
\n
_(This is a paragraph)
\n\nIt requires the i18n extension to be loaded and configured.\n\n.. literalinclude:: examples/inline_gettext_extension.py\n :language: python\n\n\nExtension API\n-------------\n\nExtension\n~~~~~~~~~\n\nExtensions always have to extend the :class:`jinja2.ext.Extension` class:\n\n.. autoclass:: Extension\n :members: preprocess, filter_stream, parse, attr, call_method\n\n .. attribute:: identifier\n\n The identifier of the extension. This is always the true import name\n of the extension class and must not be changed.\n\n .. attribute:: tags\n\n If the extension implements custom tags this is a set of tag names\n the extension is listening for.\n\n\nParser\n~~~~~~\n\nThe parser passed to :meth:`Extension.parse` provides ways to parse\nexpressions of different types. The following methods may be used by\nextensions:\n\n.. autoclass:: jinja2.parser.Parser\n :members: parse_expression, parse_tuple, parse_assign_target,\n parse_statements, free_identifier, fail\n\n .. attribute:: filename\n\n The filename of the template the parser processes. This is **not**\n the load name of the template. For the load name see :attr:`name`.\n For templates that were not loaded form the file system this is\n ``None``.\n\n .. attribute:: name\n\n The load name of the template.\n\n .. attribute:: stream\n\n The current :class:`~jinja2.lexer.TokenStream`\n\n.. autoclass:: jinja2.lexer.TokenStream\n :members: push, look, eos, skip, __next__, next_if, skip_if, expect\n\n .. attribute:: current\n\n The current :class:`~jinja2.lexer.Token`.\n\n.. autoclass:: jinja2.lexer.Token\n :members: test, test_any\n\n .. attribute:: lineno\n\n The line number of the token\n\n .. attribute:: type\n\n The type of the token. This string is interned so you may compare\n it with arbitrary strings using the ``is`` operator.\n\n .. attribute:: value\n\n The value of the token.\n\nThere is also a utility function in the lexer module that can count newline\ncharacters in strings:\n\n.. autofunction:: jinja2.lexer.count_newlines\n\n\nAST\n~~~\n\nThe AST (Abstract Syntax Tree) is used to represent a template after parsing.\nIt's build of nodes that the compiler then converts into executable Python\ncode objects. Extensions that provide custom statements can return nodes to\nexecute custom Python code.\n\nThe list below describes all nodes that are currently available. The AST may\nchange between Jinja versions but will stay backwards compatible.\n\nFor more information have a look at the repr of :meth:`jinja2.Environment.parse`.\n\n.. module:: jinja2.nodes\n\n.. jinja:nodes:: jinja2.nodes.Node\n\n.. autoexception:: Impossible\n"
},
{
"path": "docs/faq.rst",
"content": "Frequently Asked Questions\n==========================\n\n\nWhy is it called Jinja?\n-----------------------\n\n\"Jinja\" is a Japanese `Shinto shrine`_, or temple, and temple and\ntemplate share a similar English pronunciation. It is not named after\nthe `city in Uganda`_.\n\n.. _Shinto shrine: https://en.wikipedia.org/wiki/Shinto_shrine\n.. _city in Uganda: https://en.wikipedia.org/wiki/Jinja%2C_Uganda\n\n\nHow fast is Jinja?\n------------------\n\nJinja is relatively fast among template engines because it compiles and\ncaches template code to Python code, so that the template does not need\nto be parsed and interpreted each time. Rendering a template becomes as\nclose to executing a Python function as possible.\n\nJinja also makes extensive use of caching. Templates are cached by name\nafter loading, so future uses of the template avoid loading. The\ntemplate loading itself uses a bytecode cache to avoid repeated\ncompiling. The caches can be external to persist across restarts.\nTemplates can also be precompiled and loaded as fast Python imports.\n\nWe dislike benchmarks because they don't reflect real use. Performance\ndepends on many factors. Different engines have different default\nconfigurations and tradeoffs that make it unclear how to set up a useful\ncomparison. Often, database access, API calls, and data processing have\na much larger effect on performance than the template engine.\n\n\nIsn't it a bad idea to put logic in templates?\n----------------------------------------------\n\nWithout a doubt you should try to remove as much logic from templates as\npossible. With less logic, the template is easier to understand, has\nfewer potential side effects, and is faster to compile and render. But a\ntemplate without any logic means processing must be done in code before\nrendering. A template engine that does that is shipped with Python,\ncalled :class:`string.Template`, and while it's definitely fast it's not\nconvenient.\n\nJinja's features such as blocks, statements, filters, and function calls\nmake it much easier to write expressive templates, with very few\nrestrictions. Jinja doesn't allow arbitrary Python code in templates, or\nevery feature available in the Python language. This keeps the engine\neasier to maintain, and keeps templates more readable.\n\nSome amount of logic is required in templates to keep everyone happy.\nToo much logic in the template can make it complex to reason about and\nmaintain. It's up to you to decide how your application will work and\nbalance how much logic you want to put in the template.\n\n\nWhy is HTML escaping not the default?\n-------------------------------------\n\nJinja provides a feature that can be enabled to escape HTML syntax in\nrendered templates. However, it is disabled by default.\n\nJinja is a general purpose template engine, it is not only used for HTML\ndocuments. You can generate plain text, LaTeX, emails, CSS, JavaScript,\nconfiguration files, etc. HTML escaping wouldn't make sense for any of\nthese document types.\n\nWhile automatic escaping means that you are less likely have an XSS\nproblem, it also requires significant extra processing during compiling\nand rendering, which can reduce performance. Jinja uses `MarkupSafe`_ for\nescaping, which provides optimized C code for speed, but it still\nintroduces overhead to track escaping across methods and formatting.\n\n.. _MarkupSafe: https://markupsafe.palletsprojects.com/\n"
},
{
"path": "docs/index.rst",
"content": ".. rst-class:: hide-header\n\nJinja\n=====\n\n.. image:: _static/jinja-name.svg\n :align: center\n :height: 200px\n\nJinja is a fast, expressive, extensible templating engine. Special\nplaceholders in the template allow writing code similar to Python\nsyntax. Then the template is passed data to render the final document.\n\n.. toctree::\n :maxdepth: 2\n :caption: Contents:\n\n intro\n api\n sandbox\n nativetypes\n templates\n extensions\n integration\n switching\n tricks\n faq\n license\n changes\n"
},
{
"path": "docs/integration.rst",
"content": "Integration\n===========\n\n\nFlask\n-----\n\nThe `Flask`_ web application framework, also maintained by Pallets, uses\nJinja templates by default. Flask sets up a Jinja environment and\ntemplate loader for you, and provides functions to easily render\ntemplates from view functions.\n\n.. _Flask: https://flask.palletsprojects.com\n\n\nDjango\n------\n\nDjango supports using Jinja as its template engine, see\nhttps://docs.djangoproject.com/en/stable/topics/templates/#support-for-template-engines.\n\n\n.. _babel-integration:\n\nBabel\n-----\n\nJinja provides support for extracting gettext messages from templates\nvia a `Babel`_ extractor entry point called\n``jinja2.ext.babel_extract``. The support is implemented as part of the\n:ref:`i18n-extension` extension.\n\nGettext messages are extracted from both ``trans`` tags and code\nexpressions.\n\nTo extract gettext messages from templates, the project needs a Jinja\nsection in its Babel extraction method `mapping file`_:\n\n.. sourcecode:: ini\n\n [jinja2: **/templates/**.html]\n encoding = utf-8\n\nThe syntax related options of the :class:`Environment` are also\navailable as configuration values in the mapping file. For example, to\ntell the extractor that templates use ``%`` as\n``line_statement_prefix`` you can use this code:\n\n.. sourcecode:: ini\n\n [jinja2: **/templates/**.html]\n encoding = utf-8\n line_statement_prefix = %\n\n:ref:`jinja-extensions` may also be defined by passing a comma separated\nlist of import paths as the ``extensions`` value. The i18n extension is\nadded automatically.\n\nTemplate syntax errors are ignored by default. The assumption is that\ntests will catch syntax errors in templates. If you don't want to ignore\nerrors, add ``silent = false`` to the settings.\n\n.. _Babel: https://babel.readthedocs.io/\n.. _mapping file: https://babel.readthedocs.io/en/latest/messages.html#extraction-method-mapping-and-configuration\n\n\nPylons\n------\n\nIt's easy to integrate Jinja into a `Pylons`_ application.\n\nThe template engine is configured in ``config/environment.py``. The\nconfiguration for Jinja looks something like this:\n\n.. code-block:: python\n\n from jinja2 import Environment, PackageLoader\n config['pylons.app_globals'].jinja_env = Environment(\n loader=PackageLoader('yourapplication', 'templates')\n )\n\nAfter that you can render Jinja templates by using the ``render_jinja``\nfunction from the ``pylons.templating`` module.\n\nAdditionally it's a good idea to set the Pylons ``c`` object to strict\nmode. By default attribute access on missing attributes on the ``c``\nobject returns an empty string and not an undefined object. To change\nthis add this to ``config/environment.py``:\n\n.. code-block:: python\n\n config['pylons.strict_c'] = True\n\n.. _Pylons: https://pylonsproject.org/\n"
},
{
"path": "docs/intro.rst",
"content": "Introduction\n============\n\nJinja is a fast, expressive, extensible templating engine. Special\nplaceholders in the template allow writing code similar to Python\nsyntax. Then the template is passed data to render the final document.\n\nIt includes:\n\n- Template inheritance and inclusion.\n- Define and import macros within templates.\n- HTML templates can use autoescaping to prevent XSS from untrusted\n user input.\n- A sandboxed environment can safely render untrusted templates.\n- Async support for generating templates that automatically handle\n sync and async functions without extra syntax.\n- I18N support with Babel.\n- Templates are compiled to optimized Python code just-in-time and\n cached, or can be compiled ahead-of-time.\n- Exceptions point to the correct line in templates to make debugging\n easier.\n- Extensible filters, tests, functions, and even syntax.\n\nJinja's philosophy is that while application logic belongs in Python if\npossible, it shouldn't make the template designer's job difficult by\nrestricting functionality too much.\n\n\nInstallation\n------------\n\nWe recommend using the latest version of Python. Jinja supports Python\n3.10 and newer. We also recommend using a `virtual environment`_ in order\nto isolate your project dependencies from other projects and the system.\n\n.. _virtual environment: https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments\n\nInstall the most recent Jinja version using pip:\n\n.. code-block:: text\n\n $ pip install Jinja2\n\n\nDependencies\n~~~~~~~~~~~~\n\nThese will be installed automatically when installing Jinja.\n\n- `MarkupSafe`_ escapes untrusted input when rendering templates to\n avoid injection attacks.\n\n.. _MarkupSafe: https://markupsafe.palletsprojects.com/\n\n\nOptional Dependencies\n~~~~~~~~~~~~~~~~~~~~~\n\nThese distributions will not be installed automatically.\n\n- `Babel`_ provides translation support in templates.\n\n.. _Babel: https://babel.pocoo.org/\n"
},
{
"path": "docs/license.rst",
"content": "BSD-3-Clause License\n====================\n\n.. literalinclude:: ../LICENSE.txt\n :language: text\n"
},
{
"path": "docs/make.bat",
"content": "@ECHO OFF\n\npushd %~dp0\n\nREM Command file for Sphinx documentation\n\nif \"%SPHINXBUILD%\" == \"\" (\n\tset SPHINXBUILD=sphinx-build\n)\nset SOURCEDIR=.\nset BUILDDIR=_build\n\nif \"%1\" == \"\" goto help\n\n%SPHINXBUILD% >NUL 2>NUL\nif errorlevel 9009 (\n\techo.\n\techo.The 'sphinx-build' command was not found. Make sure you have Sphinx\n\techo.installed, then set the SPHINXBUILD environment variable to point\n\techo.to the full path of the 'sphinx-build' executable. Alternatively you\n\techo.may add the Sphinx directory to PATH.\n\techo.\n\techo.If you don't have Sphinx installed, grab it from\n\techo.https://www.sphinx-doc.org/\n\texit /b 1\n)\n\n%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\ngoto end\n\n:help\n%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\n\n:end\npopd\n"
},
{
"path": "docs/nativetypes.rst",
"content": ".. module:: jinja2.nativetypes\n\n.. _nativetypes:\n\nNative Python Types\n===================\n\nThe default :class:`~jinja2.Environment` renders templates to strings. With\n:class:`NativeEnvironment`, rendering a template produces a native Python type.\nThis is useful if you are using Jinja outside the context of creating text\nfiles. For example, your code may have an intermediate step where users may use\ntemplates to define values that will then be passed to a traditional string\nenvironment.\n\nExamples\n--------\n\nAdding two values results in an integer, not a string with a number:\n\n>>> env = NativeEnvironment()\n>>> t = env.from_string('{{ x + y }}')\n>>> result = t.render(x=4, y=2)\n>>> print(result)\n6\n>>> print(type(result))\nint\n\nRendering list syntax produces a list:\n\n>>> t = env.from_string('[{% for item in data %}{{ item + 1 }},{% endfor %}]')\n>>> result = t.render(data=range(5))\n>>> print(result)\n[1, 2, 3, 4, 5]\n>>> print(type(result))\nlist\n\nRendering something that doesn't look like a Python literal produces a string:\n\n>>> t = env.from_string('{{ x }} * {{ y }}')\n>>> result = t.render(x=4, y=2)\n>>> print(result)\n4 * 2\n>>> print(type(result))\nstr\n\nRendering a Python object produces that object as long as it is the only node:\n\n>>> class Foo:\n... def __init__(self, value):\n... self.value = value\n...\n>>> result = env.from_string('{{ x }}').render(x=Foo(15))\n>>> print(type(result).__name__)\nFoo\n>>> print(result.value)\n15\n\nSandboxed Native Environment\n----------------------------\n\nYou can combine :class:`.SandboxedEnvironment` and :class:`NativeEnvironment` to\nget both behaviors.\n\n.. code-block:: python\n\n class SandboxedNativeEnvironment(SandboxedEnvironment, NativeEnvironment):\n pass\n\nAPI\n---\n\n.. autoclass:: NativeEnvironment([options])\n\n.. autoclass:: NativeTemplate([options])\n :members: render\n"
},
{
"path": "docs/sandbox.rst",
"content": "Sandbox\n=======\n\nThe Jinja sandbox can be used to render untrusted templates. Access to\nattributes, method calls, operators, mutating data structures, and\nstring formatting can be intercepted and prohibited.\n\n.. code-block:: pycon\n\n >>> from jinja2.sandbox import SandboxedEnvironment\n >>> env = SandboxedEnvironment()\n >>> func = lambda: \"Hello, Sandbox!\"\n >>> env.from_string(\"{{ func() }}\").render(func=func)\n 'Hello, Sandbox!'\n >>> env.from_string(\"{{ func.__code__.co_code }}\").render(func=func)\n Traceback (most recent call last):\n ...\n SecurityError: access to attribute '__code__' of 'function' object is unsafe.\n\nA sandboxed environment can be useful, for example, to allow users of an\ninternal reporting system to create custom emails. You would document\nwhat data is available in the templates, then the user would write a\ntemplate using that information. Your code would generate the report\ndata and pass it to the user's sandboxed template to render.\n\n\nSecurity Considerations\n-----------------------\n\nThe sandbox alone is not a solution for perfect security. Keep these\nthings in mind when using the sandbox.\n\nTemplates can still raise errors when compiled or rendered. Your code\nshould attempt to catch errors instead of crashing.\n\nIt is possible to construct a relatively small template that renders to\na very large amount of output, which could correspond to a high use of\nCPU or memory. You should run your application with limits on resources\nsuch as CPU and memory to mitigate this.\n\nJinja only renders text, it does not understand, for example, JavaScript\ncode. Depending on how the rendered template will be used, you may need\nto do other postprocessing to restrict the output.\n\nPass only the data that is relevant to the template. Avoid passing\nglobal data, or objects with methods that have side effects. By default\nthe sandbox prevents private and internal attribute access. You can\noverride :meth:`~SandboxedEnvironment.is_safe_attribute` to further\nrestrict attributes access. Decorate methods with :func:`unsafe` to\nprevent calling them from templates when passing objects as data. Use\n:class:`ImmutableSandboxedEnvironment` to prevent modifying lists and\ndictionaries.\n\n\nAPI\n---\n\n.. module:: jinja2.sandbox\n\n.. autoclass:: SandboxedEnvironment([options])\n :members: is_safe_attribute, is_safe_callable, default_binop_table,\n default_unop_table, intercepted_binops, intercepted_unops,\n call_binop, call_unop\n\n.. autoclass:: ImmutableSandboxedEnvironment([options])\n\n.. autoexception:: SecurityError\n\n.. autofunction:: unsafe\n\n.. autofunction:: is_internal_attribute\n\n.. autofunction:: modifies_known_mutable\n\n\nOperator Intercepting\n---------------------\n\nFor performance, Jinja outputs operators directly when compiling. This\nmeans it's not possible to intercept operator behavior by overriding\n:meth:`SandboxEnvironment.call ` by default, because\noperator special methods are handled by the Python interpreter, and\nmight not correspond with exactly one method depending on the operator's\nuse.\n\nThe sandbox can instruct the compiler to output a function to intercept\ncertain operators instead. Override\n:attr:`SandboxedEnvironment.intercepted_binops` and\n:attr:`SandboxedEnvironment.intercepted_unops` with the operator symbols\nyou want to intercept. The compiler will replace the symbols with calls\nto :meth:`SandboxedEnvironment.call_binop` and\n:meth:`SandboxedEnvironment.call_unop` instead. The default\nimplementation of those methods will use\n:attr:`SandboxedEnvironment.binop_table` and\n:attr:`SandboxedEnvironment.unop_table` to translate operator symbols\ninto :mod:`operator` functions.\n\nFor example, the power (``**``) operator can be disabled:\n\n.. code-block:: python\n\n from jinja2.sandbox import SandboxedEnvironment\n\n class MyEnvironment(SandboxedEnvironment):\n intercepted_binops = frozenset([\"**\"])\n\n def call_binop(self, context, operator, left, right):\n if operator == \"**\":\n return self.undefined(\"The power (**) operator is unavailable.\")\n\n return super().call_binop(self, context, operator, left, right)\n"
},
{
"path": "docs/switching.rst",
"content": "Switching From Other Template Engines\n=====================================\n\nThis is a brief guide on some of the differences between Jinja syntax\nand other template languages. See :doc:`/templates` for a comprehensive\nguide to Jinja syntax and features.\n\n\nDjango\n------\n\nIf you have previously worked with Django templates, you should find\nJinja very familiar. Many of the syntax elements look and work the same.\nHowever, Jinja provides some more syntax elements, and some work a bit\ndifferently.\n\nThis section covers the template changes. The API, including extension\nsupport, is fundamentally different so it won't be covered here.\n\nDjango supports using Jinja as its template engine, see\nhttps://docs.djangoproject.com/en/stable/topics/templates/#support-for-template-engines.\n\n\nMethod Calls\n~~~~~~~~~~~~\n\nIn Django, methods are called implicitly, without parentheses.\n\n.. code-block:: django\n\n {% for page in user.get_created_pages %}\n ...\n {% endfor %}\n\nIn Jinja, using parentheses is required for calls, like in Python. This\nallows you to pass variables to the method, which is not possible\nin Django. This syntax is also used for calling macros.\n\n.. code-block:: jinja\n\n {% for page in user.get_created_pages() %}\n ...\n {% endfor %}\n\n\nFilter Arguments\n~~~~~~~~~~~~~~~~\n\nIn Django, one literal value can be passed to a filter after a colon.\n\n.. code-block:: django\n\n {{ items|join:\", \" }}\n\nIn Jinja, filters can take any number of positional and keyword\narguments in parentheses, like function calls. Arguments can also be\nvariables instead of literal values.\n\n.. code-block:: jinja\n\n {{ items|join(\", \") }}\n\n\nTests\n~~~~~\n\nIn addition to filters, Jinja also has \"tests\" used with the ``is``\noperator. This operator is not the same as the Python operator.\n\n.. code-block:: jinja\n\n {% if user.user_id is odd %}\n {{ user.username|e }} is odd\n {% else %}\n hmm. {{ user.username|e }} looks pretty normal\n {% endif %}\n\nLoops\n~~~~~\n\nIn Django, the special variable for the loop context is called\n``forloop``, and the ``empty`` is used for no loop items.\n\n.. code-block:: django\n\n {% for item in items %}\n {{ forloop.counter }}. {{ item }}\n {% empty %}\n No items!\n {% endfor %}\n\nIn Jinja, the special variable for the loop context is called ``loop``,\nand the ``else`` block is used for no loop items.\n\n.. code-block:: jinja\n\n {% for item in items %}\n {{ loop.index }}. {{ item }}\n {% else %}\n No items!\n {% endfor %}\n\n\nCycle\n~~~~~\n\nIn Django, the ``{% cycle %}`` can be used in a for loop to alternate\nbetween values per loop.\n\n.. code-block:: django\n\n {% for user in users %}\n
{{ user }}
\n {% endfor %}\n\nIn Jinja, the ``loop`` context has a ``cycle`` method.\n\n.. code-block:: jinja\n\n {% for user in users %}\n
{{ user }}
\n {% endfor %}\n\nA cycler can also be assigned to a variable and used outside or across\nloops with the ``cycle()`` global function.\n\n\nMako\n----\n\nYou can configure Jinja to look more like Mako:\n\n.. code-block:: python\n\n env = Environment(\n block_start_string=\"<%\",\n block_end_string=\"%>\",\n variable_start_string=\"${\",\n variable_end_string=\"}\",\n comment_start_string=\"<%doc>\",\n commend_end_string=\"\",\n line_statement_prefix=\"%\",\n line_comment_prefix=\"##\",\n )\n\nWith an environment configured like that, Jinja should be able to\ninterpret a small subset of Mako templates without any changes.\n\nJinja does not support embedded Python code, so you would have to move\nthat out of the template. You could either process the data with the\nsame code before rendering, or add a global function or filter to the\nJinja environment.\n\nThe syntax for defs (which are called macros in Jinja) and template\ninheritance is different too.\n\nThe following Mako template:\n\n.. code-block:: mako\n\n <%inherit file=\"layout.html\" />\n <%def name=\"title()\">Page Title\n
\n % for item in list:\n
${item}
\n % endfor\n
\n\nLooks like this in Jinja with the above configuration:\n\n.. code-block:: jinja\n\n <% extends \"layout.html\" %>\n <% block title %>Page Title<% endblock %>\n <% block body %>\n
\n % for item in list:\n
${item}
\n % endfor\n
\n <% endblock %>\n"
},
{
"path": "docs/templates.rst",
"content": ".. py:currentmodule:: jinja2\n.. highlight:: html+jinja\n\nTemplate Designer Documentation\n===============================\n\nThis document describes the syntax and semantics of the template engine and\nwill be most useful as reference to those creating Jinja templates. As the\ntemplate engine is very flexible, the configuration from the application can\nbe slightly different from the code presented here in terms of delimiters and\nbehavior of undefined values.\n\n\nSynopsis\n--------\n\nA Jinja template is simply a text file. Jinja can generate any text-based\nformat (HTML, XML, CSV, LaTeX, etc.). A Jinja template doesn't need to have a\nspecific extension: ``.html``, ``.xml``, or any other extension is just fine.\n\nA template contains **variables** and/or **expressions**, which get replaced\nwith values when a template is *rendered*; and **tags**, which control the\nlogic of the template. The template syntax is heavily inspired by Django and\nPython.\n\nBelow is a minimal template that illustrates a few basics using the default\nJinja configuration. We will cover the details later in this document::\n\n \n \n \n My Webpage\n \n \n
\n {{ a_variable }}\n\n {# a comment #}\n \n \n\nThe following example shows the default configuration settings. An application\ndeveloper can change the syntax configuration from ``{% foo %}`` to ``<% foo\n%>``, or something similar.\n\nThere are a few kinds of delimiters. The default Jinja delimiters are\nconfigured as follows:\n\n* ``{% ... %}`` for :ref:`Statements `\n* ``{{ ... }}`` for :ref:`Expressions` to print to the template output\n* ``{# ... #}`` for :ref:`Comments` not included in the template output\n\n:ref:`Line Statements and Comments ` are also possible,\nthough they don't have default prefix characters. To use them, set\n``line_statement_prefix`` and ``line_comment_prefix`` when creating the\n:class:`~jinja2.Environment`.\n\n\nTemplate File Extension\n~~~~~~~~~~~~~~~~~~~~~~~\n\nAs stated above, any file can be loaded as a template, regardless of\nfile extension. Adding a ``.jinja`` extension, like ``user.html.jinja``\nmay make it easier for some IDEs or editor plugins, but is not required.\nAutoescaping, introduced later, can be applied based on file extension,\nso you'll need to take the extra suffix into account in that case.\n\nAnother good heuristic for identifying templates is that they are in a\n``templates`` folder, regardless of extension. This is a common layout\nfor projects.\n\n\n.. _variables:\n\nVariables\n---------\n\nTemplate variables are defined by the context dictionary passed to the\ntemplate.\n\nYou can mess around with the variables in templates provided they are passed in\nby the application. Variables may have attributes or elements on them you can\naccess too. What attributes a variable has depends heavily on the application\nproviding that variable.\n\nYou can use a dot (``.``) to access attributes of a variable in addition\nto the standard Python ``__getitem__`` \"subscript\" syntax (``[]``).\n\nThe following lines do the same thing::\n\n {{ foo.bar }}\n {{ foo['bar'] }}\n\nIt's important to know that the outer double-curly braces are *not* part of the\nvariable, but the print statement. If you access variables inside tags don't\nput the braces around them.\n\nIf a variable or attribute does not exist, you will get back an undefined\nvalue. What you can do with that kind of value depends on the application\nconfiguration: the default behavior is to evaluate to an empty string if\nprinted or iterated over, and to fail for every other operation.\n\n.. _notes-on-subscriptions:\n\n.. admonition:: Implementation\n\n For the sake of convenience, ``foo.bar`` in Jinja does the following\n things on the Python layer:\n\n - check for an attribute called `bar` on `foo`\n (``getattr(foo, 'bar')``)\n - if there is not, check for an item ``'bar'`` in `foo`\n (``foo.__getitem__('bar')``)\n - if there is not, return an undefined object.\n\n ``foo['bar']`` works mostly the same with a small difference in sequence:\n\n - check for an item ``'bar'`` in `foo`.\n (``foo.__getitem__('bar')``)\n - if there is not, check for an attribute called `bar` on `foo`.\n (``getattr(foo, 'bar')``)\n - if there is not, return an undefined object.\n\n This is important if an object has an item and attribute with the same\n name. Additionally, the :func:`attr` filter only looks up attributes.\n\n.. _filters:\n\nFilters\n-------\n\nVariables can be modified by **filters**. Filters are separated from the\nvariable by a pipe symbol (``|``) and may have optional arguments in\nparentheses. Multiple filters can be chained. The output of one filter is\napplied to the next.\n\nFor example, ``{{ name|striptags|title }}`` will remove all HTML Tags from\nvariable `name` and title-case the output (``title(striptags(name))``).\n\nFilters that accept arguments have parentheses around the arguments, just like\na function call. For example: ``{{ listx|join(', ') }}`` will join a list with\ncommas (``str.join(', ', listx)``).\n\nThe :ref:`builtin-filters` below describes all the builtin filters.\n\n.. _tests:\n\nTests\n-----\n\nBeside filters, there are also so-called \"tests\" available. Tests can be used\nto test a variable against a common expression. To test a variable or\nexpression, you add `is` plus the name of the test after the variable. For\nexample, to find out if a variable is defined, you can do ``name is defined``,\nwhich will then return true or false depending on whether `name` is defined\nin the current template context.\n\nTests can accept arguments, too. If the test only takes one argument, you can\nleave out the parentheses. For example, the following two\nexpressions do the same thing::\n\n {% if loop.index is divisibleby 3 %}\n {% if loop.index is divisibleby(3) %}\n\nThe :ref:`builtin-tests` below describes all the builtin tests.\n\n\n.. _comments:\n\nComments\n--------\n\nTo comment-out part of a line in a template, use the comment syntax which is\nby default set to ``{# ... #}``. This is useful to comment out parts of the\ntemplate for debugging or to add information for other template designers or\nyourself::\n\n {# note: commented-out template because we no longer use this\n {% for user in users %}\n ...\n {% endfor %}\n #}\n\n\nWhitespace Control\n------------------\n\nIn the default configuration:\n\n* a single trailing newline is stripped if present\n* other whitespace (spaces, tabs, newlines etc.) is returned unchanged\n\nIf an application configures Jinja to `trim_blocks`, the first newline after a\ntemplate tag is removed automatically (like in PHP). The `lstrip_blocks`\noption can also be set to strip tabs and spaces from the beginning of a\nline to the start of a block. (Nothing will be stripped if there are\nother characters before the start of the block.)\n\nWith both ``trim_blocks`` and ``lstrip_blocks`` disabled (the default), block\ntags on their own lines will be removed, but a blank line will remain and the\nspaces in the content will be preserved. For example, this template:\n\n.. code-block:: jinja\n\n
\n {% if True %}\n yay\n {% endif %}\n
\n\nWith both ``trim_blocks`` and ``lstrip_blocks`` disabled, the template is\nrendered with blank lines inside the div:\n\n.. code-block:: text\n\n
\n\n yay\n\n
\n\nWith both ``trim_blocks`` and ``lstrip_blocks`` enabled, the template block\nlines are completely removed:\n\n.. code-block:: text\n\n
\n yay\n
\n\nYou can manually disable the `lstrip_blocks` behavior by putting a\nplus sign (``+``) at the start of a block::\n\n
\n {%+ if something %}yay{% endif %}\n
\n\nSimilarly, you can manually disable the ``trim_blocks`` behavior by\nputting a plus sign (``+``) at the end of a block::\n\n
\n {% if something +%}\n yay\n {% endif %}\n
\n\nYou can also strip whitespace in templates by hand. If you add a minus\nsign (``-``) to the start or end of a block (e.g. a :ref:`for-loop` tag), a\ncomment, or a variable expression, the whitespaces before or after\nthat block will be removed::\n\n {% for item in seq -%}\n {{ item }}\n {%- endfor %}\n\nThis will yield all elements without whitespace between them. If `seq` was\na list of numbers from ``1`` to ``9``, the output would be ``123456789``.\n\nIf :ref:`line-statements` are enabled, they strip leading whitespace\nautomatically up to the beginning of the line.\n\nBy default, Jinja also removes trailing newlines. To keep single\ntrailing newlines, configure Jinja to `keep_trailing_newline`.\n\n.. admonition:: Note\n\n You must not add whitespace between the tag and the minus sign.\n\n **valid**::\n\n {%- if foo -%}...{% endif %}\n\n **invalid**::\n\n {% - if foo - %}...{% endif %}\n\n\nEscaping\n--------\n\nIt is sometimes desirable -- even necessary -- to have Jinja ignore parts\nit would otherwise handle as variables or blocks. For example, if, with\nthe default syntax, you want to use ``{{`` as a raw string in a template and\nnot start a variable, you have to use a trick.\n\nThe easiest way to output a literal variable delimiter (``{{``) is by using a\nvariable expression::\n\n {{ '{{' }}\n\nFor bigger sections, it makes sense to mark a block `raw`. For example, to\ninclude example Jinja syntax in a template, you can use this snippet::\n\n {% raw %}\n
\n {% for item in seq %}\n
{{ item }}
\n {% endfor %}\n
\n {% endraw %}\n\n.. admonition:: Note\n\n Minus sign at the end of ``{% raw -%}`` tag cleans all the spaces and newlines\n preceding the first character of your raw data.\n\n\n.. _line-statements:\n\nLine Statements\n---------------\n\nIf line statements are enabled by the application, it's possible to mark a\nline as a statement. For example, if the line statement prefix is configured\nto ``#``, the following two examples are equivalent::\n\n
\n # for item in seq\n
{{ item }}
\n # endfor\n
\n\n
\n {% for item in seq %}\n
{{ item }}
\n {% endfor %}\n
\n\nThe line statement prefix can appear anywhere on the line as long as no text\nprecedes it. For better readability, statements that start a block (such as\n`for`, `if`, `elif` etc.) may end with a colon::\n\n # for item in seq:\n ...\n # endfor\n\n\n.. admonition:: Note\n\n Line statements can span multiple lines if there are open parentheses,\n braces or brackets::\n\n
\n # for href, caption in [('index.html', 'Index'),\n ('about.html', 'About')]:\n
\n\nSince Jinja 2.2, line-based comments are available as well. For example, if\nthe line-comment prefix is configured to be ``##``, everything from ``##`` to\nthe end of the line is ignored (excluding the newline sign)::\n\n # for item in seq:\n
{{ item }}
## this comment is ignored\n # endfor\n\n\n.. _template-inheritance:\n\nTemplate Inheritance\n--------------------\n\nThe most powerful part of Jinja is template inheritance. Template inheritance\nallows you to build a base \"skeleton\" template that contains all the common\nelements of your site and defines **blocks** that child templates can override.\n\nSounds complicated but is very basic. It's easiest to understand it by starting\nwith an example.\n\n\nBase Template\n~~~~~~~~~~~~~\n\nThis template, which we'll call ``base.html``, defines a simple HTML skeleton\ndocument that you might use for a simple two-column page. It's the job of\n\"child\" templates to fill the empty blocks with content::\n\n \n \n \n {% block head %}\n \n {% block title %}{% endblock %} - My Webpage\n {% endblock %}\n \n \n
{% block content %}{% endblock %}
\n \n \n \n\nIn this example, the ``{% block %}`` tags define four blocks that child templates\ncan fill in. All the `block` tag does is tell the template engine that a\nchild template may override those placeholders in the template.\n\n``block`` tags can be inside other blocks such as ``if``, but they will\nalways be executed regardless of if the ``if`` block is actually\nrendered.\n\nChild Template\n~~~~~~~~~~~~~~\n\nA child template might look like this::\n\n {% extends \"base.html\" %}\n {% block title %}Index{% endblock %}\n {% block head %}\n {{ super() }}\n \n {% endblock %}\n {% block content %}\n
Index
\n
\n Welcome to my awesome homepage.\n
\n {% endblock %}\n\nThe ``{% extends %}`` tag is the key here. It tells the template engine that\nthis template \"extends\" another template. When the template system evaluates\nthis template, it first locates the parent. The extends tag should be the\nfirst tag in the template. Everything before it is printed out normally and\nmay cause confusion. For details about this behavior and how to take\nadvantage of it, see :ref:`null-default-fallback`. Also a block will always be\nfilled in regardless of whether the surrounding condition is evaluated to be true\nor false.\n\nThe filename of the template depends on the template loader. For example, the\n:class:`FileSystemLoader` allows you to access other templates by giving the\nfilename. You can access templates in subdirectories with a slash::\n\n {% extends \"layout/default.html\" %}\n\nBut this behavior can depend on the application embedding Jinja. Note that\nsince the child template doesn't define the ``footer`` block, the value from\nthe parent template is used instead.\n\nYou can't define multiple ``{% block %}`` tags with the same name in the\nsame template. This limitation exists because a block tag works in \"both\"\ndirections. That is, a block tag doesn't just provide a placeholder to fill\n- it also defines the content that fills the placeholder in the *parent*.\nIf there were two similarly-named ``{% block %}`` tags in a template,\nthat template's parent wouldn't know which one of the blocks' content to use.\n\nIf you want to print a block multiple times, you can, however, use the special\n`self` variable and call the block with that name::\n\n {% block title %}{% endblock %}\n
{{ self.title() }}
\n {% block body %}{% endblock %}\n\n\nSuper Blocks\n~~~~~~~~~~~~\n\nIt's possible to render the contents of the parent block by calling ``super()``.\nThis gives back the results of the parent block::\n\n {% block sidebar %}\n
Table Of Contents
\n ...\n {{ super() }}\n {% endblock %}\n\n\nNesting extends\n~~~~~~~~~~~~~~~\n\nIn the case of multiple levels of ``{% extends %}``,\n``super`` references may be chained (as in ``super.super()``)\nto skip levels in the inheritance tree.\n\nFor example::\n\n # parent.tmpl\n body: {% block body %}Hi from parent.{% endblock %}\n\n # child.tmpl\n {% extends \"parent.tmpl\" %}\n {% block body %}Hi from child. {{ super() }}{% endblock %}\n\n # grandchild1.tmpl\n {% extends \"child.tmpl\" %}\n {% block body %}Hi from grandchild1.{% endblock %}\n\n # grandchild2.tmpl\n {% extends \"child.tmpl\" %}\n {% block body %}Hi from grandchild2. {{ super.super() }} {% endblock %}\n\n\nRendering ``child.tmpl`` will give\n``body: Hi from child. Hi from parent.``\n\nRendering ``grandchild1.tmpl`` will give\n``body: Hi from grandchild1.``\n\nRendering ``grandchild2.tmpl`` will give\n``body: Hi from grandchild2. Hi from parent.``\n\n\nNamed Block End-Tags\n~~~~~~~~~~~~~~~~~~~~\n\nJinja allows you to put the name of the block after the end tag for better\nreadability::\n\n {% block sidebar %}\n {% block inner_sidebar %}\n ...\n {% endblock inner_sidebar %}\n {% endblock sidebar %}\n\nHowever, the name after the `endblock` word must match the block name.\n\n\nBlock Nesting and Scope\n~~~~~~~~~~~~~~~~~~~~~~~\n\nBlocks can be nested for more complex layouts. By default, a block may not\naccess variables from outside the block (outer scopes)::\n\n {% for item in seq %}\n
{% block loop_item %}{{ item }}{% endblock %}
\n {% endfor %}\n\nThis example would output empty ``
`` items because `item` is unavailable\ninside the block. The reason for this is that if the block is replaced by\na child template, a variable would appear that was not defined in the block or\npassed to the context.\n\nStarting with Jinja 2.2, you can explicitly specify that variables are\navailable in a block by setting the block to \"scoped\" by adding the `scoped`\nmodifier to a block declaration::\n\n {% for item in seq %}\n
\n {% endfor %}\n\nWhen overriding a block, the `scoped` modifier does not have to be provided.\n\n\nRequired Blocks\n~~~~~~~~~~~~~~~\n\nBlocks can be marked as ``required``. They must be overridden at some\npoint, but not necessarily by the direct child template. Required blocks\nmay only contain space and comments, and they cannot be rendered\ndirectly.\n\n.. code-block:: jinja\n :caption: ``page.txt``\n\n {% block body required %}{% endblock %}\n\n.. code-block:: jinja\n :caption: ``issue.txt``\n\n {% extends \"page.txt\" %}\n\n.. code-block:: jinja\n :caption: ``bug_report.txt``\n\n {% extends \"issue.txt\" %}\n {% block body %}Provide steps to demonstrate the bug.{% endblock %}\n\nRendering ``page.txt`` or ``issue.txt`` will raise\n``TemplateRuntimeError`` because they don't override the ``body`` block.\nRendering ``bug_report.txt`` will succeed because it does override the\nblock.\n\nWhen combined with ``scoped``, the ``required`` modifier must be placed\n*after* the scoped modifier. Here are some valid examples:\n\n.. code-block:: jinja\n\n {% block body scoped %}{% endblock %}\n {% block body required %}{% endblock %}\n {% block body scoped required %}{% endblock %}\n\n\nTemplate Objects\n~~~~~~~~~~~~~~~~\n\n``extends``, ``include``, and ``import`` can take a template object\ninstead of the name of a template to load. This could be useful in some\nadvanced situations, since you can use Python code to load a template\nfirst and pass it in to ``render``.\n\n.. code-block:: python\n\n if debug_mode:\n layout = env.get_template(\"debug_layout.html\")\n else:\n layout = env.get_template(\"layout.html\")\n\n user_detail = env.get_template(\"user/detail.html\")\n return user_detail.render(layout=layout)\n\n.. code-block:: jinja\n\n {% extends layout %}\n\nNote how ``extends`` is passed the variable with the template object\nthat was passed to ``render``, instead of a string.\n\n\nHTML Escaping\n-------------\n\nWhen generating HTML from templates, there's always a risk that a variable will\ninclude characters that affect the resulting HTML. There are two approaches:\n\na. manually escaping each variable; or\nb. automatically escaping everything by default.\n\nJinja supports both. What is used depends on the application configuration.\nThe default configuration is no automatic escaping; for various reasons:\n\n- Escaping everything except for safe values will also mean that Jinja is\n escaping variables known to not include HTML (e.g. numbers, booleans)\n which can be a huge performance hit.\n\n- The information about the safety of a variable is very fragile. It could\n happen that by coercing safe and unsafe values, the return value is\n double-escaped HTML.\n\nWorking with Manual Escaping\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf manual escaping is enabled, it's **your** responsibility to escape\nvariables if needed. What to escape? If you have a variable that *may*\ninclude any of the following chars (``>``, ``<``, ``&``, or ``\"``) you\n**SHOULD** escape it unless the variable contains well-formed and trusted\nHTML. Escaping works by piping the variable through the ``|e`` filter::\n\n {{ user.username|e }}\n\nWorking with Automatic Escaping\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nWhen automatic escaping is enabled, everything is escaped by default except\nfor values explicitly marked as safe. Variables and expressions\ncan be marked as safe either in:\n\na. The context dictionary by the application with\n :class:`markupsafe.Markup`\nb. The template, with the ``|safe`` filter.\n\nIf a string that you marked safe is passed through other Python code\nthat doesn't understand that mark, it may get lost. Be aware of when\nyour data is marked safe and how it is processed before arriving at the\ntemplate.\n\nIf a value has been escaped but is not marked safe, auto-escaping will\nstill take place and result in double-escaped characters. If you know\nyou have data that is already safe but not marked, be sure to wrap it in\n``Markup`` or use the ``|safe`` filter.\n\nJinja functions (macros, `super`, `self.BLOCKNAME`) always return template\ndata that is marked as safe.\n\nString literals in templates with automatic escaping are considered\nunsafe because native Python strings are not safe.\n\n.. _list-of-control-structures:\n\nList of Control Structures\n--------------------------\n\nA control structure refers to all those things that control the flow of a\nprogram - conditionals (i.e. if/elif/else), for-loops, as well as things like\nmacros and blocks. With the default syntax, control structures appear inside\n``{% ... %}`` blocks.\n\n.. _for-loop:\n\nFor\n~~~\n\nLoop over each item in a sequence. For example, to display a list of users\nprovided in a variable called `users`::\n\n
Members
\n
\n {% for user in users %}\n
{{ user.username|e }}
\n {% endfor %}\n
\n\nAs variables in templates retain their object properties, it is possible to\niterate over containers like `dict`::\n\n
\n {% for key, value in my_dict.items() %}\n
{{ key|e }}
\n
{{ value|e }}
\n {% endfor %}\n
\n\nPython dicts may not be in the order you want to display them in. If\norder matters, use the ``|dictsort`` filter.\n\n.. code-block:: jinja\n\n
\n {% for key, value in my_dict | dictsort %}\n
{{ key|e }}
\n
{{ value|e }}
\n {% endfor %}\n
\n\nInside of a for-loop block, you can access some special variables:\n\n+-----------------------+---------------------------------------------------+\n| Variable | Description |\n+=======================+===================================================+\n| `loop.index` | The current iteration of the loop. (1 indexed) |\n+-----------------------+---------------------------------------------------+\n| `loop.index0` | The current iteration of the loop. (0 indexed) |\n+-----------------------+---------------------------------------------------+\n| `loop.revindex` | The number of iterations from the end of the loop |\n| | (1 indexed) |\n+-----------------------+---------------------------------------------------+\n| `loop.revindex0` | The number of iterations from the end of the loop |\n| | (0 indexed) |\n+-----------------------+---------------------------------------------------+\n| `loop.first` | True if first iteration. |\n+-----------------------+---------------------------------------------------+\n| `loop.last` | True if last iteration. |\n+-----------------------+---------------------------------------------------+\n| `loop.length` | The number of items in the sequence. |\n+-----------------------+---------------------------------------------------+\n| `loop.cycle` | A helper function to cycle between a list of |\n| | sequences. See the explanation below. |\n+-----------------------+---------------------------------------------------+\n| `loop.depth` | Indicates how deep in a recursive loop |\n| | the rendering currently is. Starts at level 1 |\n+-----------------------+---------------------------------------------------+\n| `loop.depth0` | Indicates how deep in a recursive loop |\n| | the rendering currently is. Starts at level 0 |\n+-----------------------+---------------------------------------------------+\n| `loop.previtem` | The item from the previous iteration of the loop. |\n| | Undefined during the first iteration. |\n+-----------------------+---------------------------------------------------+\n| `loop.nextitem` | The item from the following iteration of the loop.|\n| | Undefined during the last iteration. |\n+-----------------------+---------------------------------------------------+\n| `loop.changed(*val)` | True if previously called with a different value |\n| | (or not called at all). |\n+-----------------------+---------------------------------------------------+\n\nWithin a for-loop, it's possible to cycle among a list of strings/variables\neach time through the loop by using the special `loop.cycle` helper::\n\n {% for row in rows %}\n
{{ row }}
\n {% endfor %}\n\nSince Jinja 2.1, an extra `cycle` helper exists that allows loop-unbound\ncycling. For more information, have a look at the :ref:`builtin-globals`.\n\n.. _loop-filtering:\n\nUnlike in Python, it's not possible to `break` or `continue` in a loop. You\ncan, however, filter the sequence during iteration, which allows you to skip\nitems. The following example skips all the users which are hidden::\n\n {% for user in users if not user.hidden %}\n
{{ user.username|e }}
\n {% endfor %}\n\nThe advantage is that the special `loop` variable will count correctly; thus\nnot counting the users not iterated over.\n\nIf no iteration took place because the sequence was empty or the filtering\nremoved all the items from the sequence, you can render a default block\nby using `else`::\n\n
\n {% for user in users %}\n
{{ user.username|e }}
\n {% else %}\n
no users found
\n {% endfor %}\n
\n\nNote that, in Python, `else` blocks are executed whenever the corresponding\nloop **did not** `break`. Since Jinja loops cannot `break` anyway,\na slightly different behavior of the `else` keyword was chosen.\n\nIt is also possible to use loops recursively. This is useful if you are\ndealing with recursive data such as sitemaps or RDFa.\nTo use loops recursively, you basically have to add the `recursive` modifier\nto the loop definition and call the `loop` variable with the new iterable\nwhere you want to recurse.\n\nThe following example implements a sitemap with recursive loops::\n\n
\n\nThe `loop` variable always refers to the closest (innermost) loop. If we\nhave more than one level of loops, we can rebind the variable `loop` by\nwriting `{% set outer_loop = loop %}` after the loop that we want to\nuse recursively. Then, we can call it using `{{ outer_loop(...) }}`\n\nPlease note that assignments in loops will be cleared at the end of the\niteration and cannot outlive the loop scope. Older versions of Jinja had\na bug where in some circumstances it appeared that assignments would work.\nThis is not supported. See :ref:`assignments` for more information about\nhow to deal with this.\n\nIf all you want to do is check whether some value has changed since the\nlast iteration or will change in the next iteration, you can use `previtem`\nand `nextitem`::\n\n {% for value in values %}\n {% if loop.previtem is defined and value > loop.previtem %}\n The value just increased!\n {% endif %}\n {{ value }}\n {% if loop.nextitem is defined and loop.nextitem > value %}\n The value will increase even more!\n {% endif %}\n {% endfor %}\n\nIf you only care whether the value changed at all, using `changed` is even\neasier::\n\n {% for entry in entries %}\n {% if loop.changed(entry.category) %}\n
{{ entry.category }}
\n {% endif %}\n
{{ entry.message }}
\n {% endfor %}\n\n.. _if:\n\nIf\n~~\n\nThe `if` statement in Jinja is comparable with the Python if statement.\nIn the simplest form, you can use it to test if a variable is defined, not\nempty and not false::\n\n {% if users %}\n
\n {% for user in users %}\n
{{ user.username|e }}
\n {% endfor %}\n
\n {% endif %}\n\nFor multiple branches, `elif` and `else` can be used like in Python. You can\nuse more complex :ref:`expressions` there, too::\n\n {% if kenny.sick %}\n Kenny is sick.\n {% elif kenny.dead %}\n You killed Kenny! You bastard!!!\n {% else %}\n Kenny looks okay --- so far\n {% endif %}\n\nIf can also be used as an :ref:`inline expression ` and for\n:ref:`loop filtering `.\n\n.. _macros:\n\nMacros\n~~~~~~\n\nMacros are comparable with functions in regular programming languages. They\nare useful to put often used idioms into reusable functions to not repeat\nyourself (\"DRY\").\n\nHere's a small example of a macro that renders a form element::\n\n {% macro input(name, value='', type='text', size=20) -%}\n \n {%- endmacro %}\n\nThe macro can then be called like a function in the namespace::\n\n
{{ input('username') }}
\n
{{ input('password', type='password') }}
\n\nIf the macro was defined in a different template, you have to\n:ref:`import ` it first.\n\nInside macros, you have access to three special variables:\n\n`varargs`\n If more positional arguments are passed to the macro than accepted by the\n macro, they end up in the special `varargs` variable as a list of values.\n\n`kwargs`\n Like `varargs` but for keyword arguments. All unconsumed keyword\n arguments are stored in this special variable.\n\n`caller`\n If the macro was called from a :ref:`call` tag, the caller is stored\n in this variable as a callable macro.\n\nMacros also expose some of their internal details. The following attributes\nare available on a macro object:\n\n`name`\n The name of the macro. ``{{ input.name }}`` will print ``input``.\n\n`arguments`\n A tuple of the names of arguments the macro accepts.\n\n`catch_kwargs`\n This is `true` if the macro accepts extra keyword arguments (i.e.: accesses\n the special `kwargs` variable).\n\n`catch_varargs`\n This is `true` if the macro accepts extra positional arguments (i.e.:\n accesses the special `varargs` variable).\n\n`caller`\n This is `true` if the macro accesses the special `caller` variable and may\n be called from a :ref:`call` tag.\n\nIf a macro name starts with an underscore, it's not exported and can't\nbe imported.\n\nDue to how scopes work in Jinja, a macro in a child template does not\noverride a macro in a parent template. The following will output\n\"LAYOUT\", not \"CHILD\".\n\n.. code-block:: jinja\n :caption: ``layout.txt``\n\n {% macro foo() %}LAYOUT{% endmacro %}\n {% block body %}{% endblock %}\n\n.. code-block:: jinja\n :caption: ``child.txt``\n\n {% extends 'layout.txt' %}\n {% macro foo() %}CHILD{% endmacro %}\n {% block body %}{{ foo() }}{% endblock %}\n\n\n.. _call:\n\nCall\n~~~~\n\nIn some cases it can be useful to pass a macro to another macro. For this\npurpose, you can use the special `call` block. The following example shows\na macro that takes advantage of the call functionality and how it can be\nused::\n\n {% macro render_dialog(title, class='dialog') -%}\n
\n
{{ title }}
\n
\n {{ caller() }}\n
\n
\n {%- endmacro %}\n\n {% call render_dialog('Hello World') %}\n This is a simple dialog rendered by using a macro and\n a call block.\n {% endcall %}\n\nIt's also possible to pass arguments back to the call block. This makes it\nuseful as a replacement for loops. Generally speaking, a call block works\nexactly like a macro without a name.\n\nHere's an example of how a call block can be used with arguments::\n\n {% macro dump_users(users) -%}\n
\n {% endcall %}\n\n\nFilters\n~~~~~~~\n\nFilter sections allow you to apply regular Jinja filters on a block of\ntemplate data. Just wrap the code in the special `filter` section::\n\n {% filter upper %}\n This text becomes uppercase\n {% endfilter %}\n\nFilters that accept arguments can be called like this::\n\n {% filter center(100) %}Center this{% endfilter %}\n\n.. _assignments:\n\nAssignments\n~~~~~~~~~~~\n\nInside code blocks, you can also assign values to variables. Assignments at\ntop level (outside of blocks, macros or loops) are exported from the template\nlike top level macros and can be imported by other templates.\n\nAssignments use the `set` tag and can have multiple targets::\n\n {% set navigation = [('index.html', 'Index'), ('about.html', 'About')] %}\n {% set key, value = call_something() %}\n\n.. admonition:: Scoping Behavior\n\n Please keep in mind that it is not possible to set variables inside a\n block and have them show up outside of it. This also applies to\n loops. The only exception to that rule are if statements which do not\n introduce a scope. As a result the following template is not going\n to do what you might expect::\n\n {% set iterated = false %}\n {% for item in seq %}\n {{ item }}\n {% set iterated = true %}\n {% endfor %}\n {% if not iterated %} did not iterate {% endif %}\n\n It is not possible with Jinja syntax to do this. Instead use\n alternative constructs like the loop else block or the special `loop`\n variable::\n\n {% for item in seq %}\n {{ item }}\n {% else %}\n did not iterate\n {% endfor %}\n\n As of version 2.10 more complex use cases can be handled using namespace\n objects which allow propagating of changes across scopes::\n\n {% set ns = namespace(found=false) %}\n {% for item in items %}\n {% if item.check_something() %}\n {% set ns.found = true %}\n {% endif %}\n * {{ item.title }}\n {% endfor %}\n Found item having something: {{ ns.found }}\n\n Note that the ``obj.attr`` notation in the `set` tag is only allowed for\n namespace objects; attempting to assign an attribute on any other object\n will raise an exception.\n\n .. versionadded:: 2.10 Added support for namespace objects\n\n\nBlock Assignments\n~~~~~~~~~~~~~~~~~\n\nIt's possible to use `set` as a block to assign the content of the block to a\nvariable. This can be used to create multi-line strings, since Jinja doesn't\nsupport Python's triple quotes (``\"\"\"``, ``'''``).\n\nInstead of using an equals sign and a value, you only write the variable name,\nand everything until ``{% endset %}`` is captured.\n\n.. code-block:: jinja\n\n {% set navigation %}\n
Downloads\n {% endset %}\n\nFilters applied to the variable name will be applied to the block's content.\n\n.. code-block:: jinja\n\n {% set reply | wordwrap %}\n You wrote:\n {{ message }}\n {% endset %}\n\n.. versionadded:: 2.8\n\n.. versionchanged:: 2.10\n\n Block assignment supports filters.\n\n.. _extends:\n\nExtends\n~~~~~~~\n\nThe `extends` tag can be used to extend one template from another. You can\nhave multiple `extends` tags in a file, but only one of them may be executed at\na time.\n\nSee the section about :ref:`template-inheritance` above.\n\n\n.. _blocks:\n\nBlocks\n~~~~~~\n\nBlocks are used for inheritance and act as both placeholders and replacements\nat the same time. They are documented in detail in the\n:ref:`template-inheritance` section.\n\n\nInclude\n~~~~~~~\n\nThe ``include`` tag renders another template and outputs the result into\nthe current template.\n\n.. code-block:: jinja\n\n {% include 'header.html' %}\n Body goes here.\n {% include 'footer.html' %}\n\nThe included template has access to context of the current template by\ndefault. Use ``without context`` to use a separate context instead.\n``with context`` is also valid, but is the default behavior. See\n:ref:`import-visibility`.\n\nThe included template can ``extend`` another template and override\nblocks in that template. However, the current template cannot override\nany blocks that the included template outputs.\n\nUse ``ignore missing`` to ignore the statement if the template does not\nexist. It must be placed *before* a context visibility statement.\n\n.. code-block:: jinja\n\n {% include \"sidebar.html\" without context %}\n {% include \"sidebar.html\" ignore missing %}\n {% include \"sidebar.html\" ignore missing with context %}\n {% include \"sidebar.html\" ignore missing without context %}\n\nIf a list of templates is given, each will be tried in order until one\nis not missing. This can be used with ``ignore missing`` to ignore if\nnone of the templates exist.\n\n.. code-block:: jinja\n\n {% include ['page_detailed.html', 'page.html'] %}\n {% include ['special_sidebar.html', 'sidebar.html'] ignore missing %}\n\nA variable, with either a template name or template object, can also be\npassed to the statement.\n\n.. _import:\n\nImport\n~~~~~~\n\nJinja supports putting often used code into macros. These macros can go into\ndifferent templates and get imported from there. This works similarly to the\nimport statements in Python. It's important to know that imports are cached\nand imported templates don't have access to the current template variables,\njust the globals by default. For more details about context behavior of\nimports and includes, see :ref:`import-visibility`.\n\nThere are two ways to import templates. You can import a complete template\ninto a variable or request specific macros / exported variables from it.\n\nImagine we have a helper module that renders forms (called `forms.html`)::\n\n {% macro input(name, value='', type='text') -%}\n \n {%- endmacro %}\n\n {%- macro textarea(name, value='', rows=10, cols=40) -%}\n \n {%- endmacro %}\n\nThe easiest and most flexible way to access a template's variables\nand macros is to import the whole template module into a variable.\nThat way, you can access the attributes::\n\n {% import 'forms.html' as forms %}\n
\n
Username
\n
{{ forms.input('username') }}
\n
Password
\n
{{ forms.input('password', type='password') }}
\n
\n
{{ forms.textarea('comment') }}
\n\n\nAlternatively, you can import specific names from a template into the current\nnamespace::\n\n {% from 'forms.html' import input as input_field, textarea %}\n
\n
Username
\n
{{ input_field('username') }}
\n
Password
\n
{{ input_field('password', type='password') }}
\n
\n
{{ textarea('comment') }}
\n\nMacros and variables starting with one or more underscores are private and\ncannot be imported.\n\n.. versionchanged:: 2.4\n If a template object was passed to the template context, you can\n import from that object.\n\n\n.. _import-visibility:\n\nImport Context Behavior\n-----------------------\n\nBy default, included templates are passed the current context and imported\ntemplates are not. The reason for this is that imports, unlike includes,\nare cached; as imports are often used just as a module that holds macros.\n\nThis behavior can be changed explicitly: by adding `with context`\nor `without context` to the import/include directive, the current context\ncan be passed to the template and caching is disabled automatically.\n\nHere are two examples::\n\n {% from 'forms.html' import input with context %}\n {% include 'header.html' without context %}\n\n.. admonition:: Note\n\n In Jinja 2.0, the context that was passed to the included template\n did not include variables defined in the template. As a matter of\n fact, this did not work::\n\n {% for box in boxes %}\n {% include \"render_box.html\" %}\n {% endfor %}\n\n The included template ``render_box.html`` is *not* able to access\n `box` in Jinja 2.0. As of Jinja 2.1, ``render_box.html`` *is* able\n to do so.\n\n\n.. _expressions:\n\nExpressions\n-----------\n\nJinja allows basic expressions everywhere. These work very similarly to\nregular Python; even if you're not working with Python\nyou should feel comfortable with it.\n\nLiterals\n~~~~~~~~\n\nThe simplest form of expressions are literals. Literals are representations\nfor Python objects such as strings and numbers. The following literals exist:\n\n``\"Hello World\"``\n Everything between two double or single quotes is a string. They are\n useful whenever you need a string in the template (e.g. as\n arguments to function calls and filters, or just to extend or include a\n template).\n\n``42`` / ``123_456``\n Integers are whole numbers without a decimal part. The '_' character\n can be used to separate groups for legibility.\n\n``42.23`` / ``42.1e2`` / ``123_456.789``\n Floating point numbers can be written using a '.' as a decimal mark.\n They can also be written in scientific notation with an upper or\n lower case 'e' to indicate the exponent part. The '_' character can\n be used to separate groups for legibility, but cannot be used in the\n exponent part.\n\n``['list', 'of', 'objects']``\n Everything between two brackets is a list. Lists are useful for storing\n sequential data to be iterated over. For example, you can easily\n create a list of links using lists and tuples for (and with) a for loop::\n\n
\n {% for href, caption in [('index.html', 'Index'), ('about.html', 'About'),\n ('downloads.html', 'Downloads')] %}\n
\n\n``('tuple', 'of', 'values')``\n Tuples are like lists that cannot be modified (\"immutable\"). If a tuple\n only has one item, it must be followed by a comma (``('1-tuple',)``).\n Tuples are usually used to represent items of two or more elements.\n See the list example above for more details.\n\n``{'dict': 'of', 'key': 'and', 'value': 'pairs'}``\n A dict in Python is a structure that combines keys and values. Keys must\n be unique and always have exactly one value. Dicts are rarely used in\n templates; they are useful in some rare cases such as the :func:`xmlattr`\n filter.\n\n``true`` / ``false``\n ``true`` is always true and ``false`` is always false.\n\n.. admonition:: Note\n\n The special constants `true`, `false`, and `none` are indeed lowercase.\n Because that caused confusion in the past, (`True` used to expand\n to an undefined variable that was considered false),\n all three can now also be written in title case\n (`True`, `False`, and `None`).\n However, for consistency, (all Jinja identifiers are lowercase)\n you should use the lowercase versions.\n\nMath\n~~~~\n\nJinja allows you to calculate with values. This is rarely useful in templates\nbut exists for completeness' sake. The following operators are supported:\n\n``+``\n Adds two objects together. Usually the objects are numbers, but if both are\n strings or lists, you can concatenate them this way. This, however, is not\n the preferred way to concatenate strings! For string concatenation, have\n a look-see at the ``~`` operator. ``{{ 1 + 1 }}`` is ``2``.\n\n``-``\n Subtract the second number from the first one. ``{{ 3 - 2 }}`` is ``1``.\n\n``/``\n Divide two numbers. The return value will be a floating point number.\n ``{{ 1 / 2 }}`` is ``{{ 0.5 }}``.\n\n``//``\n Divide two numbers and return the truncated integer result.\n ``{{ 20 // 7 }}`` is ``2``.\n\n``%``\n Calculate the remainder of an integer division. ``{{ 11 % 7 }}`` is ``4``.\n\n``*``\n Multiply the left operand with the right one. ``{{ 2 * 2 }}`` would\n return ``4``. This can also be used to repeat a string multiple times.\n ``{{ '=' * 80 }}`` would print a bar of 80 equal signs.\n\n``**``\n Raise the left operand to the power of the right operand.\n ``{{ 2**3 }}`` would return ``8``.\n\n Unlike Python, chained pow is evaluated left to right.\n ``{{ 3**3**3 }}`` is evaluated as ``(3**3)**3`` in Jinja, but would\n be evaluated as ``3**(3**3)`` in Python. Use parentheses in Jinja\n to be explicit about what order you want. It is usually preferable\n to do extended math in Python and pass the results to ``render``\n rather than doing it in the template.\n\n This behavior may be changed in the future to match Python, if it's\n possible to introduce an upgrade path.\n\n\nComparisons\n~~~~~~~~~~~\n\n``==``\n Compares two objects for equality.\n\n``!=``\n Compares two objects for inequality.\n\n``>``\n ``true`` if the left hand side is greater than the right hand side.\n\n``>=``\n ``true`` if the left hand side is greater or equal to the right hand side.\n\n``<``\n ``true`` if the left hand side is lower than the right hand side.\n\n``<=``\n ``true`` if the left hand side is lower or equal to the right hand side.\n\nLogic\n~~~~~\n\nFor ``if`` statements, ``for`` filtering, and ``if`` expressions, it can be\nuseful to combine multiple expressions.\n\n``and``\n For ``x and y``, if ``x`` is false, then the value is ``x``, else ``y``. In\n a boolean context, this will be treated as ``True`` if both operands are\n truthy.\n\n``or``\n For ``x or y``, if ``x`` is true, then the value is ``x``, else ``y``. In a\n boolean context, this will be treated as ``True`` if at least one operand is\n truthy.\n\n``not``\n For ``not x``, if ``x`` is false, then the value is ``True``, else\n ``False``.\n\n Prefer negating ``is`` and ``in`` using their infix notation:\n ``foo is not bar`` instead of ``not foo is bar``; ``foo not in bar`` instead\n of ``not foo in bar``. All other expressions require prefix notation:\n ``not (foo and bar).``\n\n``(expr)``\n Parentheses group an expression. This is used to change evaluation order, or\n to make a long expression easier to read or less ambiguous.\n\n\nOther Operators\n~~~~~~~~~~~~~~~\n\nThe following operators are very useful but don't fit into any of the other\ntwo categories:\n\n``in``\n Perform a sequence / mapping containment test. Returns true if the left\n operand is contained in the right. ``{{ 1 in [1, 2, 3] }}`` would, for\n example, return true.\n\n``is``\n Performs a :ref:`test `.\n\n``|`` (pipe, vertical bar)\n Applies a :ref:`filter `.\n\n``~`` (tilde)\n Converts all operands into strings and concatenates them.\n\n ``{{ \"Hello \" ~ name ~ \"!\" }}`` would return (assuming `name` is set\n to ``'John'``) ``Hello John!``.\n\n``()``\n Call a callable: ``{{ post.render() }}``. Inside of the parentheses you\n can use positional arguments and keyword arguments like in Python:\n\n ``{{ post.render(user, full=true) }}``.\n\n``.`` / ``[]``\n Get an attribute of an object. (See :ref:`variables`)\n\n\n.. _if-expression:\n\nIf Expression\n~~~~~~~~~~~~~\n\nIt is also possible to use inline `if` expressions. These are useful in some\nsituations. For example, you can use this to extend from one template if a\nvariable is defined, otherwise from the default layout template::\n\n {% extends layout_template if layout_template is defined else 'default.html' %}\n\nThe general syntax is `` if else ``.\n\nThe `else` part is optional. If not provided, the else block implicitly\nevaluates into an :class:`Undefined` object (regardless of what ``undefined``\nin the environment is set to):\n\n.. code-block:: jinja\n\n {{ \"[{}]\".format(page.title) if page.title }}\n\n\n.. _python-methods:\n\nPython Methods\n~~~~~~~~~~~~~~\n\nYou can also use any of the methods defined on a variable's type.\nThe value returned from the method invocation is used as the value of the expression.\nHere is an example that uses methods defined on strings (where ``page.title`` is a string):\n\n.. code-block:: text\n\n {{ page.title.capitalize() }}\n\nThis works for methods on user-defined types. For example, if variable\n``f`` of type ``Foo`` has a method ``bar`` defined on it, you can do the\nfollowing:\n\n.. code-block:: text\n\n {{ f.bar(value) }}\n\nOperator methods also work as expected. For example, ``%`` implements\nprintf-style for strings:\n\n.. code-block:: text\n\n {{ \"Hello, %s!\" % name }}\n\nAlthough you should prefer the ``.format`` method for that case (which\nis a bit contrived in the context of rendering a template):\n\n.. code-block:: text\n\n {{ \"Hello, {}!\".format(name) }}\n\n\n.. _builtin-filters:\n\nList of Builtin Filters\n-----------------------\n\n.. py:currentmodule:: jinja-filters\n\n.. jinja:filters:: jinja2.defaults.DEFAULT_FILTERS\n\n\n.. _builtin-tests:\n\nList of Builtin Tests\n---------------------\n\n.. py:currentmodule:: jinja-tests\n\n.. jinja:tests:: jinja2.defaults.DEFAULT_TESTS\n\n\n.. _builtin-globals:\n\nList of Global Functions\n------------------------\n\nThe following functions are available in the global scope by default:\n\n.. py:currentmodule:: jinja-globals\n\n.. function:: range([start,] stop[, step])\n\n Return a list containing an arithmetic progression of integers.\n ``range(i, j)`` returns ``[i, i+1, i+2, ..., j-1]``;\n start (!) defaults to ``0``.\n When step is given, it specifies the increment (or decrement).\n For example, ``range(4)`` and ``range(0, 4, 1)`` return ``[0, 1, 2, 3]``.\n The end point is omitted!\n These are exactly the valid indices for a list of 4 elements.\n\n This is useful to repeat a template block multiple times, e.g.\n to fill a list. Imagine you have 7 users in the list but you want to\n render three empty items to enforce a height with CSS::\n\n
\n {% for user in users %}\n
{{ user.username }}
\n {% endfor %}\n {% for number in range(10 - users|count) %}\n
...
\n {% endfor %}\n
\n\n.. function:: lipsum(n=5, html=True, min=20, max=100)\n\n Generates some lorem ipsum for the template. By default, five paragraphs\n of HTML are generated with each paragraph between 20 and 100 words.\n If html is False, regular text is returned. This is useful to generate simple\n contents for layout testing.\n\n.. function:: dict(\\**items)\n\n A convenient alternative to dict literals. ``{'foo': 'bar'}`` is the same\n as ``dict(foo='bar')``.\n\n.. class:: cycler(\\*items)\n\n Cycle through values by yielding them one at a time, then restarting\n once the end is reached.\n\n Similar to ``loop.cycle``, but can be used outside loops or across\n multiple loops. For example, render a list of folders and files in a\n list, alternating giving them \"odd\" and \"even\" classes.\n\n .. code-block:: html+jinja\n\n {% set row_class = cycler(\"odd\", \"even\") %}\n
\n {% for folder in folders %}\n
{{ folder }}\n {% endfor %}\n {% for file in files %}\n
{{ file }}\n {% endfor %}\n
\n\n :param items: Each positional argument will be yielded in the order\n given for each cycle.\n\n .. versionadded:: 2.1\n\n .. property:: current\n\n Return the current item. Equivalent to the item that will be\n returned next time :meth:`next` is called.\n\n .. method:: next()\n\n Return the current item, then advance :attr:`current` to the\n next item.\n\n .. method:: reset()\n\n Resets the current item to the first item.\n\n.. class:: joiner(sep=', ')\n\n A tiny helper that can be used to \"join\" multiple sections. A joiner is\n passed a string and will return that string every time it's called, except\n the first time (in which case it returns an empty string). You can\n use this to join things::\n\n {% set pipe = joiner(\"|\") %}\n {% if categories %} {{ pipe() }}\n Categories: {{ categories|join(\", \") }}\n {% endif %}\n {% if author %} {{ pipe() }}\n Author: {{ author() }}\n {% endif %}\n {% if can_edit %} {{ pipe() }}\n Edit\n {% endif %}\n\n .. versionadded:: 2.1\n\n.. class:: namespace(...)\n\n Creates a new container that allows attribute assignment using the\n ``{% set %}`` tag::\n\n {% set ns = namespace() %}\n {% set ns.foo = 'bar' %}\n\n The main purpose of this is to allow carrying a value from within a loop\n body to an outer scope. Initial values can be provided as a dict, as\n keyword arguments, or both (same behavior as Python's `dict` constructor)::\n\n {% set ns = namespace(found=false) %}\n {% for item in items %}\n {% if item.check_something() %}\n {% set ns.found = true %}\n {% endif %}\n * {{ item.title }}\n {% endfor %}\n Found item having something: {{ ns.found }}\n\n .. versionadded:: 2.10\n\n .. versionchanged:: 3.2\n Namespace attributes can be assigned to in multiple assignment.\n\n\nExtensions\n----------\n\n.. py:currentmodule:: jinja2\n\nThe following sections cover the built-in Jinja extensions that may be\nenabled by an application. An application could also provide further\nextensions not covered by this documentation; in which case there should\nbe a separate document explaining said :ref:`extensions\n`.\n\n\n.. _i18n-in-templates:\n\ni18n\n~~~~\n\nIf the :ref:`i18n-extension` is enabled, it's possible to mark text in\nthe template as translatable. To mark a section as translatable, use a\n``trans`` block:\n\n.. code-block:: jinja\n\n {% trans %}Hello, {{ user }}!{% endtrans %}\n\nInside the block, no statements are allowed, only text and simple\nvariable tags.\n\nVariable tags can only be a name, not attribute access, filters, or\nother expressions. To use an expression, bind it to a name in the\n``trans`` tag for use in the block.\n\n.. code-block:: jinja\n\n {% trans user=user.username %}Hello, {{ user }}!{% endtrans %}\n\nTo bind more than one expression, separate each with a comma (``,``).\n\n.. code-block:: jinja\n\n {% trans book_title=book.title, author=author.name %}\n This is {{ book_title }} by {{ author }}\n {% endtrans %}\n\nTo pluralize, specify both the singular and plural forms separated by\nthe ``pluralize`` tag.\n\n.. code-block:: jinja\n\n {% trans count=list|length %}\n There is {{ count }} {{ name }} object.\n {% pluralize %}\n There are {{ count }} {{ name }} objects.\n {% endtrans %}\n\nBy default, the first variable in a block is used to determine whether\nto use singular or plural form. If that isn't correct, specify the\nvariable used for pluralizing as a parameter to ``pluralize``.\n\n.. code-block:: jinja\n\n {% trans ..., user_count=users|length %}...\n {% pluralize user_count %}...{% endtrans %}\n\nWhen translating blocks of text, whitespace and linebreaks result in\nhard to read and error-prone translation strings. To avoid this, a trans\nblock can be marked as trimmed, which will replace all linebreaks and\nthe whitespace surrounding them with a single space and remove leading\nand trailing whitespace.\n\n.. code-block:: jinja\n\n {% trans trimmed book_title=book.title %}\n This is {{ book_title }}.\n You should read it!\n {% endtrans %}\n\nThis results in ``This is %(book_title)s. You should read it!`` in the\ntranslation file.\n\nIf trimming is enabled globally, the ``notrimmed`` modifier can be used\nto disable it for a block.\n\n.. versionadded:: 2.10\n The ``trimmed`` and ``notrimmed`` modifiers have been added.\n\nIf the translation depends on the context that the message appears in,\nthe ``pgettext`` and ``npgettext`` functions take a ``context`` string\nas the first argument, which is used to select the appropriate\ntranslation. To specify a context with the ``{% trans %}`` tag, provide\na string as the first token after ``trans``.\n\n.. code-block:: jinja\n\n {% trans \"fruit\" %}apple{% endtrans %}\n {% trans \"fruit\" trimmed count -%}\n 1 apple\n {%- pluralize -%}\n {{ count }} apples\n {%- endtrans %}\n\n.. versionadded:: 3.1\n A context can be passed to the ``trans`` tag to use ``pgettext`` and\n ``npgettext``.\n\nIt's possible to translate strings in expressions with these functions:\n\n- ``_(message)``: Alias for ``gettext``.\n- ``gettext(message)``: Translate a message.\n- ``ngettext(singular, plural, n)``: Translate a singular or plural\n message based on a count variable.\n- ``pgettext(context, message)``: Like ``gettext()``, but picks the\n translation based on the context string.\n- ``npgettext(context, singular, plural, n)``: Like ``npgettext()``,\n but picks the translation based on the context string.\n\nYou can print a translated string like this:\n\n.. code-block:: jinja\n\n {{ _(\"Hello, World!\") }}\n\nTo use placeholders, use the ``format`` filter.\n\n.. code-block:: jinja\n\n {{ _(\"Hello, %(user)s!\")|format(user=user.username) }}\n\nAlways use keyword arguments to ``format``, as other languages may not\nuse the words in the same order.\n\nIf :ref:`newstyle-gettext` calls are activated, using placeholders is\neasier. Formatting is part of the ``gettext`` call instead of using the\n``format`` filter.\n\n.. sourcecode:: jinja\n\n {{ gettext('Hello World!') }}\n {{ gettext('Hello %(name)s!', name='World') }}\n {{ ngettext('%(num)d apple', '%(num)d apples', apples|count) }}\n\nThe ``ngettext`` function's format string automatically receives the\ncount as a ``num`` parameter in addition to the given parameters.\n\n\nExpression Statement\n~~~~~~~~~~~~~~~~~~~~\n\nIf the expression-statement extension is loaded, a tag called `do` is available\nthat works exactly like the regular variable expression (``{{ ... }}``); except\nit doesn't print anything. This can be used to modify lists::\n\n {% do navigation.append('a string') %}\n\n\nLoop Controls\n~~~~~~~~~~~~~\n\nIf the application enables the :ref:`loopcontrols-extension`, it's possible to\nuse `break` and `continue` in loops. When `break` is reached, the loop is\nterminated; if `continue` is reached, the processing is stopped and continues\nwith the next iteration.\n\nHere's a loop that skips every second item::\n\n {% for user in users %}\n {%- if loop.index is even %}{% continue %}{% endif %}\n ...\n {% endfor %}\n\nLikewise, a loop that stops processing after the 10th iteration::\n\n {% for user in users %}\n {%- if loop.index >= 10 %}{% break %}{% endif %}\n {%- endfor %}\n\nNote that ``loop.index`` starts with 1, and ``loop.index0`` starts with 0\n(See: :ref:`for-loop`).\n\n\nDebug Statement\n~~~~~~~~~~~~~~~\n\nIf the :ref:`debug-extension` is enabled, a ``{% debug %}`` tag will be\navailable to dump the current context as well as the available filters\nand tests. This is useful to see what's available to use in the template\nwithout setting up a debugger.\n\n.. code-block:: html+jinja\n\n
{% debug %}
\n\n.. code-block:: text\n\n {'context': {'cycler': ,\n ...,\n 'namespace': },\n 'filters': ['abs', 'attr', 'batch', 'capitalize', 'center', 'count', 'd',\n ..., 'urlencode', 'urlize', 'wordcount', 'wordwrap', 'xmlattr'],\n 'tests': ['!=', '<', '<=', '==', '>', '>=', 'callable', 'defined',\n ..., 'odd', 'sameas', 'sequence', 'string', 'undefined', 'upper']}\n\n\nWith Statement\n~~~~~~~~~~~~~~\n\n.. versionadded:: 2.3\n\nThe with statement makes it possible to create a new inner scope.\nVariables set within this scope are not visible outside of the scope.\n\nWith in a nutshell::\n\n {% with %}\n {% set foo = 42 %}\n {{ foo }} foo is 42 here\n {% endwith %}\n foo is not visible here any longer\n\nBecause it is common to set variables at the beginning of the scope,\nyou can do that within the `with` statement. The following two examples\nare equivalent::\n\n {% with foo = 42 %}\n {{ foo }}\n {% endwith %}\n\n {% with %}\n {% set foo = 42 %}\n {{ foo }}\n {% endwith %}\n\nAn important note on scoping here. In Jinja versions before 2.9 the\nbehavior of referencing one variable to another had some unintended\nconsequences. In particular one variable could refer to another defined\nin the same with block's opening statement. This caused issues with the\ncleaned up scoping behavior and has since been improved. In particular\nin newer Jinja versions the following code always refers to the variable\n`a` from outside the `with` block::\n\n {% with a={}, b=a.attribute %}...{% endwith %}\n\nIn earlier Jinja versions the `b` attribute would refer to the results of\nthe first attribute. If you depend on this behavior you can rewrite it to\nuse the ``set`` tag::\n\n {% with a={} %}\n {% set b = a.attribute %}\n {% endwith %}\n\n.. admonition:: Extension\n\n In older versions of Jinja (before 2.9) it was required to enable this\n feature with an extension. It's now enabled by default.\n\n.. _autoescape-overrides:\n\nAutoescape Overrides\n--------------------\n\n.. versionadded:: 2.4\n\nIf you want you can activate and deactivate the autoescaping from within\nthe templates.\n\nExample::\n\n {% autoescape true %}\n Autoescaping is active within this block\n {% endautoescape %}\n\n {% autoescape false %}\n Autoescaping is inactive within this block\n {% endautoescape %}\n\nAfter an `endautoescape` the behavior is reverted to what it was before.\n\n.. admonition:: Extension\n\n In older versions of Jinja (before 2.9) it was required to enable this\n feature with an extension. It's now enabled by default.\n"
},
{
"path": "docs/tricks.rst",
"content": "Tips and Tricks\n===============\n\n.. highlight:: html+jinja\n\nThis part of the documentation shows some tips and tricks for Jinja\ntemplates.\n\n\n.. _null-default-fallback:\n\nNull-Default Fallback\n---------------------\n\nJinja supports dynamic inheritance and does not distinguish between parent\nand child template as long as no `extends` tag is visited. While this leads\nto the surprising behavior that everything before the first `extends` tag\nincluding whitespace is printed out instead of being ignored, it can be used\nfor a neat trick.\n\nUsually child templates extend from one template that adds a basic HTML\nskeleton. However it's possible to put the `extends` tag into an `if` tag to\nonly extend from the layout template if the `standalone` variable evaluates\nto false, which it does by default if it's not defined. Additionally a very\nbasic skeleton is added to the file so that if it's indeed rendered with\n`standalone` set to `True` a very basic HTML skeleton is added::\n\n {% if not standalone %}{% extends 'default.html' %}{% endif -%}\n \n {% block title %}The Page Title{% endblock %}\n \n {% block body %}\n
This is the page body.
\n {% endblock %}\n\n\nAlternating Rows\n----------------\n\nIf you want to have different styles for each row of a table or\nlist you can use the `cycle` method on the `loop` object::\n\n
\n {% for row in rows %}\n
{{ row }}
\n {% endfor %}\n
\n\n`cycle` can take an unlimited number of strings. Each time this\ntag is encountered the next item from the list is rendered.\n\n\nHighlighting Active Menu Items\n------------------------------\n\nOften you want to have a navigation bar with an active navigation\nitem. This is really simple to achieve. Because assignments outside\nof `block`\\s in child templates are global and executed before the layout\ntemplate is evaluated it's possible to define the active menu item in the\nchild template::\n\n {% extends \"layout.html\" %}\n {% set active_page = \"index\" %}\n\nThe layout template can then access `active_page`. Additionally it makes\nsense to define a default for that variable::\n\n {% set navigation_bar = [\n ('/', 'index', 'Index'),\n ('/downloads/', 'downloads', 'Downloads'),\n ('/about/', 'about', 'About')\n ] -%}\n {% set active_page = active_page|default('index') -%}\n ...\n
\n {% for href, id, caption in navigation_bar %}\n \n {{ caption|e }}
\n {% endfor %}\n \n ...\n\n.. _accessing-the-parent-loop:\n\nAccessing the parent Loop\n-------------------------\n\nThe special `loop` variable always points to the innermost loop. If it's\ndesired to have access to an outer loop it's possible to alias it::\n\n
\n {% for row in table %}\n
\n {% set rowloop = loop %}\n {% for cell in row %}\n
\n{%- for item in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] if item % 2 == 0 %}\n
{{ loop.index }} / {{ loop.length }}: {{ item }}
\n{%- endfor %}\n
\nif condition: {{ 1 if foo else 0 }}\n\"\"\"\n)\nprint(tmpl.render(foo=True))\n"
},
{
"path": "examples/basic/translate.py",
"content": "from jinja2 import Environment\n\nenv = Environment(extensions=[\"jinja2.ext.i18n\"])\nenv.globals[\"gettext\"] = {\"Hello %(user)s!\": \"Hallo %(user)s!\"}.__getitem__\nenv.globals[\"ngettext\"] = lambda s, p, n: {\n \"%(count)s user\": \"%(count)d Benutzer\",\n \"%(count)s users\": \"%(count)d Benutzer\",\n}[s if n == 1 else p]\nprint(\n env.from_string(\n \"\"\"\\\n{% trans %}Hello {{ user }}!{% endtrans %}\n{% trans count=users|count -%}\n{{ count }} user{% pluralize %}{{ count }} users\n{% endtrans %}\n\"\"\"\n ).render(user=\"someone\", users=[1, 2, 3])\n)\n"
},
{
"path": "pyproject.toml",
"content": "[project]\nname = \"Jinja2\"\nversion = \"3.2.0.dev\"\ndescription = \"A very fast and expressive template engine.\"\nreadme = \"README.md\"\nlicense = \"BSD-3-Clause\"\nlicense-files = [\"LICENSE.txt\"]\nmaintainers = [{name = \"Pallets\", email = \"contact@palletsprojects.com\"}]\nclassifiers = [\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Web Environment\",\n \"Intended Audience :: Developers\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content\",\n \"Topic :: Text Processing :: Markup :: HTML\",\n \"Typing :: Typed\",\n]\nrequires-python = \">=3.10\"\ndependencies = [\"MarkupSafe>=3.0\"]\n\n[project.urls]\nDonate = \"https://palletsprojects.com/donate\"\nDocumentation = \"https://jinja.palletsprojects.com/\"\nChanges = \"https://jinja.palletsprojects.com/page/changes/\"\nSource = \"https://github.com/pallets/jinja/\"\nChat = \"https://discord.gg/pallets\"\n\n[project.optional-dependencies]\ni18n = [\"Babel>=2.17\"]\n\n[dependency-groups]\ndev = [\n \"ruff\",\n \"tox\",\n \"tox-uv\",\n]\ndocs = [\n \"pallets-sphinx-themes\",\n \"sphinx\",\n \"sphinxcontrib-log-cabinet\",\n]\ndocs-auto = [\n \"sphinx-autobuild\",\n]\ngha-update = [\n \"gha-update ; python_full_version >= '3.12'\",\n]\npre-commit = [\n \"pre-commit\",\n \"pre-commit-uv\",\n]\ntests = [\n \"pytest\",\n \"pytest-timeout\",\n \"trio\"\n]\ntyping = [\n \"mypy\",\n \"pyright\",\n \"pytest\",\n]\n\n[build-system]\nrequires = [\"flit_core<4\"]\nbuild-backend = \"flit_core.buildapi\"\n\n[tool.flit.module]\nname = \"jinja2\"\n\n[tool.flit.sdist]\ninclude = [\n \"docs/\",\n \"examples/\",\n \"tests/\",\n \"CHANGES.rst\",\n \"uv.lock\"\n]\nexclude = [\n \"docs/_build/\",\n]\n\n[tool.uv]\ndefault-groups = [\"dev\", \"pre-commit\", \"tests\", \"typing\"]\n\n[tool.pytest.ini_options]\ntestpaths = [\"tests\"]\nfilterwarnings = [\n \"error\",\n]\n\n[tool.coverage.run]\nbranch = true\nsource = [\"jinja2\", \"tests\"]\n\n[tool.coverage.paths]\nsource = [\"src\", \"*/site-packages\"]\n\n[tool.coverage.report]\nexclude_also = [\n \"if t.TYPE_CHECKING\",\n \"raise NotImplementedError\",\n \": \\\\.{3}\",\n]\n\n[tool.mypy]\npython_version = \"3.10\"\nfiles = [\"src\"]\nshow_error_codes = true\npretty = true\nstrict = true\n\n[tool.pyright]\npythonVersion = \"3.10\"\ninclude = [\"src\"]\ntypeCheckingMode = \"standard\"\n\n[tool.ruff]\nsrc = [\"src\"]\nfix = true\nshow-fixes = true\noutput-format = \"full\"\n\n[tool.ruff.lint]\nselect = [\n \"B\", # flake8-bugbear\n \"E\", # pycodestyle error\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n \"W\", # pycodestyle warning\n]\nignore = [\n \"UP038\", # keep isinstance tuple\n]\n\n[tool.ruff.lint.isort]\nforce-single-line = true\norder-by-type = false\n\n[tool.gha-update]\ntag-only = [\n \"slsa-framework/slsa-github-generator\",\n]\n\n[tool.tox]\nenv_list = [\n \"py3.13\", \"py3.12\", \"py3.11\", \"py3.10\",\n \"pypy3.11\",\n \"style\",\n \"typing\",\n \"docs\",\n]\n\n[tool.tox.env_run_base]\ndescription = \"pytest on latest dependency versions\"\nrunner = \"uv-venv-lock-runner\"\npackage = \"wheel\"\nwheel_build_env = \".pkg\"\nconstrain_package_deps = true\nuse_frozen_constraints = true\ndependency_groups = [\"tests\"]\ncommands = [[\n \"pytest\", \"-v\", \"--tb=short\", \"--basetemp={env_tmp_dir}\",\n {replace = \"posargs\", default = [], extend = true},\n]]\n\n[tool.tox.env.style]\ndescription = \"run all pre-commit hooks on all files\"\ndependency_groups = [\"pre-commit\"]\nskip_install = true\ncommands = [[\"pre-commit\", \"run\", \"--all-files\"]]\n\n[tool.tox.env.typing]\ndescription = \"run static type checkers\"\ndependency_groups = [\"typing\"]\ncommands = [\n [\"mypy\"],\n]\n\n[tool.tox.env.docs]\ndescription = \"build docs\"\ndependency_groups = [\"docs\"]\ncommands = [[\"sphinx-build\", \"-E\", \"-W\", \"-b\", \"dirhtml\", \"docs\", \"docs/_build/dirhtml\"]]\n\n[tool.tox.env.docs-auto]\ndescription = \"continuously rebuild docs and start a local server\"\ndependency_groups = [\"docs\", \"docs-auto\"]\ncommands = [[\"sphinx-autobuild\", \"-W\", \"-b\", \"dirhtml\", \"--watch\", \"src\", \"docs\", \"docs/_build/dirhtml\"]]\n\n[tool.tox.env.update-actions]\ndescription = \"update GitHub Actions pins\"\nlabels = [\"update\"]\ndependency_groups = [\"gha-update\"]\nskip_install = true\ncommands = [[\"gha-update\"]]\n\n[tool.tox.env.update-pre_commit]\ndescription = \"update pre-commit pins\"\nlabels = [\"update\"]\ndependency_groups = [\"pre-commit\"]\nskip_install = true\ncommands = [[\"pre-commit\", \"autoupdate\", \"--freeze\", \"-j4\"]]\n\n[tool.tox.env.update-requirements]\ndescription = \"update uv lock\"\nlabels = [\"update\"]\ndependency_groups = []\nno_default_groups = true\nskip_install = true\ncommands = [[\"uv\", \"lock\", {replace = \"posargs\", default = [\"-U\"], extend = true}]]\n"
},
{
"path": "scripts/generate_identifier_pattern.py",
"content": "import itertools\nimport os\nimport re\nimport sys\n\n\ndef get_characters():\n \"\"\"Find every Unicode character that is valid in a Python `identifier`_ but\n is not matched by the regex ``\\\\w`` group.\n\n ``\\\\w`` matches some characters that aren't valid in identifiers, but\n :meth:`str.isidentifier` will catch that later in lexing.\n\n All start characters are valid continue characters, so we only test for\n continue characters.\n\n _identifier: https://docs.python.org/3/reference/lexical_analysis.html#identifiers\n \"\"\"\n for cp in range(sys.maxunicode + 1):\n s = chr(cp)\n\n if (\"a\" + s).isidentifier() and not re.match(r\"\\w\", s):\n yield s\n\n\ndef collapse_ranges(data):\n \"\"\"Given a sorted list of unique characters, generate ranges representing\n sequential code points.\n\n Source: https://stackoverflow.com/a/4629241/400617\n \"\"\"\n for _, g in itertools.groupby(enumerate(data), lambda x: ord(x[1]) - x[0]):\n lb = list(g)\n yield lb[0][1], lb[-1][1]\n\n\ndef build_pattern(ranges):\n \"\"\"Output the regex pattern for ranges of characters.\n\n One and two character ranges output the individual characters.\n \"\"\"\n out = []\n\n for a, b in ranges:\n if a == b: # single char\n out.append(a)\n elif ord(b) - ord(a) == 1: # two chars, range is redundant\n out.append(a)\n out.append(b)\n else:\n out.append(f\"{a}-{b}\")\n\n return \"\".join(out)\n\n\ndef main():\n \"\"\"Build the regex pattern and write it to ``jinja2/_identifier.py``.\"\"\"\n pattern = build_pattern(collapse_ranges(get_characters()))\n filename = os.path.abspath(\n os.path.join(os.path.dirname(__file__), \"..\", \"src\", \"jinja2\", \"_identifier.py\")\n )\n\n with open(filename, \"w\", encoding=\"utf8\") as f:\n f.write(\"# generated by scripts/generate_identifier_pattern.py\")\n f.write(f\"# Python {sys.version_info[0]}.{sys.version_info[1]}\\n\")\n f.write(\"import re\\n\\n\")\n f.write(\"pattern = re.compile(\\n\")\n f.write(f' r\"[\\\\w{pattern}]+\" # noqa: B950\\n')\n f.write(\")\\n\")\n\n\nif __name__ == \"__main__\":\n main()\n"
},
{
"path": "src/jinja2/__init__.py",
"content": "\"\"\"Jinja is a template engine written in pure Python. It provides a\nnon-XML syntax that supports inline expressions and an optional\nsandboxed environment.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport typing as t\n\nfrom .bccache import BytecodeCache as BytecodeCache\nfrom .bccache import FileSystemBytecodeCache as FileSystemBytecodeCache\nfrom .bccache import MemcachedBytecodeCache as MemcachedBytecodeCache\nfrom .environment import Environment as Environment\nfrom .environment import Template as Template\nfrom .exceptions import TemplateAssertionError as TemplateAssertionError\nfrom .exceptions import TemplateError as TemplateError\nfrom .exceptions import TemplateNotFound as TemplateNotFound\nfrom .exceptions import TemplateRuntimeError as TemplateRuntimeError\nfrom .exceptions import TemplatesNotFound as TemplatesNotFound\nfrom .exceptions import TemplateSyntaxError as TemplateSyntaxError\nfrom .exceptions import UndefinedError as UndefinedError\nfrom .loaders import BaseLoader as BaseLoader\nfrom .loaders import ChoiceLoader as ChoiceLoader\nfrom .loaders import DictLoader as DictLoader\nfrom .loaders import FileSystemLoader as FileSystemLoader\nfrom .loaders import FunctionLoader as FunctionLoader\nfrom .loaders import ModuleLoader as ModuleLoader\nfrom .loaders import PackageLoader as PackageLoader\nfrom .loaders import PrefixLoader as PrefixLoader\nfrom .runtime import ChainableUndefined as ChainableUndefined\nfrom .runtime import DebugUndefined as DebugUndefined\nfrom .runtime import make_logging_undefined as make_logging_undefined\nfrom .runtime import StrictUndefined as StrictUndefined\nfrom .runtime import Undefined as Undefined\nfrom .utils import clear_caches as clear_caches\nfrom .utils import is_undefined as is_undefined\nfrom .utils import pass_context as pass_context\nfrom .utils import pass_environment as pass_environment\nfrom .utils import pass_eval_context as pass_eval_context\nfrom .utils import select_autoescape as select_autoescape\n\n\ndef __getattr__(name: str) -> t.Any:\n if name == \"__version__\":\n import importlib.metadata\n import warnings\n\n warnings.warn(\n \"The `__version__` attribute is deprecated and will be removed in\"\n \" Jinja 3.3. Use feature detection or\"\n ' `importlib.metadata.version(\"jinja2\")` instead.',\n DeprecationWarning,\n stacklevel=2,\n )\n return importlib.metadata.version(\"jinja2\")\n\n raise AttributeError(name)\n"
},
{
"path": "src/jinja2/_identifier.py",
"content": "# generated by scripts/generate_identifier_pattern.py for Python 3.10\nimport re\n\npattern = re.compile(\n r\"[\\w·̀-ͯ·҃-֑҇-ׇֽֿׁׂׅׄؐ-ًؚ-ٰٟۖ-ۜ۟-۪ۤۧۨ-ܑۭܰ-݊ަ-ް߫-߽߳ࠖ-࠙ࠛ-ࠣࠥ-ࠧࠩ-࡙࠭-࡛࣓-ࣣ࣡-ःऺ-़ा-ॏ॑-ॗॢॣঁ-ঃ়া-ৄেৈো-্ৗৢৣ৾ਁ-ਃ਼ਾ-ੂੇੈੋ-੍ੑੰੱੵઁ-ઃ઼ા-ૅે-ૉો-્ૢૣૺ-૿ଁ-ଃ଼ା-ୄେୈୋ-୍୕-ୗୢୣஂா-ூெ-ைொ-்ௗఀ-ఄా-ౄె-ైొ-్ౕౖౢౣಁ-ಃ಼ಾ-ೄೆ-ೈೊ-್ೕೖೢೣഀ-ഃ഻഼ാ-ൄെ-ൈൊ-്ൗൢൣඁ-ඃ්ා-ුූෘ-ෟෲෳัิ-ฺ็-๎ັິ-ຼ່-ໍ༹༘༙༵༷༾༿ཱ-྄྆྇ྍ-ྗྙ-ྼ࿆ါ-ှၖ-ၙၞ-ၠၢ-ၤၧ-ၭၱ-ၴႂ-ႍႏႚ-ႝ፝-፟ᜒ-᜔ᜲ-᜴ᝒᝓᝲᝳ឴-៓៝᠋-᠍ᢅᢆᢩᤠ-ᤫᤰ-᤻ᨗ-ᨛᩕ-ᩞ᩠-᩿᩼᪰-᪽ᪿᫀᬀ-ᬄ᬴-᭄᭫-᭳ᮀ-ᮂᮡ-ᮭ᯦-᯳ᰤ-᰷᳐-᳔᳒-᳨᳭᳴᳷-᳹᷀-᷹᷻-᷿‿⁀⁔⃐-⃥⃜⃡-⃰℘℮⳯-⵿⳱ⷠ-〪ⷿ-゙゚〯꙯ꙴ-꙽ꚞꚟ꛰꛱ꠂ꠆ꠋꠣ-ꠧ꠬ꢀꢁꢴ-ꣅ꣠-꣱ꣿꤦ-꤭ꥇ-꥓ꦀ-ꦃ꦳-꧀ꧥꨩ-ꨶꩃꩌꩍꩻ-ꩽꪰꪲ-ꪴꪷꪸꪾ꪿꫁ꫫ-ꫯꫵ꫶ꯣ-ꯪ꯬꯭ﬞ︀-️︠-︯︳︴﹍-﹏＿𐇽𐋠𐍶-𐍺𐨁-𐨃𐨅𐨆𐨌-𐨏𐨸-𐨿𐨺𐫦𐫥𐴤-𐽆𐴧𐺫𐺬-𐽐𑀀-𑀂𑀸-𑁆𑁿-𑂂𑂰-𑂺𑄀-𑄂𑄧-𑄴𑅅𑅆𑅳𑆀-𑆂𑆳-𑇀𑇉-𑇌𑇎𑇏𑈬-𑈷𑈾𑋟-𑋪𑌀-𑌃𑌻𑌼𑌾-𑍄𑍇𑍈𑍋-𑍍𑍗𑍢𑍣𑍦-𑍬𑍰-𑍴𑐵-𑑆𑑞𑒰-𑓃𑖯-𑖵𑖸-𑗀𑗜𑗝𑘰-𑙀𑚫-𑚷𑜝-𑜫𑠬-𑠺𑤰-𑤵𑤷𑤸𑤻-𑤾𑥀𑥂𑥃𑧑-𑧗𑧚-𑧠𑧤𑨁-𑨊𑨳-𑨹𑨻-𑨾𑩇𑩑-𑩛𑪊-𑪙𑰯-𑰶𑰸-𑰿𑲒-𑲧𑲩-𑲶𑴱-𑴶𑴺𑴼𑴽𑴿-𑵅𑵇𑶊-𑶎𑶐𑶑𑶓-𑶗𑻳-𑻶𖫰-𖫴𖬰-𖬶𖽏𖽑-𖾇𖾏-𖾒𖿤𖿰𖿱𛲝𛲞𝅥-𝅩𝅭-𝅲𝅻-𝆂𝆅-𝆋𝆪-𝆭𝉂-𝉄𝨀-𝨶𝨻-𝩬𝩵𝪄𝪛-𝪟𝪡-𝪯𞀀-𞀆𞀈-𞀘𞀛-𞀡𞀣𞀤𞀦-𞀪𞄰-𞄶𞋬-𞣐𞋯-𞣖𞥄-𞥊󠄀-󠇯]+\" # noqa: B950\n)\n"
},
{
"path": "src/jinja2/async_utils.py",
"content": "import inspect\nimport typing as t\nfrom functools import WRAPPER_ASSIGNMENTS\nfrom functools import wraps\n\nfrom .utils import _PassArg\nfrom .utils import pass_eval_context\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\nV = t.TypeVar(\"V\")\n\n\ndef async_variant(normal_func): # type: ignore\n def decorator(async_func): # type: ignore\n pass_arg = _PassArg.from_obj(normal_func)\n need_eval_context = pass_arg is None\n\n if pass_arg is _PassArg.environment:\n\n def is_async(args: t.Any) -> bool:\n return t.cast(bool, args[0].is_async)\n\n else:\n\n def is_async(args: t.Any) -> bool:\n return t.cast(bool, args[0].environment.is_async)\n\n # Take the doc and annotations from the sync function, but the\n # name from the async function. Pallets-Sphinx-Themes\n # build_function_directive expects __wrapped__ to point to the\n # sync function.\n async_func_attrs = (\"__module__\", \"__name__\", \"__qualname__\")\n normal_func_attrs = tuple(set(WRAPPER_ASSIGNMENTS).difference(async_func_attrs))\n\n @wraps(normal_func, assigned=normal_func_attrs)\n @wraps(async_func, assigned=async_func_attrs, updated=())\n def wrapper(*args, **kwargs): # type: ignore\n b = is_async(args)\n\n if need_eval_context:\n args = args[1:]\n\n if b:\n return async_func(*args, **kwargs)\n\n return normal_func(*args, **kwargs)\n\n if need_eval_context:\n wrapper = pass_eval_context(wrapper)\n\n wrapper.jinja_async_variant = True # type: ignore[attr-defined]\n return wrapper\n\n return decorator\n\n\n_common_primitives = {int, float, bool, str, list, dict, tuple, type(None)}\n\n\nasync def auto_await(value: t.Union[t.Awaitable[\"V\"], \"V\"]) -> \"V\":\n # Avoid a costly call to isawaitable\n if type(value) in _common_primitives:\n return t.cast(\"V\", value)\n\n if inspect.isawaitable(value):\n return await t.cast(\"t.Awaitable[V]\", value)\n\n return value\n\n\nclass _IteratorToAsyncIterator(t.Generic[V]):\n def __init__(self, iterator: \"t.Iterator[V]\"):\n self._iterator = iterator\n\n def __aiter__(self) -> \"te.Self\":\n return self\n\n async def __anext__(self) -> V:\n try:\n return next(self._iterator)\n except StopIteration as e:\n raise StopAsyncIteration(e.value) from e\n\n\ndef auto_aiter(\n iterable: \"t.AsyncIterable[V] | t.Iterable[V]\",\n) -> \"t.AsyncIterator[V]\":\n if hasattr(iterable, \"__aiter__\"):\n return iterable.__aiter__()\n else:\n return _IteratorToAsyncIterator(iter(iterable))\n\n\nasync def auto_to_list(\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n) -> list[\"V\"]:\n return [x async for x in auto_aiter(value)]\n"
},
{
"path": "src/jinja2/bccache.py",
"content": "\"\"\"The optional bytecode cache system. This is useful if you have very\ncomplex template situations and the compilation of all those templates\nslows down your application too much.\n\nSituations where this is useful are often forking web applications that\nare initialized on the first request.\n\"\"\"\n\nimport errno\nimport fnmatch\nimport marshal\nimport os\nimport pickle\nimport stat\nimport sys\nimport tempfile\nimport typing as t\nfrom hashlib import sha1\nfrom io import BytesIO\nfrom types import CodeType\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n from .environment import Environment\n\n class _MemcachedClient(te.Protocol):\n def get(self, key: str) -> bytes: ...\n\n def set(self, key: str, value: bytes, timeout: int | None = None) -> None: ...\n\n\nbc_version = 5\n# Magic bytes to identify Jinja bytecode cache files. Contains the\n# Python major and minor version to avoid loading incompatible bytecode\n# if a project upgrades its Python version.\nbc_magic = (\n b\"j2\"\n + pickle.dumps(bc_version, 2)\n + pickle.dumps((sys.version_info[0] << 24) | sys.version_info[1], 2)\n)\n\n\nclass Bucket:\n \"\"\"Buckets are used to store the bytecode for one template. It's created\n and initialized by the bytecode cache and passed to the loading functions.\n\n The buckets get an internal checksum from the cache assigned and use this\n to automatically reject outdated cache material. Individual bytecode\n cache subclasses don't have to care about cache invalidation.\n \"\"\"\n\n def __init__(self, environment: \"Environment\", key: str, checksum: str) -> None:\n self.environment = environment\n self.key = key\n self.checksum = checksum\n self.reset()\n\n def reset(self) -> None:\n \"\"\"Resets the bucket (unloads the bytecode).\"\"\"\n self.code: CodeType | None = None\n\n def load_bytecode(self, f: t.BinaryIO) -> None:\n \"\"\"Loads bytecode from a file or file like object.\"\"\"\n # make sure the magic header is correct\n magic = f.read(len(bc_magic))\n if magic != bc_magic:\n self.reset()\n return\n # the source code of the file changed, we need to reload\n checksum = pickle.load(f)\n if self.checksum != checksum:\n self.reset()\n return\n # if marshal_load fails then we need to reload\n try:\n self.code = marshal.load(f)\n except (EOFError, ValueError, TypeError):\n self.reset()\n return\n\n def write_bytecode(self, f: t.IO[bytes]) -> None:\n \"\"\"Dump the bytecode into the file or file like object passed.\"\"\"\n if self.code is None:\n raise TypeError(\"can't write empty bucket\")\n f.write(bc_magic)\n pickle.dump(self.checksum, f, 2)\n marshal.dump(self.code, f)\n\n def bytecode_from_string(self, string: bytes) -> None:\n \"\"\"Load bytecode from bytes.\"\"\"\n self.load_bytecode(BytesIO(string))\n\n def bytecode_to_string(self) -> bytes:\n \"\"\"Return the bytecode as bytes.\"\"\"\n out = BytesIO()\n self.write_bytecode(out)\n return out.getvalue()\n\n\nclass BytecodeCache:\n \"\"\"To implement your own bytecode cache you have to subclass this class\n and override :meth:`load_bytecode` and :meth:`dump_bytecode`. Both of\n these methods are passed a :class:`~jinja2.bccache.Bucket`.\n\n A very basic bytecode cache that saves the bytecode on the file system::\n\n from os import path\n\n class MyCache(BytecodeCache):\n\n def __init__(self, directory):\n self.directory = directory\n\n def load_bytecode(self, bucket):\n filename = path.join(self.directory, bucket.key)\n if path.exists(filename):\n with open(filename, 'rb') as f:\n bucket.load_bytecode(f)\n\n def dump_bytecode(self, bucket):\n filename = path.join(self.directory, bucket.key)\n with open(filename, 'wb') as f:\n bucket.write_bytecode(f)\n\n A more advanced version of a filesystem based bytecode cache is part of\n Jinja.\n \"\"\"\n\n def load_bytecode(self, bucket: Bucket) -> None:\n \"\"\"Subclasses have to override this method to load bytecode into a\n bucket. If they are not able to find code in the cache for the\n bucket, it must not do anything.\n \"\"\"\n raise NotImplementedError()\n\n def dump_bytecode(self, bucket: Bucket) -> None:\n \"\"\"Subclasses have to override this method to write the bytecode\n from a bucket back to the cache. If it unable to do so it must not\n fail silently but raise an exception.\n \"\"\"\n raise NotImplementedError()\n\n def clear(self) -> None:\n \"\"\"Clears the cache. This method is not used by Jinja but should be\n implemented to allow applications to clear the bytecode cache used\n by a particular environment.\n \"\"\"\n\n def get_cache_key(self, name: str, filename: str | None = None) -> str:\n \"\"\"Returns the unique hash key for this template name.\"\"\"\n hash = sha1(name.encode(\"utf-8\"))\n\n if filename is not None:\n hash.update(f\"|{filename}\".encode())\n\n return hash.hexdigest()\n\n def get_source_checksum(self, source: str) -> str:\n \"\"\"Returns a checksum for the source.\"\"\"\n return sha1(source.encode(\"utf-8\")).hexdigest()\n\n def get_bucket(\n self,\n environment: \"Environment\",\n name: str,\n filename: str | None,\n source: str,\n ) -> Bucket:\n \"\"\"Return a cache bucket for the given template. All arguments are\n mandatory but filename may be `None`.\n \"\"\"\n key = self.get_cache_key(name, filename)\n checksum = self.get_source_checksum(source)\n bucket = Bucket(environment, key, checksum)\n self.load_bytecode(bucket)\n return bucket\n\n def set_bucket(self, bucket: Bucket) -> None:\n \"\"\"Put the bucket into the cache.\"\"\"\n self.dump_bytecode(bucket)\n\n\nclass FileSystemBytecodeCache(BytecodeCache):\n \"\"\"A bytecode cache that stores bytecode on the filesystem. It accepts\n two arguments: The directory where the cache items are stored and a\n pattern string that is used to build the filename.\n\n If no directory is specified a default cache directory is selected. On\n Windows the user's temp directory is used, on UNIX systems a directory\n is created for the user in the system temp directory.\n\n The pattern can be used to have multiple separate caches operate on the\n same directory. The default pattern is ``'__jinja2_%s.cache'``. ``%s``\n is replaced with the cache key.\n\n >>> bcc = FileSystemBytecodeCache('/tmp/jinja_cache', '%s.cache')\n\n This bytecode cache supports clearing of the cache using the clear method.\n \"\"\"\n\n def __init__(\n self, directory: str | None = None, pattern: str = \"__jinja2_%s.cache\"\n ) -> None:\n if directory is None:\n directory = self._get_default_cache_dir()\n self.directory = directory\n self.pattern = pattern\n\n def _get_default_cache_dir(self) -> str:\n def _unsafe_dir() -> \"te.NoReturn\":\n raise RuntimeError(\n \"Cannot determine safe temp directory. You \"\n \"need to explicitly provide one.\"\n )\n\n tmpdir = tempfile.gettempdir()\n\n # On windows the temporary directory is used specific unless\n # explicitly forced otherwise. We can just use that.\n if os.name == \"nt\":\n return tmpdir\n if not hasattr(os, \"getuid\"):\n _unsafe_dir()\n\n dirname = f\"_jinja2-cache-{os.getuid()}\"\n actual_dir = os.path.join(tmpdir, dirname)\n\n try:\n os.mkdir(actual_dir, stat.S_IRWXU)\n except OSError as e:\n if e.errno != errno.EEXIST:\n raise\n try:\n os.chmod(actual_dir, stat.S_IRWXU)\n actual_dir_stat = os.lstat(actual_dir)\n if (\n actual_dir_stat.st_uid != os.getuid()\n or not stat.S_ISDIR(actual_dir_stat.st_mode)\n or stat.S_IMODE(actual_dir_stat.st_mode) != stat.S_IRWXU\n ):\n _unsafe_dir()\n except OSError as e:\n if e.errno != errno.EEXIST:\n raise\n\n actual_dir_stat = os.lstat(actual_dir)\n if (\n actual_dir_stat.st_uid != os.getuid()\n or not stat.S_ISDIR(actual_dir_stat.st_mode)\n or stat.S_IMODE(actual_dir_stat.st_mode) != stat.S_IRWXU\n ):\n _unsafe_dir()\n\n return actual_dir\n\n def _get_cache_filename(self, bucket: Bucket) -> str:\n return os.path.join(self.directory, self.pattern % (bucket.key,))\n\n def load_bytecode(self, bucket: Bucket) -> None:\n filename = self._get_cache_filename(bucket)\n\n # Don't test for existence before opening the file, since the\n # file could disappear after the test before the open.\n try:\n f = open(filename, \"rb\")\n except (FileNotFoundError, IsADirectoryError, PermissionError):\n # PermissionError can occur on Windows when an operation is\n # in progress, such as calling clear().\n return\n\n with f:\n bucket.load_bytecode(f)\n\n def dump_bytecode(self, bucket: Bucket) -> None:\n # Write to a temporary file, then rename to the real name after\n # writing. This avoids another process reading the file before\n # it is fully written.\n name = self._get_cache_filename(bucket)\n f = tempfile.NamedTemporaryFile(\n mode=\"wb\",\n dir=os.path.dirname(name),\n prefix=os.path.basename(name),\n suffix=\".tmp\",\n delete=False,\n )\n\n def remove_silent() -> None:\n try:\n os.remove(f.name)\n except OSError:\n # Another process may have called clear(). On Windows,\n # another program may be holding the file open.\n pass\n\n try:\n with f:\n bucket.write_bytecode(f)\n except BaseException:\n remove_silent()\n raise\n\n try:\n os.replace(f.name, name)\n except OSError:\n # Another process may have called clear(). On Windows,\n # another program may be holding the file open.\n remove_silent()\n except BaseException:\n remove_silent()\n raise\n\n def clear(self) -> None:\n # imported lazily here because google app-engine doesn't support\n # write access on the file system and the function does not exist\n # normally.\n from os import remove\n\n files = fnmatch.filter(os.listdir(self.directory), self.pattern % (\"*\",))\n for filename in files:\n try:\n remove(os.path.join(self.directory, filename))\n except OSError:\n pass\n\n\nclass MemcachedBytecodeCache(BytecodeCache):\n \"\"\"This class implements a bytecode cache that uses a memcache cache for\n storing the information. It does not enforce a specific memcache library\n (tummy's memcache or cmemcache) but will accept any class that provides\n the minimal interface required.\n\n Libraries compatible with this class:\n\n - `cachelib `_\n - `python-memcached `_\n\n (Unfortunately the django cache interface is not compatible because it\n does not support storing binary data, only text. You can however pass\n the underlying cache client to the bytecode cache which is available\n as `django.core.cache.cache._client`.)\n\n The minimal interface for the client passed to the constructor is this:\n\n .. class:: MinimalClientInterface\n\n .. method:: set(key, value[, timeout])\n\n Stores the bytecode in the cache. `value` is a string and\n `timeout` the timeout of the key. If timeout is not provided\n a default timeout or no timeout should be assumed, if it's\n provided it's an integer with the number of seconds the cache\n item should exist.\n\n .. method:: get(key)\n\n Returns the value for the cache key. If the item does not\n exist in the cache the return value must be `None`.\n\n The other arguments to the constructor are the prefix for all keys that\n is added before the actual cache key and the timeout for the bytecode in\n the cache system. We recommend a high (or no) timeout.\n\n This bytecode cache does not support clearing of used items in the cache.\n The clear method is a no-operation function.\n\n .. versionadded:: 2.7\n Added support for ignoring memcache errors through the\n `ignore_memcache_errors` parameter.\n \"\"\"\n\n def __init__(\n self,\n client: \"_MemcachedClient\",\n prefix: str = \"jinja2/bytecode/\",\n timeout: int | None = None,\n ignore_memcache_errors: bool = True,\n ):\n self.client = client\n self.prefix = prefix\n self.timeout = timeout\n self.ignore_memcache_errors = ignore_memcache_errors\n\n def load_bytecode(self, bucket: Bucket) -> None:\n try:\n code = self.client.get(self.prefix + bucket.key)\n except Exception:\n if not self.ignore_memcache_errors:\n raise\n else:\n bucket.bytecode_from_string(code)\n\n def dump_bytecode(self, bucket: Bucket) -> None:\n key = self.prefix + bucket.key\n value = bucket.bytecode_to_string()\n\n try:\n if self.timeout is not None:\n self.client.set(key, value, self.timeout)\n else:\n self.client.set(key, value)\n except Exception:\n if not self.ignore_memcache_errors:\n raise\n"
},
{
"path": "src/jinja2/compiler.py",
"content": "\"\"\"Compiles nodes from the parser into Python code.\"\"\"\n\nimport typing as t\nfrom contextlib import contextmanager\nfrom functools import update_wrapper\nfrom io import StringIO\nfrom itertools import chain\nfrom keyword import iskeyword as is_python_keyword\n\nfrom markupsafe import escape\nfrom markupsafe import Markup\n\nfrom . import nodes\nfrom .exceptions import TemplateAssertionError\nfrom .idtracking import Symbols\nfrom .idtracking import VAR_LOAD_ALIAS\nfrom .idtracking import VAR_LOAD_PARAMETER\nfrom .idtracking import VAR_LOAD_RESOLVE\nfrom .idtracking import VAR_LOAD_UNDEFINED\nfrom .nodes import EvalContext\nfrom .optimizer import Optimizer\nfrom .utils import _PassArg\nfrom .utils import concat\nfrom .visitor import NodeVisitor\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n from .environment import Environment\n\nF = t.TypeVar(\"F\", bound=t.Callable[..., t.Any])\n\noperators = {\n \"eq\": \"==\",\n \"ne\": \"!=\",\n \"gt\": \">\",\n \"gteq\": \">=\",\n \"lt\": \"<\",\n \"lteq\": \"<=\",\n \"in\": \"in\",\n \"notin\": \"not in\",\n}\n\n\ndef optimizeconst(f: F) -> F:\n def new_func(\n self: \"CodeGenerator\", node: nodes.Expr, frame: \"Frame\", **kwargs: t.Any\n ) -> t.Any:\n # Only optimize if the frame is not volatile\n if self.optimizer is not None and not frame.eval_ctx.volatile:\n new_node = self.optimizer.visit(node, frame.eval_ctx)\n\n if new_node != node:\n return self.visit(new_node, frame)\n\n return f(self, node, frame, **kwargs)\n\n return update_wrapper(new_func, f) # type: ignore[return-value]\n\n\ndef _make_binop(op: str) -> t.Callable[[\"CodeGenerator\", nodes.BinExpr, \"Frame\"], None]:\n @optimizeconst\n def visitor(self: \"CodeGenerator\", node: nodes.BinExpr, frame: Frame) -> None:\n if (\n self.environment.sandboxed and op in self.environment.intercepted_binops # type: ignore\n ):\n self.write(f\"environment.call_binop(context, {op!r}, \")\n self.visit(node.left, frame)\n self.write(\", \")\n self.visit(node.right, frame)\n else:\n self.write(\"(\")\n self.visit(node.left, frame)\n self.write(f\" {op} \")\n self.visit(node.right, frame)\n\n self.write(\")\")\n\n return visitor\n\n\ndef _make_unop(\n op: str,\n) -> t.Callable[[\"CodeGenerator\", nodes.UnaryExpr, \"Frame\"], None]:\n @optimizeconst\n def visitor(self: \"CodeGenerator\", node: nodes.UnaryExpr, frame: Frame) -> None:\n if (\n self.environment.sandboxed and op in self.environment.intercepted_unops # type: ignore\n ):\n self.write(f\"environment.call_unop(context, {op!r}, \")\n self.visit(node.node, frame)\n else:\n self.write(\"(\" + op)\n self.visit(node.node, frame)\n\n self.write(\")\")\n\n return visitor\n\n\ndef generate(\n node: nodes.Template,\n environment: \"Environment\",\n name: str | None,\n filename: str | None,\n stream: t.TextIO | None = None,\n defer_init: bool = False,\n optimized: bool = True,\n) -> str | None:\n \"\"\"Generate the python source for a node tree.\"\"\"\n if not isinstance(node, nodes.Template):\n raise TypeError(\"Can't compile non template nodes\")\n\n generator = environment.code_generator_class(\n environment, name, filename, stream, defer_init, optimized\n )\n generator.visit(node)\n\n if stream is None:\n return generator.stream.getvalue() # type: ignore\n\n return None\n\n\ndef has_safe_repr(value: t.Any) -> bool:\n \"\"\"Does the node have a safe representation?\"\"\"\n if value is None or value is NotImplemented or value is Ellipsis:\n return True\n\n if type(value) in {bool, int, float, complex, range, str, Markup}:\n return True\n\n if type(value) in {tuple, list, set, frozenset}:\n return all(has_safe_repr(v) for v in value)\n\n if type(value) is dict: # noqa E721\n return all(has_safe_repr(k) and has_safe_repr(v) for k, v in value.items())\n\n return False\n\n\ndef find_undeclared(nodes: t.Iterable[nodes.Node], names: t.Iterable[str]) -> set[str]:\n \"\"\"Check if the names passed are accessed undeclared. The return value\n is a set of all the undeclared names from the sequence of names found.\n \"\"\"\n visitor = UndeclaredNameVisitor(names)\n try:\n for node in nodes:\n visitor.visit(node)\n except VisitorExit:\n pass\n return visitor.undeclared\n\n\nclass MacroRef:\n def __init__(self, node: nodes.Macro | nodes.CallBlock) -> None:\n self.node = node\n self.accesses_caller = False\n self.accesses_kwargs = False\n self.accesses_varargs = False\n\n\nclass Frame:\n \"\"\"Holds compile time information for us.\"\"\"\n\n def __init__(\n self,\n eval_ctx: EvalContext,\n parent: t.Optional[\"Frame\"] = None,\n level: int | None = None,\n ) -> None:\n self.eval_ctx = eval_ctx\n\n # the parent of this frame\n self.parent = parent\n\n if parent is None:\n self.symbols = Symbols(level=level)\n\n # in some dynamic inheritance situations the compiler needs to add\n # write tests around output statements.\n self.require_output_check = False\n\n # inside some tags we are using a buffer rather than yield statements.\n # this for example affects {% filter %} or {% macro %}. If a frame\n # is buffered this variable points to the name of the list used as\n # buffer.\n self.buffer: str | None = None\n\n # the name of the block we're in, otherwise None.\n self.block: str | None = None\n\n else:\n self.symbols = Symbols(parent.symbols, level=level)\n self.require_output_check = parent.require_output_check\n self.buffer = parent.buffer\n self.block = parent.block\n\n # a toplevel frame is the root + soft frames such as if conditions.\n self.toplevel = False\n\n # the root frame is basically just the outermost frame, so no if\n # conditions. This information is used to optimize inheritance\n # situations.\n self.rootlevel = False\n\n # variables set inside of loops and blocks should not affect outer frames,\n # but they still needs to be kept track of as part of the active context.\n self.loop_frame = False\n self.block_frame = False\n\n # track whether the frame is being used in an if-statement or conditional\n # expression as it determines which errors should be raised during runtime\n # or compile time.\n self.soft_frame = False\n\n def copy(self) -> \"te.Self\":\n \"\"\"Create a copy of the current one.\"\"\"\n rv = object.__new__(self.__class__)\n rv.__dict__.update(self.__dict__)\n rv.symbols = self.symbols.copy()\n return rv\n\n def inner(self, isolated: bool = False) -> \"Frame\":\n \"\"\"Return an inner frame.\"\"\"\n if isolated:\n return Frame(self.eval_ctx, level=self.symbols.level + 1)\n return Frame(self.eval_ctx, self)\n\n def soft(self) -> \"te.Self\":\n \"\"\"Return a soft frame. A soft frame may not be modified as\n standalone thing as it shares the resources with the frame it\n was created of, but it's not a rootlevel frame any longer.\n\n This is only used to implement if-statements and conditional\n expressions.\n \"\"\"\n rv = self.copy()\n rv.rootlevel = False\n rv.soft_frame = True\n return rv\n\n __copy__ = copy\n\n\nclass VisitorExit(RuntimeError):\n \"\"\"Exception used by the `UndeclaredNameVisitor` to signal a stop.\"\"\"\n\n\nclass DependencyFinderVisitor(NodeVisitor):\n \"\"\"A visitor that collects filter and test calls.\"\"\"\n\n def __init__(self) -> None:\n self.filters: set[str] = set()\n self.tests: set[str] = set()\n\n def visit_Filter(self, node: nodes.Filter) -> None:\n self.generic_visit(node)\n self.filters.add(node.name)\n\n def visit_Test(self, node: nodes.Test) -> None:\n self.generic_visit(node)\n self.tests.add(node.name)\n\n def visit_Block(self, node: nodes.Block) -> None:\n \"\"\"Stop visiting at blocks.\"\"\"\n\n\nclass UndeclaredNameVisitor(NodeVisitor):\n \"\"\"A visitor that checks if a name is accessed without being\n declared. This is different from the frame visitor as it will\n not stop at closure frames.\n \"\"\"\n\n def __init__(self, names: t.Iterable[str]) -> None:\n self.names = set(names)\n self.undeclared: set[str] = set()\n\n def visit_Name(self, node: nodes.Name) -> None:\n if node.ctx == \"load\" and node.name in self.names:\n self.undeclared.add(node.name)\n if self.undeclared == self.names:\n raise VisitorExit()\n else:\n self.names.discard(node.name)\n\n def visit_Block(self, node: nodes.Block) -> None:\n \"\"\"Stop visiting a blocks.\"\"\"\n\n\nclass CompilerExit(Exception):\n \"\"\"Raised if the compiler encountered a situation where it just\n doesn't make sense to further process the code. Any block that\n raises such an exception is not further processed.\n \"\"\"\n\n\nclass CodeGenerator(NodeVisitor):\n def __init__(\n self,\n environment: \"Environment\",\n name: str | None,\n filename: str | None,\n stream: t.TextIO | None = None,\n defer_init: bool = False,\n optimized: bool = True,\n ) -> None:\n if stream is None:\n stream = StringIO()\n self.environment = environment\n self.name = name\n self.filename = filename\n self.stream = stream\n self.created_block_context = False\n self.defer_init = defer_init\n self.optimizer: Optimizer | None = None\n\n if optimized:\n self.optimizer = Optimizer(environment)\n\n # aliases for imports\n self.import_aliases: dict[str, str] = {}\n\n # a registry for all blocks. Because blocks are moved out\n # into the global python scope they are registered here\n self.blocks: dict[str, nodes.Block] = {}\n\n # the number of extends statements so far\n self.extends_so_far = 0\n\n # some templates have a rootlevel extends. In this case we\n # can safely assume that we're a child template and do some\n # more optimizations.\n self.has_known_extends = False\n\n # the current line number\n self.code_lineno = 1\n\n # registry of all filters and tests (global, not block local)\n self.tests: dict[str, str] = {}\n self.filters: dict[str, str] = {}\n\n # the debug information\n self.debug_info: list[tuple[int, int]] = []\n self._write_debug_info: int | None = None\n\n # the number of new lines before the next write()\n self._new_lines = 0\n\n # the line number of the last written statement\n self._last_line = 0\n\n # true if nothing was written so far.\n self._first_write = True\n\n # used by the `temporary_identifier` method to get new\n # unique, temporary identifier\n self._last_identifier = 0\n\n # the current indentation\n self._indentation = 0\n\n # Tracks toplevel assignments\n self._assign_stack: list[set[str]] = []\n\n # Tracks parameter definition blocks\n self._param_def_block: list[set[str]] = []\n\n # Tracks the current context.\n self._context_reference_stack = [\"context\"]\n\n @property\n def optimized(self) -> bool:\n return self.optimizer is not None\n\n # -- Various compilation helpers\n\n def fail(self, msg: str, lineno: int) -> \"te.NoReturn\":\n \"\"\"Fail with a :exc:`TemplateAssertionError`.\"\"\"\n raise TemplateAssertionError(msg, lineno, self.name, self.filename)\n\n def temporary_identifier(self) -> str:\n \"\"\"Get a new unique identifier.\"\"\"\n self._last_identifier += 1\n return f\"t_{self._last_identifier}\"\n\n def buffer(self, frame: Frame) -> None:\n \"\"\"Enable buffering for the frame from that point onwards.\"\"\"\n frame.buffer = self.temporary_identifier()\n self.writeline(f\"{frame.buffer} = []\")\n\n def return_buffer_contents(\n self, frame: Frame, force_unescaped: bool = False\n ) -> None:\n \"\"\"Return the buffer contents of the frame.\"\"\"\n if not force_unescaped:\n if frame.eval_ctx.volatile:\n self.writeline(\"if context.eval_ctx.autoescape:\")\n self.indent()\n self.writeline(f\"return Markup(concat({frame.buffer}))\")\n self.outdent()\n self.writeline(\"else:\")\n self.indent()\n self.writeline(f\"return concat({frame.buffer})\")\n self.outdent()\n return\n elif frame.eval_ctx.autoescape:\n self.writeline(f\"return Markup(concat({frame.buffer}))\")\n return\n self.writeline(f\"return concat({frame.buffer})\")\n\n def indent(self) -> None:\n \"\"\"Indent by one.\"\"\"\n self._indentation += 1\n\n def outdent(self, step: int = 1) -> None:\n \"\"\"Outdent by step.\"\"\"\n self._indentation -= step\n\n def start_write(self, frame: Frame, node: nodes.Node | None = None) -> None:\n \"\"\"Yield or write into the frame buffer.\"\"\"\n if frame.buffer is None:\n self.writeline(\"yield \", node)\n else:\n self.writeline(f\"{frame.buffer}.append(\", node)\n\n def end_write(self, frame: Frame) -> None:\n \"\"\"End the writing process started by `start_write`.\"\"\"\n if frame.buffer is not None:\n self.write(\")\")\n\n def simple_write(\n self, s: str, frame: Frame, node: nodes.Node | None = None\n ) -> None:\n \"\"\"Simple shortcut for start_write + write + end_write.\"\"\"\n self.start_write(frame, node)\n self.write(s)\n self.end_write(frame)\n\n def blockvisit(self, nodes: t.Iterable[nodes.Node], frame: Frame) -> None:\n \"\"\"Visit a list of nodes as block in a frame. If the current frame\n is no buffer a dummy ``if 0: yield None`` is written automatically.\n \"\"\"\n try:\n self.writeline(\"pass\")\n for node in nodes:\n self.visit(node, frame)\n except CompilerExit:\n pass\n\n def write(self, x: str) -> None:\n \"\"\"Write a string into the output stream.\"\"\"\n if self._new_lines:\n if not self._first_write:\n self.stream.write(\"\\n\" * self._new_lines)\n self.code_lineno += self._new_lines\n if self._write_debug_info is not None:\n self.debug_info.append((self._write_debug_info, self.code_lineno))\n self._write_debug_info = None\n self._first_write = False\n self.stream.write(\" \" * self._indentation)\n self._new_lines = 0\n self.stream.write(x)\n\n def writeline(self, x: str, node: nodes.Node | None = None, extra: int = 0) -> None:\n \"\"\"Combination of newline and write.\"\"\"\n self.newline(node, extra)\n self.write(x)\n\n def newline(self, node: nodes.Node | None = None, extra: int = 0) -> None:\n \"\"\"Add one or more newlines before the next write.\"\"\"\n self._new_lines = max(self._new_lines, 1 + extra)\n if node is not None and node.lineno != self._last_line:\n self._write_debug_info = node.lineno\n self._last_line = node.lineno\n\n def signature(\n self,\n node: nodes.Call | nodes.Filter | nodes.Test,\n frame: Frame,\n extra_kwargs: t.Mapping[str, t.Any] | None = None,\n ) -> None:\n \"\"\"Writes a function call to the stream for the current node.\n A leading comma is added automatically. The extra keyword\n arguments may not include python keywords otherwise a syntax\n error could occur. The extra keyword arguments should be given\n as python dict.\n \"\"\"\n # if any of the given keyword arguments is a python keyword\n # we have to make sure that no invalid call is created.\n kwarg_workaround = any(\n is_python_keyword(t.cast(str, k))\n for k in chain((x.key for x in node.kwargs), extra_kwargs or ())\n )\n\n for arg in node.args:\n self.write(\", \")\n self.visit(arg, frame)\n\n if not kwarg_workaround:\n for kwarg in node.kwargs:\n self.write(\", \")\n self.visit(kwarg, frame)\n if extra_kwargs is not None:\n for key, value in extra_kwargs.items():\n self.write(f\", {key}={value}\")\n if node.dyn_args:\n self.write(\", *\")\n self.visit(node.dyn_args, frame)\n\n if kwarg_workaround:\n if node.dyn_kwargs is not None:\n self.write(\", **dict({\")\n else:\n self.write(\", **{\")\n for kwarg in node.kwargs:\n self.write(f\"{kwarg.key!r}: \")\n self.visit(kwarg.value, frame)\n self.write(\", \")\n if extra_kwargs is not None:\n for key, value in extra_kwargs.items():\n self.write(f\"{key!r}: {value}, \")\n if node.dyn_kwargs is not None:\n self.write(\"}, **\")\n self.visit(node.dyn_kwargs, frame)\n self.write(\")\")\n else:\n self.write(\"}\")\n\n elif node.dyn_kwargs is not None:\n self.write(\", **\")\n self.visit(node.dyn_kwargs, frame)\n\n def pull_dependencies(self, nodes: t.Iterable[nodes.Node]) -> None:\n \"\"\"Find all filter and test names used in the template and\n assign them to variables in the compiled namespace. Checking\n that the names are registered with the environment is done when\n compiling the Filter and Test nodes. If the node is in an If or\n CondExpr node, the check is done at runtime instead.\n\n .. versionchanged:: 3.0\n Filters and tests in If and CondExpr nodes are checked at\n runtime instead of compile time.\n \"\"\"\n visitor = DependencyFinderVisitor()\n\n for node in nodes:\n visitor.visit(node)\n\n for id_map, names, dependency in (\n (self.filters, visitor.filters, \"filters\"),\n (\n self.tests,\n visitor.tests,\n \"tests\",\n ),\n ):\n for name in sorted(names):\n if name not in id_map:\n id_map[name] = self.temporary_identifier()\n\n # add check during runtime that dependencies used inside of executed\n # blocks are defined, as this step may be skipped during compile time\n self.writeline(\"try:\")\n self.indent()\n self.writeline(f\"{id_map[name]} = environment.{dependency}[{name!r}]\")\n self.outdent()\n self.writeline(\"except KeyError:\")\n self.indent()\n self.writeline(\"@internalcode\")\n self.writeline(f\"def {id_map[name]}(*unused):\")\n self.indent()\n self.writeline(\n f'raise TemplateRuntimeError(\"No {dependency[:-1]}'\n f' named {name!r} found.\")'\n )\n self.outdent()\n self.outdent()\n\n def enter_frame(self, frame: Frame) -> None:\n undefs = []\n for target, (action, param) in frame.symbols.loads.items():\n if action == VAR_LOAD_PARAMETER:\n pass\n elif action == VAR_LOAD_RESOLVE:\n self.writeline(f\"{target} = {self.get_resolve_func()}({param!r})\")\n elif action == VAR_LOAD_ALIAS:\n self.writeline(f\"{target} = {param}\")\n elif action == VAR_LOAD_UNDEFINED:\n undefs.append(target)\n else:\n raise NotImplementedError(\"unknown load instruction\")\n if undefs:\n self.writeline(f\"{' = '.join(undefs)} = missing\")\n\n def leave_frame(self, frame: Frame, with_python_scope: bool = False) -> None:\n if not with_python_scope:\n undefs = []\n for target in frame.symbols.loads:\n undefs.append(target)\n if undefs:\n self.writeline(f\"{' = '.join(undefs)} = missing\")\n\n def choose_async(self, async_value: str = \"async \", sync_value: str = \"\") -> str:\n return async_value if self.environment.is_async else sync_value\n\n def func(self, name: str) -> str:\n return f\"{self.choose_async()}def {name}\"\n\n def macro_body(\n self, node: nodes.Macro | nodes.CallBlock, frame: Frame\n ) -> tuple[Frame, MacroRef]:\n \"\"\"Dump the function def of a macro or call block.\"\"\"\n frame = frame.inner()\n frame.symbols.analyze_node(node)\n macro_ref = MacroRef(node)\n\n explicit_caller = None\n skip_special_params = set()\n args = []\n\n for idx, arg in enumerate(node.args):\n if arg.name == \"caller\":\n explicit_caller = idx\n if arg.name in (\"kwargs\", \"varargs\"):\n skip_special_params.add(arg.name)\n args.append(frame.symbols.ref(arg.name))\n\n undeclared = find_undeclared(node.body, (\"caller\", \"kwargs\", \"varargs\"))\n\n if \"caller\" in undeclared:\n # In older Jinja versions there was a bug that allowed caller\n # to retain the special behavior even if it was mentioned in\n # the argument list. However thankfully this was only really\n # working if it was the last argument. So we are explicitly\n # checking this now and error out if it is anywhere else in\n # the argument list.\n if explicit_caller is not None:\n try:\n node.defaults[explicit_caller - len(node.args)]\n except IndexError:\n self.fail(\n \"When defining macros or call blocks the \"\n 'special \"caller\" argument must be omitted '\n \"or be given a default.\",\n node.lineno,\n )\n else:\n args.append(frame.symbols.declare_parameter(\"caller\"))\n macro_ref.accesses_caller = True\n if \"kwargs\" in undeclared and \"kwargs\" not in skip_special_params:\n args.append(frame.symbols.declare_parameter(\"kwargs\"))\n macro_ref.accesses_kwargs = True\n if \"varargs\" in undeclared and \"varargs\" not in skip_special_params:\n args.append(frame.symbols.declare_parameter(\"varargs\"))\n macro_ref.accesses_varargs = True\n\n # macros are delayed, they never require output checks\n frame.require_output_check = False\n frame.symbols.analyze_node(node)\n self.writeline(f\"{self.func('macro')}({', '.join(args)}):\", node)\n self.indent()\n\n self.buffer(frame)\n self.enter_frame(frame)\n\n self.push_parameter_definitions(frame)\n for idx, arg in enumerate(node.args):\n ref = frame.symbols.ref(arg.name)\n self.writeline(f\"if {ref} is missing:\")\n self.indent()\n try:\n default = node.defaults[idx - len(node.args)]\n except IndexError:\n self.writeline(\n f'{ref} = undefined(\"parameter {arg.name!r} was not provided\",'\n f\" name={arg.name!r})\"\n )\n else:\n self.writeline(f\"{ref} = \")\n self.visit(default, frame)\n self.mark_parameter_stored(ref)\n self.outdent()\n self.pop_parameter_definitions()\n\n self.blockvisit(node.body, frame)\n self.return_buffer_contents(frame, force_unescaped=True)\n self.leave_frame(frame, with_python_scope=True)\n self.outdent()\n\n return frame, macro_ref\n\n def macro_def(self, macro_ref: MacroRef, frame: Frame) -> None:\n \"\"\"Dump the macro definition for the def created by macro_body.\"\"\"\n arg_tuple = \", \".join(repr(x.name) for x in macro_ref.node.args)\n name = getattr(macro_ref.node, \"name\", None)\n if len(macro_ref.node.args) == 1:\n arg_tuple += \",\"\n self.write(\n f\"Macro(environment, macro, {name!r}, ({arg_tuple}),\"\n f\" {macro_ref.accesses_kwargs!r}, {macro_ref.accesses_varargs!r},\"\n f\" {macro_ref.accesses_caller!r}, context.eval_ctx.autoescape)\"\n )\n\n def position(self, node: nodes.Node) -> str:\n \"\"\"Return a human readable position for the node.\"\"\"\n rv = f\"line {node.lineno}\"\n if self.name is not None:\n rv = f\"{rv} in {self.name!r}\"\n return rv\n\n def dump_local_context(self, frame: Frame) -> str:\n items_kv = \", \".join(\n f\"{name!r}: {target}\"\n for name, target in frame.symbols.dump_stores().items()\n )\n return f\"{{{items_kv}}}\"\n\n def write_commons(self) -> None:\n \"\"\"Writes a common preamble that is used by root and block functions.\n Primarily this sets up common local helpers and enforces a generator\n through a dead branch.\n \"\"\"\n self.writeline(\"resolve = context.resolve_or_missing\")\n self.writeline(\"undefined = environment.undefined\")\n self.writeline(\"concat = environment.concat\")\n # always use the standard Undefined class for the implicit else of\n # conditional expressions\n self.writeline(\"cond_expr_undefined = Undefined\")\n self.writeline(\"if 0: yield None\")\n\n def push_parameter_definitions(self, frame: Frame) -> None:\n \"\"\"Pushes all parameter targets from the given frame into a local\n stack that permits tracking of yet to be assigned parameters. In\n particular this enables the optimization from `visit_Name` to skip\n undefined expressions for parameters in macros as macros can reference\n otherwise unbound parameters.\n \"\"\"\n self._param_def_block.append(frame.symbols.dump_param_targets())\n\n def pop_parameter_definitions(self) -> None:\n \"\"\"Pops the current parameter definitions set.\"\"\"\n self._param_def_block.pop()\n\n def mark_parameter_stored(self, target: str) -> None:\n \"\"\"Marks a parameter in the current parameter definitions as stored.\n This will skip the enforced undefined checks.\n \"\"\"\n if self._param_def_block:\n self._param_def_block[-1].discard(target)\n\n def push_context_reference(self, target: str) -> None:\n self._context_reference_stack.append(target)\n\n def pop_context_reference(self) -> None:\n self._context_reference_stack.pop()\n\n def get_context_ref(self) -> str:\n return self._context_reference_stack[-1]\n\n def get_resolve_func(self) -> str:\n target = self._context_reference_stack[-1]\n if target == \"context\":\n return \"resolve\"\n return f\"{target}.resolve\"\n\n def derive_context(self, frame: Frame) -> str:\n return f\"{self.get_context_ref()}.derived({self.dump_local_context(frame)})\"\n\n def parameter_is_undeclared(self, target: str) -> bool:\n \"\"\"Checks if a given target is an undeclared parameter.\"\"\"\n if not self._param_def_block:\n return False\n return target in self._param_def_block[-1]\n\n def push_assign_tracking(self) -> None:\n \"\"\"Pushes a new layer for assignment tracking.\"\"\"\n self._assign_stack.append(set())\n\n def pop_assign_tracking(self, frame: Frame) -> None:\n \"\"\"Pops the topmost level for assignment tracking and updates the\n context variables if necessary.\n \"\"\"\n vars = self._assign_stack.pop()\n if (\n not frame.block_frame\n and not frame.loop_frame\n and not frame.toplevel\n or not vars\n ):\n return\n public_names = [x for x in vars if x[:1] != \"_\"]\n if len(vars) == 1:\n name = next(iter(vars))\n ref = frame.symbols.ref(name)\n if frame.loop_frame:\n self.writeline(f\"_loop_vars[{name!r}] = {ref}\")\n return\n if frame.block_frame:\n self.writeline(f\"_block_vars[{name!r}] = {ref}\")\n return\n self.writeline(f\"context.vars[{name!r}] = {ref}\")\n else:\n if frame.loop_frame:\n self.writeline(\"_loop_vars.update({\")\n elif frame.block_frame:\n self.writeline(\"_block_vars.update({\")\n else:\n self.writeline(\"context.vars.update({\")\n for idx, name in enumerate(sorted(vars)):\n if idx:\n self.write(\", \")\n ref = frame.symbols.ref(name)\n self.write(f\"{name!r}: {ref}\")\n self.write(\"})\")\n if not frame.block_frame and not frame.loop_frame and public_names:\n if len(public_names) == 1:\n self.writeline(f\"context.exported_vars.add({public_names[0]!r})\")\n else:\n names_str = \", \".join(map(repr, sorted(public_names)))\n self.writeline(f\"context.exported_vars.update(({names_str}))\")\n\n # -- Statement Visitors\n\n def visit_Template(self, node: nodes.Template, frame: Frame | None = None) -> None:\n assert frame is None, \"no root frame allowed\"\n eval_ctx = EvalContext(self.environment, self.name)\n\n from .runtime import async_exported\n from .runtime import exported\n\n if self.environment.is_async:\n exported_names = sorted(exported + async_exported)\n else:\n exported_names = sorted(exported)\n\n self.writeline(\"from jinja2.runtime import \" + \", \".join(exported_names))\n\n # if we want a deferred initialization we cannot move the\n # environment into a local name\n envenv = \"\" if self.defer_init else \", environment=environment\"\n\n # do we have an extends tag at all? If not, we can save some\n # overhead by just not processing any inheritance code.\n have_extends = node.find(nodes.Extends) is not None\n\n # find all blocks\n for block in node.find_all(nodes.Block):\n if block.name in self.blocks:\n self.fail(f\"block {block.name!r} defined twice\", block.lineno)\n self.blocks[block.name] = block\n\n # find all imports and import them\n for import_ in node.find_all(nodes.ImportedName):\n if import_.importname not in self.import_aliases:\n imp = import_.importname\n self.import_aliases[imp] = alias = self.temporary_identifier()\n if \".\" in imp:\n module, obj = imp.rsplit(\".\", 1)\n self.writeline(f\"from {module} import {obj} as {alias}\")\n else:\n self.writeline(f\"import {imp} as {alias}\")\n\n # add the load name\n self.writeline(f\"name = {self.name!r}\")\n\n # generate the root render function.\n self.writeline(\n f\"{self.func('root')}(context, missing=missing{envenv}):\", extra=1\n )\n self.indent()\n self.write_commons()\n\n # process the root\n frame = Frame(eval_ctx)\n if \"self\" in find_undeclared(node.body, (\"self\",)):\n ref = frame.symbols.declare_parameter(\"self\")\n self.writeline(f\"{ref} = TemplateReference(context)\")\n frame.symbols.analyze_node(node)\n frame.toplevel = frame.rootlevel = True\n frame.require_output_check = have_extends and not self.has_known_extends\n if have_extends:\n self.writeline(\"parent_template = None\")\n self.enter_frame(frame)\n self.pull_dependencies(node.body)\n self.blockvisit(node.body, frame)\n self.leave_frame(frame, with_python_scope=True)\n self.outdent()\n\n # make sure that the parent root is called.\n if have_extends:\n if not self.has_known_extends:\n self.indent()\n self.writeline(\"if parent_template is not None:\")\n self.indent()\n if not self.environment.is_async:\n self.writeline(\"yield from parent_template.root_render_func(context)\")\n else:\n self.writeline(\"agen = parent_template.root_render_func(context)\")\n self.writeline(\"try:\")\n self.indent()\n self.writeline(\"async for event in agen:\")\n self.indent()\n self.writeline(\"yield event\")\n self.outdent()\n self.outdent()\n self.writeline(\"finally: await agen.aclose()\")\n self.outdent(1 + (not self.has_known_extends))\n\n # at this point we now have the blocks collected and can visit them too.\n for name, block in self.blocks.items():\n self.writeline(\n f\"{self.func('block_' + name)}(context, missing=missing{envenv}):\",\n block,\n 1,\n )\n self.indent()\n self.write_commons()\n # It's important that we do not make this frame a child of the\n # toplevel template. This would cause a variety of\n # interesting issues with identifier tracking.\n block_frame = Frame(eval_ctx)\n block_frame.block_frame = True\n undeclared = find_undeclared(block.body, (\"self\", \"super\"))\n if \"self\" in undeclared:\n ref = block_frame.symbols.declare_parameter(\"self\")\n self.writeline(f\"{ref} = TemplateReference(context)\")\n if \"super\" in undeclared:\n ref = block_frame.symbols.declare_parameter(\"super\")\n self.writeline(f\"{ref} = context.super({name!r}, block_{name})\")\n block_frame.symbols.analyze_node(block)\n block_frame.block = name\n self.writeline(\"_block_vars = {}\")\n self.enter_frame(block_frame)\n self.pull_dependencies(block.body)\n self.blockvisit(block.body, block_frame)\n self.leave_frame(block_frame, with_python_scope=True)\n self.outdent()\n\n blocks_kv_str = \", \".join(f\"{x!r}: block_{x}\" for x in self.blocks)\n self.writeline(f\"blocks = {{{blocks_kv_str}}}\", extra=1)\n debug_kv_str = \"&\".join(f\"{k}={v}\" for k, v in self.debug_info)\n self.writeline(f\"debug_info = {debug_kv_str!r}\")\n\n def visit_Block(self, node: nodes.Block, frame: Frame) -> None:\n \"\"\"Call a block and register it for the template.\"\"\"\n level = 0\n if frame.toplevel:\n # if we know that we are a child template, there is no need to\n # check if we are one\n if self.has_known_extends:\n return\n if self.extends_so_far > 0:\n self.writeline(\"if parent_template is None:\")\n self.indent()\n level += 1\n\n if node.scoped:\n context = self.derive_context(frame)\n else:\n context = self.get_context_ref()\n\n if node.required:\n self.writeline(f\"if len(context.blocks[{node.name!r}]) <= 1:\", node)\n self.indent()\n self.writeline(\n f'raise TemplateRuntimeError(\"Required block {node.name!r} not found\")',\n node,\n )\n self.outdent()\n\n if not self.environment.is_async and frame.buffer is None:\n self.writeline(\n f\"yield from context.blocks[{node.name!r}][0]({context})\", node\n )\n else:\n self.writeline(f\"gen = context.blocks[{node.name!r}][0]({context})\")\n self.writeline(\"try:\")\n self.indent()\n self.writeline(\n f\"{self.choose_async()}for event in gen:\",\n node,\n )\n self.indent()\n self.simple_write(\"event\", frame)\n self.outdent()\n self.outdent()\n self.writeline(\n f\"finally: {self.choose_async('await gen.aclose()', 'gen.close()')}\"\n )\n\n self.outdent(level)\n\n def visit_Extends(self, node: nodes.Extends, frame: Frame) -> None:\n \"\"\"Calls the extender.\"\"\"\n if not frame.toplevel:\n self.fail(\"cannot use extend from a non top-level scope\", node.lineno)\n\n # if the number of extends statements in general is zero so\n # far, we don't have to add a check if something extended\n # the template before this one.\n if self.extends_so_far > 0:\n # if we have a known extends we just add a template runtime\n # error into the generated code. We could catch that at compile\n # time too, but i welcome it not to confuse users by throwing the\n # same error at different times just \"because we can\".\n if not self.has_known_extends:\n self.writeline(\"if parent_template is not None:\")\n self.indent()\n self.writeline('raise TemplateRuntimeError(\"extended multiple times\")')\n\n # if we have a known extends already we don't need that code here\n # as we know that the template execution will end here.\n if self.has_known_extends:\n raise CompilerExit()\n else:\n self.outdent()\n\n self.writeline(\"parent_template = environment.get_template(\", node)\n self.visit(node.template, frame)\n self.write(f\", {self.name!r})\")\n self.writeline(\"for name, parent_block in parent_template.blocks.items():\")\n self.indent()\n self.writeline(\"context.blocks.setdefault(name, []).append(parent_block)\")\n self.outdent()\n\n # if this extends statement was in the root level we can take\n # advantage of that information and simplify the generated code\n # in the top level from this point onwards\n if frame.rootlevel:\n self.has_known_extends = True\n\n # and now we have one more\n self.extends_so_far += 1\n\n def visit_Include(self, node: nodes.Include, frame: Frame) -> None:\n \"\"\"Handles includes.\"\"\"\n if node.ignore_missing:\n self.writeline(\"try:\")\n self.indent()\n\n func_name = \"get_or_select_template\"\n if isinstance(node.template, nodes.Const):\n if isinstance(node.template.value, str):\n func_name = \"get_template\"\n elif isinstance(node.template.value, (tuple, list)):\n func_name = \"select_template\"\n elif isinstance(node.template, (nodes.Tuple, nodes.List)):\n func_name = \"select_template\"\n\n self.writeline(f\"template = environment.{func_name}(\", node)\n self.visit(node.template, frame)\n self.write(f\", {self.name!r})\")\n if node.ignore_missing:\n self.outdent()\n self.writeline(\"except TemplateNotFound:\")\n self.indent()\n self.writeline(\"pass\")\n self.outdent()\n self.writeline(\"else:\")\n self.indent()\n\n def loop_body() -> None:\n self.indent()\n self.simple_write(\"event\", frame)\n self.outdent()\n\n if node.with_context:\n self.writeline(\n f\"gen = template.root_render_func(\"\n \"template.new_context(context.get_all(), True,\"\n f\" {self.dump_local_context(frame)}))\"\n )\n self.writeline(\"try:\")\n self.indent()\n self.writeline(f\"{self.choose_async()}for event in gen:\")\n loop_body()\n self.outdent()\n self.writeline(\n f\"finally: {self.choose_async('await gen.aclose()', 'gen.close()')}\"\n )\n elif self.environment.is_async:\n self.writeline(\n \"for event in (await template._get_default_module_async())\"\n \"._body_stream:\"\n )\n loop_body()\n else:\n self.writeline(\"yield from template._get_default_module()._body_stream\")\n\n if node.ignore_missing:\n self.outdent()\n\n def _import_common(\n self, node: nodes.Import | nodes.FromImport, frame: Frame\n ) -> None:\n self.write(f\"{self.choose_async('await ')}environment.get_template(\")\n self.visit(node.template, frame)\n self.write(f\", {self.name!r}).\")\n\n if node.with_context:\n f_name = f\"make_module{self.choose_async('_async')}\"\n self.write(\n f\"{f_name}(context.get_all(), True, {self.dump_local_context(frame)})\"\n )\n else:\n self.write(f\"_get_default_module{self.choose_async('_async')}(context)\")\n\n def visit_Import(self, node: nodes.Import, frame: Frame) -> None:\n \"\"\"Visit regular imports.\"\"\"\n self.writeline(f\"{frame.symbols.ref(node.target)} = \", node)\n if frame.toplevel:\n self.write(f\"context.vars[{node.target!r}] = \")\n\n self._import_common(node, frame)\n\n if frame.toplevel and not node.target.startswith(\"_\"):\n self.writeline(f\"context.exported_vars.discard({node.target!r})\")\n\n def visit_FromImport(self, node: nodes.FromImport, frame: Frame) -> None:\n \"\"\"Visit named imports.\"\"\"\n self.newline(node)\n self.write(\"included_template = \")\n self._import_common(node, frame)\n var_names = []\n discarded_names = []\n for name in node.names:\n if isinstance(name, tuple):\n name, alias = name\n else:\n alias = name\n self.writeline(\n f\"{frame.symbols.ref(alias)} =\"\n f\" getattr(included_template, {name!r}, missing)\"\n )\n self.writeline(f\"if {frame.symbols.ref(alias)} is missing:\")\n self.indent()\n # The position will contain the template name, and will be formatted\n # into a string that will be compiled into an f-string. Curly braces\n # in the name must be replaced with escapes so that they will not be\n # executed as part of the f-string.\n position = self.position(node).replace(\"{\", \"{{\").replace(\"}\", \"}}\")\n message = (\n \"the template {included_template.__name__!r}\"\n f\" (imported on {position})\"\n f\" does not export the requested name {name!r}\"\n )\n self.writeline(\n f\"{frame.symbols.ref(alias)} = undefined(f{message!r}, name={name!r})\"\n )\n self.outdent()\n if frame.toplevel:\n var_names.append(alias)\n if not alias.startswith(\"_\"):\n discarded_names.append(alias)\n\n if var_names:\n if len(var_names) == 1:\n name = var_names[0]\n self.writeline(f\"context.vars[{name!r}] = {frame.symbols.ref(name)}\")\n else:\n names_kv = \", \".join(\n f\"{name!r}: {frame.symbols.ref(name)}\" for name in var_names\n )\n self.writeline(f\"context.vars.update({{{names_kv}}})\")\n if discarded_names:\n if len(discarded_names) == 1:\n self.writeline(f\"context.exported_vars.discard({discarded_names[0]!r})\")\n else:\n names_str = \", \".join(map(repr, discarded_names))\n self.writeline(\n f\"context.exported_vars.difference_update(({names_str}))\"\n )\n\n def visit_For(self, node: nodes.For, frame: Frame) -> None:\n loop_frame = frame.inner()\n loop_frame.loop_frame = True\n test_frame = frame.inner()\n else_frame = frame.inner()\n\n # try to figure out if we have an extended loop. An extended loop\n # is necessary if the loop is in recursive mode if the special loop\n # variable is accessed in the body if the body is a scoped block.\n extended_loop = (\n node.recursive\n or \"loop\"\n in find_undeclared(node.iter_child_nodes(only=(\"body\",)), (\"loop\",))\n or any(block.scoped for block in node.find_all(nodes.Block))\n )\n\n loop_ref = None\n if extended_loop:\n loop_ref = loop_frame.symbols.declare_parameter(\"loop\")\n\n loop_frame.symbols.analyze_node(node, for_branch=\"body\")\n if node.else_:\n else_frame.symbols.analyze_node(node, for_branch=\"else\")\n\n if node.test:\n loop_filter_func = self.temporary_identifier()\n test_frame.symbols.analyze_node(node, for_branch=\"test\")\n self.writeline(f\"{self.func(loop_filter_func)}(fiter):\", node.test)\n self.indent()\n self.enter_frame(test_frame)\n self.writeline(self.choose_async(\"async for \", \"for \"))\n self.visit(node.target, loop_frame)\n self.write(\" in \")\n self.write(self.choose_async(\"auto_aiter(fiter)\", \"fiter\"))\n self.write(\":\")\n self.indent()\n self.writeline(\"if \", node.test)\n self.visit(node.test, test_frame)\n self.write(\":\")\n self.indent()\n self.writeline(\"yield \")\n self.visit(node.target, loop_frame)\n self.outdent(3)\n self.leave_frame(test_frame, with_python_scope=True)\n\n # if we don't have an recursive loop we have to find the shadowed\n # variables at that point. Because loops can be nested but the loop\n # variable is a special one we have to enforce aliasing for it.\n if node.recursive:\n self.writeline(\n f\"{self.func('loop')}(reciter, loop_render_func, depth=0):\", node\n )\n self.indent()\n self.buffer(loop_frame)\n\n # Use the same buffer for the else frame\n else_frame.buffer = loop_frame.buffer\n\n # make sure the loop variable is a special one and raise a template\n # assertion error if a loop tries to write to loop\n if extended_loop:\n self.writeline(f\"{loop_ref} = missing\")\n\n for name in node.find_all(nodes.Name):\n if name.ctx == \"store\" and name.name == \"loop\":\n self.fail(\n \"Can't assign to special loop variable in for-loop target\",\n name.lineno,\n )\n\n if node.else_:\n iteration_indicator = self.temporary_identifier()\n self.writeline(f\"{iteration_indicator} = 1\")\n\n self.writeline(self.choose_async(\"async for \", \"for \"), node)\n self.visit(node.target, loop_frame)\n if extended_loop:\n self.write(f\", {loop_ref} in {self.choose_async('Async')}LoopContext(\")\n else:\n self.write(\" in \")\n\n if node.test:\n self.write(f\"{loop_filter_func}(\")\n if node.recursive:\n self.write(\"reciter\")\n else:\n if self.environment.is_async and not extended_loop:\n self.write(\"auto_aiter(\")\n self.visit(node.iter, frame)\n if self.environment.is_async and not extended_loop:\n self.write(\")\")\n if node.test:\n self.write(\")\")\n\n if node.recursive:\n self.write(\", undefined, loop_render_func, depth):\")\n else:\n self.write(\", undefined):\" if extended_loop else \":\")\n\n self.indent()\n self.enter_frame(loop_frame)\n\n self.writeline(\"_loop_vars = {}\")\n self.blockvisit(node.body, loop_frame)\n if node.else_:\n self.writeline(f\"{iteration_indicator} = 0\")\n self.outdent()\n self.leave_frame(\n loop_frame, with_python_scope=node.recursive and not node.else_\n )\n\n if node.else_:\n self.writeline(f\"if {iteration_indicator}:\")\n self.indent()\n self.enter_frame(else_frame)\n self.blockvisit(node.else_, else_frame)\n self.leave_frame(else_frame)\n self.outdent()\n\n # if the node was recursive we have to return the buffer contents\n # and start the iteration code\n if node.recursive:\n self.return_buffer_contents(loop_frame)\n self.outdent()\n self.start_write(frame, node)\n self.write(f\"{self.choose_async('await ')}loop(\")\n if self.environment.is_async:\n self.write(\"auto_aiter(\")\n self.visit(node.iter, frame)\n if self.environment.is_async:\n self.write(\")\")\n self.write(\", loop)\")\n self.end_write(frame)\n\n # at the end of the iteration, clear any assignments made in the\n # loop from the top level\n if self._assign_stack:\n self._assign_stack[-1].difference_update(loop_frame.symbols.stores)\n\n def visit_If(self, node: nodes.If, frame: Frame) -> None:\n if_frame = frame.soft()\n self.writeline(\"if \", node)\n self.visit(node.test, if_frame)\n self.write(\":\")\n self.indent()\n self.blockvisit(node.body, if_frame)\n self.outdent()\n for elif_ in node.elif_:\n self.writeline(\"elif \", elif_)\n self.visit(elif_.test, if_frame)\n self.write(\":\")\n self.indent()\n self.blockvisit(elif_.body, if_frame)\n self.outdent()\n if node.else_:\n self.writeline(\"else:\")\n self.indent()\n self.blockvisit(node.else_, if_frame)\n self.outdent()\n\n def visit_Macro(self, node: nodes.Macro, frame: Frame) -> None:\n macro_frame, macro_ref = self.macro_body(node, frame)\n self.newline()\n if frame.toplevel:\n if not node.name.startswith(\"_\"):\n self.write(f\"context.exported_vars.add({node.name!r})\")\n self.writeline(f\"context.vars[{node.name!r}] = \")\n self.write(f\"{frame.symbols.ref(node.name)} = \")\n self.macro_def(macro_ref, macro_frame)\n\n def visit_CallBlock(self, node: nodes.CallBlock, frame: Frame) -> None:\n call_frame, macro_ref = self.macro_body(node, frame)\n self.writeline(\"caller = \")\n self.macro_def(macro_ref, call_frame)\n self.start_write(frame, node)\n self.visit_Call(node.call, frame, forward_caller=True)\n self.end_write(frame)\n\n def visit_FilterBlock(self, node: nodes.FilterBlock, frame: Frame) -> None:\n filter_frame = frame.inner()\n filter_frame.symbols.analyze_node(node)\n self.enter_frame(filter_frame)\n self.buffer(filter_frame)\n self.blockvisit(node.body, filter_frame)\n self.start_write(frame, node)\n self.visit_Filter(node.filter, filter_frame)\n self.end_write(frame)\n self.leave_frame(filter_frame)\n\n def visit_With(self, node: nodes.With, frame: Frame) -> None:\n with_frame = frame.inner()\n with_frame.symbols.analyze_node(node)\n self.enter_frame(with_frame)\n for target, expr in zip(node.targets, node.values, strict=False):\n self.newline()\n self.visit(target, with_frame)\n self.write(\" = \")\n self.visit(expr, frame)\n self.blockvisit(node.body, with_frame)\n self.leave_frame(with_frame)\n\n def visit_ExprStmt(self, node: nodes.ExprStmt, frame: Frame) -> None:\n self.newline(node)\n self.visit(node.node, frame)\n\n class _FinalizeInfo(t.NamedTuple):\n const: t.Callable[..., str] | None\n src: str | None\n\n @staticmethod\n def _default_finalize(value: t.Any) -> t.Any:\n \"\"\"The default finalize function if the environment isn't\n configured with one. Or, if the environment has one, this is\n called on that function's output for constants.\n \"\"\"\n return str(value)\n\n _finalize: _FinalizeInfo | None = None\n\n def _make_finalize(self) -> _FinalizeInfo:\n \"\"\"Build the finalize function to be used on constants and at\n runtime. Cached so it's only created once for all output nodes.\n\n Returns a ``namedtuple`` with the following attributes:\n\n ``const``\n A function to finalize constant data at compile time.\n\n ``src``\n Source code to output around nodes to be evaluated at\n runtime.\n \"\"\"\n if self._finalize is not None:\n return self._finalize\n\n finalize: t.Callable[..., t.Any] | None\n finalize = default = self._default_finalize\n src = None\n\n if self.environment.finalize:\n src = \"environment.finalize(\"\n env_finalize = self.environment.finalize\n pass_arg = {\n _PassArg.context: \"context\",\n _PassArg.eval_context: \"context.eval_ctx\",\n _PassArg.environment: \"environment\",\n }.get(\n _PassArg.from_obj(env_finalize) # type: ignore\n )\n finalize = None\n\n if pass_arg is None:\n\n def finalize(value: t.Any) -> t.Any: # noqa: F811\n return default(env_finalize(value))\n\n else:\n src = f\"{src}{pass_arg}, \"\n\n if pass_arg == \"environment\":\n\n def finalize(value: t.Any) -> t.Any: # noqa: F811\n return default(env_finalize(self.environment, value))\n\n self._finalize = self._FinalizeInfo(finalize, src)\n return self._finalize\n\n def _output_const_repr(self, group: t.Iterable[t.Any]) -> str:\n \"\"\"Given a group of constant values converted from ``Output``\n child nodes, produce a string to write to the template module\n source.\n \"\"\"\n return repr(concat(group))\n\n def _output_child_to_const(\n self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo\n ) -> str:\n \"\"\"Try to optimize a child of an ``Output`` node by trying to\n convert it to constant, finalized data at compile time.\n\n If :exc:`Impossible` is raised, the node is not constant and\n will be evaluated at runtime. Any other exception will also be\n evaluated at runtime for easier debugging.\n \"\"\"\n const = node.as_const(frame.eval_ctx)\n\n if frame.eval_ctx.autoescape:\n const = escape(const)\n\n # Template data doesn't go through finalize.\n if isinstance(node, nodes.TemplateData):\n return str(const)\n\n return finalize.const(const) # type: ignore\n\n def _output_child_pre(\n self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo\n ) -> None:\n \"\"\"Output extra source code before visiting a child of an\n ``Output`` node.\n \"\"\"\n if frame.eval_ctx.volatile:\n self.write(\"(escape if context.eval_ctx.autoescape else str)(\")\n elif frame.eval_ctx.autoescape:\n self.write(\"escape(\")\n else:\n self.write(\"str(\")\n\n if finalize.src is not None:\n self.write(finalize.src)\n\n def _output_child_post(\n self, node: nodes.Expr, frame: Frame, finalize: _FinalizeInfo\n ) -> None:\n \"\"\"Output extra source code after visiting a child of an\n ``Output`` node.\n \"\"\"\n self.write(\")\")\n\n if finalize.src is not None:\n self.write(\")\")\n\n def visit_Output(self, node: nodes.Output, frame: Frame) -> None:\n # If an extends is active, don't render outside a block.\n if frame.require_output_check:\n # A top-level extends is known to exist at compile time.\n if self.has_known_extends:\n return\n\n self.writeline(\"if parent_template is None:\")\n self.indent()\n\n finalize = self._make_finalize()\n body: list[list[t.Any] | nodes.Expr] = []\n\n # Evaluate constants at compile time if possible. Each item in\n # body will be either a list of static data or a node to be\n # evaluated at runtime.\n for child in node.nodes:\n try:\n if not (\n # If the finalize function requires runtime context,\n # constants can't be evaluated at compile time.\n finalize.const\n # Unless it's basic template data that won't be\n # finalized anyway.\n or isinstance(child, nodes.TemplateData)\n ):\n raise nodes.Impossible()\n\n const = self._output_child_to_const(child, frame, finalize)\n except (nodes.Impossible, Exception):\n # The node was not constant and needs to be evaluated at\n # runtime. Or another error was raised, which is easier\n # to debug at runtime.\n body.append(child)\n continue\n\n if body and isinstance(body[-1], list):\n body[-1].append(const)\n else:\n body.append([const])\n\n if frame.buffer is not None:\n if len(body) == 1:\n self.writeline(f\"{frame.buffer}.append(\")\n else:\n self.writeline(f\"{frame.buffer}.extend((\")\n\n self.indent()\n\n for item in body:\n if isinstance(item, list):\n # A group of constant data to join and output.\n val = self._output_const_repr(item)\n\n if frame.buffer is None:\n self.writeline(\"yield \" + val)\n else:\n self.writeline(val + \",\")\n else:\n if frame.buffer is None:\n self.writeline(\"yield \", item)\n else:\n self.newline(item)\n\n # A node to be evaluated at runtime.\n self._output_child_pre(item, frame, finalize)\n self.visit(item, frame)\n self._output_child_post(item, frame, finalize)\n\n if frame.buffer is not None:\n self.write(\",\")\n\n if frame.buffer is not None:\n self.outdent()\n self.writeline(\")\" if len(body) == 1 else \"))\")\n\n if frame.require_output_check:\n self.outdent()\n\n def visit_Assign(self, node: nodes.Assign, frame: Frame) -> None:\n self.push_assign_tracking()\n\n # ``a.b`` is allowed for assignment, and is parsed as an NSRef. However,\n # it is only valid if it references a Namespace object. Emit a check for\n # that for each ref here, before assignment code is emitted. This can't\n # be done in visit_NSRef as the ref could be in the middle of a tuple.\n seen_refs: set[str] = set()\n\n for nsref in node.find_all(nodes.NSRef):\n if nsref.name in seen_refs:\n # Only emit the check for each reference once, in case the same\n # ref is used multiple times in a tuple, `ns.a, ns.b = c, d`.\n continue\n\n seen_refs.add(nsref.name)\n ref = frame.symbols.ref(nsref.name)\n self.writeline(f\"if not isinstance({ref}, Namespace):\")\n self.indent()\n self.writeline(\n \"raise TemplateRuntimeError\"\n '(\"cannot assign attribute on non-namespace object\")'\n )\n self.outdent()\n\n self.newline(node)\n self.visit(node.target, frame)\n self.write(\" = \")\n self.visit(node.node, frame)\n self.pop_assign_tracking(frame)\n\n def visit_AssignBlock(self, node: nodes.AssignBlock, frame: Frame) -> None:\n self.push_assign_tracking()\n block_frame = frame.inner()\n # This is a special case. Since a set block always captures we\n # will disable output checks. This way one can use set blocks\n # toplevel even in extended templates.\n block_frame.require_output_check = False\n block_frame.symbols.analyze_node(node)\n self.enter_frame(block_frame)\n self.buffer(block_frame)\n self.blockvisit(node.body, block_frame)\n self.newline(node)\n self.visit(node.target, frame)\n self.write(\" = (Markup if context.eval_ctx.autoescape else identity)(\")\n if node.filter is not None:\n self.visit_Filter(node.filter, block_frame)\n else:\n self.write(f\"concat({block_frame.buffer})\")\n self.write(\")\")\n self.pop_assign_tracking(frame)\n self.leave_frame(block_frame)\n\n # -- Expression Visitors\n\n def visit_Name(self, node: nodes.Name, frame: Frame) -> None:\n if node.ctx == \"store\" and (\n frame.toplevel or frame.loop_frame or frame.block_frame\n ):\n if self._assign_stack:\n self._assign_stack[-1].add(node.name)\n ref = frame.symbols.ref(node.name)\n\n # If we are looking up a variable we might have to deal with the\n # case where it's undefined. We can skip that case if the load\n # instruction indicates a parameter which are always defined.\n if node.ctx == \"load\":\n load = frame.symbols.find_load(ref)\n if not (\n load is not None\n and load[0] == VAR_LOAD_PARAMETER\n and not self.parameter_is_undeclared(ref)\n ):\n self.write(\n f\"(undefined(name={node.name!r}) if {ref} is missing else {ref})\"\n )\n return\n\n self.write(ref)\n\n def visit_NSRef(self, node: nodes.NSRef, frame: Frame) -> None:\n # NSRef is a dotted assignment target a.b=c, but uses a[b]=c internally.\n # visit_Assign emits code to validate that each ref is to a Namespace\n # object only. That can't be emitted here as the ref could be in the\n # middle of a tuple assignment.\n ref = frame.symbols.ref(node.name)\n self.writeline(f\"{ref}[{node.attr!r}]\")\n\n def visit_Const(self, node: nodes.Const, frame: Frame) -> None:\n val = node.as_const(frame.eval_ctx)\n if isinstance(val, float):\n self.write(str(val))\n else:\n self.write(repr(val))\n\n def visit_TemplateData(self, node: nodes.TemplateData, frame: Frame) -> None:\n try:\n self.write(repr(node.as_const(frame.eval_ctx)))\n except nodes.Impossible:\n self.write(\n f\"(Markup if context.eval_ctx.autoescape else identity)({node.data!r})\"\n )\n\n def visit_Tuple(self, node: nodes.Tuple, frame: Frame) -> None:\n self.write(\"(\")\n idx = -1\n for idx, item in enumerate(node.items):\n if idx:\n self.write(\", \")\n self.visit(item, frame)\n self.write(\",)\" if idx == 0 else \")\")\n\n def visit_List(self, node: nodes.List, frame: Frame) -> None:\n self.write(\"[\")\n for idx, item in enumerate(node.items):\n if idx:\n self.write(\", \")\n self.visit(item, frame)\n self.write(\"]\")\n\n def visit_Dict(self, node: nodes.Dict, frame: Frame) -> None:\n self.write(\"{\")\n for idx, item in enumerate(node.items):\n if idx:\n self.write(\", \")\n self.visit(item.key, frame)\n self.write(\": \")\n self.visit(item.value, frame)\n self.write(\"}\")\n\n visit_Add = _make_binop(\"+\")\n visit_Sub = _make_binop(\"-\")\n visit_Mul = _make_binop(\"*\")\n visit_Div = _make_binop(\"/\")\n visit_FloorDiv = _make_binop(\"//\")\n visit_Pow = _make_binop(\"**\")\n visit_Mod = _make_binop(\"%\")\n visit_And = _make_binop(\"and\")\n visit_Or = _make_binop(\"or\")\n visit_Pos = _make_unop(\"+\")\n visit_Neg = _make_unop(\"-\")\n visit_Not = _make_unop(\"not \")\n\n @optimizeconst\n def visit_Concat(self, node: nodes.Concat, frame: Frame) -> None:\n if frame.eval_ctx.volatile:\n func_name = \"(markup_join if context.eval_ctx.volatile else str_join)\"\n elif frame.eval_ctx.autoescape:\n func_name = \"markup_join\"\n else:\n func_name = \"str_join\"\n self.write(f\"{func_name}((\")\n for arg in node.nodes:\n self.visit(arg, frame)\n self.write(\", \")\n self.write(\"))\")\n\n @optimizeconst\n def visit_Compare(self, node: nodes.Compare, frame: Frame) -> None:\n self.write(\"(\")\n self.visit(node.expr, frame)\n for op in node.ops:\n self.visit(op, frame)\n self.write(\")\")\n\n def visit_Operand(self, node: nodes.Operand, frame: Frame) -> None:\n self.write(f\" {operators[node.op]} \")\n self.visit(node.expr, frame)\n\n @optimizeconst\n def visit_Getattr(self, node: nodes.Getattr, frame: Frame) -> None:\n if self.environment.is_async:\n self.write(\"(await auto_await(\")\n\n self.write(\"environment.getattr(\")\n self.visit(node.node, frame)\n self.write(f\", {node.attr!r})\")\n\n if self.environment.is_async:\n self.write(\"))\")\n\n @optimizeconst\n def visit_Getitem(self, node: nodes.Getitem, frame: Frame) -> None:\n # slices bypass the environment getitem method.\n if isinstance(node.arg, nodes.Slice):\n self.visit(node.node, frame)\n self.write(\"[\")\n self.visit(node.arg, frame)\n self.write(\"]\")\n else:\n if self.environment.is_async:\n self.write(\"(await auto_await(\")\n\n self.write(\"environment.getitem(\")\n self.visit(node.node, frame)\n self.write(\", \")\n self.visit(node.arg, frame)\n self.write(\")\")\n\n if self.environment.is_async:\n self.write(\"))\")\n\n def visit_Slice(self, node: nodes.Slice, frame: Frame) -> None:\n if node.start is not None:\n self.visit(node.start, frame)\n self.write(\":\")\n if node.stop is not None:\n self.visit(node.stop, frame)\n if node.step is not None:\n self.write(\":\")\n self.visit(node.step, frame)\n\n @contextmanager\n def _filter_test_common(\n self, node: nodes.Filter | nodes.Test, frame: Frame, is_filter: bool\n ) -> t.Iterator[None]:\n if self.environment.is_async:\n self.write(\"(await auto_await(\")\n\n if is_filter:\n self.write(f\"{self.filters[node.name]}(\")\n func = self.environment.filters.get(node.name)\n else:\n self.write(f\"{self.tests[node.name]}(\")\n func = self.environment.tests.get(node.name)\n\n # When inside an If or CondExpr frame, allow the filter to be\n # undefined at compile time and only raise an error if it's\n # actually called at runtime. See pull_dependencies.\n if func is None and not frame.soft_frame:\n type_name = \"filter\" if is_filter else \"test\"\n self.fail(f\"No {type_name} named {node.name!r}.\", node.lineno)\n\n pass_arg = {\n _PassArg.context: \"context\",\n _PassArg.eval_context: \"context.eval_ctx\",\n _PassArg.environment: \"environment\",\n }.get(\n _PassArg.from_obj(func) # type: ignore\n )\n\n if pass_arg is not None:\n self.write(f\"{pass_arg}, \")\n\n # Back to the visitor function to handle visiting the target of\n # the filter or test.\n yield\n\n self.signature(node, frame)\n self.write(\")\")\n\n if self.environment.is_async:\n self.write(\"))\")\n\n @optimizeconst\n def visit_Filter(self, node: nodes.Filter, frame: Frame) -> None:\n with self._filter_test_common(node, frame, True):\n # if the filter node is None we are inside a filter block\n # and want to write to the current buffer\n if node.node is not None:\n self.visit(node.node, frame)\n elif frame.eval_ctx.volatile:\n self.write(\n f\"(Markup(concat({frame.buffer}))\"\n f\" if context.eval_ctx.autoescape else concat({frame.buffer}))\"\n )\n elif frame.eval_ctx.autoescape:\n self.write(f\"Markup(concat({frame.buffer}))\")\n else:\n self.write(f\"concat({frame.buffer})\")\n\n @optimizeconst\n def visit_Test(self, node: nodes.Test, frame: Frame) -> None:\n with self._filter_test_common(node, frame, False):\n self.visit(node.node, frame)\n\n @optimizeconst\n def visit_CondExpr(self, node: nodes.CondExpr, frame: Frame) -> None:\n frame = frame.soft()\n\n def write_expr2() -> None:\n if node.expr2 is not None:\n self.visit(node.expr2, frame)\n return\n\n self.write(\n f'cond_expr_undefined(\"the inline if-expression on'\n f\" {self.position(node)} evaluated to false and no else\"\n f' section was defined.\")'\n )\n\n self.write(\"(\")\n self.visit(node.expr1, frame)\n self.write(\" if \")\n self.visit(node.test, frame)\n self.write(\" else \")\n write_expr2()\n self.write(\")\")\n\n @optimizeconst\n def visit_Call(\n self, node: nodes.Call, frame: Frame, forward_caller: bool = False\n ) -> None:\n if self.environment.is_async:\n self.write(\"(await auto_await(\")\n if self.environment.sandboxed:\n self.write(\"environment.call(context, \")\n else:\n self.write(\"context.call(\")\n self.visit(node.node, frame)\n extra_kwargs = {\"caller\": \"caller\"} if forward_caller else None\n loop_kwargs = {\"_loop_vars\": \"_loop_vars\"} if frame.loop_frame else {}\n block_kwargs = {\"_block_vars\": \"_block_vars\"} if frame.block_frame else {}\n if extra_kwargs:\n extra_kwargs.update(loop_kwargs, **block_kwargs)\n elif loop_kwargs or block_kwargs:\n extra_kwargs = dict(loop_kwargs, **block_kwargs)\n self.signature(node, frame, extra_kwargs)\n self.write(\")\")\n if self.environment.is_async:\n self.write(\"))\")\n\n def visit_Keyword(self, node: nodes.Keyword, frame: Frame) -> None:\n self.write(node.key + \"=\")\n self.visit(node.value, frame)\n\n # -- Unused nodes for extensions\n\n def visit_MarkSafe(self, node: nodes.MarkSafe, frame: Frame) -> None:\n self.write(\"Markup(\")\n self.visit(node.expr, frame)\n self.write(\")\")\n\n def visit_MarkSafeIfAutoescape(\n self, node: nodes.MarkSafeIfAutoescape, frame: Frame\n ) -> None:\n self.write(\"(Markup if context.eval_ctx.autoescape else identity)(\")\n self.visit(node.expr, frame)\n self.write(\")\")\n\n def visit_EnvironmentAttribute(\n self, node: nodes.EnvironmentAttribute, frame: Frame\n ) -> None:\n self.write(\"environment.\" + node.name)\n\n def visit_ExtensionAttribute(\n self, node: nodes.ExtensionAttribute, frame: Frame\n ) -> None:\n self.write(f\"environment.extensions[{node.identifier!r}].{node.name}\")\n\n def visit_ImportedName(self, node: nodes.ImportedName, frame: Frame) -> None:\n self.write(self.import_aliases[node.importname])\n\n def visit_InternalName(self, node: nodes.InternalName, frame: Frame) -> None:\n self.write(node.name)\n\n def visit_ContextReference(\n self, node: nodes.ContextReference, frame: Frame\n ) -> None:\n self.write(\"context\")\n\n def visit_DerivedContextReference(\n self, node: nodes.DerivedContextReference, frame: Frame\n ) -> None:\n self.write(self.derive_context(frame))\n\n def visit_Continue(self, node: nodes.Continue, frame: Frame) -> None:\n self.writeline(\"continue\", node)\n\n def visit_Break(self, node: nodes.Break, frame: Frame) -> None:\n self.writeline(\"break\", node)\n\n def visit_Scope(self, node: nodes.Scope, frame: Frame) -> None:\n scope_frame = frame.inner()\n scope_frame.symbols.analyze_node(node)\n self.enter_frame(scope_frame)\n self.blockvisit(node.body, scope_frame)\n self.leave_frame(scope_frame)\n\n def visit_OverlayScope(self, node: nodes.OverlayScope, frame: Frame) -> None:\n ctx = self.temporary_identifier()\n self.writeline(f\"{ctx} = {self.derive_context(frame)}\")\n self.writeline(f\"{ctx}.vars = \")\n self.visit(node.context, frame)\n self.push_context_reference(ctx)\n\n scope_frame = frame.inner(isolated=True)\n scope_frame.symbols.analyze_node(node)\n self.enter_frame(scope_frame)\n self.blockvisit(node.body, scope_frame)\n self.leave_frame(scope_frame)\n self.pop_context_reference()\n\n def visit_EvalContextModifier(\n self, node: nodes.EvalContextModifier, frame: Frame\n ) -> None:\n for keyword in node.options:\n self.writeline(f\"context.eval_ctx.{keyword.key} = \")\n self.visit(keyword.value, frame)\n try:\n val = keyword.value.as_const(frame.eval_ctx)\n except nodes.Impossible:\n frame.eval_ctx.volatile = True\n else:\n setattr(frame.eval_ctx, keyword.key, val)\n\n def visit_ScopedEvalContextModifier(\n self, node: nodes.ScopedEvalContextModifier, frame: Frame\n ) -> None:\n old_ctx_name = self.temporary_identifier()\n saved_ctx = frame.eval_ctx.save()\n self.writeline(f\"{old_ctx_name} = context.eval_ctx.save()\")\n self.visit_EvalContextModifier(node, frame)\n for child in node.body:\n self.visit(child, frame)\n frame.eval_ctx.revert(saved_ctx)\n self.writeline(f\"context.eval_ctx.revert({old_ctx_name})\")\n"
},
{
"path": "src/jinja2/constants.py",
"content": "#: list of lorem ipsum words used by the lipsum() helper function\nLOREM_IPSUM_WORDS = \"\"\"\\\na ac accumsan ad adipiscing aenean aliquam aliquet amet ante aptent arcu at\nauctor augue bibendum blandit class commodo condimentum congue consectetuer\nconsequat conubia convallis cras cubilia cum curabitur curae cursus dapibus\ndiam dictum dictumst dignissim dis dolor donec dui duis egestas eget eleifend\nelementum elit enim erat eros est et etiam eu euismod facilisi facilisis fames\nfaucibus felis fermentum feugiat fringilla fusce gravida habitant habitasse hac\nhendrerit hymenaeos iaculis id imperdiet in inceptos integer interdum ipsum\njusto lacinia lacus laoreet lectus leo libero ligula litora lobortis lorem\nluctus maecenas magna magnis malesuada massa mattis mauris metus mi molestie\nmollis montes morbi mus nam nascetur natoque nec neque netus nibh nisi nisl non\nnonummy nostra nulla nullam nunc odio orci ornare parturient pede pellentesque\npenatibus per pharetra phasellus placerat platea porta porttitor posuere\npotenti praesent pretium primis proin pulvinar purus quam quis quisque rhoncus\nridiculus risus rutrum sagittis sapien scelerisque sed sem semper senectus sit\nsociis sociosqu sodales sollicitudin suscipit suspendisse taciti tellus tempor\ntempus tincidunt torquent tortor tristique turpis ullamcorper ultrices\nultricies urna ut varius vehicula vel velit venenatis vestibulum vitae vivamus\nviverra volutpat vulputate\"\"\"\n"
},
{
"path": "src/jinja2/debug.py",
"content": "import sys\nimport typing as t\nfrom types import CodeType\nfrom types import TracebackType\n\nfrom .exceptions import TemplateSyntaxError\nfrom .utils import internal_code\nfrom .utils import missing\n\nif t.TYPE_CHECKING:\n from .runtime import Context\n\n\ndef rewrite_traceback_stack(source: str | None = None) -> BaseException:\n \"\"\"Rewrite the current exception to replace any tracebacks from\n within compiled template code with tracebacks that look like they\n came from the template source.\n\n This must be called within an ``except`` block.\n\n :param source: For ``TemplateSyntaxError``, the original source if\n known.\n :return: The original exception with the rewritten traceback.\n \"\"\"\n _, exc_value, tb = sys.exc_info()\n exc_value = t.cast(BaseException, exc_value)\n tb = t.cast(TracebackType, tb)\n\n if isinstance(exc_value, TemplateSyntaxError) and not exc_value.translated:\n exc_value.translated = True\n exc_value.source = source\n # Remove the old traceback, otherwise the frames from the\n # compiler still show up.\n exc_value.with_traceback(None)\n # Outside of runtime, so the frame isn't executing template\n # code, but it still needs to point at the template.\n tb = fake_traceback(\n exc_value, None, exc_value.filename or \"\", exc_value.lineno\n )\n else:\n # Skip the frame for the render function.\n tb = tb.tb_next\n\n stack = []\n\n # Build the stack of traceback object, replacing any in template\n # code with the source file and line information.\n while tb is not None:\n # Skip frames decorated with @internalcode. These are internal\n # calls that aren't useful in template debugging output.\n if tb.tb_frame.f_code in internal_code:\n tb = tb.tb_next\n continue\n\n template = tb.tb_frame.f_globals.get(\"__jinja_template__\")\n\n if template is not None:\n lineno = template.get_corresponding_lineno(tb.tb_lineno)\n fake_tb = fake_traceback(exc_value, tb, template.filename, lineno)\n stack.append(fake_tb)\n else:\n stack.append(tb)\n\n tb = tb.tb_next\n\n tb_next = None\n\n # Assign tb_next in reverse to avoid circular references.\n for tb in reversed(stack):\n tb.tb_next = tb_next\n tb_next = tb\n\n return exc_value.with_traceback(tb_next)\n\n\ndef fake_traceback( # type: ignore\n exc_value: BaseException, tb: TracebackType | None, filename: str, lineno: int\n) -> TracebackType:\n \"\"\"Produce a new traceback object that looks like it came from the\n template source instead of the compiled code. The filename, line\n number, and location name will point to the template, and the local\n variables will be the current template context.\n\n :param exc_value: The original exception to be re-raised to create\n the new traceback.\n :param tb: The original traceback to get the local variables and\n code info from.\n :param filename: The template filename.\n :param lineno: The line number in the template source.\n \"\"\"\n if tb is not None:\n # Replace the real locals with the context that would be\n # available at that point in the template.\n locals = get_template_locals(tb.tb_frame.f_locals)\n locals.pop(\"__jinja_exception__\", None)\n else:\n locals = {}\n\n globals = {\n \"__name__\": filename,\n \"__file__\": filename,\n \"__jinja_exception__\": exc_value,\n }\n # Raise an exception at the correct line number.\n code: CodeType = compile(\n \"\\n\" * (lineno - 1) + \"raise __jinja_exception__\", filename, \"exec\"\n )\n\n # Build a new code object that points to the template file and\n # replaces the location with a block name.\n location = \"template\"\n\n if tb is not None:\n function = tb.tb_frame.f_code.co_name\n\n if function == \"root\":\n location = \"top-level template code\"\n elif function.startswith(\"block_\"):\n location = f\"block {function[6:]!r}\"\n\n code = code.replace(co_name=location)\n\n # Execute the new code, which is guaranteed to raise, and return\n # the new traceback without this frame.\n try:\n exec(code, globals, locals)\n except BaseException:\n return sys.exc_info()[2].tb_next # type: ignore\n\n\ndef get_template_locals(real_locals: t.Mapping[str, t.Any]) -> dict[str, t.Any]:\n \"\"\"Based on the runtime locals, get the context that would be\n available at that point in the template.\n \"\"\"\n # Start with the current template context.\n ctx: Context | None = real_locals.get(\"context\")\n\n if ctx is not None:\n data: dict[str, t.Any] = ctx.get_all().copy()\n else:\n data = {}\n\n # Might be in a derived context that only sets local variables\n # rather than pushing a context. Local variables follow the scheme\n # l_depth_name. Find the highest-depth local that has a value for\n # each name.\n local_overrides: dict[str, tuple[int, t.Any]] = {}\n\n for name, value in real_locals.items():\n if not name.startswith(\"l_\") or value is missing:\n # Not a template variable, or no longer relevant.\n continue\n\n try:\n _, depth_str, name = name.split(\"_\", 2)\n depth = int(depth_str)\n except ValueError:\n continue\n\n cur_depth = local_overrides.get(name, (-1,))[0]\n\n if cur_depth < depth:\n local_overrides[name] = (depth, value)\n\n # Modify the context with any derived context.\n for name, (_, value) in local_overrides.items():\n if value is missing:\n data.pop(name, None)\n else:\n data[name] = value\n\n return data\n"
},
{
"path": "src/jinja2/defaults.py",
"content": "import typing as t\n\nfrom .filters import FILTERS as DEFAULT_FILTERS # noqa: F401\nfrom .tests import TESTS as DEFAULT_TESTS # noqa: F401\nfrom .utils import Cycler\nfrom .utils import generate_lorem_ipsum\nfrom .utils import Joiner\nfrom .utils import Namespace\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n# defaults for the parser / lexer\nBLOCK_START_STRING = \"{%\"\nBLOCK_END_STRING = \"%}\"\nVARIABLE_START_STRING = \"{{\"\nVARIABLE_END_STRING = \"}}\"\nCOMMENT_START_STRING = \"{#\"\nCOMMENT_END_STRING = \"#}\"\nLINE_STATEMENT_PREFIX: str | None = None\nLINE_COMMENT_PREFIX: str | None = None\nTRIM_BLOCKS = False\nLSTRIP_BLOCKS = False\nNEWLINE_SEQUENCE: \"te.Literal['\\\\n', '\\\\r\\\\n', '\\\\r']\" = \"\\n\"\nKEEP_TRAILING_NEWLINE = False\n\n# default filters, tests and namespace\n\nDEFAULT_NAMESPACE = {\n \"range\": range,\n \"dict\": dict,\n \"lipsum\": generate_lorem_ipsum,\n \"cycler\": Cycler,\n \"joiner\": Joiner,\n \"namespace\": Namespace,\n}\n\n# default policies\nDEFAULT_POLICIES: dict[str, t.Any] = {\n \"compiler.ascii_str\": True,\n \"urlize.rel\": \"noopener\",\n \"urlize.target\": None,\n \"urlize.extra_schemes\": None,\n \"truncate.leeway\": 5,\n \"json.dumps_function\": None,\n \"json.dumps_kwargs\": {\"sort_keys\": True},\n \"ext.i18n.trimmed\": False,\n}\n"
},
{
"path": "src/jinja2/environment.py",
"content": "\"\"\"Classes for managing templates and their runtime and compile time\noptions.\n\"\"\"\n\nimport os\nimport typing\nimport typing as t\nimport weakref\nfrom collections import ChainMap\nfrom contextlib import aclosing\nfrom functools import lru_cache\nfrom functools import partial\nfrom functools import reduce\nfrom types import CodeType\n\nfrom markupsafe import Markup\n\nfrom . import nodes\nfrom .compiler import CodeGenerator\nfrom .compiler import generate\nfrom .defaults import BLOCK_END_STRING\nfrom .defaults import BLOCK_START_STRING\nfrom .defaults import COMMENT_END_STRING\nfrom .defaults import COMMENT_START_STRING\nfrom .defaults import DEFAULT_FILTERS # type: ignore[attr-defined]\nfrom .defaults import DEFAULT_NAMESPACE\nfrom .defaults import DEFAULT_POLICIES\nfrom .defaults import DEFAULT_TESTS # type: ignore[attr-defined]\nfrom .defaults import KEEP_TRAILING_NEWLINE\nfrom .defaults import LINE_COMMENT_PREFIX\nfrom .defaults import LINE_STATEMENT_PREFIX\nfrom .defaults import LSTRIP_BLOCKS\nfrom .defaults import NEWLINE_SEQUENCE\nfrom .defaults import TRIM_BLOCKS\nfrom .defaults import VARIABLE_END_STRING\nfrom .defaults import VARIABLE_START_STRING\nfrom .exceptions import TemplateNotFound\nfrom .exceptions import TemplateRuntimeError\nfrom .exceptions import TemplatesNotFound\nfrom .exceptions import TemplateSyntaxError\nfrom .exceptions import UndefinedError\nfrom .lexer import get_lexer\nfrom .lexer import Lexer\nfrom .lexer import TokenStream\nfrom .nodes import EvalContext\nfrom .parser import Parser\nfrom .runtime import Context\nfrom .runtime import new_context\nfrom .runtime import Undefined\nfrom .utils import _PassArg\nfrom .utils import concat\nfrom .utils import consume\nfrom .utils import import_string\nfrom .utils import internalcode\nfrom .utils import LRUCache\nfrom .utils import missing\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n from .bccache import BytecodeCache\n from .ext import Extension\n from .loaders import BaseLoader\n\n_env_bound = t.TypeVar(\"_env_bound\", bound=\"Environment\")\n\n\n# for direct template usage we have up to ten living environments\n@lru_cache(maxsize=10)\ndef get_spontaneous_environment(cls: type[_env_bound], *args: t.Any) -> _env_bound:\n \"\"\"Return a new spontaneous environment. A spontaneous environment\n is used for templates created directly rather than through an\n existing environment.\n\n :param cls: Environment class to create.\n :param args: Positional arguments passed to environment.\n \"\"\"\n env = cls(*args)\n env.shared = True\n return env\n\n\ndef create_cache(\n size: int,\n) -> t.MutableMapping[tuple[\"weakref.ref[BaseLoader]\", str], \"Template\"] | None:\n \"\"\"Return the cache class for the given size.\"\"\"\n if size == 0:\n return None\n\n if size < 0:\n return {}\n\n return LRUCache(size) # type: ignore\n\n\ndef copy_cache(\n cache: t.MutableMapping[tuple[\"weakref.ref[BaseLoader]\", str], \"Template\"] | None,\n) -> t.MutableMapping[tuple[\"weakref.ref[BaseLoader]\", str], \"Template\"] | None:\n \"\"\"Create an empty copy of the given cache.\"\"\"\n if cache is None:\n return None\n\n if type(cache) is dict: # noqa E721\n return {}\n\n return LRUCache(cache.capacity) # type: ignore\n\n\ndef load_extensions(\n environment: \"Environment\",\n extensions: t.Sequence[str | type[\"Extension\"]],\n) -> dict[str, \"Extension\"]:\n \"\"\"Load the extensions from the list and bind it to the environment.\n Returns a dict of instantiated extensions.\n \"\"\"\n result = {}\n\n for extension in extensions:\n if isinstance(extension, str):\n extension = t.cast(type[\"Extension\"], import_string(extension))\n\n result[extension.identifier] = extension(environment)\n\n return result\n\n\ndef _environment_config_check(environment: _env_bound) -> _env_bound:\n \"\"\"Perform a sanity check on the environment.\"\"\"\n assert issubclass(environment.undefined, Undefined), (\n \"'undefined' must be a subclass of 'jinja2.Undefined'.\"\n )\n assert (\n environment.block_start_string\n != environment.variable_start_string\n != environment.comment_start_string\n ), \"block, variable and comment start strings must be different.\"\n assert environment.newline_sequence in {\n \"\\r\",\n \"\\r\\n\",\n \"\\n\",\n }, \"'newline_sequence' must be one of '\\\\n', '\\\\r\\\\n', or '\\\\r'.\"\n return environment\n\n\nclass Environment:\n r\"\"\"The core component of Jinja is the `Environment`. It contains\n important shared variables like configuration, filters, tests,\n globals and others. Instances of this class may be modified if\n they are not shared and if no template was loaded so far.\n Modifications on environments after the first template was loaded\n will lead to surprising effects and undefined behavior.\n\n Here are the possible initialization parameters:\n\n `block_start_string`\n The string marking the beginning of a block. Defaults to ``'{%'``.\n\n `block_end_string`\n The string marking the end of a block. Defaults to ``'%}'``.\n\n `variable_start_string`\n The string marking the beginning of a print statement.\n Defaults to ``'{{'``.\n\n `variable_end_string`\n The string marking the end of a print statement. Defaults to\n ``'}}'``.\n\n `comment_start_string`\n The string marking the beginning of a comment. Defaults to ``'{#'``.\n\n `comment_end_string`\n The string marking the end of a comment. Defaults to ``'#}'``.\n\n `line_statement_prefix`\n If given and a string, this will be used as prefix for line based\n statements. See also :ref:`line-statements`.\n\n `line_comment_prefix`\n If given and a string, this will be used as prefix for line based\n comments. See also :ref:`line-statements`.\n\n .. versionadded:: 2.2\n\n `trim_blocks`\n If this is set to ``True`` the first newline after a block is\n removed (block, not variable tag!). Defaults to `False`.\n\n `lstrip_blocks`\n If this is set to ``True`` leading spaces and tabs are stripped\n from the start of a line to a block. Defaults to `False`.\n\n `newline_sequence`\n The sequence that starts a newline. Must be one of ``'\\r'``,\n ``'\\n'`` or ``'\\r\\n'``. The default is ``'\\n'`` which is a\n useful default for Linux and OS X systems as well as web\n applications.\n\n `keep_trailing_newline`\n Preserve the trailing newline when rendering templates.\n The default is ``False``, which causes a single newline,\n if present, to be stripped from the end of the template.\n\n .. versionadded:: 2.7\n\n `extensions`\n List of Jinja extensions to use. This can either be import paths\n as strings or extension classes. For more information have a\n look at :ref:`the extensions documentation `.\n\n `optimized`\n should the optimizer be enabled? Default is ``True``.\n\n `undefined`\n :class:`Undefined` or a subclass of it that is used to represent\n undefined values in the template.\n\n `finalize`\n A callable that can be used to process the result of a variable\n expression before it is output. For example one can convert\n ``None`` implicitly into an empty string here.\n\n `autoescape`\n If set to ``True`` the XML/HTML autoescaping feature is enabled by\n default. For more details about autoescaping see\n :class:`~markupsafe.Markup`. As of Jinja 2.4 this can also\n be a callable that is passed the template name and has to\n return ``True`` or ``False`` depending on autoescape should be\n enabled by default.\n\n .. versionchanged:: 2.4\n `autoescape` can now be a function\n\n `loader`\n The template loader for this environment.\n\n `cache_size`\n The size of the cache. Per default this is ``400`` which means\n that if more than 400 templates are loaded the loader will clean\n out the least recently used template. If the cache size is set to\n ``0`` templates are recompiled all the time, if the cache size is\n ``-1`` the cache will not be cleaned.\n\n .. versionchanged:: 2.8\n The cache size was increased to 400 from a low 50.\n\n `auto_reload`\n Some loaders load templates from locations where the template\n sources may change (ie: file system or database). If\n ``auto_reload`` is set to ``True`` (default) every time a template is\n requested the loader checks if the source changed and if yes, it\n will reload the template. For higher performance it's possible to\n disable that.\n\n `bytecode_cache`\n If set to a bytecode cache object, this object will provide a\n cache for the internal Jinja bytecode so that templates don't\n have to be parsed if they were not changed.\n\n See :ref:`bytecode-cache` for more information.\n\n `enable_async`\n If set to true this enables async template execution which\n allows using async functions and generators.\n \"\"\"\n\n #: if this environment is sandboxed. Modifying this variable won't make\n #: the environment sandboxed though. For a real sandboxed environment\n #: have a look at jinja2.sandbox. This flag alone controls the code\n #: generation by the compiler.\n sandboxed = False\n\n #: True if the environment is just an overlay\n overlayed = False\n\n #: the environment this environment is linked to if it is an overlay\n linked_to: t.Optional[\"Environment\"] = None\n\n #: shared environments have this set to `True`. A shared environment\n #: must not be modified\n shared = False\n\n #: the class that is used for code generation. See\n #: :class:`~jinja2.compiler.CodeGenerator` for more information.\n code_generator_class: type[\"CodeGenerator\"] = CodeGenerator\n\n concat = \"\".join\n\n #: the context class that is used for templates. See\n #: :class:`~jinja2.runtime.Context` for more information.\n context_class: type[Context] = Context\n\n template_class: type[\"Template\"]\n\n def __init__(\n self,\n block_start_string: str = BLOCK_START_STRING,\n block_end_string: str = BLOCK_END_STRING,\n variable_start_string: str = VARIABLE_START_STRING,\n variable_end_string: str = VARIABLE_END_STRING,\n comment_start_string: str = COMMENT_START_STRING,\n comment_end_string: str = COMMENT_END_STRING,\n line_statement_prefix: str | None = LINE_STATEMENT_PREFIX,\n line_comment_prefix: str | None = LINE_COMMENT_PREFIX,\n trim_blocks: bool = TRIM_BLOCKS,\n lstrip_blocks: bool = LSTRIP_BLOCKS,\n newline_sequence: \"te.Literal['\\\\n', '\\\\r\\\\n', '\\\\r']\" = NEWLINE_SEQUENCE,\n keep_trailing_newline: bool = KEEP_TRAILING_NEWLINE,\n extensions: t.Sequence[str | type[\"Extension\"]] = (),\n optimized: bool = True,\n undefined: type[Undefined] = Undefined,\n finalize: t.Callable[..., t.Any] | None = None,\n autoescape: bool | t.Callable[[str | None], bool] = False,\n loader: t.Optional[\"BaseLoader\"] = None,\n cache_size: int = 400,\n auto_reload: bool = True,\n bytecode_cache: t.Optional[\"BytecodeCache\"] = None,\n enable_async: bool = False,\n ):\n # !!Important notice!!\n # The constructor accepts quite a few arguments that should be\n # passed by keyword rather than position. However it's important to\n # not change the order of arguments because it's used at least\n # internally in those cases:\n # - spontaneous environments (i18n extension and Template)\n # - unittests\n # If parameter changes are required only add parameters at the end\n # and don't change the arguments (or the defaults!) of the arguments\n # existing already.\n\n # lexer / parser information\n self.block_start_string = block_start_string\n self.block_end_string = block_end_string\n self.variable_start_string = variable_start_string\n self.variable_end_string = variable_end_string\n self.comment_start_string = comment_start_string\n self.comment_end_string = comment_end_string\n self.line_statement_prefix = line_statement_prefix\n self.line_comment_prefix = line_comment_prefix\n self.trim_blocks = trim_blocks\n self.lstrip_blocks = lstrip_blocks\n self.newline_sequence = newline_sequence\n self.keep_trailing_newline = keep_trailing_newline\n\n # runtime information\n self.undefined: type[Undefined] = undefined\n self.optimized = optimized\n self.finalize = finalize\n self.autoescape = autoescape\n\n # defaults\n self.filters = DEFAULT_FILTERS.copy()\n self.tests = DEFAULT_TESTS.copy()\n self.globals = DEFAULT_NAMESPACE.copy()\n\n # set the loader provided\n self.loader = loader\n self.cache = create_cache(cache_size)\n self.bytecode_cache = bytecode_cache\n self.auto_reload = auto_reload\n\n # configurable policies\n self.policies = DEFAULT_POLICIES.copy()\n\n # load extensions\n self.extensions = load_extensions(self, extensions)\n\n self.is_async = enable_async\n _environment_config_check(self)\n\n def add_extension(self, extension: str | type[\"Extension\"]) -> None:\n \"\"\"Adds an extension after the environment was created.\n\n .. versionadded:: 2.5\n \"\"\"\n self.extensions.update(load_extensions(self, [extension]))\n\n def extend(self, **attributes: t.Any) -> None:\n \"\"\"Add the items to the instance of the environment if they do not exist\n yet. This is used by :ref:`extensions ` to register\n callbacks and configuration values without breaking inheritance.\n \"\"\"\n for key, value in attributes.items():\n if not hasattr(self, key):\n setattr(self, key, value)\n\n def overlay(\n self,\n block_start_string: str = missing,\n block_end_string: str = missing,\n variable_start_string: str = missing,\n variable_end_string: str = missing,\n comment_start_string: str = missing,\n comment_end_string: str = missing,\n line_statement_prefix: str | None = missing,\n line_comment_prefix: str | None = missing,\n trim_blocks: bool = missing,\n lstrip_blocks: bool = missing,\n newline_sequence: \"te.Literal['\\\\n', '\\\\r\\\\n', '\\\\r']\" = missing,\n keep_trailing_newline: bool = missing,\n extensions: t.Sequence[str | type[\"Extension\"]] = missing,\n optimized: bool = missing,\n undefined: type[Undefined] = missing,\n finalize: t.Callable[..., t.Any] | None = missing,\n autoescape: bool | t.Callable[[str | None], bool] = missing,\n loader: t.Optional[\"BaseLoader\"] = missing,\n cache_size: int = missing,\n auto_reload: bool = missing,\n bytecode_cache: t.Optional[\"BytecodeCache\"] = missing,\n enable_async: bool = missing,\n ) -> \"te.Self\":\n \"\"\"Create a new overlay environment that shares all the data with the\n current environment except for cache and the overridden attributes.\n Extensions cannot be removed for an overlayed environment. An overlayed\n environment automatically gets all the extensions of the environment it\n is linked to plus optional extra extensions.\n\n Creating overlays should happen after the initial environment was set\n up completely. Not all attributes are truly linked, some are just\n copied over so modifications on the original environment may not shine\n through.\n\n .. versionchanged:: 3.1.5\n ``enable_async`` is applied correctly.\n\n .. versionchanged:: 3.1.2\n Added the ``newline_sequence``, ``keep_trailing_newline``,\n and ``enable_async`` parameters to match ``__init__``.\n \"\"\"\n args = dict(locals())\n del args[\"self\"], args[\"cache_size\"], args[\"extensions\"], args[\"enable_async\"]\n\n rv = object.__new__(self.__class__)\n rv.__dict__.update(self.__dict__)\n rv.overlayed = True\n rv.linked_to = self\n\n for key, value in args.items():\n if value is not missing:\n setattr(rv, key, value)\n\n if cache_size is not missing:\n rv.cache = create_cache(cache_size)\n else:\n rv.cache = copy_cache(self.cache)\n\n rv.extensions = {}\n for key, value in self.extensions.items():\n rv.extensions[key] = value.bind(rv)\n if extensions is not missing:\n rv.extensions.update(load_extensions(rv, extensions))\n\n if enable_async is not missing:\n rv.is_async = enable_async\n\n return _environment_config_check(rv)\n\n @property\n def lexer(self) -> Lexer:\n \"\"\"The lexer for this environment.\"\"\"\n return get_lexer(self)\n\n def iter_extensions(self) -> t.Iterator[\"Extension\"]:\n \"\"\"Iterates over the extensions by priority.\"\"\"\n return iter(sorted(self.extensions.values(), key=lambda x: x.priority))\n\n def getitem(self, obj: t.Any, argument: str | t.Any) -> t.Any | Undefined:\n \"\"\"Get an item or attribute of an object but prefer the item.\"\"\"\n try:\n return obj[argument]\n except (AttributeError, TypeError, LookupError):\n if isinstance(argument, str):\n try:\n attr = str(argument)\n except Exception:\n pass\n else:\n try:\n return getattr(obj, attr)\n except AttributeError:\n pass\n return self.undefined(obj=obj, name=argument)\n\n def getattr(self, obj: t.Any, attribute: str) -> t.Any:\n \"\"\"Get an item or attribute of an object but prefer the attribute.\n Unlike :meth:`getitem` the attribute *must* be a string.\n \"\"\"\n try:\n return getattr(obj, attribute)\n except AttributeError:\n pass\n try:\n return obj[attribute]\n except (TypeError, LookupError, AttributeError):\n return self.undefined(obj=obj, name=attribute)\n\n def _filter_test_common(\n self,\n name: str | Undefined,\n value: t.Any,\n args: t.Sequence[t.Any] | None,\n kwargs: t.Mapping[str, t.Any] | None,\n context: Context | None,\n eval_ctx: EvalContext | None,\n is_filter: bool,\n ) -> t.Any:\n if is_filter:\n env_map = self.filters\n type_name = \"filter\"\n else:\n env_map = self.tests\n type_name = \"test\"\n\n func = env_map.get(name) # type: ignore\n\n if func is None:\n msg = f\"No {type_name} named {name!r}.\"\n\n if isinstance(name, Undefined):\n try:\n name._fail_with_undefined_error()\n except Exception as e:\n msg = f\"{msg} ({e}; did you forget to quote the callable name?)\"\n\n raise TemplateRuntimeError(msg)\n\n args = [value, *(args if args is not None else ())]\n kwargs = kwargs if kwargs is not None else {}\n pass_arg = _PassArg.from_obj(func)\n\n if pass_arg is _PassArg.context:\n if context is None:\n raise TemplateRuntimeError(\n f\"Attempted to invoke a context {type_name} without context.\"\n )\n\n args.insert(0, context)\n elif pass_arg is _PassArg.eval_context:\n if eval_ctx is None:\n if context is not None:\n eval_ctx = context.eval_ctx\n else:\n eval_ctx = EvalContext(self)\n\n args.insert(0, eval_ctx)\n elif pass_arg is _PassArg.environment:\n args.insert(0, self)\n\n return func(*args, **kwargs)\n\n def call_filter(\n self,\n name: str,\n value: t.Any,\n args: t.Sequence[t.Any] | None = None,\n kwargs: t.Mapping[str, t.Any] | None = None,\n context: Context | None = None,\n eval_ctx: EvalContext | None = None,\n ) -> t.Any:\n \"\"\"Invoke a filter on a value the same way the compiler does.\n\n This might return a coroutine if the filter is running from an\n environment in async mode and the filter supports async\n execution. It's your responsibility to await this if needed.\n\n .. versionadded:: 2.7\n \"\"\"\n return self._filter_test_common(\n name, value, args, kwargs, context, eval_ctx, True\n )\n\n def call_test(\n self,\n name: str,\n value: t.Any,\n args: t.Sequence[t.Any] | None = None,\n kwargs: t.Mapping[str, t.Any] | None = None,\n context: Context | None = None,\n eval_ctx: EvalContext | None = None,\n ) -> t.Any:\n \"\"\"Invoke a test on a value the same way the compiler does.\n\n This might return a coroutine if the test is running from an\n environment in async mode and the test supports async execution.\n It's your responsibility to await this if needed.\n\n .. versionchanged:: 3.0\n Tests support ``@pass_context``, etc. decorators. Added\n the ``context`` and ``eval_ctx`` parameters.\n\n .. versionadded:: 2.7\n \"\"\"\n return self._filter_test_common(\n name, value, args, kwargs, context, eval_ctx, False\n )\n\n @internalcode\n def parse(\n self,\n source: str,\n name: str | None = None,\n filename: str | None = None,\n ) -> nodes.Template:\n \"\"\"Parse the sourcecode and return the abstract syntax tree. This\n tree of nodes is used by the compiler to convert the template into\n executable source- or bytecode. This is useful for debugging or to\n extract information from templates.\n\n If you are :ref:`developing Jinja extensions `\n this gives you a good overview of the node tree generated.\n \"\"\"\n try:\n return self._parse(source, name, filename)\n except TemplateSyntaxError:\n self.handle_exception(source=source)\n\n def _parse(\n self, source: str, name: str | None, filename: str | None\n ) -> nodes.Template:\n \"\"\"Internal parsing function used by `parse` and `compile`.\"\"\"\n return Parser(self, source, name, filename).parse()\n\n def lex(\n self,\n source: str,\n name: str | None = None,\n filename: str | None = None,\n ) -> t.Iterator[tuple[int, str, str]]:\n \"\"\"Lex the given sourcecode and return a generator that yields\n tokens as tuples in the form ``(lineno, token_type, value)``.\n This can be useful for :ref:`extension development `\n and debugging templates.\n\n This does not perform preprocessing. If you want the preprocessing\n of the extensions to be applied you have to filter source through\n the :meth:`preprocess` method.\n \"\"\"\n source = str(source)\n try:\n return self.lexer.tokeniter(source, name, filename)\n except TemplateSyntaxError:\n self.handle_exception(source=source)\n\n def preprocess(\n self,\n source: str,\n name: str | None = None,\n filename: str | None = None,\n ) -> str:\n \"\"\"Preprocesses the source with all extensions. This is automatically\n called for all parsing and compiling methods but *not* for :meth:`lex`\n because there you usually only want the actual source tokenized.\n \"\"\"\n return reduce(\n lambda s, e: e.preprocess(s, name, filename),\n self.iter_extensions(),\n str(source),\n )\n\n def _tokenize(\n self,\n source: str,\n name: str | None,\n filename: str | None = None,\n state: str | None = None,\n ) -> TokenStream:\n \"\"\"Called by the parser to do the preprocessing and filtering\n for all the extensions. Returns a :class:`~jinja2.lexer.TokenStream`.\n \"\"\"\n source = self.preprocess(source, name, filename)\n stream = self.lexer.tokenize(source, name, filename, state)\n\n for ext in self.iter_extensions():\n stream = ext.filter_stream(stream) # type: ignore\n\n if not isinstance(stream, TokenStream):\n stream = TokenStream(stream, name, filename)\n\n return stream\n\n def _generate(\n self,\n source: nodes.Template,\n name: str | None,\n filename: str | None,\n defer_init: bool = False,\n ) -> str:\n \"\"\"Internal hook that can be overridden to hook a different generate\n method in.\n\n .. versionadded:: 2.5\n \"\"\"\n return generate( # type: ignore\n source,\n self,\n name,\n filename,\n defer_init=defer_init,\n optimized=self.optimized,\n )\n\n def _compile(self, source: str, filename: str) -> CodeType:\n \"\"\"Internal hook that can be overridden to hook a different compile\n method in.\n\n .. versionadded:: 2.5\n \"\"\"\n return compile(source, filename, \"exec\")\n\n @typing.overload\n def compile(\n self,\n source: str | nodes.Template,\n name: str | None = None,\n filename: str | None = None,\n raw: \"te.Literal[False]\" = False,\n defer_init: bool = False,\n ) -> CodeType: ...\n\n @typing.overload\n def compile(\n self,\n source: str | nodes.Template,\n name: str | None = None,\n filename: str | None = None,\n raw: \"te.Literal[True]\" = ...,\n defer_init: bool = False,\n ) -> str: ...\n\n @internalcode\n def compile(\n self,\n source: str | nodes.Template,\n name: str | None = None,\n filename: str | None = None,\n raw: bool = False,\n defer_init: bool = False,\n ) -> str | CodeType:\n \"\"\"Compile a node or template source code. The `name` parameter is\n the load name of the template after it was joined using\n :meth:`join_path` if necessary, not the filename on the file system.\n the `filename` parameter is the estimated filename of the template on\n the file system. If the template came from a database or memory this\n can be omitted.\n\n The return value of this method is a python code object. If the `raw`\n parameter is `True` the return value will be a string with python\n code equivalent to the bytecode returned otherwise. This method is\n mainly used internally.\n\n `defer_init` is use internally to aid the module code generator. This\n causes the generated code to be able to import without the global\n environment variable to be set.\n\n .. versionadded:: 2.4\n `defer_init` parameter added.\n \"\"\"\n source_hint = None\n try:\n if isinstance(source, str):\n source_hint = source\n source = self._parse(source, name, filename)\n source = self._generate(source, name, filename, defer_init=defer_init)\n if raw:\n return source\n if filename is None:\n filename = \"\"\n return self._compile(source, filename)\n except TemplateSyntaxError:\n self.handle_exception(source=source_hint)\n\n def compile_expression(\n self, source: str, undefined_to_none: bool = True\n ) -> \"TemplateExpression\":\n \"\"\"A handy helper method that returns a callable that accepts keyword\n arguments that appear as variables in the expression. If called it\n returns the result of the expression.\n\n This is useful if applications want to use the same rules as Jinja\n in template \"configuration files\" or similar situations.\n\n Example usage:\n\n >>> env = Environment()\n >>> expr = env.compile_expression('foo == 42')\n >>> expr(foo=23)\n False\n >>> expr(foo=42)\n True\n\n Per default the return value is converted to `None` if the\n expression returns an undefined value. This can be changed\n by setting `undefined_to_none` to `False`.\n\n >>> env.compile_expression('var')() is None\n True\n >>> env.compile_expression('var', undefined_to_none=False)()\n Undefined\n\n .. versionadded:: 2.1\n \"\"\"\n parser = Parser(self, source, state=\"variable\")\n try:\n expr = parser.parse_expression()\n if not parser.stream.eos:\n raise TemplateSyntaxError(\n \"chunk after expression\", parser.stream.current.lineno, None, None\n )\n expr.set_environment(self)\n except TemplateSyntaxError:\n self.handle_exception(source=source)\n\n body = [nodes.Assign(nodes.Name(\"result\", \"store\"), expr, lineno=1)]\n template = self.from_string(nodes.Template(body, lineno=1))\n return TemplateExpression(template, undefined_to_none)\n\n def compile_templates(\n self,\n target: t.Union[str, \"os.PathLike[str]\"],\n extensions: t.Collection[str] | None = None,\n filter_func: t.Callable[[str], bool] | None = None,\n zip: str | None = \"deflated\",\n log_function: t.Callable[[str], None] | None = None,\n ignore_errors: bool = True,\n ) -> None:\n \"\"\"Finds all the templates the loader can find, compiles them\n and stores them in `target`. If `zip` is `None`, instead of in a\n zipfile, the templates will be stored in a directory.\n By default a deflate zip algorithm is used. To switch to\n the stored algorithm, `zip` can be set to ``'stored'``.\n\n `extensions` and `filter_func` are passed to :meth:`list_templates`.\n Each template returned will be compiled to the target folder or\n zipfile.\n\n By default template compilation errors are ignored. In case a\n log function is provided, errors are logged. If you want template\n syntax errors to abort the compilation you can set `ignore_errors`\n to `False` and you will get an exception on syntax errors.\n\n .. versionadded:: 2.4\n \"\"\"\n from .loaders import ModuleLoader\n\n if log_function is None:\n\n def log_function(x: str) -> None:\n pass\n\n assert log_function is not None\n assert self.loader is not None, \"No loader configured.\"\n\n def write_file(filename: str, data: str) -> None:\n if zip:\n info = ZipInfo(filename)\n info.external_attr = 0o755 << 16\n zip_file.writestr(info, data)\n else:\n with open(os.path.join(target, filename), \"wb\") as f:\n f.write(data.encode(\"utf8\"))\n\n if zip is not None:\n from zipfile import ZIP_DEFLATED\n from zipfile import ZIP_STORED\n from zipfile import ZipFile\n from zipfile import ZipInfo\n\n zip_file = ZipFile(\n target, \"w\", dict(deflated=ZIP_DEFLATED, stored=ZIP_STORED)[zip]\n )\n log_function(f\"Compiling into Zip archive {target!r}\")\n else:\n if not os.path.isdir(target):\n os.makedirs(target)\n log_function(f\"Compiling into folder {target!r}\")\n\n try:\n for name in self.list_templates(extensions, filter_func):\n source, filename, _ = self.loader.get_source(self, name)\n try:\n code = self.compile(source, name, filename, True, True)\n except TemplateSyntaxError as e:\n if not ignore_errors:\n raise\n log_function(f'Could not compile \"{name}\": {e}')\n continue\n\n filename = ModuleLoader.get_module_filename(name)\n\n write_file(filename, code)\n log_function(f'Compiled \"{name}\" as {filename}')\n finally:\n if zip:\n zip_file.close()\n\n log_function(\"Finished compiling templates\")\n\n def list_templates(\n self,\n extensions: t.Collection[str] | None = None,\n filter_func: t.Callable[[str], bool] | None = None,\n ) -> list[str]:\n \"\"\"Returns a list of templates for this environment. This requires\n that the loader supports the loader's\n :meth:`~BaseLoader.list_templates` method.\n\n If there are other files in the template folder besides the\n actual templates, the returned list can be filtered. There are two\n ways: either `extensions` is set to a list of file extensions for\n templates, or a `filter_func` can be provided which is a callable that\n is passed a template name and should return `True` if it should end up\n in the result list.\n\n If the loader does not support that, a :exc:`TypeError` is raised.\n\n .. versionadded:: 2.4\n \"\"\"\n assert self.loader is not None, \"No loader configured.\"\n names = self.loader.list_templates()\n\n if extensions is not None:\n if filter_func is not None:\n raise TypeError(\n \"either extensions or filter_func can be passed, but not both\"\n )\n\n def filter_func(x: str) -> bool:\n return \".\" in x and x.rsplit(\".\", 1)[1] in extensions\n\n if filter_func is not None:\n names = [name for name in names if filter_func(name)]\n\n return names\n\n def handle_exception(self, source: str | None = None) -> \"te.NoReturn\":\n \"\"\"Exception handling helper. This is used internally to either raise\n rewritten exceptions or return a rendered traceback for the template.\n \"\"\"\n from .debug import rewrite_traceback_stack\n\n raise rewrite_traceback_stack(source=source)\n\n def join_path(self, template: str, parent: str) -> str:\n \"\"\"Join a template with the parent. By default all the lookups are\n relative to the loader root so this method returns the `template`\n parameter unchanged, but if the paths should be relative to the\n parent template, this function can be used to calculate the real\n template name.\n\n Subclasses may override this method and implement template path\n joining here.\n \"\"\"\n return template\n\n @internalcode\n def _load_template(\n self, name: str, globals: t.MutableMapping[str, t.Any] | None\n ) -> \"Template\":\n if self.loader is None:\n raise TypeError(\"no loader for this environment specified\")\n cache_key = (weakref.ref(self.loader), name)\n if self.cache is not None:\n template = self.cache.get(cache_key)\n if template is not None and (\n not self.auto_reload or template.is_up_to_date\n ):\n # template.globals is a ChainMap, modifying it will only\n # affect the template, not the environment globals.\n if globals:\n template.globals.update(globals)\n\n return template\n\n template = self.loader.load(self, name, self.make_globals(globals))\n\n if self.cache is not None:\n self.cache[cache_key] = template\n return template\n\n @internalcode\n def get_template(\n self,\n name: t.Union[str, \"Template\"],\n parent: str | None = None,\n globals: t.MutableMapping[str, t.Any] | None = None,\n ) -> \"Template\":\n \"\"\"Load a template by name with :attr:`loader` and return a\n :class:`Template`. If the template does not exist a\n :exc:`TemplateNotFound` exception is raised.\n\n :param name: Name of the template to load. When loading\n templates from the filesystem, \"/\" is used as the path\n separator, even on Windows.\n :param parent: The name of the parent template importing this\n template. :meth:`join_path` can be used to implement name\n transformations with this.\n :param globals: Extend the environment :attr:`globals` with\n these extra variables available for all renders of this\n template. If the template has already been loaded and\n cached, its globals are updated with any new items.\n\n .. versionchanged:: 3.0\n If a template is loaded from cache, ``globals`` will update\n the template's globals instead of ignoring the new values.\n\n .. versionchanged:: 2.4\n If ``name`` is a :class:`Template` object it is returned\n unchanged.\n \"\"\"\n if isinstance(name, Template):\n return name\n if parent is not None:\n name = self.join_path(name, parent)\n\n return self._load_template(name, globals)\n\n @internalcode\n def select_template(\n self,\n names: t.Iterable[t.Union[str, \"Template\"]],\n parent: str | None = None,\n globals: t.MutableMapping[str, t.Any] | None = None,\n ) -> \"Template\":\n \"\"\"Like :meth:`get_template`, but tries loading multiple names.\n If none of the names can be loaded a :exc:`TemplatesNotFound`\n exception is raised.\n\n :param names: List of template names to try loading in order.\n :param parent: The name of the parent template importing this\n template. :meth:`join_path` can be used to implement name\n transformations with this.\n :param globals: Extend the environment :attr:`globals` with\n these extra variables available for all renders of this\n template. If the template has already been loaded and\n cached, its globals are updated with any new items.\n\n .. versionchanged:: 3.0\n If a template is loaded from cache, ``globals`` will update\n the template's globals instead of ignoring the new values.\n\n .. versionchanged:: 2.11\n If ``names`` is :class:`Undefined`, an :exc:`UndefinedError`\n is raised instead. If no templates were found and ``names``\n contains :class:`Undefined`, the message is more helpful.\n\n .. versionchanged:: 2.4\n If ``names`` contains a :class:`Template` object it is\n returned unchanged.\n\n .. versionadded:: 2.3\n \"\"\"\n if isinstance(names, Undefined):\n names._fail_with_undefined_error()\n\n if not names:\n raise TemplatesNotFound(\n message=\"Tried to select from an empty list of templates.\"\n )\n\n for name in names:\n if isinstance(name, Template):\n return name\n if parent is not None:\n name = self.join_path(name, parent)\n try:\n return self._load_template(name, globals)\n except (TemplateNotFound, UndefinedError):\n pass\n raise TemplatesNotFound(names) # type: ignore\n\n @internalcode\n def get_or_select_template(\n self,\n template_name_or_list: t.Union[str, \"Template\", list[t.Union[str, \"Template\"]]],\n parent: str | None = None,\n globals: t.MutableMapping[str, t.Any] | None = None,\n ) -> \"Template\":\n \"\"\"Use :meth:`select_template` if an iterable of template names\n is given, or :meth:`get_template` if one name is given.\n\n .. versionadded:: 2.3\n \"\"\"\n if isinstance(template_name_or_list, (str, Undefined)):\n return self.get_template(template_name_or_list, parent, globals)\n elif isinstance(template_name_or_list, Template):\n return template_name_or_list\n return self.select_template(template_name_or_list, parent, globals)\n\n def from_string(\n self,\n source: str | nodes.Template,\n globals: t.MutableMapping[str, t.Any] | None = None,\n template_class: type[\"Template\"] | None = None,\n ) -> \"Template\":\n \"\"\"Load a template from a source string without using\n :attr:`loader`.\n\n :param source: Jinja source to compile into a template.\n :param globals: Extend the environment :attr:`globals` with\n these extra variables available for all renders of this\n template. If the template has already been loaded and\n cached, its globals are updated with any new items.\n :param template_class: Return an instance of this\n :class:`Template` class.\n \"\"\"\n gs = self.make_globals(globals)\n cls = template_class or self.template_class\n return cls.from_code(self, self.compile(source), gs, None)\n\n def make_globals(\n self, d: t.MutableMapping[str, t.Any] | None\n ) -> t.MutableMapping[str, t.Any]:\n \"\"\"Make the globals map for a template. Any given template\n globals overlay the environment :attr:`globals`.\n\n Returns a :class:`collections.ChainMap`. This allows any changes\n to a template's globals to only affect that template, while\n changes to the environment's globals are still reflected.\n However, avoid modifying any globals after a template is loaded.\n\n :param d: Dict of template-specific globals.\n\n .. versionchanged:: 3.0\n Use :class:`collections.ChainMap` to always prevent mutating\n environment globals.\n \"\"\"\n if d is None:\n d = {}\n\n return ChainMap(d, self.globals)\n\n\nclass Template:\n \"\"\"A compiled template that can be rendered.\n\n Use the methods on :class:`Environment` to create or load templates.\n The environment is used to configure how templates are compiled and\n behave.\n\n It is also possible to create a template object directly. This is\n not usually recommended. The constructor takes most of the same\n arguments as :class:`Environment`. All templates created with the\n same environment arguments share the same ephemeral ``Environment``\n instance behind the scenes.\n\n A template object should be considered immutable. Modifications on\n the object are not supported.\n \"\"\"\n\n #: Type of environment to create when creating a template directly\n #: rather than through an existing environment.\n environment_class: type[Environment] = Environment\n\n environment: Environment\n globals: t.MutableMapping[str, t.Any]\n name: str | None\n filename: str | None\n blocks: dict[str, t.Callable[[Context], t.Iterator[str]]]\n root_render_func: t.Callable[[Context], t.Iterator[str]]\n _module: t.Optional[\"TemplateModule\"]\n _debug_info: str\n _uptodate: t.Callable[[], bool] | None\n\n def __new__(\n cls,\n source: str | nodes.Template,\n block_start_string: str = BLOCK_START_STRING,\n block_end_string: str = BLOCK_END_STRING,\n variable_start_string: str = VARIABLE_START_STRING,\n variable_end_string: str = VARIABLE_END_STRING,\n comment_start_string: str = COMMENT_START_STRING,\n comment_end_string: str = COMMENT_END_STRING,\n line_statement_prefix: str | None = LINE_STATEMENT_PREFIX,\n line_comment_prefix: str | None = LINE_COMMENT_PREFIX,\n trim_blocks: bool = TRIM_BLOCKS,\n lstrip_blocks: bool = LSTRIP_BLOCKS,\n newline_sequence: \"te.Literal['\\\\n', '\\\\r\\\\n', '\\\\r']\" = NEWLINE_SEQUENCE,\n keep_trailing_newline: bool = KEEP_TRAILING_NEWLINE,\n extensions: t.Sequence[str | type[\"Extension\"]] = (),\n optimized: bool = True,\n undefined: type[Undefined] = Undefined,\n finalize: t.Callable[..., t.Any] | None = None,\n autoescape: bool | t.Callable[[str | None], bool] = False,\n enable_async: bool = False,\n ) -> t.Any: # it returns a `Template`, but this breaks the sphinx build...\n env = get_spontaneous_environment(\n cls.environment_class, # type: ignore\n block_start_string,\n block_end_string,\n variable_start_string,\n variable_end_string,\n comment_start_string,\n comment_end_string,\n line_statement_prefix,\n line_comment_prefix,\n trim_blocks,\n lstrip_blocks,\n newline_sequence,\n keep_trailing_newline,\n frozenset(extensions),\n optimized,\n undefined, # type: ignore\n finalize,\n autoescape,\n None,\n 0,\n False,\n None,\n enable_async,\n )\n return env.from_string(source, template_class=cls)\n\n @classmethod\n def from_code(\n cls,\n environment: Environment,\n code: CodeType,\n globals: t.MutableMapping[str, t.Any],\n uptodate: t.Callable[[], bool] | None = None,\n ) -> \"Template\":\n \"\"\"Creates a template object from compiled code and the globals. This\n is used by the loaders and environment to create a template object.\n \"\"\"\n namespace = {\"environment\": environment, \"__file__\": code.co_filename}\n exec(code, namespace)\n rv = cls._from_namespace(environment, namespace, globals)\n rv._uptodate = uptodate\n return rv\n\n @classmethod\n def from_module_dict(\n cls,\n environment: Environment,\n module_dict: t.MutableMapping[str, t.Any],\n globals: t.MutableMapping[str, t.Any],\n ) -> \"Template\":\n \"\"\"Creates a template object from a module. This is used by the\n module loader to create a template object.\n\n .. versionadded:: 2.4\n \"\"\"\n return cls._from_namespace(environment, module_dict, globals)\n\n @classmethod\n def _from_namespace(\n cls,\n environment: Environment,\n namespace: t.MutableMapping[str, t.Any],\n globals: t.MutableMapping[str, t.Any],\n ) -> \"Template\":\n t: Template = object.__new__(cls)\n t.environment = environment\n t.globals = globals\n t.name = namespace[\"name\"]\n t.filename = namespace[\"__file__\"]\n t.blocks = namespace[\"blocks\"]\n\n # render function and module\n t.root_render_func = namespace[\"root\"]\n t._module = None\n\n # debug and loader helpers\n t._debug_info = namespace[\"debug_info\"]\n t._uptodate = None\n\n # store the reference\n namespace[\"environment\"] = environment\n namespace[\"__jinja_template__\"] = t\n\n return t\n\n def render(self, *args: t.Any, **kwargs: t.Any) -> str:\n \"\"\"This method accepts the same arguments as the `dict` constructor:\n A dict, a dict subclass or some keyword arguments. If no arguments\n are given the context will be empty. These two calls do the same::\n\n template.render(knights='that say nih')\n template.render({'knights': 'that say nih'})\n\n This will return the rendered template as a string.\n \"\"\"\n if self.environment.is_async:\n import asyncio\n\n return asyncio.run(self.render_async(*args, **kwargs))\n\n ctx = self.new_context(dict(*args, **kwargs))\n\n try:\n return self.environment.concat(self.root_render_func(ctx)) # type: ignore\n except Exception:\n self.environment.handle_exception()\n\n async def render_async(self, *args: t.Any, **kwargs: t.Any) -> str:\n \"\"\"This works similar to :meth:`render` but returns a coroutine\n that when awaited returns the entire rendered template string. This\n requires the async feature to be enabled.\n\n Example usage::\n\n await template.render_async(knights='that say nih; asynchronously')\n \"\"\"\n if not self.environment.is_async:\n raise RuntimeError(\n \"The environment was not created with async mode enabled.\"\n )\n\n ctx = self.new_context(dict(*args, **kwargs))\n\n try:\n return self.environment.concat( # type: ignore\n [n async for n in self.root_render_func(ctx)] # type: ignore\n )\n except Exception:\n return self.environment.handle_exception()\n\n def stream(self, *args: t.Any, **kwargs: t.Any) -> \"TemplateStream\":\n \"\"\"Works exactly like :meth:`generate` but returns a\n :class:`TemplateStream`.\n \"\"\"\n return TemplateStream(self.generate(*args, **kwargs))\n\n def generate(self, *args: t.Any, **kwargs: t.Any) -> t.Iterator[str]:\n \"\"\"For very large templates it can be useful to not render the whole\n template at once but evaluate each statement after another and yield\n piece for piece. This method basically does exactly that and returns\n a generator that yields one item after another as strings.\n\n It accepts the same arguments as :meth:`render`.\n \"\"\"\n if self.environment.is_async:\n import asyncio\n\n async def to_list() -> list[str]:\n return [x async for x in self.generate_async(*args, **kwargs)]\n\n yield from asyncio.run(to_list())\n return\n\n ctx = self.new_context(dict(*args, **kwargs))\n\n try:\n yield from self.root_render_func(ctx)\n except Exception:\n yield self.environment.handle_exception()\n\n async def generate_async(\n self, *args: t.Any, **kwargs: t.Any\n ) -> t.AsyncGenerator[str, object]:\n \"\"\"An async version of :meth:`generate`. Works very similarly but\n returns an async iterator instead.\n \"\"\"\n if not self.environment.is_async:\n raise RuntimeError(\n \"The environment was not created with async mode enabled.\"\n )\n\n ctx = self.new_context(dict(*args, **kwargs))\n\n try:\n agen: t.AsyncGenerator[str, None] = self.root_render_func(ctx) # type: ignore[assignment]\n\n async with aclosing(agen):\n async for event in agen:\n yield event\n except Exception:\n yield self.environment.handle_exception()\n\n def new_context(\n self,\n vars: dict[str, t.Any] | None = None,\n shared: bool = False,\n locals: t.Mapping[str, t.Any] | None = None,\n ) -> Context:\n \"\"\"Create a new :class:`Context` for this template. The vars\n provided will be passed to the template. Per default the globals\n are added to the context. If shared is set to `True` the data\n is passed as is to the context without adding the globals.\n\n `locals` can be a dict of local variables for internal usage.\n \"\"\"\n return new_context(\n self.environment, self.name, self.blocks, vars, shared, self.globals, locals\n )\n\n def make_module(\n self,\n vars: dict[str, t.Any] | None = None,\n shared: bool = False,\n locals: t.Mapping[str, t.Any] | None = None,\n ) -> \"TemplateModule\":\n \"\"\"This method works like the :attr:`module` attribute when called\n without arguments but it will evaluate the template on every call\n rather than caching it. It's also possible to provide\n a dict which is then used as context. The arguments are the same\n as for the :meth:`new_context` method.\n \"\"\"\n ctx = self.new_context(vars, shared, locals)\n return TemplateModule(self, ctx)\n\n async def make_module_async(\n self,\n vars: dict[str, t.Any] | None = None,\n shared: bool = False,\n locals: t.Mapping[str, t.Any] | None = None,\n ) -> \"TemplateModule\":\n \"\"\"As template module creation can invoke template code for\n asynchronous executions this method must be used instead of the\n normal :meth:`make_module` one. Likewise the module attribute\n becomes unavailable in async mode.\n \"\"\"\n ctx = self.new_context(vars, shared, locals)\n return TemplateModule(\n self,\n ctx,\n [x async for x in self.root_render_func(ctx)], # type: ignore\n )\n\n @internalcode\n def _get_default_module(self, ctx: Context | None = None) -> \"TemplateModule\":\n \"\"\"If a context is passed in, this means that the template was\n imported. Imported templates have access to the current\n template's globals by default, but they can only be accessed via\n the context during runtime.\n\n If there are new globals, we need to create a new module because\n the cached module is already rendered and will not have access\n to globals from the current context. This new module is not\n cached because the template can be imported elsewhere, and it\n should have access to only the current template's globals.\n \"\"\"\n if self.environment.is_async:\n raise RuntimeError(\"Module is not available in async mode.\")\n\n if ctx is not None:\n keys = ctx.globals_keys - self.globals.keys()\n\n if keys:\n return self.make_module({k: ctx.parent[k] for k in keys})\n\n if self._module is None:\n self._module = self.make_module()\n\n return self._module\n\n async def _get_default_module_async(\n self, ctx: Context | None = None\n ) -> \"TemplateModule\":\n if ctx is not None:\n keys = ctx.globals_keys - self.globals.keys()\n\n if keys:\n return await self.make_module_async({k: ctx.parent[k] for k in keys})\n\n if self._module is None:\n self._module = await self.make_module_async()\n\n return self._module\n\n @property\n def module(self) -> \"TemplateModule\":\n \"\"\"The template as module. This is used for imports in the\n template runtime but is also useful if one wants to access\n exported template variables from the Python layer:\n\n >>> t = Template('{% macro foo() %}42{% endmacro %}23')\n >>> str(t.module)\n '23'\n >>> t.module.foo() == u'42'\n True\n\n This attribute is not available if async mode is enabled.\n \"\"\"\n return self._get_default_module()\n\n def get_corresponding_lineno(self, lineno: int) -> int:\n \"\"\"Return the source line number of a line number in the\n generated bytecode as they are not in sync.\n \"\"\"\n for template_line, code_line in reversed(self.debug_info):\n if code_line <= lineno:\n return template_line\n return 1\n\n @property\n def is_up_to_date(self) -> bool:\n \"\"\"If this variable is `False` there is a newer version available.\"\"\"\n if self._uptodate is None:\n return True\n return self._uptodate()\n\n @property\n def debug_info(self) -> list[tuple[int, int]]:\n \"\"\"The debug info mapping.\"\"\"\n if self._debug_info:\n return [\n tuple(map(int, x.split(\"=\"))) # type: ignore\n for x in self._debug_info.split(\"&\")\n ]\n\n return []\n\n def __repr__(self) -> str:\n if self.name is None:\n name = f\"memory:{id(self):x}\"\n else:\n name = repr(self.name)\n return f\"<{type(self).__name__} {name}>\"\n\n\nclass TemplateModule:\n \"\"\"Represents an imported template. All the exported names of the\n template are available as attributes on this object. Additionally\n converting it into a string renders the contents.\n \"\"\"\n\n def __init__(\n self,\n template: Template,\n context: Context,\n body_stream: t.Iterable[str] | None = None,\n ) -> None:\n if body_stream is None:\n if context.environment.is_async:\n raise RuntimeError(\n \"Async mode requires a body stream to be passed to\"\n \" a template module. Use the async methods of the\"\n \" API you are using.\"\n )\n\n body_stream = list(template.root_render_func(context))\n\n self._body_stream = body_stream\n self.__dict__.update(context.get_exported())\n self.__name__ = template.name\n\n def __html__(self) -> Markup:\n return Markup(concat(self._body_stream))\n\n def __str__(self) -> str:\n return concat(self._body_stream)\n\n def __repr__(self) -> str:\n if self.__name__ is None:\n name = f\"memory:{id(self):x}\"\n else:\n name = repr(self.__name__)\n return f\"<{type(self).__name__} {name}>\"\n\n\nclass TemplateExpression:\n \"\"\"The :meth:`jinja2.Environment.compile_expression` method returns an\n instance of this object. It encapsulates the expression-like access\n to the template with an expression it wraps.\n \"\"\"\n\n def __init__(self, template: Template, undefined_to_none: bool) -> None:\n self._template = template\n self._undefined_to_none = undefined_to_none\n\n def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any | None:\n context = self._template.new_context(dict(*args, **kwargs))\n consume(self._template.root_render_func(context))\n rv = context.vars[\"result\"]\n if self._undefined_to_none and isinstance(rv, Undefined):\n rv = None\n return rv\n\n\nclass TemplateStream:\n \"\"\"A template stream works pretty much like an ordinary python generator\n but it can buffer multiple items to reduce the number of total iterations.\n Per default the output is unbuffered which means that for every unbuffered\n instruction in the template one string is yielded.\n\n If buffering is enabled with a buffer size of 5, five items are combined\n into a new string. This is mainly useful if you are streaming\n big templates to a client via WSGI which flushes after each iteration.\n \"\"\"\n\n def __init__(self, gen: t.Iterator[str]) -> None:\n self._gen = gen\n self.disable_buffering()\n\n def dump(\n self,\n fp: str | t.IO[bytes],\n encoding: str | None = None,\n errors: str | None = \"strict\",\n ) -> None:\n \"\"\"Dump the complete stream into a file or file-like object.\n Per default strings are written, if you want to encode\n before writing specify an `encoding`.\n\n Example usage::\n\n Template('Hello {{ name }}!').stream(name='foo').dump('hello.html')\n \"\"\"\n close = False\n\n if isinstance(fp, str):\n if encoding is None:\n encoding = \"utf-8\"\n\n real_fp: t.IO[bytes] = open(fp, \"wb\")\n close = True\n else:\n real_fp = fp\n\n try:\n if encoding is not None:\n iterable = (x.encode(encoding, errors) for x in self) # type: ignore\n else:\n iterable = self # type: ignore\n\n if hasattr(real_fp, \"writelines\"):\n real_fp.writelines(iterable)\n else:\n for item in iterable:\n real_fp.write(item)\n finally:\n if close:\n real_fp.close()\n\n def disable_buffering(self) -> None:\n \"\"\"Disable the output buffering.\"\"\"\n self._next = partial(next, self._gen)\n self.buffered = False\n\n def _buffered_generator(self, size: int) -> t.Iterator[str]:\n buf: list[str] = []\n c_size = 0\n push = buf.append\n\n while True:\n try:\n while c_size < size:\n c = next(self._gen)\n push(c)\n if c:\n c_size += 1\n except StopIteration:\n if not c_size:\n return\n yield concat(buf)\n del buf[:]\n c_size = 0\n\n def enable_buffering(self, size: int = 5) -> None:\n \"\"\"Enable buffering. Buffer `size` items before yielding them.\"\"\"\n if size <= 1:\n raise ValueError(\"buffer size too small\")\n\n self.buffered = True\n self._next = partial(next, self._buffered_generator(size))\n\n def __iter__(self) -> \"TemplateStream\":\n return self\n\n def __next__(self) -> str:\n return self._next() # type: ignore\n\n\n# hook in default template class. if anyone reads this comment: ignore that\n# it's possible to use custom templates ;-)\nEnvironment.template_class = Template\n"
},
{
"path": "src/jinja2/exceptions.py",
"content": "import typing as t\n\nif t.TYPE_CHECKING:\n from .runtime import Undefined\n\n\nclass TemplateError(Exception):\n \"\"\"Baseclass for all template errors.\"\"\"\n\n def __init__(self, message: str | None = None) -> None:\n super().__init__(message)\n\n @property\n def message(self) -> str | None:\n return self.args[0] if self.args else None\n\n\nclass TemplateNotFound(IOError, LookupError, TemplateError):\n \"\"\"Raised if a template does not exist.\n\n .. versionchanged:: 2.11\n If the given name is :class:`Undefined` and no message was\n provided, an :exc:`UndefinedError` is raised.\n \"\"\"\n\n # Silence the Python warning about message being deprecated since\n # it's not valid here.\n message: str | None = None\n\n def __init__(\n self,\n name: t.Union[str, \"Undefined\"] | None,\n message: str | None = None,\n ) -> None:\n IOError.__init__(self, name)\n\n if message is None:\n from .runtime import Undefined\n\n if isinstance(name, Undefined):\n name._fail_with_undefined_error()\n\n message = name\n\n self.message = message\n self.name = name\n self.templates = [name]\n\n def __str__(self) -> str:\n return str(self.message)\n\n\nclass TemplatesNotFound(TemplateNotFound):\n \"\"\"Like :class:`TemplateNotFound` but raised if multiple templates\n are selected. This is a subclass of :class:`TemplateNotFound`\n exception, so just catching the base exception will catch both.\n\n .. versionchanged:: 2.11\n If a name in the list of names is :class:`Undefined`, a message\n about it being undefined is shown rather than the empty string.\n\n .. versionadded:: 2.2\n \"\"\"\n\n def __init__(\n self,\n names: t.Sequence[t.Union[str, \"Undefined\"]] = (),\n message: str | None = None,\n ) -> None:\n if message is None:\n from .runtime import Undefined\n\n parts = []\n\n for name in names:\n if isinstance(name, Undefined):\n parts.append(name._undefined_message)\n else:\n parts.append(name)\n\n parts_str = \", \".join(map(str, parts))\n message = f\"none of the templates given were found: {parts_str}\"\n\n super().__init__(names[-1] if names else None, message)\n self.templates = list(names)\n\n\nclass TemplateSyntaxError(TemplateError):\n \"\"\"Raised to tell the user that there is a problem with the template.\"\"\"\n\n def __init__(\n self,\n message: str,\n lineno: int,\n name: str | None = None,\n filename: str | None = None,\n ) -> None:\n super().__init__(message)\n self.lineno = lineno\n self.name = name\n self.filename = filename\n self.source: str | None = None\n\n # this is set to True if the debug.translate_syntax_error\n # function translated the syntax error into a new traceback\n self.translated = False\n\n def __str__(self) -> str:\n # for translated errors we only return the message\n if self.translated:\n return t.cast(str, self.message)\n\n # otherwise attach some stuff\n location = f\"line {self.lineno}\"\n name = self.filename or self.name\n if name:\n location = f'File \"{name}\", {location}'\n lines = [t.cast(str, self.message), \" \" + location]\n\n # if the source is set, add the line to the output\n if self.source is not None:\n try:\n line = self.source.splitlines()[self.lineno - 1]\n except IndexError:\n pass\n else:\n lines.append(\" \" + line.strip())\n\n return \"\\n\".join(lines)\n\n def __reduce__(self): # type: ignore\n # https://bugs.python.org/issue1692335 Exceptions that take\n # multiple required arguments have problems with pickling.\n # Without this, raises TypeError: __init__() missing 1 required\n # positional argument: 'lineno'\n return self.__class__, (self.message, self.lineno, self.name, self.filename)\n\n\nclass TemplateAssertionError(TemplateSyntaxError):\n \"\"\"Like a template syntax error, but covers cases where something in the\n template caused an error at compile time that wasn't necessarily caused\n by a syntax error. However it's a direct subclass of\n :exc:`TemplateSyntaxError` and has the same attributes.\n \"\"\"\n\n\nclass TemplateRuntimeError(TemplateError):\n \"\"\"A generic runtime error in the template engine. Under some situations\n Jinja may raise this exception.\n \"\"\"\n\n\nclass UndefinedError(TemplateRuntimeError):\n \"\"\"Raised if a template tries to operate on :class:`Undefined`.\"\"\"\n\n\nclass SecurityError(TemplateRuntimeError):\n \"\"\"Raised if a template tries to do something insecure if the\n sandbox is enabled.\n \"\"\"\n\n\nclass FilterArgumentError(TemplateRuntimeError):\n \"\"\"This error is raised if a filter was called with inappropriate\n arguments\n \"\"\"\n"
},
{
"path": "src/jinja2/ext.py",
"content": "\"\"\"Extension API for adding custom tags and behavior.\"\"\"\n\nimport pprint\nimport re\nimport typing as t\n\nfrom markupsafe import Markup\n\nfrom . import defaults\nfrom . import nodes\nfrom .environment import Environment\nfrom .exceptions import TemplateAssertionError\nfrom .exceptions import TemplateSyntaxError\nfrom .runtime import concat # type: ignore\nfrom .runtime import Context\nfrom .runtime import Undefined\nfrom .utils import import_string\nfrom .utils import pass_context\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n from .lexer import Token\n from .lexer import TokenStream\n from .parser import Parser\n\n class _TranslationsBasic(te.Protocol):\n def gettext(self, message: str) -> str: ...\n\n def ngettext(self, singular: str, plural: str, n: int) -> str:\n pass\n\n class _TranslationsContext(_TranslationsBasic):\n def pgettext(self, context: str, message: str) -> str: ...\n\n def npgettext(\n self, context: str, singular: str, plural: str, n: int\n ) -> str: ...\n\n _SupportedTranslations = _TranslationsBasic | _TranslationsContext\n\n\n# I18N functions available in Jinja templates. If the I18N library\n# provides ugettext, it will be assigned to gettext.\nGETTEXT_FUNCTIONS: tuple[str, ...] = (\n \"_\",\n \"gettext\",\n \"ngettext\",\n \"pgettext\",\n \"npgettext\",\n)\n_ws_re = re.compile(r\"\\s*\\n\\s*\")\n\n\nclass Extension:\n \"\"\"Extensions can be used to add extra functionality to the Jinja template\n system at the parser level. Custom extensions are bound to an environment\n but may not store environment specific data on `self`. The reason for\n this is that an extension can be bound to another environment (for\n overlays) by creating a copy and reassigning the `environment` attribute.\n\n As extensions are created by the environment they cannot accept any\n arguments for configuration. One may want to work around that by using\n a factory function, but that is not possible as extensions are identified\n by their import name. The correct way to configure the extension is\n storing the configuration values on the environment. Because this way the\n environment ends up acting as central configuration storage the\n attributes may clash which is why extensions have to ensure that the names\n they choose for configuration are not too generic. ``prefix`` for example\n is a terrible name, ``fragment_cache_prefix`` on the other hand is a good\n name as includes the name of the extension (fragment cache).\n \"\"\"\n\n identifier: t.ClassVar[str]\n\n def __init_subclass__(cls) -> None:\n cls.identifier = f\"{cls.__module__}.{cls.__name__}\"\n\n #: if this extension parses this is the list of tags it's listening to.\n tags: set[str] = set()\n\n #: the priority of that extension. This is especially useful for\n #: extensions that preprocess values. A lower value means higher\n #: priority.\n #:\n #: .. versionadded:: 2.4\n priority = 100\n\n def __init__(self, environment: Environment) -> None:\n self.environment = environment\n\n def bind(self, environment: Environment) -> \"te.Self\":\n \"\"\"Create a copy of this extension bound to another environment.\"\"\"\n rv = object.__new__(self.__class__)\n rv.__dict__.update(self.__dict__)\n rv.environment = environment\n return rv\n\n def preprocess(\n self, source: str, name: str | None, filename: str | None = None\n ) -> str:\n \"\"\"This method is called before the actual lexing and can be used to\n preprocess the source. The `filename` is optional. The return value\n must be the preprocessed source.\n \"\"\"\n return source\n\n def filter_stream(\n self, stream: \"TokenStream\"\n ) -> t.Union[\"TokenStream\", t.Iterable[\"Token\"]]:\n \"\"\"It's passed a :class:`~jinja2.lexer.TokenStream` that can be used\n to filter tokens returned. This method has to return an iterable of\n :class:`~jinja2.lexer.Token`\\\\s, but it doesn't have to return a\n :class:`~jinja2.lexer.TokenStream`.\n \"\"\"\n return stream\n\n def parse(self, parser: \"Parser\") -> nodes.Node | list[nodes.Node]:\n \"\"\"If any of the :attr:`tags` matched this method is called with the\n parser as first argument. The token the parser stream is pointing at\n is the name token that matched. This method has to return one or a\n list of multiple nodes.\n \"\"\"\n raise NotImplementedError()\n\n def attr(self, name: str, lineno: int | None = None) -> nodes.ExtensionAttribute:\n \"\"\"Return an attribute node for the current extension. This is useful\n to pass constants on extensions to generated template code.\n\n ::\n\n self.attr('_my_attribute', lineno=lineno)\n \"\"\"\n return nodes.ExtensionAttribute(self.identifier, name, lineno=lineno)\n\n def call_method(\n self,\n name: str,\n args: list[nodes.Expr] | None = None,\n kwargs: list[nodes.Keyword] | None = None,\n dyn_args: nodes.Expr | None = None,\n dyn_kwargs: nodes.Expr | None = None,\n lineno: int | None = None,\n ) -> nodes.Call:\n \"\"\"Call a method of the extension. This is a shortcut for\n :meth:`attr` + :class:`jinja2.nodes.Call`.\n \"\"\"\n if args is None:\n args = []\n if kwargs is None:\n kwargs = []\n return nodes.Call(\n self.attr(name, lineno=lineno),\n args,\n kwargs,\n dyn_args,\n dyn_kwargs,\n lineno=lineno,\n )\n\n\n@pass_context\ndef _gettext_alias(\n __context: Context, *args: t.Any, **kwargs: t.Any\n) -> t.Any | Undefined:\n return __context.call(__context.resolve(\"gettext\"), *args, **kwargs)\n\n\ndef _make_new_gettext(func: t.Callable[[str], str]) -> t.Callable[..., str]:\n @pass_context\n def gettext(__context: Context, __string: str, **variables: t.Any) -> str:\n rv = __context.call(func, __string)\n if __context.eval_ctx.autoescape:\n rv = Markup(rv)\n # Always treat as a format string, even if there are no\n # variables. This makes translation strings more consistent\n # and predictable. This requires escaping\n return rv % variables # type: ignore\n\n return gettext\n\n\ndef _make_new_ngettext(func: t.Callable[[str, str, int], str]) -> t.Callable[..., str]:\n @pass_context\n def ngettext(\n __context: Context,\n __singular: str,\n __plural: str,\n __num: int,\n **variables: t.Any,\n ) -> str:\n variables.setdefault(\"num\", __num)\n rv = __context.call(func, __singular, __plural, __num)\n if __context.eval_ctx.autoescape:\n rv = Markup(rv)\n # Always treat as a format string, see gettext comment above.\n return rv % variables # type: ignore\n\n return ngettext\n\n\ndef _make_new_pgettext(func: t.Callable[[str, str], str]) -> t.Callable[..., str]:\n @pass_context\n def pgettext(\n __context: Context, __string_ctx: str, __string: str, **variables: t.Any\n ) -> str:\n variables.setdefault(\"context\", __string_ctx)\n rv = __context.call(func, __string_ctx, __string)\n\n if __context.eval_ctx.autoescape:\n rv = Markup(rv)\n\n # Always treat as a format string, see gettext comment above.\n return rv % variables # type: ignore\n\n return pgettext\n\n\ndef _make_new_npgettext(\n func: t.Callable[[str, str, str, int], str],\n) -> t.Callable[..., str]:\n @pass_context\n def npgettext(\n __context: Context,\n __string_ctx: str,\n __singular: str,\n __plural: str,\n __num: int,\n **variables: t.Any,\n ) -> str:\n variables.setdefault(\"context\", __string_ctx)\n variables.setdefault(\"num\", __num)\n rv = __context.call(func, __string_ctx, __singular, __plural, __num)\n\n if __context.eval_ctx.autoescape:\n rv = Markup(rv)\n\n # Always treat as a format string, see gettext comment above.\n return rv % variables # type: ignore\n\n return npgettext\n\n\nclass InternationalizationExtension(Extension):\n \"\"\"This extension adds gettext support to Jinja.\"\"\"\n\n tags = {\"trans\"}\n\n # TODO: the i18n extension is currently reevaluating values in a few\n # situations. Take this example:\n # {% trans count=something() %}{{ count }} foo{% pluralize\n # %}{{ count }} fooss{% endtrans %}\n # something is called twice here. One time for the gettext value and\n # the other time for the n-parameter of the ngettext function.\n\n def __init__(self, environment: Environment) -> None:\n super().__init__(environment)\n environment.globals[\"_\"] = _gettext_alias\n environment.extend(\n install_gettext_translations=self._install,\n install_null_translations=self._install_null,\n install_gettext_callables=self._install_callables,\n uninstall_gettext_translations=self._uninstall,\n extract_translations=self._extract,\n newstyle_gettext=False,\n )\n\n def _install(\n self, translations: \"_SupportedTranslations\", newstyle: bool | None = None\n ) -> None:\n # ugettext and ungettext are preferred in case the I18N library\n # is providing compatibility with older Python versions.\n gettext = getattr(translations, \"ugettext\", None)\n if gettext is None:\n gettext = translations.gettext\n ngettext = getattr(translations, \"ungettext\", None)\n if ngettext is None:\n ngettext = translations.ngettext\n\n pgettext = getattr(translations, \"pgettext\", None)\n npgettext = getattr(translations, \"npgettext\", None)\n self._install_callables(\n gettext, ngettext, newstyle=newstyle, pgettext=pgettext, npgettext=npgettext\n )\n\n def _install_null(self, newstyle: bool | None = None) -> None:\n import gettext\n\n translations = gettext.NullTranslations()\n self._install_callables(\n gettext=translations.gettext,\n ngettext=translations.ngettext,\n newstyle=newstyle,\n pgettext=translations.pgettext,\n npgettext=translations.npgettext,\n )\n\n def _install_callables(\n self,\n gettext: t.Callable[[str], str],\n ngettext: t.Callable[[str, str, int], str],\n newstyle: bool | None = None,\n pgettext: t.Callable[[str, str], str] | None = None,\n npgettext: t.Callable[[str, str, str, int], str] | None = None,\n ) -> None:\n if newstyle is not None:\n self.environment.newstyle_gettext = newstyle # type: ignore\n if self.environment.newstyle_gettext: # type: ignore\n gettext = _make_new_gettext(gettext)\n ngettext = _make_new_ngettext(ngettext)\n\n if pgettext is not None:\n pgettext = _make_new_pgettext(pgettext)\n\n if npgettext is not None:\n npgettext = _make_new_npgettext(npgettext)\n\n self.environment.globals.update(\n gettext=gettext, ngettext=ngettext, pgettext=pgettext, npgettext=npgettext\n )\n\n def _uninstall(self, translations: \"_SupportedTranslations\") -> None:\n for key in (\"gettext\", \"ngettext\", \"pgettext\", \"npgettext\"):\n self.environment.globals.pop(key, None)\n\n def _extract(\n self,\n source: str | nodes.Template,\n gettext_functions: t.Sequence[str] = GETTEXT_FUNCTIONS,\n ) -> t.Iterator[tuple[int, str, str | None | tuple[str | None, ...]]]:\n if isinstance(source, str):\n source = self.environment.parse(source)\n return extract_from_ast(source, gettext_functions)\n\n def parse(self, parser: \"Parser\") -> nodes.Node | list[nodes.Node]:\n \"\"\"Parse a translatable tag.\"\"\"\n lineno = next(parser.stream).lineno\n\n context = None\n context_token = parser.stream.next_if(\"string\")\n\n if context_token is not None:\n context = context_token.value\n\n # find all the variables referenced. Additionally a variable can be\n # defined in the body of the trans block too, but this is checked at\n # a later state.\n plural_expr: nodes.Expr | None = None\n plural_expr_assignment: nodes.Assign | None = None\n num_called_num = False\n variables: dict[str, nodes.Expr] = {}\n trimmed = None\n while parser.stream.current.type != \"block_end\":\n if variables:\n parser.stream.expect(\"comma\")\n\n # skip colon for python compatibility\n if parser.stream.skip_if(\"colon\"):\n break\n\n token = parser.stream.expect(\"name\")\n if token.value in variables:\n parser.fail(\n f\"translatable variable {token.value!r} defined twice.\",\n token.lineno,\n exc=TemplateAssertionError,\n )\n\n # expressions\n if parser.stream.current.type == \"assign\":\n next(parser.stream)\n variables[token.value] = var = parser.parse_expression()\n elif trimmed is None and token.value in (\"trimmed\", \"notrimmed\"):\n trimmed = token.value == \"trimmed\"\n continue\n else:\n variables[token.value] = var = nodes.Name(token.value, \"load\")\n\n if plural_expr is None:\n if isinstance(var, nodes.Call):\n plural_expr = nodes.Name(\"_trans\", \"load\")\n variables[token.value] = plural_expr\n plural_expr_assignment = nodes.Assign(\n nodes.Name(\"_trans\", \"store\"), var\n )\n else:\n plural_expr = var\n num_called_num = token.value == \"num\"\n\n parser.stream.expect(\"block_end\")\n\n plural = None\n have_plural = False\n referenced = set()\n\n # now parse until endtrans or pluralize\n singular_names, singular = self._parse_block(parser, True)\n if singular_names:\n referenced.update(singular_names)\n if plural_expr is None:\n plural_expr = nodes.Name(singular_names[0], \"load\")\n num_called_num = singular_names[0] == \"num\"\n\n # if we have a pluralize block, we parse that too\n if parser.stream.current.test(\"name:pluralize\"):\n have_plural = True\n next(parser.stream)\n if parser.stream.current.type != \"block_end\":\n token = parser.stream.expect(\"name\")\n if token.value not in variables:\n parser.fail(\n f\"unknown variable {token.value!r} for pluralization\",\n token.lineno,\n exc=TemplateAssertionError,\n )\n plural_expr = variables[token.value]\n num_called_num = token.value == \"num\"\n parser.stream.expect(\"block_end\")\n plural_names, plural = self._parse_block(parser, False)\n next(parser.stream)\n referenced.update(plural_names)\n else:\n next(parser.stream)\n\n # register free names as simple name expressions\n for name in referenced:\n if name not in variables:\n variables[name] = nodes.Name(name, \"load\")\n\n if not have_plural:\n plural_expr = None\n elif plural_expr is None:\n parser.fail(\"pluralize without variables\", lineno)\n\n if trimmed is None:\n trimmed = self.environment.policies[\"ext.i18n.trimmed\"]\n if trimmed:\n singular = self._trim_whitespace(singular)\n if plural:\n plural = self._trim_whitespace(plural)\n\n node = self._make_node(\n singular,\n plural,\n context,\n variables,\n plural_expr,\n bool(referenced),\n num_called_num and have_plural,\n )\n node.set_lineno(lineno)\n if plural_expr_assignment is not None:\n return [plural_expr_assignment, node]\n else:\n return node\n\n def _trim_whitespace(self, string: str, _ws_re: t.Pattern[str] = _ws_re) -> str:\n return _ws_re.sub(\" \", string.strip())\n\n def _parse_block(\n self, parser: \"Parser\", allow_pluralize: bool\n ) -> tuple[list[str], str]:\n \"\"\"Parse until the next block tag with a given name.\"\"\"\n referenced = []\n buf = []\n\n while True:\n if parser.stream.current.type == \"data\":\n buf.append(parser.stream.current.value.replace(\"%\", \"%%\"))\n next(parser.stream)\n elif parser.stream.current.type == \"variable_begin\":\n next(parser.stream)\n name = parser.stream.expect(\"name\").value\n referenced.append(name)\n buf.append(f\"%({name})s\")\n parser.stream.expect(\"variable_end\")\n elif parser.stream.current.type == \"block_begin\":\n next(parser.stream)\n block_name = (\n parser.stream.current.value\n if parser.stream.current.type == \"name\"\n else None\n )\n if block_name == \"endtrans\":\n break\n elif block_name == \"pluralize\":\n if allow_pluralize:\n break\n parser.fail(\n \"a translatable section can have only one pluralize section\"\n )\n elif block_name == \"trans\":\n parser.fail(\n \"trans blocks can't be nested; did you mean `endtrans`?\"\n )\n parser.fail(\n f\"control structures in translatable sections are not allowed; \"\n f\"saw `{block_name}`\"\n )\n elif parser.stream.eos:\n parser.fail(\"unclosed translation block\")\n else:\n raise RuntimeError(\"internal parser error\")\n\n return referenced, concat(buf)\n\n def _make_node(\n self,\n singular: str,\n plural: str | None,\n context: str | None,\n variables: dict[str, nodes.Expr],\n plural_expr: nodes.Expr | None,\n vars_referenced: bool,\n num_called_num: bool,\n ) -> nodes.Output:\n \"\"\"Generates a useful node from the data provided.\"\"\"\n newstyle = self.environment.newstyle_gettext # type: ignore\n node: nodes.Expr\n\n # no variables referenced? no need to escape for old style\n # gettext invocations only if there are vars.\n if not vars_referenced and not newstyle:\n singular = singular.replace(\"%%\", \"%\")\n if plural:\n plural = plural.replace(\"%%\", \"%\")\n\n func_name = \"gettext\"\n func_args: list[nodes.Expr] = [nodes.Const(singular)]\n\n if context is not None:\n func_args.insert(0, nodes.Const(context))\n func_name = f\"p{func_name}\"\n\n if plural_expr is not None:\n func_name = f\"n{func_name}\"\n func_args.extend((nodes.Const(plural), plural_expr))\n\n node = nodes.Call(nodes.Name(func_name, \"load\"), func_args, [], None, None)\n\n # in case newstyle gettext is used, the method is powerful\n # enough to handle the variable expansion and autoescape\n # handling itself\n if newstyle:\n for key, value in variables.items():\n # the function adds that later anyways in case num was\n # called num, so just skip it.\n if num_called_num and key == \"num\":\n continue\n node.kwargs.append(nodes.Keyword(key, value))\n\n # otherwise do that here\n else:\n # mark the return value as safe if we are in an\n # environment with autoescaping turned on\n node = nodes.MarkSafeIfAutoescape(node)\n if variables:\n node = nodes.Mod(\n node,\n nodes.Dict(\n [\n nodes.Pair(nodes.Const(key), value)\n for key, value in variables.items()\n ]\n ),\n )\n return nodes.Output([node])\n\n\nclass ExprStmtExtension(Extension):\n \"\"\"Adds a `do` tag to Jinja that works like the print statement just\n that it doesn't print the return value.\n \"\"\"\n\n tags = {\"do\"}\n\n def parse(self, parser: \"Parser\") -> nodes.ExprStmt:\n node = nodes.ExprStmt(lineno=next(parser.stream).lineno)\n node.node = parser.parse_tuple()\n return node\n\n\nclass LoopControlExtension(Extension):\n \"\"\"Adds break and continue to the template engine.\"\"\"\n\n tags = {\"break\", \"continue\"}\n\n def parse(self, parser: \"Parser\") -> nodes.Break | nodes.Continue:\n token = next(parser.stream)\n if token.value == \"break\":\n return nodes.Break(lineno=token.lineno)\n return nodes.Continue(lineno=token.lineno)\n\n\nclass DebugExtension(Extension):\n \"\"\"A ``{% debug %}`` tag that dumps the available variables,\n filters, and tests.\n\n .. code-block:: html+jinja\n\n
{% debug %}
\n\n .. code-block:: text\n\n {'context': {'cycler': ,\n ...,\n 'namespace': },\n 'filters': ['abs', 'attr', 'batch', 'capitalize', 'center', 'count', 'd',\n ..., 'urlencode', 'urlize', 'wordcount', 'wordwrap', 'xmlattr'],\n 'tests': ['!=', '<', '<=', '==', '>', '>=', 'callable', 'defined',\n ..., 'odd', 'sameas', 'sequence', 'string', 'undefined', 'upper']}\n\n .. versionadded:: 2.11.0\n \"\"\"\n\n tags = {\"debug\"}\n\n def parse(self, parser: \"Parser\") -> nodes.Output:\n lineno = parser.stream.expect(\"name:debug\").lineno\n context = nodes.ContextReference()\n result = self.call_method(\"_render\", [context], lineno=lineno)\n return nodes.Output([result], lineno=lineno)\n\n def _render(self, context: Context) -> str:\n result = {\n \"context\": context.get_all(),\n \"filters\": sorted(self.environment.filters.keys()),\n \"tests\": sorted(self.environment.tests.keys()),\n }\n\n # Set the depth since the intent is to show the top few names.\n return pprint.pformat(result, depth=3, compact=True)\n\n\ndef extract_from_ast(\n ast: nodes.Template,\n gettext_functions: t.Sequence[str] = GETTEXT_FUNCTIONS,\n babel_style: bool = True,\n) -> t.Iterator[tuple[int, str, str | None | tuple[str | None, ...]]]:\n \"\"\"Extract localizable strings from the given template node. Per\n default this function returns matches in babel style that means non string\n parameters as well as keyword arguments are returned as `None`. This\n allows Babel to figure out what you really meant if you are using\n gettext functions that allow keyword arguments for placeholder expansion.\n If you don't want that behavior set the `babel_style` parameter to `False`\n which causes only strings to be returned and parameters are always stored\n in tuples. As a consequence invalid gettext calls (calls without a single\n string parameter or string parameters after non-string parameters) are\n skipped.\n\n This example explains the behavior:\n\n >>> from jinja2 import Environment\n >>> env = Environment()\n >>> node = env.parse('{{ (_(\"foo\"), _(), ngettext(\"foo\", \"bar\", 42)) }}')\n >>> list(extract_from_ast(node))\n [(1, '_', 'foo'), (1, '_', ()), (1, 'ngettext', ('foo', 'bar', None))]\n >>> list(extract_from_ast(node, babel_style=False))\n [(1, '_', ('foo',)), (1, 'ngettext', ('foo', 'bar'))]\n\n For every string found this function yields a ``(lineno, function,\n message)`` tuple, where:\n\n * ``lineno`` is the number of the line on which the string was found,\n * ``function`` is the name of the ``gettext`` function used (if the\n string was extracted from embedded Python code), and\n * ``message`` is the string, or a tuple of strings for functions\n with multiple string arguments.\n\n This extraction function operates on the AST and is because of that unable\n to extract any comments. For comment support you have to use the babel\n extraction interface or extract comments yourself.\n \"\"\"\n out: str | None | tuple[str | None, ...]\n\n for node in ast.find_all(nodes.Call):\n if (\n not isinstance(node.node, nodes.Name)\n or node.node.name not in gettext_functions\n ):\n continue\n\n strings: list[str | None] = []\n\n for arg in node.args:\n if isinstance(arg, nodes.Const) and isinstance(arg.value, str):\n strings.append(arg.value)\n else:\n strings.append(None)\n\n for _ in node.kwargs:\n strings.append(None)\n if node.dyn_args is not None:\n strings.append(None)\n if node.dyn_kwargs is not None:\n strings.append(None)\n\n if not babel_style:\n out = tuple(x for x in strings if x is not None)\n\n if not out:\n continue\n else:\n if len(strings) == 1:\n out = strings[0]\n else:\n out = tuple(strings)\n\n yield node.lineno, node.node.name, out\n\n\nclass _CommentFinder:\n \"\"\"Helper class to find comments in a token stream. Can only\n find comments for gettext calls forwards. Once the comment\n from line 4 is found, a comment for line 1 will not return a\n usable value.\n \"\"\"\n\n def __init__(\n self, tokens: t.Sequence[tuple[int, str, str]], comment_tags: t.Sequence[str]\n ) -> None:\n self.tokens = tokens\n self.comment_tags = comment_tags\n self.offset = 0\n self.last_lineno = 0\n\n def find_backwards(self, offset: int) -> list[str]:\n try:\n for _, token_type, token_value in reversed(\n self.tokens[self.offset : offset]\n ):\n if token_type in (\"comment\", \"linecomment\"):\n try:\n prefix, comment = token_value.split(None, 1)\n except ValueError:\n continue\n if prefix in self.comment_tags:\n return [comment.rstrip()]\n return []\n finally:\n self.offset = offset\n\n def find_comments(self, lineno: int) -> list[str]:\n if not self.comment_tags or self.last_lineno > lineno:\n return []\n for idx, (token_lineno, _, _) in enumerate(self.tokens[self.offset :]):\n if token_lineno > lineno:\n return self.find_backwards(self.offset + idx)\n return self.find_backwards(len(self.tokens))\n\n\ndef babel_extract(\n fileobj: t.BinaryIO,\n keywords: t.Sequence[str],\n comment_tags: t.Sequence[str],\n options: dict[str, t.Any],\n) -> t.Iterator[tuple[int, str, str | None | tuple[str | None, ...], list[str]]]:\n \"\"\"Babel extraction method for Jinja templates.\n\n .. versionchanged:: 2.3\n Basic support for translation comments was added. If `comment_tags`\n is now set to a list of keywords for extraction, the extractor will\n try to find the best preceding comment that begins with one of the\n keywords. For best results, make sure to not have more than one\n gettext call in one line of code and the matching comment in the\n same line or the line before.\n\n .. versionchanged:: 2.5.1\n The `newstyle_gettext` flag can be set to `True` to enable newstyle\n gettext calls.\n\n .. versionchanged:: 2.7\n A `silent` option can now be provided. If set to `False` template\n syntax errors are propagated instead of being ignored.\n\n :param fileobj: the file-like object the messages should be extracted from\n :param keywords: a list of keywords (i.e. function names) that should be\n recognized as translation functions\n :param comment_tags: a list of translator tags to search for and include\n in the results.\n :param options: a dictionary of additional options (optional)\n :return: an iterator over ``(lineno, funcname, message, comments)`` tuples.\n (comments will be empty currently)\n \"\"\"\n extensions: dict[type[Extension], None] = {}\n\n for extension_name in options.get(\"extensions\", \"\").split(\",\"):\n extension_name = extension_name.strip()\n\n if not extension_name:\n continue\n\n extensions[import_string(extension_name)] = None\n\n if InternationalizationExtension not in extensions:\n extensions[InternationalizationExtension] = None\n\n def getbool(options: t.Mapping[str, str], key: str, default: bool = False) -> bool:\n return options.get(key, str(default)).lower() in {\"1\", \"on\", \"yes\", \"true\"}\n\n silent = getbool(options, \"silent\", True)\n environment = Environment(\n options.get(\"block_start_string\", defaults.BLOCK_START_STRING),\n options.get(\"block_end_string\", defaults.BLOCK_END_STRING),\n options.get(\"variable_start_string\", defaults.VARIABLE_START_STRING),\n options.get(\"variable_end_string\", defaults.VARIABLE_END_STRING),\n options.get(\"comment_start_string\", defaults.COMMENT_START_STRING),\n options.get(\"comment_end_string\", defaults.COMMENT_END_STRING),\n options.get(\"line_statement_prefix\") or defaults.LINE_STATEMENT_PREFIX,\n options.get(\"line_comment_prefix\") or defaults.LINE_COMMENT_PREFIX,\n getbool(options, \"trim_blocks\", defaults.TRIM_BLOCKS),\n getbool(options, \"lstrip_blocks\", defaults.LSTRIP_BLOCKS),\n defaults.NEWLINE_SEQUENCE,\n getbool(options, \"keep_trailing_newline\", defaults.KEEP_TRAILING_NEWLINE),\n tuple(extensions),\n cache_size=0,\n auto_reload=False,\n )\n\n if getbool(options, \"trimmed\"):\n environment.policies[\"ext.i18n.trimmed\"] = True\n if getbool(options, \"newstyle_gettext\"):\n environment.newstyle_gettext = True # type: ignore\n\n source = fileobj.read().decode(options.get(\"encoding\", \"utf-8\"))\n try:\n node = environment.parse(source)\n tokens = list(environment.lex(environment.preprocess(source)))\n except TemplateSyntaxError:\n if not silent:\n raise\n # skip templates with syntax errors\n return\n\n finder = _CommentFinder(tokens, comment_tags)\n for lineno, func, message in extract_from_ast(node, keywords):\n yield lineno, func, message, finder.find_comments(lineno)\n\n\n#: nicer import names\ni18n = InternationalizationExtension\ndo = ExprStmtExtension\nloopcontrols = LoopControlExtension\ndebug = DebugExtension\n"
},
{
"path": "src/jinja2/filters.py",
"content": "\"\"\"Built-in template filters used with the ``|`` operator.\"\"\"\n\nimport math\nimport random\nimport re\nimport typing\nimport typing as t\nfrom collections import abc\nfrom inspect import getattr_static\nfrom itertools import chain\nfrom itertools import groupby\n\nfrom markupsafe import escape\nfrom markupsafe import Markup\nfrom markupsafe import soft_str\n\nfrom .async_utils import async_variant\nfrom .async_utils import auto_aiter\nfrom .async_utils import auto_await\nfrom .async_utils import auto_to_list\nfrom .exceptions import FilterArgumentError\nfrom .runtime import Undefined\nfrom .utils import htmlsafe_json_dumps\nfrom .utils import pass_context\nfrom .utils import pass_environment\nfrom .utils import pass_eval_context\nfrom .utils import pformat\nfrom .utils import url_quote\nfrom .utils import urlize\n\nif t.TYPE_CHECKING:\n import typing_extensions as te\n\n from .environment import Environment\n from .nodes import EvalContext\n from .runtime import Context\n from .sandbox import SandboxedEnvironment # noqa: F401\n\n class HasHTML(te.Protocol):\n def __html__(self) -> str:\n pass\n\n\nF = t.TypeVar(\"F\", bound=t.Callable[..., t.Any])\nK = t.TypeVar(\"K\")\nV = t.TypeVar(\"V\")\n\n\ndef ignore_case(value: V) -> V:\n \"\"\"For use as a postprocessor for :func:`make_attrgetter`. Converts strings\n to lowercase and returns other types as-is.\"\"\"\n if isinstance(value, str):\n return t.cast(V, value.lower())\n\n return value\n\n\ndef make_attrgetter(\n environment: \"Environment\",\n attribute: str | int | None,\n postprocess: t.Callable[[t.Any], t.Any] | None = None,\n default: t.Any | None = None,\n) -> t.Callable[[t.Any], t.Any]:\n \"\"\"Returns a callable that looks up the given attribute from a\n passed object with the rules of the environment. Dots are allowed\n to access attributes of attributes. Integer parts in paths are\n looked up as integers.\n \"\"\"\n parts = _prepare_attribute_parts(attribute)\n\n def attrgetter(item: t.Any) -> t.Any:\n for part in parts:\n item = environment.getitem(item, part)\n\n if default is not None and isinstance(item, Undefined):\n item = default\n\n if postprocess is not None:\n item = postprocess(item)\n\n return item\n\n return attrgetter\n\n\ndef make_multi_attrgetter(\n environment: \"Environment\",\n attribute: str | int | None,\n postprocess: t.Callable[[t.Any], t.Any] | None = None,\n) -> t.Callable[[t.Any], list[t.Any]]:\n \"\"\"Returns a callable that looks up the given comma separated\n attributes from a passed object with the rules of the environment.\n Dots are allowed to access attributes of each attribute. Integer\n parts in paths are looked up as integers.\n\n The value returned by the returned callable is a list of extracted\n attribute values.\n\n Examples of attribute: \"attr1,attr2\", \"attr1.inner1.0,attr2.inner2.0\", etc.\n \"\"\"\n if isinstance(attribute, str):\n split: t.Sequence[str | int | None] = attribute.split(\",\")\n else:\n split = [attribute]\n\n parts = [_prepare_attribute_parts(item) for item in split]\n\n def attrgetter(item: t.Any) -> list[t.Any]:\n items = [None] * len(parts)\n\n for i, attribute_part in enumerate(parts):\n item_i = item\n\n for part in attribute_part:\n item_i = environment.getitem(item_i, part)\n\n if postprocess is not None:\n item_i = postprocess(item_i)\n\n items[i] = item_i\n\n return items\n\n return attrgetter\n\n\ndef _prepare_attribute_parts(\n attr: str | int | None,\n) -> list[str | int]:\n if attr is None:\n return []\n\n if isinstance(attr, str):\n return [int(x) if x.isdigit() else x for x in attr.split(\".\")]\n\n return [attr]\n\n\ndef do_forceescape(value: \"str | HasHTML\") -> Markup:\n \"\"\"Enforce HTML escaping. This will probably double escape variables.\"\"\"\n if hasattr(value, \"__html__\"):\n value = t.cast(\"HasHTML\", value).__html__()\n\n return escape(str(value))\n\n\ndef do_urlencode(\n value: str | t.Mapping[str, t.Any] | t.Iterable[tuple[str, t.Any]],\n) -> str:\n \"\"\"Quote data for use in a URL path or query using UTF-8.\n\n Basic wrapper around :func:`urllib.parse.quote` when given a\n string, or :func:`urllib.parse.urlencode` for a dict or iterable.\n\n :param value: Data to quote. A string will be quoted directly. A\n dict or iterable of ``(key, value)`` pairs will be joined as a\n query string.\n\n When given a string, \"/\" is not quoted. HTTP servers treat \"/\" and\n \"%2F\" equivalently in paths. If you need quoted slashes, use the\n ``|replace(\"/\", \"%2F\")`` filter.\n\n .. versionadded:: 2.7\n \"\"\"\n if isinstance(value, str) or not isinstance(value, abc.Iterable):\n return url_quote(value)\n\n if isinstance(value, dict):\n items: t.Iterable[tuple[str, t.Any]] = value.items()\n else:\n items = value # type: ignore\n\n return \"&\".join(\n f\"{url_quote(k, for_qs=True)}={url_quote(v, for_qs=True)}\" for k, v in items\n )\n\n\n@pass_eval_context\ndef do_replace(\n eval_ctx: \"EvalContext\", s: str, old: str, new: str, count: int | None = None\n) -> str:\n \"\"\"Return a copy of the value with all occurrences of a substring\n replaced with a new one. The first argument is the substring\n that should be replaced, the second is the replacement string.\n If the optional third argument ``count`` is given, only the first\n ``count`` occurrences are replaced:\n\n .. sourcecode:: jinja\n\n {{ \"Hello World\"|replace(\"Hello\", \"Goodbye\") }}\n -> Goodbye World\n\n {{ \"aaaaargh\"|replace(\"a\", \"d'oh, \", 2) }}\n -> d'oh, d'oh, aaargh\n \"\"\"\n if count is None:\n count = -1\n\n if not eval_ctx.autoescape:\n return str(s).replace(str(old), str(new), count)\n\n if (\n hasattr(old, \"__html__\")\n or hasattr(new, \"__html__\")\n and not hasattr(s, \"__html__\")\n ):\n s = escape(s)\n else:\n s = soft_str(s)\n\n return s.replace(soft_str(old), soft_str(new), count)\n\n\ndef do_upper(s: str) -> str:\n \"\"\"Convert a value to uppercase.\"\"\"\n return soft_str(s).upper()\n\n\ndef do_lower(s: str) -> str:\n \"\"\"Convert a value to lowercase.\"\"\"\n return soft_str(s).lower()\n\n\ndef do_items(value: t.Mapping[K, V] | Undefined) -> t.Iterator[tuple[K, V]]:\n \"\"\"Return an iterator over the ``(key, value)`` items of a mapping.\n\n ``x|items`` is the same as ``x.items()``, except if ``x`` is\n undefined an empty iterator is returned.\n\n This filter is useful if you expect the template to be rendered with\n an implementation of Jinja in another programming language that does\n not have a ``.items()`` method on its mapping type.\n\n .. code-block:: html+jinja\n\n
\n {% for key, value in my_dict|items %}\n
{{ key }}\n
{{ value }}\n {% endfor %}\n
\n\n .. versionadded:: 3.1\n \"\"\"\n if isinstance(value, Undefined):\n return\n\n if not isinstance(value, abc.Mapping):\n raise TypeError(\"Can only get item pairs from a mapping.\")\n\n yield from value.items()\n\n\n# Check for characters that would move the parser state from key to value.\n# https://html.spec.whatwg.org/#attribute-name-state\n_attr_key_re = re.compile(r\"[\\s/>=]\", flags=re.ASCII)\n\n\n@pass_eval_context\ndef do_xmlattr(\n eval_ctx: \"EvalContext\", d: t.Mapping[str, t.Any], autospace: bool = True\n) -> str:\n \"\"\"Create an SGML/XML attribute string based on the items in a dict.\n\n **Values** that are neither ``none`` nor ``undefined`` are automatically\n escaped, safely allowing untrusted user input.\n\n User input should not be used as **keys** to this filter. If any key\n contains a space, ``/`` solidus, ``>`` greater-than sign, or ``=`` equals\n sign, this fails with a ``ValueError``. Regardless of this, user input\n should never be used as keys to this filter, or must be separately validated\n first.\n\n .. sourcecode:: html+jinja\n\n \n ...\n \n\n Results in something like this:\n\n .. sourcecode:: html\n\n
\n ...\n
\n\n As you can see it automatically prepends a space in front of the item\n if the filter returned something unless the second parameter is false.\n\n .. versionchanged:: 3.1.4\n Keys with ``/`` solidus, ``>`` greater-than sign, or ``=`` equals sign\n are not allowed.\n\n .. versionchanged:: 3.1.3\n Keys with spaces are not allowed.\n \"\"\"\n items = []\n\n for key, value in d.items():\n if value is None or isinstance(value, Undefined):\n continue\n\n if _attr_key_re.search(key) is not None:\n raise ValueError(f\"Invalid character in attribute name: {key!r}\")\n\n items.append(f'{escape(key)}=\"{escape(value)}\"')\n\n rv = \" \".join(items)\n\n if autospace and rv:\n rv = \" \" + rv\n\n if eval_ctx.autoescape:\n rv = Markup(rv)\n\n return rv\n\n\ndef do_capitalize(s: str) -> str:\n \"\"\"Capitalize a value. The first character will be uppercase, all others\n lowercase.\n \"\"\"\n return soft_str(s).capitalize()\n\n\n_word_beginning_split_re = re.compile(r\"([-\\s({\\[<]+)\")\n\n\ndef do_title(s: str) -> str:\n \"\"\"Return a titlecased version of the value. I.e. words will start with\n uppercase letters, all remaining characters are lowercase.\n \"\"\"\n return \"\".join(\n [\n item[0].upper() + item[1:].lower()\n for item in _word_beginning_split_re.split(soft_str(s))\n if item\n ]\n )\n\n\ndef do_dictsort(\n value: t.Mapping[K, V],\n case_sensitive: bool = False,\n by: 'te.Literal[\"key\", \"value\"]' = \"key\",\n reverse: bool = False,\n) -> list[tuple[K, V]]:\n \"\"\"Sort a dict and yield (key, value) pairs. Python dicts may not\n be in the order you want to display them in, so sort them first.\n\n .. sourcecode:: jinja\n\n {% for key, value in mydict|dictsort %}\n sort the dict by key, case insensitive\n\n {% for key, value in mydict|dictsort(reverse=true) %}\n sort the dict by key, case insensitive, reverse order\n\n {% for key, value in mydict|dictsort(true) %}\n sort the dict by key, case sensitive\n\n {% for key, value in mydict|dictsort(false, 'value') %}\n sort the dict by value, case insensitive\n \"\"\"\n if by == \"key\":\n pos = 0\n elif by == \"value\":\n pos = 1\n else:\n raise FilterArgumentError('You can only sort by either \"key\" or \"value\"')\n\n def sort_func(item: tuple[t.Any, t.Any]) -> t.Any:\n value = item[pos]\n\n if not case_sensitive:\n value = ignore_case(value)\n\n return value\n\n return sorted(value.items(), key=sort_func, reverse=reverse)\n\n\n@pass_environment\ndef do_sort(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n reverse: bool = False,\n case_sensitive: bool = False,\n attribute: str | int | None = None,\n) -> \"list[V]\":\n \"\"\"Sort an iterable using Python's :func:`sorted`.\n\n .. sourcecode:: jinja\n\n {% for city in cities|sort %}\n ...\n {% endfor %}\n\n :param reverse: Sort descending instead of ascending.\n :param case_sensitive: When sorting strings, sort upper and lower\n case separately.\n :param attribute: When sorting objects or dicts, an attribute or\n key to sort by. Can use dot notation like ``\"address.city\"``.\n Can be a list of attributes like ``\"age,name\"``.\n\n The sort is stable, it does not change the relative order of\n elements that compare equal. This makes it is possible to chain\n sorts on different attributes and ordering.\n\n .. sourcecode:: jinja\n\n {% for user in users|sort(attribute=\"name\")\n |sort(reverse=true, attribute=\"age\") %}\n ...\n {% endfor %}\n\n As a shortcut to chaining when the direction is the same for all\n attributes, pass a comma separate list of attributes.\n\n .. sourcecode:: jinja\n\n {% for user in users|sort(attribute=\"age,name\") %}\n ...\n {% endfor %}\n\n .. versionchanged:: 2.11.0\n The ``attribute`` parameter can be a comma separated list of\n attributes, e.g. ``\"age,name\"``.\n\n .. versionchanged:: 2.6\n The ``attribute`` parameter was added.\n \"\"\"\n key_func = make_multi_attrgetter(\n environment, attribute, postprocess=ignore_case if not case_sensitive else None\n )\n return sorted(value, key=key_func, reverse=reverse)\n\n\n@pass_environment\ndef sync_do_unique(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n case_sensitive: bool = False,\n attribute: str | int | None = None,\n) -> \"t.Iterator[V]\":\n \"\"\"Returns a list of unique items from the given iterable.\n\n .. sourcecode:: jinja\n\n {{ ['foo', 'bar', 'foobar', 'FooBar']|unique|list }}\n -> ['foo', 'bar', 'foobar']\n\n The unique items are yielded in the same order as their first occurrence in\n the iterable passed to the filter.\n\n :param case_sensitive: Treat upper and lower case strings as distinct.\n :param attribute: Filter objects with unique values for this attribute.\n \"\"\"\n getter = make_attrgetter(\n environment, attribute, postprocess=ignore_case if not case_sensitive else None\n )\n seen = set()\n\n for item in value:\n key = getter(item)\n\n if key not in seen:\n seen.add(key)\n yield item\n\n\n@async_variant(sync_do_unique) # type: ignore\nasync def do_unique(\n environment: \"Environment\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n case_sensitive: bool = False,\n attribute: str | int | None = None,\n) -> \"t.Iterator[V]\":\n return sync_do_unique(\n environment, await auto_to_list(value), case_sensitive, attribute\n )\n\n\ndef _min_or_max(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n func: \"t.Callable[..., V]\",\n case_sensitive: bool,\n attribute: str | int | None,\n) -> \"V | Undefined\":\n it = iter(value)\n\n try:\n first = next(it)\n except StopIteration:\n return environment.undefined(\"No aggregated item, sequence was empty.\")\n\n key_func = make_attrgetter(\n environment, attribute, postprocess=ignore_case if not case_sensitive else None\n )\n return func(chain([first], it), key=key_func)\n\n\n@pass_environment\ndef do_min(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n case_sensitive: bool = False,\n attribute: str | int | None = None,\n) -> \"V | Undefined\":\n \"\"\"Return the smallest item from the sequence.\n\n .. sourcecode:: jinja\n\n {{ [1, 2, 3]|min }}\n -> 1\n\n :param case_sensitive: Treat upper and lower case strings as distinct.\n :param attribute: Get the object with the min value of this attribute.\n \"\"\"\n return _min_or_max(environment, value, min, case_sensitive, attribute)\n\n\n@pass_environment\ndef do_max(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n case_sensitive: bool = False,\n attribute: str | int | None = None,\n) -> \"V | Undefined\":\n \"\"\"Return the largest item from the sequence.\n\n .. sourcecode:: jinja\n\n {{ [1, 2, 3]|max }}\n -> 3\n\n :param case_sensitive: Treat upper and lower case strings as distinct.\n :param attribute: Get the object with the max value of this attribute.\n \"\"\"\n return _min_or_max(environment, value, max, case_sensitive, attribute)\n\n\ndef do_default(\n value: V,\n default_value: V = \"\", # type: ignore\n boolean: bool = False,\n) -> V:\n \"\"\"If the value is undefined it will return the passed default value,\n otherwise the value of the variable:\n\n .. sourcecode:: jinja\n\n {{ my_variable|default('my_variable is not defined') }}\n\n This will output the value of ``my_variable`` if the variable was\n defined, otherwise ``'my_variable is not defined'``. If you want\n to use default with variables that evaluate to false you have to\n set the second parameter to `true`:\n\n .. sourcecode:: jinja\n\n {{ ''|default('the string was empty', true) }}\n\n .. versionchanged:: 2.11\n It's now possible to configure the :class:`~jinja2.Environment` with\n :class:`~jinja2.ChainableUndefined` to make the `default` filter work\n on nested elements and attributes that may contain undefined values\n in the chain without getting an :exc:`~jinja2.UndefinedError`.\n \"\"\"\n if isinstance(value, Undefined) or (boolean and not value):\n return default_value\n\n return value\n\n\n@pass_eval_context\ndef sync_do_join(\n eval_ctx: \"EvalContext\",\n value: t.Iterable[t.Any],\n d: str = \"\",\n attribute: str | int | None = None,\n) -> str:\n \"\"\"Return a string which is the concatenation of the strings in the\n sequence. The separator between elements is an empty string per\n default, you can define it with the optional parameter:\n\n .. sourcecode:: jinja\n\n {{ [1, 2, 3]|join('|') }}\n -> 1|2|3\n\n {{ [1, 2, 3]|join }}\n -> 123\n\n It is also possible to join certain attributes of an object:\n\n .. sourcecode:: jinja\n\n {{ users|join(', ', attribute='username') }}\n\n .. versionadded:: 2.6\n The `attribute` parameter was added.\n \"\"\"\n if attribute is not None:\n value = map(make_attrgetter(eval_ctx.environment, attribute), value)\n\n # no automatic escaping? joining is a lot easier then\n if not eval_ctx.autoescape:\n return str(d).join(map(str, value))\n\n # if the delimiter doesn't have an html representation we check\n # if any of the items has. If yes we do a coercion to Markup\n if not hasattr(d, \"__html__\"):\n value = list(value)\n do_escape = False\n\n for idx, item in enumerate(value):\n if hasattr(item, \"__html__\"):\n do_escape = True\n else:\n value[idx] = str(item)\n\n if do_escape:\n d = escape(d)\n else:\n d = str(d)\n\n return d.join(value)\n\n # no html involved, to normal joining\n return soft_str(d).join(map(soft_str, value))\n\n\n@async_variant(sync_do_join) # type: ignore\nasync def do_join(\n eval_ctx: \"EvalContext\",\n value: t.AsyncIterable[t.Any] | t.Iterable[t.Any],\n d: str = \"\",\n attribute: str | int | None = None,\n) -> str:\n return sync_do_join(eval_ctx, await auto_to_list(value), d, attribute)\n\n\ndef do_center(value: str, width: int = 80) -> str:\n \"\"\"Centers the value in a field of a given width.\"\"\"\n return soft_str(value).center(width)\n\n\n@pass_environment\ndef sync_do_first(environment: \"Environment\", seq: \"t.Iterable[V]\") -> \"V | Undefined\":\n \"\"\"Return the first item of a sequence.\"\"\"\n try:\n return next(iter(seq))\n except StopIteration:\n return environment.undefined(\"No first item, sequence was empty.\")\n\n\n@async_variant(sync_do_first) # type: ignore\nasync def do_first(\n environment: \"Environment\", seq: \"t.AsyncIterable[V] | t.Iterable[V]\"\n) -> \"V | Undefined\":\n try:\n return await auto_aiter(seq).__anext__()\n except StopAsyncIteration:\n return environment.undefined(\"No first item, sequence was empty.\")\n\n\n@pass_environment\ndef do_last(environment: \"Environment\", seq: \"t.Reversible[V]\") -> \"V | Undefined\":\n \"\"\"Return the last item of a sequence.\n\n Note: Does not work with generators. You may want to explicitly\n convert it to a list:\n\n .. sourcecode:: jinja\n\n {{ data | selectattr('name', '==', 'Jinja') | list | last }}\n \"\"\"\n try:\n return next(iter(reversed(seq)))\n except StopIteration:\n return environment.undefined(\"No last item, sequence was empty.\")\n\n\n# No async do_last, it may not be safe in async mode.\n\n\n@pass_context\ndef do_random(context: \"Context\", seq: \"t.Sequence[V]\") -> \"V | Undefined\":\n \"\"\"Return a random item from the sequence.\"\"\"\n try:\n return random.choice(seq)\n except IndexError:\n return context.environment.undefined(\"No random item, sequence was empty.\")\n\n\ndef do_filesizeformat(value: str | float | int, binary: bool = False) -> str:\n \"\"\"Format the value like a 'human-readable' file size (i.e. 13 kB,\n 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega,\n Giga, etc.), if the second parameter is set to `True` the binary\n prefixes are used (Mebi, Gibi).\n \"\"\"\n bytes = float(value)\n base = 1024 if binary else 1000\n prefixes = [\n (\"KiB\" if binary else \"kB\"),\n (\"MiB\" if binary else \"MB\"),\n (\"GiB\" if binary else \"GB\"),\n (\"TiB\" if binary else \"TB\"),\n (\"PiB\" if binary else \"PB\"),\n (\"EiB\" if binary else \"EB\"),\n (\"ZiB\" if binary else \"ZB\"),\n (\"YiB\" if binary else \"YB\"),\n ]\n\n if bytes == 1:\n return \"1 Byte\"\n elif bytes < base:\n return f\"{int(bytes)} Bytes\"\n else:\n for i, prefix in enumerate(prefixes):\n unit = base ** (i + 2)\n\n if bytes < unit:\n return f\"{base * bytes / unit:.1f} {prefix}\"\n\n return f\"{base * bytes / unit:.1f} {prefix}\"\n\n\ndef do_pprint(value: t.Any) -> str:\n \"\"\"Pretty print a variable. Useful for debugging.\"\"\"\n return pformat(value)\n\n\n_uri_scheme_re = re.compile(r\"^([\\w.+-]{2,}:(/){0,2})$\")\n\n\n@pass_eval_context\ndef do_urlize(\n eval_ctx: \"EvalContext\",\n value: str,\n trim_url_limit: int | None = None,\n nofollow: bool = False,\n target: str | None = None,\n rel: str | None = None,\n extra_schemes: t.Iterable[str] | None = None,\n) -> str:\n \"\"\"Convert URLs in text into clickable links.\n\n This may not recognize links in some situations. Usually, a more\n comprehensive formatter, such as a Markdown library, is a better\n choice.\n\n Works on ``http://``, ``https://``, ``www.``, ``mailto:``, and email\n addresses. Links with trailing punctuation (periods, commas, closing\n parentheses) and leading punctuation (opening parentheses) are\n recognized excluding the punctuation. Email addresses that include\n header fields are not recognized (for example,\n ``mailto:address@example.com?cc=copy@example.com``).\n\n :param value: Original text containing URLs to link.\n :param trim_url_limit: Shorten displayed URL values to this length.\n :param nofollow: Add the ``rel=nofollow`` attribute to links.\n :param target: Add the ``target`` attribute to links.\n :param rel: Add the ``rel`` attribute to links.\n :param extra_schemes: Recognize URLs that start with these schemes\n in addition to the default behavior. Defaults to\n ``env.policies[\"urlize.extra_schemes\"]``, which defaults to no\n extra schemes.\n\n .. versionchanged:: 3.0\n The ``extra_schemes`` parameter was added.\n\n .. versionchanged:: 3.0\n Generate ``https://`` links for URLs without a scheme.\n\n .. versionchanged:: 3.0\n The parsing rules were updated. Recognize email addresses with\n or without the ``mailto:`` scheme. Validate IP addresses. Ignore\n parentheses and brackets in more cases.\n\n .. versionchanged:: 2.8\n The ``target`` parameter was added.\n \"\"\"\n policies = eval_ctx.environment.policies\n rel_parts = set((rel or \"\").split())\n\n if nofollow:\n rel_parts.add(\"nofollow\")\n\n rel_parts.update((policies[\"urlize.rel\"] or \"\").split())\n rel = \" \".join(sorted(rel_parts)) or None\n\n if target is None:\n target = policies[\"urlize.target\"]\n\n if extra_schemes is None:\n extra_schemes = policies[\"urlize.extra_schemes\"] or ()\n\n for scheme in extra_schemes:\n if _uri_scheme_re.fullmatch(scheme) is None:\n raise FilterArgumentError(f\"{scheme!r} is not a valid URI scheme prefix.\")\n\n rv = urlize(\n value,\n trim_url_limit=trim_url_limit,\n rel=rel,\n target=target,\n extra_schemes=extra_schemes,\n )\n\n if eval_ctx.autoescape:\n rv = Markup(rv)\n\n return rv\n\n\ndef do_indent(\n s: str, width: int | str = 4, first: bool = False, blank: bool = False\n) -> str:\n \"\"\"Return a copy of the string with each line indented by 4 spaces. The\n first line and blank lines are not indented by default.\n\n :param width: Number of spaces, or a string, to indent by.\n :param first: Don't skip indenting the first line.\n :param blank: Don't skip indenting empty lines.\n\n .. versionchanged:: 3.0\n ``width`` can be a string.\n\n .. versionchanged:: 2.10\n Blank lines are not indented by default.\n\n Rename the ``indentfirst`` argument to ``first``.\n \"\"\"\n if isinstance(width, str):\n indention = width\n else:\n indention = \" \" * width\n\n newline = \"\\n\"\n\n if isinstance(s, Markup):\n indention = Markup(indention)\n newline = Markup(newline)\n\n s += newline # this quirk is necessary for splitlines method\n\n if blank:\n rv = (newline + indention).join(s.splitlines())\n else:\n lines = s.splitlines()\n rv = lines.pop(0)\n\n if lines:\n rv += newline + newline.join(\n indention + line if line else line for line in lines\n )\n\n if first:\n rv = indention + rv\n\n return rv\n\n\n@pass_environment\ndef do_truncate(\n env: \"Environment\",\n s: str,\n length: int = 255,\n killwords: bool = False,\n end: str = \"...\",\n leeway: int | None = None,\n) -> str:\n \"\"\"Return a truncated copy of the string. The length is specified\n with the first parameter which defaults to ``255``. If the second\n parameter is ``true`` the filter will cut the text at length. Otherwise\n it will discard the last word. If the text was in fact\n truncated it will append an ellipsis sign (``\"...\"``). If you want a\n different ellipsis sign than ``\"...\"`` you can specify it using the\n third parameter. Strings that only exceed the length by the tolerance\n margin given in the fourth parameter will not be truncated.\n\n .. sourcecode:: jinja\n\n {{ \"foo bar baz qux\"|truncate(9) }}\n -> \"foo...\"\n {{ \"foo bar baz qux\"|truncate(9, True) }}\n -> \"foo ba...\"\n {{ \"foo bar baz qux\"|truncate(11) }}\n -> \"foo bar baz qux\"\n {{ \"foo bar baz qux\"|truncate(11, False, '...', 0) }}\n -> \"foo bar...\"\n\n The default leeway on newer Jinja versions is 5 and was 0 before but\n can be reconfigured globally.\n \"\"\"\n if leeway is None:\n leeway = env.policies[\"truncate.leeway\"]\n\n assert length >= len(end), f\"expected length >= {len(end)}, got {length}\"\n assert leeway >= 0, f\"expected leeway >= 0, got {leeway}\"\n\n if len(s) <= length + leeway:\n return s\n\n if killwords:\n return s[: length - len(end)] + end\n\n result = s[: length - len(end)].rsplit(\" \", 1)[0]\n return result + end\n\n\n@pass_environment\ndef do_wordwrap(\n environment: \"Environment\",\n s: str,\n width: int = 79,\n break_long_words: bool = True,\n wrapstring: str | None = None,\n break_on_hyphens: bool = True,\n) -> str:\n \"\"\"Wrap a string to the given width. Existing newlines are treated\n as paragraphs to be wrapped separately.\n\n :param s: Original text to wrap.\n :param width: Maximum length of wrapped lines.\n :param break_long_words: If a word is longer than ``width``, break\n it across lines.\n :param break_on_hyphens: If a word contains hyphens, it may be split\n across lines.\n :param wrapstring: String to join each wrapped line. Defaults to\n :attr:`Environment.newline_sequence`.\n\n .. versionchanged:: 2.11\n Existing newlines are treated as paragraphs wrapped separately.\n\n .. versionchanged:: 2.11\n Added the ``break_on_hyphens`` parameter.\n\n .. versionchanged:: 2.7\n Added the ``wrapstring`` parameter.\n \"\"\"\n import textwrap\n\n if wrapstring is None:\n wrapstring = environment.newline_sequence\n\n # textwrap.wrap doesn't consider existing newlines when wrapping.\n # If the string has a newline before width, wrap will still insert\n # a newline at width, resulting in a short line. Instead, split and\n # wrap each paragraph individually.\n return wrapstring.join(\n [\n wrapstring.join(\n textwrap.wrap(\n line,\n width=width,\n expand_tabs=False,\n replace_whitespace=False,\n break_long_words=break_long_words,\n break_on_hyphens=break_on_hyphens,\n )\n )\n for line in s.splitlines()\n ]\n )\n\n\n_word_re = re.compile(r\"\\w+\")\n\n\ndef do_wordcount(s: str) -> int:\n \"\"\"Count the words in that string.\"\"\"\n return len(_word_re.findall(soft_str(s)))\n\n\ndef do_int(value: t.Any, default: int = 0, base: int = 10) -> int:\n \"\"\"Convert the value into an integer. If the\n conversion doesn't work it will return ``0``. You can\n override this default using the first parameter. You\n can also override the default base (10) in the second\n parameter, which handles input with prefixes such as\n 0b, 0o and 0x for bases 2, 8 and 16 respectively.\n The base is ignored for decimal numbers and non-string values.\n \"\"\"\n try:\n if isinstance(value, str):\n return int(value, base)\n\n return int(value)\n except (TypeError, ValueError):\n # this quirk is necessary so that \"42.23\"|int gives 42.\n try:\n return int(float(value))\n except (TypeError, ValueError, OverflowError):\n return default\n\n\ndef do_float(value: t.Any, default: float = 0.0) -> float:\n \"\"\"Convert the value into a floating point number. If the\n conversion doesn't work it will return ``0.0``. You can\n override this default using the first parameter.\n \"\"\"\n try:\n return float(value)\n except (TypeError, ValueError):\n return default\n\n\ndef do_format(value: str, *args: t.Any, **kwargs: t.Any) -> str:\n \"\"\"Apply the given values to a `printf-style`_ format string, like\n ``string % values``.\n\n .. sourcecode:: jinja\n\n {{ \"%s, %s!\"|format(greeting, name) }}\n Hello, World!\n\n In most cases it should be more convenient and efficient to use the\n ``%`` operator or :meth:`str.format`.\n\n .. code-block:: text\n\n {{ \"%s, %s!\" % (greeting, name) }}\n {{ \"{}, {}!\".format(greeting, name) }}\n\n .. _printf-style: https://docs.python.org/library/stdtypes.html\n #printf-style-string-formatting\n \"\"\"\n if args and kwargs:\n raise FilterArgumentError(\n \"can't handle positional and keyword arguments at the same time\"\n )\n\n return soft_str(value) % (kwargs or args)\n\n\ndef do_trim(value: str, chars: str | None = None) -> str:\n \"\"\"Strip leading and trailing characters, by default whitespace.\"\"\"\n return soft_str(value).strip(chars)\n\n\ndef do_striptags(value: \"str | HasHTML\") -> str:\n \"\"\"Strip SGML/XML tags and replace adjacent whitespace by one space.\"\"\"\n if hasattr(value, \"__html__\"):\n value = t.cast(\"HasHTML\", value).__html__()\n\n return Markup(str(value)).striptags()\n\n\ndef sync_do_slice(\n value: \"t.Collection[V]\", slices: int, fill_with: \"V | None\" = None\n) -> \"t.Iterator[list[V]]\":\n \"\"\"Slice an iterator and return a list of lists containing\n those items. Useful if you want to create a div containing\n three ul tags that represent columns:\n\n .. sourcecode:: html+jinja\n\n
\n {%- for column in items|slice(3) %}\n
\n {%- for item in column %}\n
{{ item }}
\n {%- endfor %}\n
\n {%- endfor %}\n
\n\n If you pass it a second argument it's used to fill missing\n values on the last iteration.\n \"\"\"\n seq = list(value)\n length = len(seq)\n items_per_slice = length // slices\n slices_with_extra = length % slices\n offset = 0\n\n for slice_number in range(slices):\n start = offset + slice_number * items_per_slice\n\n if slice_number < slices_with_extra:\n offset += 1\n\n end = offset + (slice_number + 1) * items_per_slice\n tmp = seq[start:end]\n\n if fill_with is not None and slice_number >= slices_with_extra:\n tmp.append(fill_with)\n\n yield tmp\n\n\n@async_variant(sync_do_slice) # type: ignore\nasync def do_slice(\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n slices: int,\n fill_with: t.Any | None = None,\n) -> \"t.Iterator[list[V]]\":\n return sync_do_slice(await auto_to_list(value), slices, fill_with)\n\n\ndef do_batch(\n value: \"t.Iterable[V]\", linecount: int, fill_with: \"V | None\" = None\n) -> \"t.Iterator[list[V]]\":\n \"\"\"\n A filter that batches items. It works pretty much like `slice`\n just the other way round. It returns a list of lists with the\n given number of items. If you provide a second parameter this\n is used to fill up missing items. See this example:\n\n .. sourcecode:: html+jinja\n\n
\n {%- for row in items|batch(3, ' ') %}\n
\n {%- for column in row %}\n
{{ column }}
\n {%- endfor %}\n
\n {%- endfor %}\n
\n \"\"\"\n tmp: list[V] = []\n\n for item in value:\n if len(tmp) == linecount:\n yield tmp\n tmp = []\n\n tmp.append(item)\n\n if tmp:\n if fill_with is not None and len(tmp) < linecount:\n tmp += [fill_with] * (linecount - len(tmp))\n\n yield tmp\n\n\ndef do_round(\n value: float,\n precision: int = 0,\n method: 'te.Literal[\"common\", \"ceil\", \"floor\"]' = \"common\",\n) -> float:\n \"\"\"Round the number to a given precision. The first\n parameter specifies the precision (default is ``0``), the\n second the rounding method:\n\n - ``'common'`` rounds either up or down\n - ``'ceil'`` always rounds up\n - ``'floor'`` always rounds down\n\n If you don't specify a method ``'common'`` is used.\n\n .. sourcecode:: jinja\n\n {{ 42.55|round }}\n -> 43.0\n {{ 42.55|round(1, 'floor') }}\n -> 42.5\n\n Note that even if rounded to 0 precision, a float is returned. If\n you need a real integer, pipe it through `int`:\n\n .. sourcecode:: jinja\n\n {{ 42.55|round|int }}\n -> 43\n \"\"\"\n if method not in {\"common\", \"ceil\", \"floor\"}:\n raise FilterArgumentError(\"method must be common, ceil or floor\")\n\n if method == \"common\":\n return round(value, precision)\n\n func = getattr(math, method)\n return t.cast(float, func(value * (10**precision)) / (10**precision))\n\n\nclass _GroupTuple(t.NamedTuple):\n grouper: t.Any\n list: list[t.Any]\n\n # Use the regular tuple repr to hide this subclass if users print\n # out the value during debugging.\n def __repr__(self) -> str:\n return tuple.__repr__(self)\n\n def __str__(self) -> str:\n return tuple.__str__(self)\n\n\n@pass_environment\ndef sync_do_groupby(\n environment: \"Environment\",\n value: \"t.Iterable[V]\",\n attribute: str | int,\n default: t.Any | None = None,\n case_sensitive: bool = False,\n) -> \"list[_GroupTuple]\":\n \"\"\"Group a sequence of objects by an attribute using Python's\n :func:`itertools.groupby`. The attribute can use dot notation for\n nested access, like ``\"address.city\"``. Unlike Python's ``groupby``,\n the values are sorted first so only one group is returned for each\n unique value.\n\n For example, a list of ``User`` objects with a ``city`` attribute\n can be rendered in groups. In this example, ``grouper`` refers to\n the ``city`` value of the group.\n\n .. sourcecode:: html+jinja\n\n
{% for city, items in users|groupby(\"city\") %}\n
{{ city }}\n
{% for user in items %}\n
{{ user.name }}\n {% endfor %}
\n
\n {% endfor %}
\n\n ``groupby`` yields namedtuples of ``(grouper, list)``, which\n can be used instead of the tuple unpacking above. ``grouper`` is the\n value of the attribute, and ``list`` is the items with that value.\n\n .. sourcecode:: html+jinja\n\n
\n\n You can specify a ``default`` value to use if an object in the list\n does not have the given attribute.\n\n .. sourcecode:: jinja\n\n
{% for city, items in users|groupby(\"city\", default=\"NY\") %}\n
{{ city }}: {{ items|map(attribute=\"name\")|join(\", \") }}
\n {% endfor %}
\n\n Like the :func:`~jinja-filters.sort` filter, sorting and grouping is\n case-insensitive by default. The ``key`` for each group will have\n the case of the first item in that group of values. For example, if\n a list of users has cities ``[\"CA\", \"NY\", \"ca\"]``, the \"CA\" group\n will have two values. This can be disabled by passing\n ``case_sensitive=True``.\n\n .. versionchanged:: 3.1\n Added the ``case_sensitive`` parameter. Sorting and grouping is\n case-insensitive by default, matching other filters that do\n comparisons.\n\n .. versionchanged:: 3.0\n Added the ``default`` parameter.\n\n .. versionchanged:: 2.6\n The attribute supports dot notation for nested access.\n \"\"\"\n expr = make_attrgetter(\n environment,\n attribute,\n postprocess=ignore_case if not case_sensitive else None,\n default=default,\n )\n out = [\n _GroupTuple(key, list(values))\n for key, values in groupby(sorted(value, key=expr), expr)\n ]\n\n if not case_sensitive:\n # Return the real key from the first value instead of the lowercase key.\n output_expr = make_attrgetter(environment, attribute, default=default)\n out = [_GroupTuple(output_expr(values[0]), values) for _, values in out]\n\n return out\n\n\n@async_variant(sync_do_groupby) # type: ignore\nasync def do_groupby(\n environment: \"Environment\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n attribute: str | int,\n default: t.Any | None = None,\n case_sensitive: bool = False,\n) -> \"list[_GroupTuple]\":\n expr = make_attrgetter(\n environment,\n attribute,\n postprocess=ignore_case if not case_sensitive else None,\n default=default,\n )\n out = [\n _GroupTuple(key, await auto_to_list(values))\n for key, values in groupby(sorted(await auto_to_list(value), key=expr), expr)\n ]\n\n if not case_sensitive:\n # Return the real key from the first value instead of the lowercase key.\n output_expr = make_attrgetter(environment, attribute, default=default)\n out = [_GroupTuple(output_expr(values[0]), values) for _, values in out]\n\n return out\n\n\n@pass_environment\ndef sync_do_sum(\n environment: \"Environment\",\n iterable: \"t.Iterable[V]\",\n attribute: str | int | None = None,\n start: V = 0, # type: ignore\n) -> V:\n \"\"\"Returns the sum of a sequence of numbers plus the value of parameter\n 'start' (which defaults to 0). When the sequence is empty it returns\n start.\n\n It is also possible to sum up only certain attributes:\n\n .. sourcecode:: jinja\n\n Total: {{ items|sum(attribute='price') }}\n\n .. versionchanged:: 2.6\n The ``attribute`` parameter was added to allow summing up over\n attributes. Also the ``start`` parameter was moved on to the right.\n \"\"\"\n if attribute is not None:\n iterable = map(make_attrgetter(environment, attribute), iterable)\n\n return sum(iterable, start) # type: ignore[no-any-return, call-overload]\n\n\n@async_variant(sync_do_sum) # type: ignore\nasync def do_sum(\n environment: \"Environment\",\n iterable: \"t.AsyncIterable[V] | t.Iterable[V]\",\n attribute: str | int | None = None,\n start: V = 0, # type: ignore\n) -> V:\n rv = start\n\n if attribute is not None:\n func = make_attrgetter(environment, attribute)\n else:\n\n def func(x: V) -> V:\n return x\n\n async for item in auto_aiter(iterable):\n rv += func(item)\n\n return rv\n\n\ndef sync_do_list(value: \"t.Iterable[V]\") -> \"list[V]\":\n \"\"\"Convert the value into a list. If it was a string the returned list\n will be a list of characters.\n \"\"\"\n return list(value)\n\n\n@async_variant(sync_do_list) # type: ignore\nasync def do_list(value: \"t.AsyncIterable[V] | t.Iterable[V]\") -> \"list[V]\":\n return await auto_to_list(value)\n\n\ndef do_mark_safe(value: str) -> Markup:\n \"\"\"Mark the value as safe which means that in an environment with automatic\n escaping enabled this variable will not be escaped.\n \"\"\"\n return Markup(value)\n\n\ndef do_mark_unsafe(value: str) -> str:\n \"\"\"Mark a value as unsafe. This is the reverse operation for :func:`safe`.\"\"\"\n return str(value)\n\n\n@typing.overload\ndef do_reverse(value: str) -> str: ...\n\n\n@typing.overload\ndef do_reverse(value: \"t.Iterable[V]\") -> \"t.Iterable[V]\": ...\n\n\ndef do_reverse(value: str | t.Iterable[V]) -> str | t.Iterable[V]:\n \"\"\"Reverse the object or return an iterator that iterates over it the other\n way round.\n \"\"\"\n if isinstance(value, str):\n return value[::-1]\n\n try:\n return reversed(value) # type: ignore\n except TypeError:\n try:\n rv = list(value)\n rv.reverse()\n return rv\n except TypeError as e:\n raise FilterArgumentError(\"argument must be iterable\") from e\n\n\n@pass_environment\ndef do_attr(environment: \"Environment\", obj: t.Any, name: str) -> Undefined | t.Any:\n \"\"\"Get an attribute of an object. ``foo|attr(\"bar\")`` works like\n ``foo.bar``, but returns undefined instead of falling back to ``foo[\"bar\"]``\n if the attribute doesn't exist.\n\n See :ref:`Notes on subscriptions ` for more details.\n \"\"\"\n # Environment.getattr will fall back to obj[name] if obj.name doesn't exist.\n # But we want to call env.getattr to get behavior such as sandboxing.\n # Determine if the attr exists first, so we know the fallback won't trigger.\n try:\n # This avoids executing properties/descriptors, but misses __getattr__\n # and __getattribute__ dynamic attrs.\n getattr_static(obj, name)\n except AttributeError:\n # This finds dynamic attrs, and we know it's not a descriptor at this point.\n if not hasattr(obj, name):\n return environment.undefined(obj=obj, name=name)\n\n return environment.getattr(obj, name)\n\n\n@typing.overload\ndef sync_do_map(\n context: \"Context\",\n value: t.Iterable[t.Any],\n name: str,\n *args: t.Any,\n **kwargs: t.Any,\n) -> t.Iterable[t.Any]: ...\n\n\n@typing.overload\ndef sync_do_map(\n context: \"Context\",\n value: t.Iterable[t.Any],\n *,\n attribute: str = ...,\n default: t.Any | None = None,\n) -> t.Iterable[t.Any]: ...\n\n\n@pass_context\ndef sync_do_map(\n context: \"Context\", value: t.Iterable[t.Any], *args: t.Any, **kwargs: t.Any\n) -> t.Iterable[t.Any]:\n \"\"\"Applies a filter on a sequence of objects or looks up an attribute.\n This is useful when dealing with lists of objects but you are really\n only interested in a certain value of it.\n\n The basic usage is mapping on an attribute. Imagine you have a list\n of users but you are only interested in a list of usernames:\n\n .. sourcecode:: jinja\n\n Users on this page: {{ users|map(attribute='username')|join(', ') }}\n\n You can specify a ``default`` value to use if an object in the list\n does not have the given attribute.\n\n .. sourcecode:: jinja\n\n {{ users|map(attribute=\"username\", default=\"Anonymous\")|join(\", \") }}\n\n Alternatively you can let it invoke a filter by passing the name of the\n filter and the arguments afterwards. A good example would be applying a\n text conversion filter on a sequence:\n\n .. sourcecode:: jinja\n\n Users on this page: {{ titles|map('lower')|join(', ') }}\n\n Similar to a generator comprehension such as:\n\n .. code-block:: python\n\n (u.username for u in users)\n (getattr(u, \"username\", \"Anonymous\") for u in users)\n (do_lower(x) for x in titles)\n\n .. versionchanged:: 2.11.0\n Added the ``default`` parameter.\n\n .. versionadded:: 2.7\n \"\"\"\n if value:\n func = prepare_map(context, args, kwargs)\n\n for item in value:\n yield func(item)\n\n\n@typing.overload\ndef do_map(\n context: \"Context\",\n value: t.AsyncIterable[t.Any] | t.Iterable[t.Any],\n name: str,\n *args: t.Any,\n **kwargs: t.Any,\n) -> t.Iterable[t.Any]: ...\n\n\n@typing.overload\ndef do_map(\n context: \"Context\",\n value: t.AsyncIterable[t.Any] | t.Iterable[t.Any],\n *,\n attribute: str = ...,\n default: t.Any | None = None,\n) -> t.Iterable[t.Any]: ...\n\n\n@async_variant(sync_do_map) # type: ignore\nasync def do_map(\n context: \"Context\",\n value: t.AsyncIterable[t.Any] | t.Iterable[t.Any],\n *args: t.Any,\n **kwargs: t.Any,\n) -> t.AsyncIterable[t.Any]:\n if value:\n func = prepare_map(context, args, kwargs)\n\n async for item in auto_aiter(value):\n yield await auto_await(func(item))\n\n\n@pass_context\ndef sync_do_select(\n context: \"Context\", value: \"t.Iterable[V]\", *args: t.Any, **kwargs: t.Any\n) -> \"t.Iterator[V]\":\n \"\"\"Filters a sequence of objects by applying a test to each object,\n and only selecting the objects with the test succeeding.\n\n If no test is specified, each object will be evaluated as a boolean.\n\n Example usage:\n\n .. sourcecode:: jinja\n\n {{ numbers|select(\"odd\") }}\n {{ numbers|select(\"odd\") }}\n {{ numbers|select(\"divisibleby\", 3) }}\n {{ numbers|select(\"lessthan\", 42) }}\n {{ strings|select(\"equalto\", \"mystring\") }}\n\n Similar to a generator comprehension such as:\n\n .. code-block:: python\n\n (n for n in numbers if test_odd(n))\n (n for n in numbers if test_divisibleby(n, 3))\n\n .. versionadded:: 2.7\n \"\"\"\n return select_or_reject(context, value, args, kwargs, lambda x: x, False)\n\n\n@async_variant(sync_do_select) # type: ignore\nasync def do_select(\n context: \"Context\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n *args: t.Any,\n **kwargs: t.Any,\n) -> \"t.AsyncIterator[V]\":\n return async_select_or_reject(context, value, args, kwargs, lambda x: x, False)\n\n\n@pass_context\ndef sync_do_reject(\n context: \"Context\", value: \"t.Iterable[V]\", *args: t.Any, **kwargs: t.Any\n) -> \"t.Iterator[V]\":\n \"\"\"Filters a sequence of objects by applying a test to each object,\n and rejecting the objects with the test succeeding.\n\n If no test is specified, each object will be evaluated as a boolean.\n\n Example usage:\n\n .. sourcecode:: jinja\n\n {{ numbers|reject(\"odd\") }}\n\n Similar to a generator comprehension such as:\n\n .. code-block:: python\n\n (n for n in numbers if not test_odd(n))\n\n .. versionadded:: 2.7\n \"\"\"\n return select_or_reject(context, value, args, kwargs, lambda x: not x, False)\n\n\n@async_variant(sync_do_reject) # type: ignore\nasync def do_reject(\n context: \"Context\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n *args: t.Any,\n **kwargs: t.Any,\n) -> \"t.AsyncIterator[V]\":\n return async_select_or_reject(context, value, args, kwargs, lambda x: not x, False)\n\n\n@pass_context\ndef sync_do_selectattr(\n context: \"Context\", value: \"t.Iterable[V]\", *args: t.Any, **kwargs: t.Any\n) -> \"t.Iterator[V]\":\n \"\"\"Filters a sequence of objects by applying a test to the specified\n attribute of each object, and only selecting the objects with the\n test succeeding.\n\n If no test is specified, the attribute's value will be evaluated as\n a boolean.\n\n Example usage:\n\n .. sourcecode:: jinja\n\n {{ users|selectattr(\"is_active\") }}\n {{ users|selectattr(\"email\", \"none\") }}\n\n Similar to a generator comprehension such as:\n\n .. code-block:: python\n\n (user for user in users if user.is_active)\n (user for user in users if test_none(user.email))\n\n .. versionadded:: 2.7\n \"\"\"\n return select_or_reject(context, value, args, kwargs, lambda x: x, True)\n\n\n@async_variant(sync_do_selectattr) # type: ignore\nasync def do_selectattr(\n context: \"Context\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n *args: t.Any,\n **kwargs: t.Any,\n) -> \"t.AsyncIterator[V]\":\n return async_select_or_reject(context, value, args, kwargs, lambda x: x, True)\n\n\n@pass_context\ndef sync_do_rejectattr(\n context: \"Context\", value: \"t.Iterable[V]\", *args: t.Any, **kwargs: t.Any\n) -> \"t.Iterator[V]\":\n \"\"\"Filters a sequence of objects by applying a test to the specified\n attribute of each object, and rejecting the objects with the test\n succeeding.\n\n If no test is specified, the attribute's value will be evaluated as\n a boolean.\n\n .. sourcecode:: jinja\n\n {{ users|rejectattr(\"is_active\") }}\n {{ users|rejectattr(\"email\", \"none\") }}\n\n Similar to a generator comprehension such as:\n\n .. code-block:: python\n\n (user for user in users if not user.is_active)\n (user for user in users if not test_none(user.email))\n\n .. versionadded:: 2.7\n \"\"\"\n return select_or_reject(context, value, args, kwargs, lambda x: not x, True)\n\n\n@async_variant(sync_do_rejectattr) # type: ignore\nasync def do_rejectattr(\n context: \"Context\",\n value: \"t.AsyncIterable[V] | t.Iterable[V]\",\n *args: t.Any,\n **kwargs: t.Any,\n) -> \"t.AsyncIterator[V]\":\n return async_select_or_reject(context, value, args, kwargs, lambda x: not x, True)\n\n\n@pass_eval_context\ndef do_tojson(\n eval_ctx: \"EvalContext\", value: t.Any, indent: int | None = None\n) -> Markup:\n \"\"\"Serialize an object to a string of JSON, and mark it safe to\n render in HTML. This filter is only for use in HTML documents.\n\n The returned string is safe to render in HTML documents and\n ``
![\"\"](\"https://raw.githubusercontent.com/pallets/jinja/refs/heads/stable/docs/_static/jinja-name.svg\")