FsSpecProtocolPathLoader

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
  94642252134032["fsspecloaders.FsSpecProtocolPathLoader"]
  94642250124976["loaders.LoaderMixin"]
  140025743487200["builtins.object"]
  94642249831088["loaders.BaseLoader"]
  94642250124976 --> 94642252134032
  140025743487200 --> 94642250124976
  94642249831088 --> 94642252134032
  140025743487200 --> 94642249831088

🛈 DocStrings

Bases: LoaderMixin, BaseLoader

A jinja loader for fsspec filesystems.

This loader allows to access templates from an fsspec protocol path, like "github://phil65:mknodes@main/README.md"

Examples:

loader = FsSpecProtocolPathLoader()
env = Environment(loader=loader)
env.get_template("github://phil65:mknodes@main/docs/icons.jinja").render()

Source code in src/jinjarope/fsspecloaders.py

class FsSpecProtocolPathLoader(loaders_.LoaderMixin, jinja2.BaseLoader):
    """A jinja loader for fsspec filesystems.

    This loader allows to access templates from an fsspec protocol path,
    like "github://phil65:mknodes@main/README.md"

    Examples:
        ``` py
        loader = FsSpecProtocolPathLoader()
        env = Environment(loader=loader)
        env.get_template("github://phil65:mknodes@main/docs/icons.jinja").render()
        ```
    """

    ID = "fsspec_protocol_path"

    def __eq__(self, other: object):
        return type(self) is type(other)

    def __hash__(self):
        return hash(type(self))

    def get_source(
        self,
        environment: jinja2.Environment | None,
        template: str,
    ) -> tuple[str, str, Callable[[], bool] | None]:
        try:
            src = envglobals.load_file_cached(template)
        except FileNotFoundError as e:
            raise jinja2.TemplateNotFound(template) from e
        path = pathlib.Path(template).as_posix()
        return src, path, lambda: True

    async def get_source_async(
        self,
        environment: jinja2.Environment | None,
        template: str,
    ) -> tuple[str, str, Callable[[], bool] | None]:
        try:
            src = await get_template(template)
        except FileNotFoundError as e:
            raise jinja2.TemplateNotFound(template) from e
        path = pathlib.Path(template).as_posix()
        return src, path, lambda: True

    def list_templates(self) -> list[str]:
        return []

    def __contains__(self, path: str):
        try:
            self.get_source(None, path)
        except jinja2.TemplateNotFound:
            return False
        else:
            return True

    def __repr__(self):
        return utils.get_repr(self)

Show source on GitHub