Skip to content

Check

check

Structured diagnostics produced by the read-only batch_edit checks.

A :class:CheckDiagnostic is the single currency of the static-check layer: it locates a finding (op_index + file), qualifies it (severity + stable code) and explains it (message + actionable hint). The model carries no I/O and no rendering concern.

Severity = Literal['error', 'warning'] module-attribute

Closed set of diagnostic severities.

CheckDiagnostic

Bases: BaseModel

A single static-check finding on a batch operation.

Attributes:

Name Type Description
op_index int

0-indexed position of the offending operation in the batch.
file str

Relative path targeted by that operation.
severity Severity

"error" blocks the batch, "warning" only informs.
code str

Stable machine-readable identifier (e.g. UNKNOWN_EDIT_KEY).
message str

Human-readable explanation of what was found.
hint str

Actionable remediation advice.
edit_index int | None

0-indexed position of the offending edit inside that operation, or None when the finding is not edit-scoped.
anchor_excerpt str | None

Bounded single-line excerpt of the offending anchor, or None when the finding carries no anchor.
Source code in packages/axm-edit/src/axm_edit/models/check.py
Python
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class CheckDiagnostic(BaseModel):  # type: ignore[explicit-any]  # pydantic synthesizes __init__(**data: Any)
    """A single static-check finding on a batch operation.

    Attributes:
        op_index: 0-indexed position of the offending operation in the batch.
        file: Relative path targeted by that operation.
        severity: ``"error"`` blocks the batch, ``"warning"`` only informs.
        code: Stable machine-readable identifier (e.g. ``UNKNOWN_EDIT_KEY``).
        message: Human-readable explanation of what was found.
        hint: Actionable remediation advice.
        edit_index: 0-indexed position of the offending edit inside that
            operation, or ``None`` when the finding is not edit-scoped.
        anchor_excerpt: Bounded single-line excerpt of the offending anchor,
            or ``None`` when the finding carries no anchor.
    """

    op_index: int = Field(
        ...,
        ge=0,
        description="0-indexed position of the operation in the batch",
    )
    file: str = Field(..., min_length=1, description="Relative path to the file")
    severity: Severity = Field(
        default="error",
        description="Diagnostic severity (error blocks, warning informs)",
    )
    code: str = Field(..., min_length=1, description="Stable diagnostic code")
    message: str = Field(..., description="Human-readable explanation")
    hint: str = Field(default="", description="Actionable remediation hint")
    edit_index: int | None = Field(
        default=None,
        description="0-indexed position of the offending edit in the operation",
    )
    anchor_excerpt: str | None = Field(
        default=None,
        description="Bounded single-line excerpt of the offending anchor",
    )

    model_config = {"extra": "forbid"}

PreflightReport

Bases: BaseModel

A partitioned preflight verdict over a single batch.

Attributes:

Name Type Description
diagnostics list[CheckDiagnostic]

Every diagnostic collected, in the order given.
errors list[CheckDiagnostic]

The blocking subset, in input order.
warnings list[CheckDiagnostic]

The non-blocking subset, in input order.
blocking bool

True iff at least one diagnostic blocks the batch.
Source code in packages/axm-edit/src/axm_edit/models/check.py
Python
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
class PreflightReport(BaseModel):  # type: ignore[explicit-any]
    """A partitioned preflight verdict over a single batch.

    Attributes:
        diagnostics: Every diagnostic collected, in the order given.
        errors: The blocking subset, in input order.
        warnings: The non-blocking subset, in input order.
        blocking: True iff at least one diagnostic blocks the batch.
    """

    diagnostics: list[CheckDiagnostic] = Field(
        default_factory=list,
        description="Every diagnostic collected for the batch, in order",
    )
    errors: list[CheckDiagnostic] = Field(
        default_factory=list,
        description="Blocking diagnostics, in input order",
    )
    warnings: list[CheckDiagnostic] = Field(
        default_factory=list,
        description="Non-blocking diagnostics, in input order",
    )
    blocking: bool = Field(
        default=False,
        description="True iff at least one diagnostic blocks the batch",
    )

    model_config = {"extra": "forbid"}