Skip to content

Check

check

Check models — Grade, CheckResult, ProjectResult, CategoryScore.

CategoryScore

Bases: BaseModel

Aggregated score for a category.

Source code in packages/axm-init/src/axm_init/models/check.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class CategoryScore(BaseModel):
    """Aggregated score for a category."""

    model_config = {"extra": "forbid"}

    category: str
    earned: int
    total: int

    @classmethod
    def from_checks(cls, category: str, checks: list[CheckResult]) -> CategoryScore:
        """Build from a list of checks belonging to this category."""
        return cls(
            category=category,
            earned=sum(c.earned for c in checks),
            total=sum(c.weight for c in checks),
        )
from_checks(category, checks) classmethod

Build from a list of checks belonging to this category.

Source code in packages/axm-init/src/axm_init/models/check.py 
68
69
70
71
72
73
74
75
@classmethod
def from_checks(cls, category: str, checks: list[CheckResult]) -> CategoryScore:
    """Build from a list of checks belonging to this category."""
    return cls(
        category=category,
        earned=sum(c.earned for c in checks),
        total=sum(c.weight for c in checks),
    )

CheckResult

Bases: BaseModel

Result of a single audit check.

Source code in packages/axm-init/src/axm_init/models/check.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class CheckResult(BaseModel):
    """Result of a single audit check."""

    model_config = {"extra": "forbid"}

    name: str
    category: str
    passed: bool
    weight: int
    message: str
    details: list[str]
    fix: str

    @computed_field  # type: ignore[prop-decorator]
    @property
    def earned(self) -> int:
        """Points earned: weight if passed, 0 otherwise."""
        return self.weight if self.passed else 0
earned property

Points earned: weight if passed, 0 otherwise.

Grade

Bases: StrEnum

AXM gold standard grade.

Source code in packages/axm-init/src/axm_init/models/check.py 
16
17
18
19
20
21
22
23
class Grade(StrEnum):
    """AXM gold standard grade."""

    A = "A"  # ≥90
    B = "B"  # ≥75
    C = "C"  # ≥60
    D = "D"  # ≥40
    F = "F"  # <40

ProjectResult

Bases: BaseModel

Complete project check result with score and grade.

Source code in packages/axm-init/src/axm_init/models/check.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
class ProjectResult(BaseModel):
    """Complete project check result with score and grade."""

    model_config = {"extra": "forbid"}

    project_path: Path
    checks: list[CheckResult]
    score: int
    grade: Grade
    categories: dict[str, CategoryScore]
    failures: list[CheckResult]
    context: str | None = None
    workspace_root: Path | None = None
    excluded_checks: list[str] = []

    @classmethod
    def from_checks(
        cls,
        project_path: Path,
        checks: list[CheckResult],
        *,
        context: str | None = None,
        workspace_root: Path | None = None,
        excluded_checks: list[str] | None = None,
    ) -> ProjectResult:
        """Compute score, grade, and category breakdowns from check results."""
        total_weight = sum(c.weight for c in checks)
        total_earned = sum(c.earned for c in checks)
        score = round(total_earned / total_weight * 100) if total_weight > 0 else 0

        # Group by category
        cat_map: dict[str, list[CheckResult]] = {}
        for c in checks:
            cat_map.setdefault(c.category, []).append(c)

        categories = {
            cat: CategoryScore.from_checks(cat, cat_checks)
            for cat, cat_checks in cat_map.items()
        }

        failures = [c for c in checks if not c.passed]

        return cls(
            project_path=project_path,
            checks=checks,
            score=score,
            grade=compute_grade(score),
            categories=categories,
            failures=failures,
            context=context,
            workspace_root=workspace_root,
            excluded_checks=excluded_checks or [],
        )
from_checks(project_path, checks, *, context=None, workspace_root=None, excluded_checks=None) classmethod

Compute score, grade, and category breakdowns from check results.

Source code in packages/axm-init/src/axm_init/models/check.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@classmethod
def from_checks(
    cls,
    project_path: Path,
    checks: list[CheckResult],
    *,
    context: str | None = None,
    workspace_root: Path | None = None,
    excluded_checks: list[str] | None = None,
) -> ProjectResult:
    """Compute score, grade, and category breakdowns from check results."""
    total_weight = sum(c.weight for c in checks)
    total_earned = sum(c.earned for c in checks)
    score = round(total_earned / total_weight * 100) if total_weight > 0 else 0

    # Group by category
    cat_map: dict[str, list[CheckResult]] = {}
    for c in checks:
        cat_map.setdefault(c.category, []).append(c)

    categories = {
        cat: CategoryScore.from_checks(cat, cat_checks)
        for cat, cat_checks in cat_map.items()
    }

    failures = [c for c in checks if not c.passed]

    return cls(
        project_path=project_path,
        checks=checks,
        score=score,
        grade=compute_grade(score),
        categories=categories,
        failures=failures,
        context=context,
        workspace_root=workspace_root,
        excluded_checks=excluded_checks or [],
    )

compute_grade(score)

Map a 0-100 score to a Grade.

Source code in packages/axm-init/src/axm_init/models/check.py 
26
27
28
29
30
31
32
33
34
35
36
def compute_grade(score: int | float) -> Grade:
    """Map a 0-100 score to a Grade."""
    if score >= 90:
        return Grade.A
    if score >= 75:
        return Grade.B
    if score >= 60:
        return Grade.C
    if score >= 40:
        return Grade.D
    return Grade.F