NestedDictLoader

Sub classes¶

Name	Children	Inherits
TemplateFileLoader jinjarope.configloaders A jinja loader for loading templates from config files.		NestedDictLoader

Base classes¶

Name	Children	Inherits
LoaderMixin jinjarope.loaders Loader mixin which allows to OR loaders into a choice loader.	PrefixLoader ModuleLoader FunctionLoader PackageLoader FileSystemLoader ChoiceLoader DictLoader RewriteLoader NestedDictLoader FsSpecProtocolPathLoader FsSpecFileSystemLoader ...	object
BaseLoader jinja2.loaders Baseclass for all loaders. Subclass this and override `get_source` to	FileSystemLoader PackageLoader DictLoader FunctionLoader PrefixLoader ChoiceLoader ModuleLoader RewriteLoader NestedDictLoader FsSpecProtocolPathLoader FsSpecFileSystemLoader ...	object

⋔ Inheritance diagram¶

graph TD
  94142655718000["configloaders.NestedDictLoader"]
  94142653860608["loaders.LoaderMixin"]
  140199010283712["builtins.object"]
  94142650643376["loaders.BaseLoader"]
  94142653860608 --> 94142655718000
  140199010283712 --> 94142653860608
  94142650643376 --> 94142655718000
  140199010283712 --> 94142650643376

🛈 DocStrings¶

Bases: LoaderMixin, BaseLoader

A jinja loader for loading templates from nested dicts.

This loader allows to access templates from nested dicts. Can be used to load templates defined with markup like TOML.

Examples:

[example]
template = "{{ something }}"

content = tomllib.load(toml_file)
loader = NestedDictLoader(content)
env = Environment(loader=loader)
env.get_template("example/template")

Source code in src/jinjarope/configloaders.py

class NestedDictLoader(loaders.LoaderMixin, jinja2.BaseLoader):
    """A jinja loader for loading templates from nested dicts.

    This loader allows to access templates from nested dicts.
    Can be used to load templates defined with markup like TOML.

    Examples:
        ``` toml
        [example]
        template = "{{ something }}"
        ```
        ``` py
        content = tomllib.load(toml_file)
        loader = NestedDictLoader(content)
        env = Environment(loader=loader)
        env.get_template("example/template")
        ```
    """

    ID = "nested_dict"

    def __init__(self, mapping: NestedMapping):
        """Constructor.

        Args:
            mapping: A nested dict containing templates
        """
        super().__init__()
        self._data = mapping

    def __repr__(self):
        return utils.get_repr(self, mapping=self._data)

    def list_templates(self) -> list[str]:
        return list(iterfilters.flatten_dict(self._data).keys())

    def get_source(
        self,
        environment: jinja2.Environment,
        template: str,
    ) -> tuple[str, str | None, Callable[[], bool] | None]:
        data: Any = self._data
        try:
            for part in template.split("/"):
                data = data[part]
            assert isinstance(data, str)
        except (AssertionError, KeyError) as e:
            raise jinja2.TemplateNotFound(template) from e
        return data, None, lambda: True  # type: ignore[return-value]

init ¶

__init__(mapping: NestedMapping)

Constructor.

Parameters:

Name	Type	Description	Default
`mapping`	`NestedMapping`	A nested dict containing templates	required