Capstone Map¶
Guide Fit¶
flowchart TD
family["Python Programming"] --> program["Python Metaprogramming"]
program --> pressure["A concrete learner or reviewer question"]
pressure --> guide["Capstone Map"]
guide --> next["Modules, capstone, and reference surfaces"]
flowchart TD
question["Name the exact question you need answered"] --> skim["Skim only the sections that match that pressure"]
skim --> crosscheck["Open the linked module, proof surface, or capstone route"]
crosscheck --> next_move["Leave with one next decision, page, or command"]
Read the first diagram as a timing map: this guide is for a named pressure, not for wandering the whole course-book. Read the second diagram as the guide loop: arrive with a concrete question, use only the matching sections, then leave with one smaller and more honest next move.
This map keeps the course attached to one executable system. The capstone is a plugin runtime for incident delivery adapters, and each major course mechanism has a clearly named home inside it.
Start by question¶
| If you need to know... | Start with | Then inspect |
|---|---|---|
| what the runtime exposes without execution | make manifest and make registry |
framework.py, manifest.json, and Capstone Architecture Guide |
| where wrapper behavior really lives | Capstone Architecture Guide | actions.py and tests/test_runtime.py |
| where field ownership and validation live | Capstone File Guide | fields.py and tests/test_fields.py |
| whether class creation is honest | Capstone Architecture Guide | framework.py and tests/test_registry.py |
| which route to hand to another reviewer | Capstone Walkthrough | make inspect, make tour, or make verify-report |
Mechanism to file map¶
- introspection and manifest export:
capstone/src/incident_plugins/framework.py - action wrappers and signature preservation:
capstone/src/incident_plugins/actions.py - descriptor-backed field contracts:
capstone/src/incident_plugins/fields.py - concrete plugin classes and realistic behavior:
capstone/src/incident_plugins/plugins.py - proof and regression coverage:
capstone/tests/
Module to capstone route¶
| Module stage | Inspect this file or surface | Why it matters | Prove it with |
|---|---|---|---|
| Modules 01-03 | capstone/src/incident_plugins/framework.py and manifest output |
shows how fields and actions stay inspectable without executing plugin work | make PROGRAM=python-programming/python-meta-programming inspect then read manifest.json |
| Modules 04-05 | capstone/src/incident_plugins/actions.py |
shows wrapper policy, preserved metadata, and recorded action history | make PROGRAM=python-programming/python-meta-programming proof then inspect trace.json and capstone/tests/test_runtime.py |
| Module 06 | generated constructor behavior in capstone/src/incident_plugins/framework.py |
shows what can stay honest after class creation before metaclasses become necessary | make PROGRAM=python-programming/python-meta-programming test then read capstone/tests/test_runtime.py |
| Modules 07-08 | capstone/src/incident_plugins/fields.py |
shows descriptor-backed validation, coercion, and per-instance storage ownership | make PROGRAM=python-programming/python-meta-programming test then read capstone/tests/test_fields.py |
| Module 09 | registration logic in capstone/src/incident_plugins/framework.py and registry output |
shows definition-time registration and duplicate prevention | make PROGRAM=python-programming/python-meta-programming inspect then read registry.json and capstone/tests/test_registry.py |
| Module 10 and Mastery Review | capstone/src/incident_plugins/cli.py plus saved proof bundles |
shows that the public review surface stays observational and reviewable | make PROGRAM=python-programming/python-meta-programming capstone-verify-report then read pytest.txt, manifest.json, and trace.json |
Local review guides¶
- Use Capstone Architecture Guide when you need ownership boundaries before reading implementation detail.
- Use Capstone Walkthrough when you need a guided first pass through commands and files.
- Use Capstone File Guide when you need a code-reading route.
- Use Capstone Proof Checklist when you need the shortest proof route.
- Use Capstone Walkthrough when you need the public-surface narrative order.
- Use Command Guide when you need the smallest honest command.
- Use Capstone Proof Checklist and Capstone Extension Guide when the question is review depth or change placement.
Practical reading order¶
- Start with one public surface such as
manifest,registry, ortrace. - Read the matching page in this capstone shelf so the ownership claim is explicit before you widen into repository-local notes.
- Read the owning file in
framework.py,fields.py,actions.py, orplugins.py. - Read the matching tests only after you know what the file is claiming to own.
- Escalate to saved bundles only when another reviewer needs the route preserved.
Inspect, explain, prove¶
For each module-stage claim, use the same loop:
- Inspect one source file or saved public output.
- Explain which runtime boundary owns the behavior.
- Prove the claim with one named test or one saved bundle file.