cadrumo.application.operator_surface.help_models module

Import-light typed records for operator help and root landing output.

class HelpSurface(*values)[source]

Bases: StrEnum

Curated help surfaces accepted by build_help_document().

ROOT
CONFIG
APP
class HelpEntry(**data)[source]

Bases: BaseModel

One localized command row in a curated HelpSection.

Parameters:

  • command (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=80, pattern=None, ascii_only=None)])

  • description (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=80, pattern=None, ascii_only=None)])

command: HelpLabel
description: HelpLabel
class HelpSection(**data)[source]

Bases: BaseModel

One workflow-ordered section in a curated HelpDocument.

Parameters:

  • title (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=80, pattern=None, ascii_only=None)])

  • entries (tuple[HelpEntry, ...])

title: HelpLabel
entries: tuple[HelpEntry, ...]
class HelpDocument(**data)[source]

Bases: BaseModel

Localized operator-help document for one accepted surface.

Parameters:

  • surface (HelpSurface)

  • heading (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=120, pattern=None, ascii_only=None)])

  • paragraphs (tuple[str, ...])

  • sections (tuple[HelpSection, ...])

  • footer (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=120, pattern=None, ascii_only=None)])

surface: HelpSurface
heading: HelpProse
paragraphs: tuple[str, ...]
sections: tuple[HelpSection, ...]
footer: HelpProse
class RootLandingReport(**data)[source]

Bases: BaseModel

Bare-root landing report built from caller-projected profile state.

Parameters:

  • profile_selected (bool)

  • active_profile (str | None)

  • command (str)

  • message (str)

profile_selected: bool
active_profile: str | None
command: str
message: str