audit_subsystem_lifecycle.py File Reference

Go to the source code of this file.

Namespaces
namespace	audit_subsystem_lifecycle

Functions
dict	audit_subsystem_lifecycle.page_index ()
	Every documentation page id with the anchors it defines.
tuple	audit_subsystem_lifecycle.required_obligations (dict record)
	The obligation ids a record owes.
list	audit_subsystem_lifecycle.check_satisfaction (str context, str key, spec, dict pages, set published, bool public)
	Verify one obligation or concern is genuinely answered.
list	audit_subsystem_lifecycle.validate (list records, dict pages, dict families, set published)
	Validate every subsystem record against the lifecycle contract.
int	audit_subsystem_lifecycle.main ()
	Report subsystem lifecycle violations.

Variables
	audit_subsystem_lifecycle.REPO_ROOT = Path(__file__).resolve().parents[2]
str	audit_subsystem_lifecycle.RECORDS = REPO_ROOT / "tests" / "tooling" / "subsystem_records.json"
str	audit_subsystem_lifecycle.PAGE_TYPES = REPO_ROOT / "tests" / "tooling" / "page_types.json"
str	audit_subsystem_lifecycle.FAMILIES = REPO_ROOT / "tests" / "tooling" / "capability_families.json"
tuple	audit_subsystem_lifecycle.PAGE_DIRS = ("docs/pages", "docs")
tuple	audit_subsystem_lifecycle.LADDER = ("planned", "internal", "experimental", "supported")
dict	audit_subsystem_lifecycle.LADDER_OBLIGATIONS
dict	audit_subsystem_lifecycle.TERMINAL_OBLIGATIONS
tuple	audit_subsystem_lifecycle.NON_INHERITED = ("not_implemented_status",)
tuple	audit_subsystem_lifecycle.NEEDS_PEAK = ("known-defective", "deprecated", "removed")
tuple	audit_subsystem_lifecycle.INHERITS_LADDER = ("known-defective", "deprecated")
	audit_subsystem_lifecycle.VALID_STATUSES = tuple(LADDER) + tuple(TERMINAL_OBLIGATIONS)
dict	audit_subsystem_lifecycle.TRANSITIONS
tuple	audit_subsystem_lifecycle.VALID_VISIBILITY = ("internal", "public")
tuple	audit_subsystem_lifecycle.VALID_CONCERNS
dict	audit_subsystem_lifecycle.RECORD_KEYS
int	audit_subsystem_lifecycle.MIN_REASON_CHARS = 30
dict	audit_subsystem_lifecycle.FILLER_REASONS = {"n/a", "na", "none", "not applicable", "no", "-", "tbd"}