jinja2.loaders.DictLoader

class documentation

class DictLoader(BaseLoader):

View In Hierarchy

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 per default.

Method __init__ Undocumented
Method get​_source No summary
Method list​_templates Iterates over all templates. If the loader does not support that it should raise a TypeError which is the default behavior.
Instance Variable mapping Undocumented

Inherited from BaseLoader:

Method load No summary
Class Variable has​_source​_access Undocumented
def __init__(self, mapping):

Undocumented

Parameters
mapping:t.Mapping[str, str]Undocumented
def get_source(self, environment, template):
overrides jinja2.loaders.BaseLoader.get_source

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.

Parameters
environment:EnvironmentUndocumented
template:strUndocumented
Returns
t.Tuple[str, None, t.Callable[[], bool]]Undocumented
def list_templates(self):
overrides jinja2.loaders.BaseLoader.list_templates
Iterates over all templates. If the loader does not support that it should raise a TypeError which is the default behavior.
Returns
t.List[str]Undocumented
mapping =

Undocumented