generate_capability_inventory.py File Reference

Go to the source code of this file.

Namespaces
namespace	generate_capability_inventory

Functions
dict	generate_capability_inventory.load_registry ()
	Load the capability family registry.
	generate_capability_inventory.literal (ast.AST node)
	Evaluate a literal AST node, additionally accepting the bare set() call that appears in the boundary-handler specs for empty parameter sets.
ast.Module	generate_capability_inventory.module_syntax (str module)
	Parse a dotted module into one syntax tree, whether file or package.
dict[str, dict]	generate_capability_inventory.python_dict_values (str module, str symbol)
	Read a public-surface dictionary from the CLI package without importing PETSc.
dict[str, dict]	generate_capability_inventory.python_normalizer_values (str module, str symbol)
	Read the canonical selector strings accepted by a normalizer function.
str	generate_capability_inventory.function_body (str path, str function)
	Return the source text of one C function, so extraction never spans the file.
dict	generate_capability_inventory.python_membership_values (str module, str symbol)
	Read the accepted values from a normalizer that validates by set membership.
dict	generate_capability_inventory.python_equality_chain_values (str module, str symbol)
	Read accepted values from a normalizer that compares against string literals.
dict[str, str]	generate_capability_inventory.c_string_map_values (str path, str function)
	Extract the case-insensitive selector strings a C parser accepts.
dict[str, str]	generate_capability_inventory.c_token_map_values (str path, str function, str variable, str field)
	Extract an exact-match token chain that assigns an enum to a context field.
set[str]	generate_capability_inventory.c_switch_values (str path, str function, str prefix)
	Extract the enum constants a C factory switch dispatches on.
set[str]	generate_capability_inventory.c_dispatch_values (str path, str function, str prefix)
	Extract the enum constants an if/else dispatch chain compares against.
set[str]	generate_capability_inventory.c_enum_values (str path, str symbol)
	Extract the members of a C enum.
dict	generate_capability_inventory.python_constant_values (str module, str symbol)
	Read the accepted values from a named module-level choice set.
dict	generate_capability_inventory.collect (dict family)
	Build one family's inventory record from its declared sources.
None	generate_capability_inventory.apply_metadata (list[dict] inventory, dict registry)
	Merge declared per-value metadata (status, alias target) into the inventory.
dict[str, int]	generate_capability_inventory.classify (list[dict] inventory)
	Count selectable, alias, and latent values separately.
None	generate_capability_inventory.apply_reachability (list[dict] inventory, dict registry)
	Mark declared values that no other family can actually satisfy as latent.
str	generate_capability_inventory.entry_anchor (dict registry_entry, str value)
	Anchor name of the Tier-2 entry for one selector value.
str	generate_capability_inventory.html_escape (str text)
	Escape text for inclusion in generated HTML.
set	generate_capability_inventory.documented_entries (dict family, dict registry_entry)
	Values whose Tier-2 entry anchor is actually present on the family page.
str	generate_capability_inventory.render_family (dict family, dict registry_entry)
	Render one family's value table as a Doxygen-includable HTML fragment.
Path	generate_capability_inventory.family_fragment_path (str family_id)
	Path of the per-family includable fragment.
str	generate_capability_inventory.render_evidence_matrix (list[dict] inventory, dict registry)
	Render the project-wide capability-by-evidence matrix as an HTML fragment.
str	generate_capability_inventory.render_markdown (list[dict] inventory)
	Render the inventory as a Doxygen-includable Markdown fragment.
int	generate_capability_inventory.main ()
	Generate the capability inventory artifacts.

Variables
	generate_capability_inventory.REPO_ROOT = Path(__file__).resolve().parents[2]
str	generate_capability_inventory.REGISTRY_PATH = REPO_ROOT / "tests" / "tooling" / "capability_families.json"
str	generate_capability_inventory.GENERATED_DIR = REPO_ROOT / "docs" / "generated"