herman.core

Core module for Herman analysis messages and rendering.

Submodules

• herman.core.analysis
• herman.core.handlers
• herman.core.output
• herman.core.story

Attributes

OutputFormat

Classes

AnalysisMessage	Message produced during analysis.
Severity	Severity levels for analysis messages.
StoryConfig	Story configuration model.
StoryFileMetadata	Metadata for a story file.

Functions

render_messages(→ int)

Select a renderer and execute it.

Package Contents

class herman.core.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.

class herman.core.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.

herman.core.OutputFormat

herman.core.render_messages(messages: list[herman.core.AnalysisMessage], *, output_format: OutputFormat | None) → int

Select a renderer and execute it.

• If format is provided explicitly, use that.

• Otherwise auto-detect:

  • If running in CI, use GitHub annotations.

  • Else fallback to Rich console renderer.

class herman.core.StoryConfig(/, **data: Any)

Bases: herman.core.story._base.HermanBaseModel

Story configuration model.

characters: dict[str, Character]

class herman.core.StoryFileMetadata(/, **data: Any)

Bases: herman.core.story._base.HermanBaseModel

Metadata for a story file.

title: str | None = None

date_: datetime.date = None

scene_dates: str | None = None

perspective: str

characters: list[str]