The core component of Jinja is the `Environment`. It contains important shared variables like configuration, filters, tests, globals and others. Instances of this class may be modified if they are not shared and if no template was loaded so far. Modifications on environments after the first template was loaded will lead to surprising effects and undefined behavior. Here are the possible initialization parameters: `block_start_string` The string marking the beginning of a block. Defaults to ``'{%'``. `block_end_string` The string marking the end of a block. Defaults to ``'%}'``. `variable_start_string` The string marking the beginning of a print statement. Defaults to ``'{{'``. `variable_end_string` The string marking the end of a print statement. Defaults to ``'}}'``. `comment_start_string` The string marking the beginning of a comment. Defaults to ``'{#'``. `comment_end_string` The string marking the end of a comment. Defaults to ``'#}'``. `line_statement_prefix` If given and a string, this will be used as prefix for line based statements. See also :ref:`line-statements`. `line_comment_prefix` If given and a string, this will be used as prefix for line based comments. See also :ref:`line-statements`. .. versionadded:: 2.2 `trim_blocks` If this is set to ``True`` the first newline after a block is removed (block, not variable tag!). Defaults to `False`. `lstrip_blocks` If this is set to ``True`` leading spaces and tabs are stripped from the start of a line to a block. Defaults to `False`. `newline_sequence` The sequence that starts a newline. Must be one of ``'\r'``, ``'\n'`` or ``'\r\n'``. The default is ``'\n'`` which is a useful default for Linux and OS X systems as well as web applications. `keep_trailing_newline` Preserve the trailing newline when rendering templates. The default is ``False``, which causes a single newline, if present, to be stripped from the end of the template. .. versionadded:: 2.7 `extensions` List of Jinja extensions to use. This can either be import paths as strings or extension classes. For more information have a look at :ref:`the extensions documentation <jinja-extensions>`. `optimized` should the optimizer be enabled? Default is ``True``. `undefined` :class:`Undefined` or a subclass of it that is used to represent undefined values in the template. `finalize` A callable that can be used to process the result of a variable expression before it is output. For example one can convert ``None`` implicitly into an empty string here. `autoescape` If set to ``True`` the XML/HTML autoescaping feature is enabled by default. For more details about autoescaping see :class:`~markupsafe.Markup`. As of Jinja 2.4 this can also be a callable that is passed the template name and has to return ``True`` or ``False`` depending on autoescape should be enabled by default. .. versionchanged:: 2.4 `autoescape` can now be a function `loader` The template loader for this environment. `cache_size` The size of the cache. Per default this is ``400`` which means that if more than 400 templates are loaded the loader will clean out the least recently used template. If the cache size is set to ``0`` templates are recompiled all the time, if the cache size is ``-1`` the cache will not be cleaned. .. versionchanged:: 2.8 The cache size was increased to 400 from a low 50. `auto_reload` Some loaders load templates from locations where the template sources may change (ie: file system or database). If ``auto_reload`` is set to ``True`` (default) every time a template is requested the loader checks if the source changed and if yes, it will reload the template. For higher performance it's possible to disable that. `bytecode_cache` If set to a bytecode cache object, this object will provide a cache for the internal Jinja bytecode so that templates don't have to be parsed if they were not changed. See :ref:`bytecode-cache` for more information. `enable_async` If set to true this enables async template execution which allows using async functions and generators.
Method | __init__ |
Undocumented |
Method | add |
Adds an extension after the environment was created. |
Method | call |
Invoke a filter on a value the same way the compiler does. |
Method | call |
Invoke a test on a value the same way the compiler does. |
Method | compile |
Compile a node or template source code. The `name` parameter is the load name of the template after it was joined using :meth:`join_path` if necessary, not the filename on the file system. the `filename` parameter is the estimated filename of the template on the file system... |
Method | compile |
A handy helper method that returns a callable that accepts keyword arguments that appear as variables in the expression. If called it returns the result of the expression. |
Method | compile |
Finds all the templates the loader can find, compiles them and stores them in `target`. If `zip` is `None`, instead of in a zipfile, the templates will be stored in a directory. By default a deflate zip algorithm is used... |
Method | extend |
Add the items to the instance of the environment if they do not exist yet. This is used by :ref:`extensions <writing-extensions>` to register callbacks and configuration values without breaking inheritance. |
Method | from |
Load a template from a source string without using :attr:`loader`. |
Method | get |
Use :meth:`select_template` if an iterable of template names is given, or :meth:`get_template` if one name is given. |
Method | get |
Load a template by name with :attr:`loader` and return a :class:`Template`. If the template does not exist a :exc:`TemplateNotFound` exception is raised. |
Method | getattr |
Get an item or attribute of an object but prefer the attribute. Unlike :meth:`getitem` the attribute *must* be a string. |
Method | getitem |
Get an item or attribute of an object but prefer the item. |
Method | handle |
Exception handling helper. This is used internally to either raise rewritten exceptions or return a rendered traceback for the template. |
Method | iter |
Iterates over the extensions by priority. |
Method | join |
Join a template with the parent. By default all the lookups are relative to the loader root so this method returns the `template` parameter unchanged, but if the paths should be relative to the parent template, this function can be used to calculate the real template name. |
Method | lex |
Lex the given sourcecode and return a generator that yields tokens as tuples in the form ``(lineno, token_type, value)``. This can be useful for :ref:`extension development <writing-extensions>` and debugging templates. |
Method | list |
Returns a list of templates for this environment. This requires that the loader supports the loader's :meth:`~BaseLoader.list_templates` method. |
Method | make |
Make the globals map for a template. Any given template globals overlay the environment :attr:`globals`. |
Method | overlay |
Create a new overlay environment that shares all the data with the current environment except for cache and the overridden attributes. Extensions cannot be removed for an overlayed environment. An overlayed environment automatically gets all the extensions of the environment it is linked to plus optional extra extensions. |
Method | parse |
Parse the sourcecode and return the abstract syntax tree. This tree of nodes is used by the compiler to convert the template into executable source- or bytecode. This is useful for debugging or to extract information from templates. |
Method | preprocess |
Preprocesses the source with all extensions. This is automatically called for all parsing and compiling methods but *not* for :meth:`lex` because there you usually only want the actual source tokenized. |
Method | select |
Like :meth:`get_template`, but tries loading multiple names. If none of the names can be loaded a :exc:`TemplatesNotFound` exception is raised. |
Class Variable | concat |
Undocumented |
Class Variable | linked |
Undocumented |
Class Variable | overlayed |
Undocumented |
Class Variable | sandboxed |
Undocumented |
Class Variable | shared |
Undocumented |
Class Variable | template |
Undocumented |
Instance Variable | auto |
Undocumented |
Instance Variable | autoescape |
Undocumented |
Instance Variable | block |
Undocumented |
Instance Variable | block |
Undocumented |
Instance Variable | bytecode |
Undocumented |
Instance Variable | cache |
Undocumented |
Instance Variable | comment |
Undocumented |
Instance Variable | comment |
Undocumented |
Instance Variable | extensions |
Undocumented |
Instance Variable | filters |
Undocumented |
Instance Variable | finalize |
Undocumented |
Instance Variable | globals |
Undocumented |
Instance Variable | is |
Undocumented |
Instance Variable | keep |
Undocumented |
Instance Variable | line |
Undocumented |
Instance Variable | line |
Undocumented |
Instance Variable | loader |
Undocumented |
Instance Variable | lstrip |
Undocumented |
Instance Variable | newline |
Undocumented |
Instance Variable | optimized |
Undocumented |
Instance Variable | policies |
Undocumented |
Instance Variable | tests |
Undocumented |
Instance Variable | trim |
Undocumented |
Instance Variable | undefined |
Undocumented |
Instance Variable | variable |
Undocumented |
Instance Variable | variable |
Undocumented |
Property | lexer |
The lexer for this environment. |
Method | _compile |
Internal hook that can be overridden to hook a different compile method in. |
Method | _filter |
Undocumented |
Method | _generate |
Internal hook that can be overridden to hook a different generate method in. |
Method | _load |
Undocumented |
Method | _parse |
Internal parsing function used by `parse` and `compile`. |
Method | _tokenize |
Called by the parser to do the preprocessing and filtering for all the extensions. Returns a :class:`~jinja2.lexer.TokenStream`. |
Undocumented
Parameters | |
blockstr | Undocumented |
blockstr | Undocumented |
variablestr | Undocumented |
variablestr | Undocumented |
commentstr | Undocumented |
commentstr | Undocumented |
linet.Optional[ | Undocumented |
linet.Optional[ | Undocumented |
trimbool | Undocumented |
lstripbool | Undocumented |
newlinete.Literal[ | Undocumented |
keepbool | Undocumented |
extensions:t.Sequence[ | Undocumented |
optimized:bool | Undocumented |
undefined:t.Type[ | Undocumented |
finalize:t.Optional[ | Undocumented |
autoescape:t.Union[ | Undocumented |
loader:t.Optional[ | Undocumented |
cacheint | Undocumented |
autobool | Undocumented |
bytecodet.Optional[ | Undocumented |
enablebool | Undocumented |
Invoke a filter on a value the same way the compiler does. This might return a coroutine if the filter is running from an environment in async mode and the filter supports async execution. It's your responsibility to await this if needed. .. versionadded:: 2.7
Parameters | |
name:str | Undocumented |
value:t.Any | Undocumented |
args:t.Optional[ | Undocumented |
kwargs:t.Optional[ | Undocumented |
context:t.Optional[ | Undocumented |
evalt.Optional[ | Undocumented |
Returns | |
t.Any | Undocumented |
Invoke a test on a value the same way the compiler does. This might return a coroutine if the test is running from an environment in async mode and the test supports async execution. It's your responsibility to await this if needed. .. versionchanged:: 3.0 Tests support ``@pass_context``, etc. decorators. Added the ``context`` and ``eval_ctx`` parameters. .. versionadded:: 2.7
Parameters | |
name:str | Undocumented |
value:t.Any | Undocumented |
args:t.Optional[ | Undocumented |
kwargs:t.Optional[ | Undocumented |
context:t.Optional[ | Undocumented |
evalt.Optional[ | Undocumented |
Returns | |
t.Any | Undocumented |
def compile(self, source, name=None, filename=None, raw=False, defer_init=False): (source)
Compile a node or template source code. The `name` parameter is the load name of the template after it was joined using :meth:`join_path` if necessary, not the filename on the file system. the `filename` parameter is the estimated filename of the template on the file system. If the template came from a database or memory this can be omitted. The return value of this method is a python code object. If the `raw` parameter is `True` the return value will be a string with python code equivalent to the bytecode returned otherwise. This method is mainly used internally. `defer_init` is use internally to aid the module code generator. This causes the generated code to be able to import without the global environment variable to be set. .. versionadded:: 2.4 `defer_init` parameter added.
Parameters | |
source:t.Union[ | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
raw:bool | Undocumented |
deferbool | Undocumented |
Returns | |
t.Union[ | Undocumented |
A handy helper method that returns a callable that accepts keyword arguments that appear as variables in the expression. If called it returns the result of the expression. This is useful if applications want to use the same rules as Jinja in template "configuration files" or similar situations. Example usage: >>> env = Environment() >>> expr = env.compile_expression('foo == 42') >>> expr(foo=23) False >>> expr(foo=42) True Per default the return value is converted to `None` if the expression returns an undefined value. This can be changed by setting `undefined_to_none` to `False`. >>> env.compile_expression('var')() is None True >>> env.compile_expression('var', undefined_to_none=False)() Undefined .. versionadded:: 2.1
Parameters | |
source:str | Undocumented |
undefinedbool | Undocumented |
Returns | |
TemplateExpression | Undocumented |
Finds all the templates the loader can find, compiles them and stores them in `target`. If `zip` is `None`, instead of in a zipfile, the templates will be stored in a directory. By default a deflate zip algorithm is used. To switch to the stored algorithm, `zip` can be set to ``'stored'``. `extensions` and `filter_func` are passed to :meth:`list_templates`. Each template returned will be compiled to the target folder or zipfile. By default template compilation errors are ignored. In case a log function is provided, errors are logged. If you want template syntax errors to abort the compilation you can set `ignore_errors` to `False` and you will get an exception on syntax errors. .. versionadded:: 2.4
Parameters | |
target:t.Union[ | Undocumented |
extensions:t.Optional[ | Undocumented |
filtert.Optional[ | Undocumented |
zip:t.Optional[ | Undocumented |
logt.Optional[ | Undocumented |
ignorebool | Undocumented |
Add the items to the instance of the environment if they do not exist yet. This is used by :ref:`extensions <writing-extensions>` to register callbacks and configuration values without breaking inheritance.
Parameters | |
**attributes:t.Any | Undocumented |
Load a template from a source string without using :attr:`loader`. :param source: Jinja source to compile into a template. :param globals: Extend the environment :attr:`globals` with these extra variables available for all renders of this template. If the template has already been loaded and cached, its globals are updated with any new items. :param template_class: Return an instance of this :class:`Template` class.
Parameters | |
source:t.Union[ | Undocumented |
globals:t.Optional[ | Undocumented |
templatet.Optional[ | Undocumented |
Returns | |
Template | Undocumented |
def get_or_select_template(self, template_name_or_list, parent=None, globals=None): (source)
Use :meth:`select_template` if an iterable of template names is given, or :meth:`get_template` if one name is given. .. versionadded:: 2.3
Parameters | |
templatet.Union[ | Undocumented |
parent:t.Optional[ | Undocumented |
globals:t.Optional[ | Undocumented |
Returns | |
Template | Undocumented |
Load a template by name with :attr:`loader` and return a :class:`Template`. If the template does not exist a :exc:`TemplateNotFound` exception is raised. :param name: Name of the template to load. When loading templates from the filesystem, "/" is used as the path separator, even on Windows. :param parent: The name of the parent template importing this template. :meth:`join_path` can be used to implement name transformations with this. :param globals: Extend the environment :attr:`globals` with these extra variables available for all renders of this template. If the template has already been loaded and cached, its globals are updated with any new items. .. versionchanged:: 3.0 If a template is loaded from cache, ``globals`` will update the template's globals instead of ignoring the new values. .. versionchanged:: 2.4 If ``name`` is a :class:`Template` object it is returned unchanged.
Parameters | |
name:t.Union[ | Undocumented |
parent:t.Optional[ | Undocumented |
globals:t.Optional[ | Undocumented |
Returns | |
Template | Undocumented |
Exception handling helper. This is used internally to either raise rewritten exceptions or return a rendered traceback for the template.
Parameters | |
source:t.Optional[ | Undocumented |
Returns | |
te.NoReturn | Undocumented |
Join a template with the parent. By default all the lookups are relative to the loader root so this method returns the `template` parameter unchanged, but if the paths should be relative to the parent template, this function can be used to calculate the real template name. Subclasses may override this method and implement template path joining here.
Parameters | |
template:str | Undocumented |
parent:str | Undocumented |
Returns | |
str | Undocumented |
Lex the given sourcecode and return a generator that yields tokens as tuples in the form ``(lineno, token_type, value)``. This can be useful for :ref:`extension development <writing-extensions>` and debugging templates. This does not perform preprocessing. If you want the preprocessing of the extensions to be applied you have to filter source through the :meth:`preprocess` method.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
Returns | |
t.Iterator[ | Undocumented |
Returns a list of templates for this environment. This requires that the loader supports the loader's :meth:`~BaseLoader.list_templates` method. If there are other files in the template folder besides the actual templates, the returned list can be filtered. There are two ways: either `extensions` is set to a list of file extensions for templates, or a `filter_func` can be provided which is a callable that is passed a template name and should return `True` if it should end up in the result list. If the loader does not support that, a :exc:`TypeError` is raised. .. versionadded:: 2.4
Parameters | |
extensions:t.Optional[ | Undocumented |
filtert.Optional[ | Undocumented |
Returns | |
t.List[ | Undocumented |
Make the globals map for a template. Any given template globals overlay the environment :attr:`globals`. Returns a :class:`collections.ChainMap`. This allows any changes to a template's globals to only affect that template, while changes to the environment's globals are still reflected. However, avoid modifying any globals after a template is loaded. :param d: Dict of template-specific globals. .. versionchanged:: 3.0 Use :class:`collections.ChainMap` to always prevent mutating environment globals.
Parameters | |
d:t.Optional[ | Undocumented |
Returns | |
t.MutableMapping[ | Undocumented |
Create a new overlay environment that shares all the data with the current environment except for cache and the overridden attributes. Extensions cannot be removed for an overlayed environment. An overlayed environment automatically gets all the extensions of the environment it is linked to plus optional extra extensions. Creating overlays should happen after the initial environment was set up completely. Not all attributes are truly linked, some are just copied over so modifications on the original environment may not shine through. .. versionchanged:: 3.1.2 Added the ``newline_sequence``,, ``keep_trailing_newline``, and ``enable_async`` parameters to match ``__init__``.
Parameters | |
blockstr | Undocumented |
blockstr | Undocumented |
variablestr | Undocumented |
variablestr | Undocumented |
commentstr | Undocumented |
commentstr | Undocumented |
linet.Optional[ | Undocumented |
linet.Optional[ | Undocumented |
trimbool | Undocumented |
lstripbool | Undocumented |
newlinete.Literal[ | Undocumented |
keepbool | Undocumented |
extensions:t.Sequence[ | Undocumented |
optimized:bool | Undocumented |
undefined:t.Type[ | Undocumented |
finalize:t.Optional[ | Undocumented |
autoescape:t.Union[ | Undocumented |
loader:t.Optional[ | Undocumented |
cacheint | Undocumented |
autobool | Undocumented |
bytecodet.Optional[ | Undocumented |
enablebool | Undocumented |
Returns | |
Environment | Undocumented |
Parse the sourcecode and return the abstract syntax tree. This tree of nodes is used by the compiler to convert the template into executable source- or bytecode. This is useful for debugging or to extract information from templates. If you are :ref:`developing Jinja extensions <writing-extensions>` this gives you a good overview of the node tree generated.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
Returns | |
nodes.Template | Undocumented |
Preprocesses the source with all extensions. This is automatically called for all parsing and compiling methods but *not* for :meth:`lex` because there you usually only want the actual source tokenized.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
Returns | |
str | Undocumented |
Like :meth:`get_template`, but tries loading multiple names. If none of the names can be loaded a :exc:`TemplatesNotFound` exception is raised. :param names: List of template names to try loading in order. :param parent: The name of the parent template importing this template. :meth:`join_path` can be used to implement name transformations with this. :param globals: Extend the environment :attr:`globals` with these extra variables available for all renders of this template. If the template has already been loaded and cached, its globals are updated with any new items. .. versionchanged:: 3.0 If a template is loaded from cache, ``globals`` will update the template's globals instead of ignoring the new values. .. versionchanged:: 2.11 If ``names`` is :class:`Undefined`, an :exc:`UndefinedError` is raised instead. If no templates were found and ``names`` contains :class:`Undefined`, the message is more helpful. .. versionchanged:: 2.4 If ``names`` contains a :class:`Template` object it is returned unchanged. .. versionadded:: 2.3
Parameters | |
names:t.Iterable[ | Undocumented |
parent:t.Optional[ | Undocumented |
globals:t.Optional[ | Undocumented |
Returns | |
Template | Undocumented |
Undocumented
Parameters | |
name:t.Union[ | Undocumented |
value:t.Any | Undocumented |
args:t.Optional[ | Undocumented |
kwargs:t.Optional[ | Undocumented |
context:t.Optional[ | Undocumented |
evalt.Optional[ | Undocumented |
isbool | Undocumented |
Returns | |
t.Any | Undocumented |
Internal hook that can be overridden to hook a different generate method in. .. versionadded:: 2.5
Parameters | |
source:nodes.Template | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
deferbool | Undocumented |
Returns | |
str | Undocumented |
Undocumented
Parameters | |
name:str | Undocumented |
globals:t.Optional[ | Undocumented |
Returns | |
Template | Undocumented |
Internal parsing function used by `parse` and `compile`.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
Returns | |
nodes.Template | Undocumented |
Called by the parser to do the preprocessing and filtering for all the extensions. Returns a :class:`~jinja2.lexer.TokenStream`.
Parameters | |
source:str | Undocumented |
name:t.Optional[ | Undocumented |
filename:t.Optional[ | Undocumented |
state:t.Optional[ | Undocumented |
Returns | |
TokenStream | Undocumented |