Commit f5d7855
Constant-rename equivalence check: prove a rename changed no behaviour
A throwaway script written for PR #567 caught a real production-breaking
bug that git, the 3,036-test backend suite and the committed lint chain
all passed over. It lived only in a session scratchpad. This commits it.
The incident (2026-07-29): #567 renamed SLOW_PATH_TO_REVIEW_REASON to
SLOW_PATH_TO_REVIEW_SKIP_REASON; #568 concurrently added BRAND NEW code
in catalog_stats.py importing and using the OLD name. Git auto-merged
with no conflict - #568 only added lines, #567 only touched a nearby
docstring, so the rename and the new references never textually
collided. The merged result would have raised ImportError at
module-import time in a module reached by the catalog-stats view and the
hourly warm_catalog_stats job. Thirteen reference sites, six modules.
The generalisation: a textual merge cannot see a name graph.
1. .github/scripts/constant_rename_equivalence.py - two checks.
--check-references (one revision, no judgment calls) resolves every
matching constant reference: a `from x import NAME` where x declares
no NAME is an ImportError, unconditionally. The equivalence check
(two revisions) normalises each module at both - inlining matching
constants with the map built across the WHOLE tree so cross-module
imports resolve, deleting those declarations/__all__ entries/imports,
deleting docstrings, constant-folding f-strings and string
concatenation - then compares ast.dump() trees.
2. Generalised past skip reasons: --pattern is a regex searched against
ALL-CAPS module-level names, defaulting to the families this repo
actually refactors (SKIP_REASON|ANONYMOUS_ID|_VERSION|_WEIGHT|
_THRESHOLD|_PREFIX|_REASON). --pattern '.' inlines everything.
3. Revisions are arguments; default is HEAD vs its merge-base with
origin/master, with fallbacks so it works in a worktree with no
remote. --paths narrows, --all widens.
4. Failures name the module, the AST node path, and both sides unparsed
back to source - not "these trees differ" on a 2,000-line file.
5. Scope includes modules the diff never touched. A changed-files-only
scope would have missed catalog_stats.py, which is the whole point:
in the merge that broke, the rename half touched only
local_calculate_verdicts.py.
CI wiring is deliberately two jobs with different trigger characters.
`references` is an unconditional invariant that runs on every Python PR
and can genuinely fail (same posture as protected-core-license).
`equivalence` gates ITSELF: with no renamed or removed constant in the
diff it prints "nothing to prove" and exits 0, rather than being a job
that runs always and passes always.
Tests follow test_docs_lint.py's conventions: fixture git repos, every
rule with a passing AND a failing case, including genuine behaviour
changes (a renamed constant whose value also moved; a comparison
operand change alongside a rename; a frozenset membership change), plus
a guard that a rename OUTSIDE the pattern is not normalised away. Two
real-repo tests pin the incident.
Two normaliser gaps were found and closed while running it against real
history, both real:
- matching had to widen to any name CONTAINING the pattern, because
LANDS_PHASH_SKIP_REASON_PREFIX ends in _PREFIX, not _REASON;
- the f-string folder has to fold a SINGLE interpolated constant back
into the surrounding literal, not just whole f-strings, because
`f"phash-{r}"` and `f"{PREFIX}{r}"` are the same value in different
shapes. Without this the real #567 commit reported a false difference.
Nothing was weakened to make the repo pass: the one remaining difference
reported against #567 is docs_lint.py, which that same PR legitimately
grew by 129 lines of new lint code.
Documented in docs/reference/constant-rename-equivalence.md (indexed
from docs/README.md and docs/MANIFEST.md), cross-referenced from
docs/reference/skip-reasons.md, promoted into docs/lessons.md per that
file's own triage ritual, and added to CLAUDE.md's task-end checks.
Verified: 37 unit tests pass; docs-lint --strict clean; pre-commit
clean; the tool reproduces the incident (6 ImportError findings plus 6
tree differences on a reconstructed auto-merge) and detects a
rename-plus-behaviour-change (7 modules, 'to-review' -> 'to-review-v2').
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013NhYmT1PxCcyemA16dFDxN1 parent 27d6cca commit f5d7855
9 files changed
Lines changed: 1773 additions & 44 deletions
File tree
- .github
- scripts
- tests
- workflows
- docs
- reference
Large diffs are not rendered by default.
Lines changed: 490 additions & 0 deletions
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
73 | 82 | | |
74 | 83 | | |
75 | 84 | | |
| |||
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
37 | 45 | | |
38 | 46 | | |
39 | 47 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1023 | 1023 | | |
1024 | 1024 | | |
1025 | 1025 | | |
| 1026 | + | |
| 1027 | + | |
| 1028 | + | |
| 1029 | + | |
| 1030 | + | |
| 1031 | + | |
| 1032 | + | |
| 1033 | + | |
| 1034 | + | |
| 1035 | + | |
| 1036 | + | |
| 1037 | + | |
| 1038 | + | |
| 1039 | + | |
| 1040 | + | |
| 1041 | + | |
| 1042 | + | |
| 1043 | + | |
| 1044 | + | |
| 1045 | + | |
| 1046 | + | |
| 1047 | + | |
| 1048 | + | |
| 1049 | + | |
| 1050 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
45 | 55 | | |
46 | 56 | | |
47 | 57 | | |
| |||
0 commit comments