API reference
python:irx:irx.diagnostics.Diagnostic
class Diagnostic
Diagnostic(message: str, node: astx.AST | None = None, code: str | None = None, severity: str = 'error', module_key: str | None = None, phase: str = 'semantic', source: SourceLocation | None = None, notes: tuple[str, ...] = (), hint: str | None = None, cause: Exception | None = None, related: tuple[DiagnosticRelatedInformation, ...] = ())
Source: packages/irx/src/irx/diagnostics.py:368
One structured diagnostic record.
Attributes
-
message — Type: str
-
node — Type: astx.AST | None
-
code — Type: str | None
-
severity — Type: str
-
module_key — Type: str | None
-
phase — Type: str
-
source — Type: SourceLocation | None
-
notes — Type: tuple[str, Ellipsis]
-
hint — Type: str | None
-
cause — Type: Exception | None
-
related — Type: tuple[DiagnosticRelatedInformation, Ellipsis]
Methods
-
__init__ —
-
format — Format the diagnostic for human display.
-
rendered_code — Return the final rendered diagnostic code.
-
resolved_module_key — Return the diagnostic's best-effort module attribution.
-
resolved_source — Return the diagnostic's best-effort source location.