jinja2.loaders.ChoiceLoader

class documentation

class ChoiceLoader(BaseLoader):

View In Hierarchy

This loader works like the PrefixLoader just that no prefix is specified. If a template could not be found by one loader the next one is tried.

>>> loader = ChoiceLoader([
...     FileSystemLoader('/path/to/user/templates'),
...     FileSystemLoader('/path/to/system/templates')
... ])

This is useful if you want to allow users to override builtin templates from a different location.

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.
Method load No summary
Instance Variable loaders Undocumented

Inherited from BaseLoader:

Class Variable has​_source​_access Undocumented
def __init__(self, loaders):

Undocumented

Parameters
loaders:t.Sequence[BaseLoader]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, t.Optional[str], t.Optional[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
@internalcode
def load(self, environment, name, globals=None):
overrides jinja2.loaders.BaseLoader.load
Loads a template. This method looks up the template in the cache or loads one by calling get_source. Subclasses should not override this method as loaders working on collections of other loaders (such as PrefixLoader or ChoiceLoader) will not call this method but get_source directly.
Parameters
environment:EnvironmentUndocumented
name:strUndocumented
globals:t.Optional[t.MutableMapping[str, t.Any]]Undocumented
Returns
TemplateUndocumented
loaders =

Undocumented