jinja2.loaders.DictLoader Class Reference

Inheritance diagram for jinja2.loaders.DictLoader:

Collaboration diagram for jinja2.loaders.DictLoader:

Public Member Functions
None	__init__ (self, t.Mapping[str, str] mapping)
t.Tuple[str, None, t.Callable[[], bool]]	get_source (self, "Environment" environment, str template)
t.List[str]	list_templates (self)
Public Member Functions inherited from jinja2.loaders.BaseLoader
"Template"	load (self, "Environment" environment, str name, t.Optional[t.MutableMapping[str, t.Any]] globals=None)

Public Attributes
	mapping

Additional Inherited Members
Static Public Attributes inherited from jinja2.loaders.BaseLoader
bool	has_source_access = True

Detailed Description

Loads a template from a Python dict mapping template names to
template source.  This loader is useful for unittesting:

>>> loader = DictLoader({'index.html': 'source here'})

Because auto reloading is rarely useful this is disabled by default.

Member Function Documentation

get_source()

t.Tuple[str, None, t.Callable[[], bool]] jinja2.loaders.DictLoader.get_source	(		self,
		"Environment"	environment,
		str	template
	)

Get the template source, filename and reload helper for a template.
It's passed the environment and template name and has to return a
tuple in the form ``(source, filename, uptodate)`` or raise a
`TemplateNotFound` error if it can't locate the template.

The source part of the returned tuple must be the source of the
template as a string. The filename should be the name of the
file on the filesystem if it was loaded from there, otherwise
``None``. The filename is used by Python for the tracebacks
if no loader extension is used.

The last item in the tuple is the `uptodate` function.  If auto
reloading is enabled it's always called to check if the template
changed.  No arguments are passed so the function must store the
old state somewhere (for example in a closure).  If it returns `False`
the template will be reloaded.

Reimplemented from jinja2.loaders.BaseLoader.

list_templates()

t.List[str] jinja2.loaders.DictLoader.list_templates

(

self

)

Iterates over all templates.  If the loader does not support that
it should raise a :exc:`TypeError` which is the default behavior.

Reimplemented from jinja2.loaders.BaseLoader.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/jinja2/loaders.py