review_packet.py File Reference

Go to the source code of this file.

Namespaces
namespace	review_packet

Functions
list[dict]	review_packet.records (Path path, str key)
	Read one registry list.
Path	review_packet.resolve_page (str name)
	Resolve a page argument, accepting a number, stem, or filename.
str	review_packet.source_path (str source)
	Extract a repository path from a path-or-symbol source declaration.
str	review_packet.module_path (str module)
	Convert a Python module identifier to its repository path.
dict[str, str]	review_packet.page_aliases ()
	Map both filenames and Doxygen page identifiers to published page stems.
str	review_packet.canonical_page (str reference)
	Resolve a registry page reference to its filename stem when declared by Doxygen id.
str	review_packet.git_log (list[str] paths)
	Recent history for a set of paths, for spotting what changed underneath a route.
list[dict]	review_packet.contracts_for (str page_stem)
	Invariant contracts that own or depend on a page.
list[dict]	review_packet.families_for (str page_stem)
	Capability families whose entries live on a page.
set[str]	review_packet.record_pages (dict record)
	Collect obligation and concern pages from a subsystem record.
list[dict]	review_packet.subsystems_for_pages (set[str] page_stems)
	Find subsystem records routed through any supplied page.
list[dict]	review_packet.scope_records_for (str page_stem)
	Scope records that name a page as a disclosure or activation surface.
list[tuple[str, dict]]	review_packet.freshness_for (str page_stem)
	Freshness surfaces that route review to a page.
list[str]	review_packet.freshness_paths (dict surface)
	Return the artifact or watched paths that define a freshness surface.
str	review_packet.freshness_state (dict surface)
	Whether a surface is current, suspect, or never attested.
str	review_packet._freshness_digest (list[str] paths)
	Digest matching audit_freshness.digest_of.
str	review_packet.uncommitted (list[str] paths)
	Current uncommitted status for declared sources.
list[tuple[str, str, str]]	review_packet.family_source_specs (dict family)
	Resolve a capability family's declared source paths and symbols.
list[str]	review_packet.symbols_for (dict family)
	Named symbols a capability family depends on, rather than whole files.
list[str]	review_packet.evidence_sources (dict family)
	Declared evidence sources across a family's values.
list	review_packet.recorded_measurements (list[str] sources)
	Measurement records cited by declared evidence sources.
list[str]	review_packet.make_targets (list[str] sources)
	Make targets named by declared evidence sources.
int	review_packet.route_status (list[str] unresolved, bool unavailable=False)
	Print the fixed route state and any unresolved declarations.
int	review_packet.unknown_identifier (str kind, str identifier, list[str] known)
	Report an invalid registry identifier with close matches and known ids.
None	review_packet.print_freshness (list[tuple[str, dict]] surfaces, str heading)
	Print freshness routing with current attestation state.
tuple[str, dict|None]	review_packet.load_xref ()
	Load the optional cross-reference index only when its dirty-byte stamp is current.
list[str]	review_packet.xref_matches (dict index, str path, str symbol)
	Match a declared path and symbol to Doxygen member identifiers.
str	review_packet.format_xref_node (dict index, str refid)
	Format one indexed symbol with its definition location.
None	review_packet.print_measurements (list records)
	Print the measurements already recorded against this route.
None	review_packet.print_xref (list[tuple[str, str, str]] specs, list[str]|None paths=None)
	Print bounded direct and two-hop Doxygen reference evidence for a route.
int	review_packet.contract_mode (str contract_id)
	Print a review packet for one invariant contract.
int	review_packet.capability_mode (str capability_id)
	Join one capability family across symbols, pages, contracts, evidence, and subsystems.
int	review_packet.subsystem_mode (str subsystem_id)
	Join one subsystem across capability families, obligation pages, contracts, and evidence.
int	review_packet.surface_mode (str surface_id)
	Join one freshness surface across watched paths, pages, contracts, families, and subsystems.
tuple[dict[str, set[str]], bool]	review_packet.changed_paths ()
	Collect staged, unstaged, and untracked nonignored paths from Git.
str	review_packet.classify_path (str path)
	Classify a changed path for routing coverage.
dict[str, list[str]]	review_packet.routes_for_path (str path)
	Find declared capabilities, surfaces, contracts, and subsystems touching a path.
str	review_packet.guide_fallback (str path)
	Return the nearest existing directory guide for an unrouted production path.
int	review_packet.changed_mode (str value)
	Report declared routing coverage for current working-tree changes.
int	review_packet.page_mode (str page_name)
	Print the original page-scoped review packet with explicit route status and xrefs.
argparse.Namespace	review_packet.parse_args (list[str] argv)
	Parse the mutually exclusive review-packet route selectors.
int	review_packet.main (list[str]|None argv=None)
	Dispatch the requested bounded route and preserve differentiated exit states.

Variables
	review_packet.REPO_ROOT = Path(__file__).resolve().parents[2]
str	review_packet.PAGES_DIR = REPO_ROOT / "docs" / "pages"
	review_packet.TOOLING_DIR = Path(__file__).resolve().parent
str	review_packet.CONTRACTS = TOOLING_DIR / "contract_registry.json"
str	review_packet.FRESHNESS = TOOLING_DIR / "freshness_manifest.json"
str	review_packet.MEASUREMENTS = TOOLING_DIR / "measurement_records.json"
str	review_packet.FAMILIES = TOOLING_DIR / "capability_families.json"
str	review_packet.SUBSYSTEMS = TOOLING_DIR / "subsystem_records.json"
str	review_packet.SCOPE = TOOLING_DIR / "capability_scope_records.json"
str	review_packet.XREF = REPO_ROOT / "docs_build" / "xref.json"
tuple	review_packet.XREF_CAVEAT
str	review_packet.COMPLETE = "ROUTE: complete over declared registry data (not over code behavior)"
str	review_packet.INCOMPLETE = "ROUTE: incomplete — declared identifier has unresolved routing"
str	review_packet.UNAVAILABLE = "ROUTE: unavailable — required environment or metadata is absent"