jinja2.loaders.FunctionLoader Class Reference

Inheritance diagram for jinja2.loaders.FunctionLoader:

Collaboration diagram for jinja2.loaders.FunctionLoader:

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

Public Attributes
	load_func

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

Detailed Description

A loader that is passed a function which does the loading.  The
function receives the name of the template and has to return either
a string with the template source, a tuple in the form ``(source,
filename, uptodatefunc)`` or `None` if the template does not exist.

>>> def load_template(name):
...     if name == 'index.html':
...         return '...'
...
>>> loader = FunctionLoader(load_template)

The `uptodatefunc` is a function that is called if autoreload is enabled
and has to return `True` if the template is still up to date.  For more
details have a look at :meth:`BaseLoader.get_source` which has the same
return value.

Member Function Documentation

get_source()

t.Tuple[str, t.Optional[str], t.Optional[t.Callable[[], bool]]] jinja2.loaders.FunctionLoader.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.

---

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

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