template

CLASS	DESCRIPTION
Template	A collection of templated files and things to do with them.

Template

Template(
    ctx: CliContext,
    template_uri: Path | str,
    src_excludes: list[str] | None = None,
    *,
    template_name: TemplateName | str | None = None,
    ref: str | None = None,
)

A collection of templated files and things to do with them.

Represents both the current state of a template (akin to copier's Template) and some operational logic against it (akin to copier's Worker).

ATTRIBUTE	DESCRIPTION
commit	The value that will be saved in the answers file. TYPE: str | None

Source code in nava/platform/templates/template.py

def __init__(
    self,
    ctx: CliContext,
    template_uri: Path | str,
    src_excludes: list[str] | None = None,
    *,
    template_name: TemplateName | str | None = None,
    ref: str | None = None,
):
    self.ctx = ctx
    self.template_uri = template_uri

    if template_name is None:
        self.template_name = TemplateName.parse(get_template_name_from_uri(template_uri))
    else:
        self.template_name = TemplateName.parse(template_name)

    if src_excludes is not None and len(src_excludes) == 0:
        self.src_excludes = []
    else:
        self.src_excludes = BASE_SRC_EXCLUDE + (src_excludes or [])

    self.copier_template = CopierTemplate(url=str(template_uri), ref=ref)

    self._run_copy = wrappers.log_call(run_copy, logger=ctx.log.info)
    self._run_update = wrappers.log_call(run_update, logger=ctx.log.info)

commit property

commit: str | None

The value that will be saved in the answers file.