5.10 · Reference
Rules API¶
hinoki.rules.RuleSet ¶
The rules an application enabled.
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
¶
__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
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