jinja2.environment Namespace Reference

Classes
class	Environment
class	Template
class	TemplateExpression
class	TemplateModule
class	TemplateStream

Functions
_env_bound	get_spontaneous_environment (t.Type[_env_bound] cls, *t.Any args)
t.Optional[t.MutableMapping[t.Tuple["weakref.ref[t.Any]", str], "Template"]]	create_cache (int size)
t.Optional[t.MutableMapping[t.Tuple["weakref.ref[t.Any]", str], "Template"]]	copy_cache (t.Optional[t.MutableMapping[t.Any, t.Any]] cache)
t.Dict[str, "Extension"]	load_extensions ("Environment" environment, t.Sequence[t.Union[str, t.Type["Extension"]]] extensions)
_env_bound	_environment_config_check (_env_bound environment)

Variables
	_env_bound = t.TypeVar("_env_bound", bound="Environment")

Detailed Description

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

Function Documentation

_environment_config_check()

_env_bound jinja2.environment._environment_config_check ( _env_bound  environment )

protected

Perform a sanity check on the environment.

copy_cache()

t.Optional[t.MutableMapping[t.Tuple["weakref.ref[t.Any]", str], "Template"]] jinja2.environment.copy_cache

(

t.Optional[t.MutableMapping[t.Any, t.Any]]

cache

)

Create an empty copy of the given cache.

create_cache()

t.Optional[t.MutableMapping[t.Tuple["weakref.ref[t.Any]", str], "Template"]] jinja2.environment.create_cache

(

int

size

)

Return the cache class for the given size.

get_spontaneous_environment()

_env_bound jinja2.environment.get_spontaneous_environment	(	t.Type[_env_bound]	cls,
		*t.Any	args
	)

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

:param cls: Environment class to create.
:param args: Positional arguments passed to environment.

load_extensions()

t.Dict[str, "Extension"] jinja2.environment.load_extensions	(	"Environment"	environment,
		t.Sequence[t.Union[str, t.Type["Extension"]]]	extensions
	)

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