raptor.conformance.public_names

raptor.conformance.public_names#

Public-name coverage, the family’s one check: every public name of the given modules is referenced by a test, or is on the allowlist.

python -m raptor.conformance.public_names –src DIR –tests DIR –allow FILE (–module a.b | –walk pkg)… [–base REF]

Public = the names in a module’s __all__, else its top-level functions, classes and assignments without a leading underscore; for a package, also the submodules its __init__ imports with from . import name (its doors). Referenced = the bare name appears as a word in a .py file under --tests. The allowlist holds one module.name  # reason per line; it may only shrink: a listed name that a test now references, or that is no longer public, fails the check until its line is deleted, and with --base REF a line added since that git ref fails too. Static, no imports. Exit 0 clean, 1 on any finding.

Functions

main(…)