Functions

List of functions in the ude.coverage namespace.

Entity Name	Description
_is_excluded_from_coverage	Private (`_foo`), dunder (`__foo__`), and logger-instance names are parser/tooling artifacts (e.g. namespace-level variable/import wrappers synthesized by the Doxygen collector), not public API surface – forcing docstrings on them is a false positive, not a real documentation gap.
compute_coverage	Computes documentation coverage over the real catalog shape.
print_coverage_table	Renders a markdown table with the coverage results to stdout.
apply_coverage_gate	Computes coverage for `catalog`, prints the audit table, and enforces the gate. raises) or “reject-undocumented” (enforces `threshold`). Sourced from `GlobalConfig.coverage_mode`. report_format: Output format for the coverage report. One of “markdown”, “sarif”, or “codeclimate”.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_is_excluded_from_coverage function

Private (_foo), dunder (__foo__), and logger-instance names are parser/tooling artifacts (e.g. namespace-level variable/import wrappers synthesized by the Doxygen collector), not public API surface – forcing docstrings on them is a false positive, not a real documentation gap.

Returns:

True if the entity should be excluded from the coverage registry.

Methods

_is_excluded_from_coverage

_is_excluded_from_coverage(name: str) -> bool

apply_coverage_gate function

Computes coverage for catalog, prints the audit table, and enforces the gate. raises) or “reject-undocumented” (enforces threshold). Sourced from GlobalConfig.coverage_mode. report_format: Output format for the coverage report. One of “markdown”, “sarif”, or “codeclimate”.

Raises: ValueError: when threshold is not within the valid 0.0-1.0 fraction range. This defense-in-depth check protects library callers who invoke apply_coverage_gate() directly, bypassing the CLI boundary check and the GlobalConfig.coverage_threshold Field constraint that already guards config-file-sourced values. CoverageGateError: when mode == “reject-undocumented” and coverage falls below threshold. Callers that need a specific process exit code (e.g. a future CLI audit handler) should catch CoverageGateError and translate it themselves.

compute_coverage function

Computes documentation coverage over the real catalog shape.

Counts each class (by fully_qualified_name), its methods, and its fields (variables). Enums, constants, and type_aliases on ClassModel are not yet counted; extending coverage to them follows the exact same pattern as the loops below.

Private (_foo), dunder (__foo__), and logger entities are excluded from the registry entirely – see _is_excluded_from_coverage.

Returns:

A CoverageReport summarizing total/documented entity counts,

Methods

compute_coverage

compute_coverage(catalog: ProjectCatalog) -> CoverageReport

print_coverage_table function

Renders a markdown table with the coverage results to stdout.

Methods

print_coverage_table

print_coverage_table(report: CoverageReport)

Renders a markdown table with the coverage results to stdout.

Parameter	Type	Description
report	`CoverageReport`	The coverage report to render.

Generated with Flude