herman.core.analysis.message

Analysis message representation.

Classes

Severity	Severity levels for analysis messages.
AnalysisMessage	Message produced during analysis.

Module Contents

class herman.core.analysis.message.Severity

Bases: str, enum.Enum

Severity levels for analysis messages.

ERROR = 'error'

WARNING = 'warning'

NOTICE = 'notice'

property order: int

Order for sorting severities.

property icon: str

Icon representing the severity level.

property color: str

Color associated with the severity level.

__lt__(other: Severity) → bool

Compare severities based on their order.

class herman.core.analysis.message.AnalysisMessage

Message produced during analysis.

sort_index: tuple[int, str, int, int, str, str]

file: pathlib.Path

message: str

code: str

severity: Severity

line: int | None = None

column: int | None = None

__post_init__() → None

Initialize the sort index for ordering messages.

property is_error: bool

Check if the message is an error.

classmethod from_text(file: pathlib.Path, message: str, code: str, severity: Severity = Severity.ERROR) → Self

Create an AnalysisMessage from plain text inputs.

classmethod from_pydantic_error(file: pathlib.Path, err: pydantic.ValidationError) → list[AnalysisMessage]

Convert a Pydantic ValidationError into AnalysisMessages.

Extracts line & column if possible.

to_dict() → dict[str, str | int | None]

JSON-friendly format.

to_rich() → rich.panel.Panel

Rich panel for local console output.

to_github_annotation() → str

GitHub Actions annotation format.