module documentation

Functions that expose information about templates that might be interesting for introspection.
Function find​_referenced​_templates No summary
Function find​_undeclared​_variables No summary
Class ​Tracking​Code​Generator We abuse the code generator for introspection.
Variable ​_ref​_types Undocumented
Variable _​Ref​Type Undocumented
def find_referenced_templates(ast):

Finds all the referenced templates from the AST. This will return an iterator over all the hardcoded template extensions, inclusions and imports. If dynamic inheritance or inclusion is used, None will be yielded.

>>> from jinja2 import Environment, meta
>>> env = Environment()
>>> ast = env.parse('{% extends "layout.html" %}{% include helper %}')
>>> list(meta.find_referenced_templates(ast))
['layout.html', None]

This function is useful for dependency tracking. For example if you want to rebuild parts of the website after a layout template has changed.

Parameters
ast:nodes.TemplateUndocumented
Returns
t.Iterator[t.Optional[str]]Undocumented
def find_undeclared_variables(ast):

Returns a set of all variables in the AST that will be looked up from the context at runtime. Because at compile time it's not known which variables will be used depending on the path the execution takes at runtime, all variables are returned.

>>> from jinja2 import Environment, meta
>>> env = Environment()
>>> ast = env.parse('{% set foo = 42 %}{{ bar + foo }}')
>>> meta.find_undeclared_variables(ast) == {'bar'}
True

Implementation

Internally the code generator is used for finding undeclared variables. This is good to know because the code generator might raise a TemplateAssertionError during compilation and as a matter of fact this function can currently raise that exception as well.

Parameters
ast:nodes.TemplateUndocumented
Returns
t.Set[str]Undocumented
_ref_types =

Undocumented

_RefType =

Undocumented