jinjaconfig

Class info

Classes

Name	Children	Inherits
JinjaConfig mkdocs_mknodes.appconfig.jinjaconfig		BaseModel
JinjaLoader mkdocs_mknodes.appconfig.jinjaconfig		BaseModel

🛈 DocStrings

JinjaConfig

Bases: BaseModel

Parameters:

Name	Type	Description	Default
jinja_block_start_string	str | None		None
jinja_block_end_string	str | None		None
jinja_variable_start_string	str | None		None
jinja_variable_end_string	str | None		None
jinja_on_undefined	str		'strict'
jinja_loaders	list[JinjaLoader] | None		None
jinja_extensions	list[str] | None		None

Source code in mkdocs_mknodes/appconfig/jinjaconfig.py

class JinjaConfig(BaseModel):
    jinja_block_start_string: str | None = None
    """Jinja block start string."""
    jinja_block_end_string: str | None = None
    """Jinja block end string."""
    jinja_variable_start_string: str | None = None
    """Jinja variable start string."""
    jinja_variable_end_string: str | None = None
    """Jinja variable end string."""
    jinja_on_undefined: str = Field("strict")
    """Jinja undefined macro behavior."""
    jinja_loaders: list[JinjaLoader] | None = None
    """List containing additional jinja loaders to use.

    Dictionaries must have the `type` key set to either "filesystem" or "fsspec".

    Examples:
        ``` yaml
        plugins:
        - mknodes:
            jinja_loaders:
            - type: fsspec
              path: github://
              repo: mknodes
              org: phil65
        ```
    """
    jinja_extensions: list[str] | None = None
    """List containing additional jinja extensions to use.

    Examples:
        ``` yaml
        plugins:
        - mknodes:
            jinja_extensions:
            - jinja2_ansible_filters.AnsibleCoreFiltersExtension
        ```
    """

    def get_jinja_config(self) -> jinjarope.EnvConfig:
        return jinjarope.EnvConfig(
            block_start_string=self.jinja_block_start_string or "{%",
            block_end_string=self.jinja_block_end_string or "%}",
            variable_start_string=self.jinja_variable_start_string or r"{{",
            variable_end_string=self.jinja_variable_end_string or r"}}",
            # undefined=self.jinja_on_undefined,
            loader=jinjarope.loaders.from_json(self.jinja_loaders),
            extensions=self.jinja_extensions or [],
        )

jinja_block_end_string class-attribute instance-attribute

jinja_block_end_string: str | None = None

Jinja block end string.

jinja_block_start_string class-attribute instance-attribute

jinja_block_start_string: str | None = None

Jinja block start string.

jinja_extensions class-attribute instance-attribute

jinja_extensions: list[str] | None = None

List containing additional jinja extensions to use.

Examples:

plugins:
- mknodes:
    jinja_extensions:
    - jinja2_ansible_filters.AnsibleCoreFiltersExtension

jinja_loaders class-attribute instance-attribute

jinja_loaders: list[JinjaLoader] | None = None

List containing additional jinja loaders to use.

Dictionaries must have the type key set to either "filesystem" or "fsspec".

Examples:

plugins:
- mknodes:
    jinja_loaders:
    - type: fsspec
      path: github://
      repo: mknodes
      org: phil65

jinja_on_undefined class-attribute instance-attribute

jinja_on_undefined: str = Field('strict')

Jinja undefined macro behavior.

jinja_variable_end_string class-attribute instance-attribute

jinja_variable_end_string: str | None = None

Jinja variable end string.

jinja_variable_start_string class-attribute instance-attribute

jinja_variable_start_string: str | None = None

Jinja variable start string.

JinjaLoader

Bases: BaseModel

Parameters:

Name	Type	Description	Default
typ	str		required
path	str		required

Source code in mkdocs_mknodes/appconfig/jinjaconfig.py

class JinjaLoader(BaseModel):
    typ: str
    path: str