Skip to content

Results

results

Result models for AXM operations.

AvailabilityStatus

Bases: StrEnum

Package name availability status.

Domain value object describing the outcome of an availability check. Lives in the application layer so the core package can depend on it without importing any concrete adapter.

Source code in packages/axm-init/src/axm_init/models/results.py
Python
12
13
14
15
16
17
18
19
20
21
22
class AvailabilityStatus(StrEnum):
    """Package name availability status.

    Domain value object describing the outcome of an availability
    check. Lives in the application layer so the ``core`` package can
    depend on it without importing any concrete adapter.
    """

    AVAILABLE = "available"
    TAKEN = "taken"
    ERROR = "error"

ReserveResult

Bases: BaseModel

Result of PyPI reservation operation.

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

Source code in packages/axm-init/src/axm_init/models/results.py
Python
40
41
42
43
44
45
46
47
48
49
50
51
52
class ReserveResult(BaseModel):  # type: ignore[explicit-any]
    """Result of PyPI reservation operation.

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

    model_config = ConfigDict(extra="forbid")

    success: bool
    package_name: str
    version: str
    message: str

ScaffoldResult

Bases: BaseModel

Result of a scaffolding operation.

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

Source code in packages/axm-init/src/axm_init/models/results.py
Python
25
26
27
28
29
30
31
32
33
34
35
36
37
class ScaffoldResult(BaseModel):  # type: ignore[explicit-any]
    """Result of a scaffolding operation.

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

    model_config = ConfigDict(extra="forbid")

    success: bool
    path: str
    message: str
    files_created: list[str] = Field(default_factory=list)