Skip to content

Templates

templates

Template path resolution for Copier scaffold templates.

TemplateInfo

Bases: BaseModel

Template metadata.

Note: type: ignore[explicit-any] flags pydantic BaseModel internals (third-party).

Source code in packages/axm-init/src/axm_init/core/templates.py
Python
35
36
37
38
39
40
41
42
43
44
45
46
class TemplateInfo(BaseModel):  # type: ignore[explicit-any]
    """Template metadata.

    Note: ``type: ignore[explicit-any]`` flags pydantic ``BaseModel``
    internals (third-party).
    """

    name: str
    description: str
    path: Path

    model_config = ConfigDict(extra="forbid")

TemplateLayer

Bases: BaseModel

One ordered Copier template application.

Source code in packages/axm-init/src/axm_init/core/templates.py
Python
25
26
27
28
29
30
31
32
class TemplateLayer(BaseModel):  # type: ignore[explicit-any]
    """One ordered Copier template application."""

    name: str
    path: Path
    data: dict[str, str]

    model_config = ConfigDict(extra="forbid", frozen=True)

TemplateType

Bases: StrEnum

Available scaffold template types.

Source code in packages/axm-init/src/axm_init/core/templates.py
Python
49
50
51
52
53
54
55
56
57
class TemplateType(StrEnum):
    """Available scaffold template types."""

    STANDALONE = "standalone"
    WORKSPACE = "workspace"
    MEMBER = "member"
    PAPER = "paper"
    EXPERIMENT = "experiment"
    LEARNING = "learning"

get_template_path(template_type=TemplateType.STANDALONE, framework=Framework.PYTHON)

Return path to a bundled Copier template for a template type + framework.

Parameters:

Name Type Description Default
template_type TemplateType

Type of template to look up.

 STANDALONE
framework Framework | None

Ecosystem the template targets (default python keeps the historical single-argument behaviour).

 PYTHON

Returns:

Type Description
Path

Path to the bundled template directory.

Raises:

Type Description
KeyError

If no template exists for the (type, framework) combination.
Source code in packages/axm-init/src/axm_init/core/templates.py
Python
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def get_template_path(
    template_type: TemplateType = TemplateType.STANDALONE,
    framework: Framework | None = Framework.PYTHON,
) -> Path:
    """Return path to a bundled Copier template for a template type + framework.

    Args:
        template_type: Type of template to look up.
        framework: Ecosystem the template targets (default ``python`` keeps the
            historical single-argument behaviour).

    Returns:
        Path to the bundled template directory.

    Raises:
        KeyError: If no template exists for the (type, framework) combination.
    """
    if template_type == TemplateType.PAPER:
        raise ValueError("Paper scaffolding is owned by axm-lab; use paper_scaffold.")
    resolved_framework = framework or Framework.PYTHON
    dir_name = _TEMPLATE_DIRS[(template_type, resolved_framework)]
    return Path(str(TEMPLATES_PKG / dir_name))

template_chain(template_type, framework, *, member, existing=False)

Resolve the ordered Copier layers for a scaffold request.

Source code in packages/axm-init/src/axm_init/core/templates.py
Python
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def template_chain(
    template_type: TemplateType,
    framework: Framework | None,
    *,
    member: bool,
    existing: bool = False,
) -> tuple[TemplateLayer, ...]:
    """Resolve the ordered Copier layers for a scaffold request."""
    if template_type in (TemplateType.LEARNING, TemplateType.EXPERIMENT):
        from axm_init.scaffolding import ScaffoldRequest, _provider_layers

        return _provider_layers(
            ScaffoldRequest(template_type.value, framework, member, existing)
        )
    return (
        TemplateLayer(
            name=template_type.value,
            path=get_template_path(template_type, framework),
            data={},
        ),
    )