pre-alpha

5.10 · Reference

Rules API

hinoki.rules.RuleSet

The rules an application enabled.

rules instance-attribute

rules = rules

__init__

__init__(*rules: Rule) -> None

run

run(
    project: Project,
    phase: Phase | None = None,
    allow_effects: bool = False,
) -> list[Diagnostic]

Every diagnostic of the rules in phase (all phases when None). A rule that raises becomes an internal error diagnostic and the other rules still run; a rule with effects is skipped (and reported) unless allow_effects.

hinoki.rules.Rule

Base class of rules. Subclasses set the class attributes and implement check. effects lists side effects (running code, files, network, database) a check needs; tools refuse effectful checks unless allowed.

diagnostic

diagnostic(
    message: str,
    location: str,
    status: Status = Status.VIOLATED,
    subject: str | None = None,
) -> Diagnostic

subject identifies the thing for waivers; an empty subject marks a diagnostic that cannot be waived (the rule could not do its job).

hinoki.rules.Diagnostic dataclass

rule_id instance-attribute

rule_id: str

severity instance-attribute

severity: Severity

phase instance-attribute

phase: Phase

message instance-attribute

message: str

location instance-attribute

location: str

explanation instance-attribute

explanation: str

status class-attribute instance-attribute

status: Status = Status.VIOLATED

subject class-attribute instance-attribute

subject: str = ''

waiver class-attribute instance-attribute

waiver: str = ''

fix class-attribute instance-attribute

fix: str = ''

__init__

__init__(
    rule_id: str,
    severity: Severity,
    phase: Phase,
    message: str,
    location: str,
    explanation: str,
    status: Status = Status.VIOLATED,
    subject: str = "",
    waiver: str = "",
    fix: str = "",
) -> None

as_dict

as_dict() -> dict[str, str]

text

text() -> str

hinoki.rules.Actions

Namespace of action rules.

hinoki.rules.Transactions

hinoki.rules.Schemas

hinoki.rules.Imports

hinoki.rules.Phase

Bases: StrEnum

hinoki.rules.Severity

Bases: StrEnum

hinoki.rules.Status

Bases: StrEnum