Proof Guide¶
Guide Maps¶
graph TD
guide["Proof Guide"]
unit["Pytest proof"]
manifest["Manifest proof"]
invoke["Invocation proof"]
review["Review questions"]
guide --> unit
guide --> manifest
guide --> invoke
guide --> review
flowchart LR
choose["Choose a claim"] --> command["Run the matching command"]
command --> output["Inspect the output"]
output --> source["Trace it back to source ownership"]
source --> review["Record what the proof actually established"]
This guide keeps the capstone honest by tying each public claim to one repeatable proof path.
Start by claim¶
| If the claim is... | Start with | Escalate with |
|---|---|---|
| the runtime surface is observational | make manifest or make registry |
make inspect |
| wrapper behavior stays visible | make trace |
tests/test_runtime.py |
| descriptor fields own validation | make field |
tests/test_fields.py |
| registration stays deterministic | make registry |
tests/test_registry.py |
| the full review surface still agrees with tests | make verify-report |
make proof |
Strongest local proof¶
Run:
This runs the regression suite proving field validation, registry determinism, manifest export, and runtime invocation behavior.
Saved review routes¶
make inspectwrites the learner-facing inspection bundle.make tourwrites the learner-facing walkthrough bundle.make verify-reportwrites executable proof together with public-surface evidence.
Public-surface proof¶
Run the public proof surface:
Or run the CLI pieces individually:
These commands prove that the runtime shape and invocation path are inspectable from the public surface without opening private internals first.
Smallest honest routes¶
- Use
manifestbeforeinspectwhen one public schema question is enough. - Use
tracebeforeverify-reportwhen one invocation route is enough. - Use
confirmbeforeproofwhen the question is executable confidence rather than published review output.
Honest distinctions¶
inspectproves what the runtime exposes publicly before invocation.tourproves that a human can follow one complete public review route.verify-reportproves that executable tests and public-surface evidence agree in one saved bundle.confirmproves the strongest local regression surface.proofpublishes the full learner-facing review route.
Read the proof route by module stage¶
- Observation modules: inspect
manifestandregistryoutput before running actions. - Decorator modules: compare
demo,trace, and runtime-test expectations. - Descriptor modules: pair
confirmwithtests/test_fields.py. - Metaclass module: pair
registryoutput withtests/test_registry.py. - Governance and mastery: use
inspect,tour, andverify-reportas the final human review surface.
Use REGISTRY_GUIDE.md when the metaclass proof question is mainly about deterministic registration and duplicate handling.
Use MANIFEST_GUIDE.md when the proof question is mainly about observational export rather than registration or invocation.
Review questions¶
- Which proof demonstrates definition-time behavior?
- Which proof demonstrates preserved callable metadata?
- Which proof demonstrates that the manifest stays observational rather than operational?
Use TRACE_GUIDE.md when the key proof question is really about wrapper history and visible invocation metadata.