jinja2.environment

module documentation

Classes for managing templates and their runtime and compile time options.

Class	`Environment`	No summary
Class	`Template`	A compiled template that can be rendered.
Class	`TemplateStream`	No summary
Class	`TemplateExpression`	The `jinja2.Environment.compile_expression` method returns an instance of this object. It encapsulates the expression-like access to the template with an expression it wraps.
Class	`TemplateModule`	Represents an imported template. All the exported names of the template are available as attributes on this object. Additionally converting it into a string renders the contents.
Function	`_environment_config_check`	Perform a sanity check on the environment.
Function	`copy_cache`	Create an empty copy of the given cache.
Function	`create_cache`	Return the cache class for the given size.
Function	`get_spontaneous_environment`	Return a new spontaneous environment. A spontaneous environment is used for templates created directly rather than through an existing environment.
Function	`load_extensions`	Load the extensions from the list and bind it to the environment. Returns a dict of instantiated extensions.
Variable	`_env_bound`	Undocumented

def _environment_config_check(environment):

Perform a sanity check on the environment.

def copy_cache(cache):

Create an empty copy of the given cache.

Parameters
cache:`t.Optional[t.MutableMapping]`	Undocumented
Returns
`t.Optional[t.MutableMapping[t.Tuple[weakref.ref, str], Template]]`	Undocumented

def create_cache(size):

Return the cache class for the given size.

Parameters
size:`int`	Undocumented
Returns
`t.Optional[t.MutableMapping[t.Tuple[weakref.ref, str], Template]]`	Undocumented

@lru_cache(maxsize=10)
def get_spontaneous_environment(cls, *args):

Return a new spontaneous environment. A spontaneous environment is used for templates created directly rather than through an existing environment.

Parameters
cls:`t.Type[_env_bound]`	Environment class to create.
*args:`t.Any`	Positional arguments passed to environment.
Returns
`_env_bound`	Undocumented

def load_extensions(environment, extensions):

Load the extensions from the list and bind it to the environment. Returns a dict of instantiated extensions.

Parameters
environment:`Environment`	Undocumented
extensions:`t.Sequence[t.Union[str, t.Type[Extension]]]`	Undocumented
Returns
`t.Dict[str, Extension]`	Undocumented

_env_bound =

Undocumented