Repository navigation
Stale-surface cleanup: remove Notation/as_list/Capability.version + align pyproject/CI/CONTRIBUTING - #26
Merged
Conversation
|
Caution Review failedAn error occurred during the review process. Please try again later. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements
docs/development/plans/2026-08-17-stale-surface-cleanup.md— the FIRST of the four 2026-08-17 near-term plans. Closes every stale/dead surface named by architecture-review §9 item 3, which unblocks the capability-scaffolder plan (its templates assume noas_list, noCapability.version, and[dependency-groups]-only dev deps).Scope: 0.x-budgeted breaking changes (public-API removals) plus packaging/CI/docs alignment. No pipeline behavior changes.
Changes by sub-item
Notationalias +as_list()bridging removed —paxman/core/domain.py,paxman/core/__init__.py, all tencapabilities/<Name>/notation.pymodules,URL/notation.pydocstring, and 11 test files. Test doubles intests/unit/test_capability.pywere retyped tolist[str](not redesigned — Trap 2).ARCHITECTURE.md"Notation Bridging" rewritten to the typed-dataclass model;CONTEXT.md/HOW_TO_ADD_NEW_CAPABILITY.mdas_listsnippets removed.Capability.versionremoved — ABC annotation +version = "1.0.0"on all tencapability.pymodules + the matching test assertions (D4: removed, not consumed —VersionStamp.paxman_versionalready owns versioning).ContractFactorydocstring — "the five capability classes satisfy it" → "every shipped capability class satisfies it" (no hardcoded count that drifts again; review W1/W2).pyproject.toml— declaredreadme = "README.md", PEP 639license = "MIT"+license-files = ["LICENSE.md"](noLicense ::classifier),[project.urls](Homepage/Repository/Issues), and consolidated dev deps into[dependency-groups] dev(PEP 735) at the max floors.[project.optional-dependencies]deleted.uv.lockregenerated and committed in the same commit (D5/D6)..github/workflows/ci.yml—push.branchesnow[main, "feature/**", "refactor/**"];pull_requestuntouched, noworkflow_dispatchadded (D7).CONTRIBUTING.md— fixed stale repo name (paxman-alternative→paxman-python), aligned setup to CI'suv sync --all-extras, removed the duplicated install block, and linked the three contributor guides under a new "Before You Write Code" section.Guard tests (architecture-as-law)
New
tests/unit/test_removed_surfaces.pylocks every removal:Notationalias gone frompaxman.core.domainandpaxman.coredef as_listanywhere underpaxman/CapabilityABC carries noversionsurface (__annotations__andvars)version(vars(cls)— Trap 8, nothasattr)tests/unit/test_package_install.pygains apyproject-declaration guard (license / urls / readme / dependency-groups-only dev deps).Notes
docs/development/AGENTS.mddoes not require the plan to be rewritten post-implementation):e783d03(wrap a pre-existing 95-char SIUnit docstring line) and85223f9(dropversionfrom two test doubles that escaped the Task 2 enumeration). End state is fully correct.RecognizedRep.__hash__list-defense stays — defensive core code, not part of the removed alias.uv run pytest tests/unit/test_removed_surfaces.py tests/unit/test_package_install.py→ 8 passed.Test plan
refactor/**(this also proves Task 5's trigger)uv run pytestfull suite greenuv buildwheel METADATA shows license / urls / readme