Enable ruff annotation rules (ANN)

[anth-volk]

Fixes #3904

Summary

Phase 1 step 1.8, group 3: annotations. Stacked on #3902.

• Annotations: select gains ANN, and every function outside tests is now annotated: 252 findings in policyengine_api and the scripts, plus 16 in .github/.

• Any (ANN401): replaced by a real type wherever one exists (56 of 63). Types used include object for opaque pass-through values, the existing JSONValue alias, CachedReformImpact, Starlette Scope, ArrayLike, and two new Protocols (CachePipeline, SPMCapabilitySource).

• Remaining suppressions: each keeps an inline # noqa: ANN401 with a reason:

  • exact-type() JSON validators mypy can't narrow;
  • Session.exec overloads that reject core selects;
  • dataclasses.replace(**changes);
  • the TOML value from Enforcer.get;
  • incompatible Flask/a2wsgi WSGI stubs;
  • pass-through JSON values;
  • Pydantic model-class maps.

  One noqa: ANN201 is on a Pydantic wrap serializer, because annotating it would change the published OpenAPI schema.

• Test-file exemptions: **/tests/** ignores S101, D1, ANN and PLR2004, as agreed for step 1.8. This is registered as api.quality.tests-ruff-exemptions.

• Annotations checked against the code: I ran mypy over the whole package (beyond the configured v2 scope) and compared it with the base branch. Annotations that didn't match the code were corrected in the commit "Correct annotations that whole-package mypy shows were wrong". Whole-package mypy errors fell from 259 to 182.

• Eight new whole-package errors remain:

  • Library typing: policyengine_core has no py.typed, and Connector.connect and numpy arithmetic return Any.
  • Two real code gaps, now visible because the functions are annotated:
    • Flask's view_args is optional, but the route indexes it.
    • get_execution_result accepts None, but its success path needs an execution.

  Fixing either needs a code change, which is out of scope for an annotation PR.

• Runtime-annotation guard: the guard Enable ruff typing-only import rules (TC) #3902 added now resolves each model's bases the way ruff does: through the import in the model's own module, following bases defined in the same module. Ruff matches that import path, not where a base is defined, so a listed base imported through a re-export doesn't count. The old guard compared definition paths and would have missed that case. A new test pins the resolution, and an experiment against ruff 0.15.12 confirmed each case. No model in the package is affected today. The rule statement and docs/engineering/skills/typing-only-imports.md now describe the matching precisely.

• PolicyEngine bundle 6.4.1 (replaces Update PolicyEngine bundle to 6.4.1 #3939): the Simulation API now runs 6.4.1 (chore(deps): update policyengine to 6.4.1 policyengine-sim-api#809). On 6.3.4, the Public API's "Ensure PolicyEngine bundle is supported by simulation API" check fails with "The us route resolves to a different worker application", which also blocks master's staging deploy. The bundle moves policyengine-uk from 2.126.12 to 2.130.1; US stays at 2.2.1.

  • Catalog counts reviewed and updated in test_v2_catalog_installed.py. UK adds 37 variables and removes one, and adds parameters for ESA and JSA remunerative work, the tax credits Pension Credit passport and the Universal Credit company-owner rules.
  • Removed input: policyengine-uk 2.129.0 removed uc_has_limited_capability_for_work in favour of uc_limited_capability_for_work. It joins DEPRECATED_VARIABLES, so a partner still sending it gets a warning naming the replacement instead of a failed calculation.

Testing

• pytest tests/unit tests/contract: 2,358 passed. to_refactor plus dedupe: 53 passed.
• Configured mypy is clean. ruff check/format are clean repo-wide.
• All 234 Pydantic model schemas and the OpenAPI spec are identical to the base branch.
• Guards and the rules tool unittest pass. scripts/rules is byte-identical with sim.

🤖 Generated with Claude Code

[codecov]

Codecov Report

❌ Patch coverage is 73.86364% with 46 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.48%. Comparing base (e76065e) to head (34af5fd).

Files with missing lines	Patch %	Lines
policyengine_api/runtime_cache/core.py	22.22%	0 Missing and 14 partials ⚠️
policyengine_api/spm.py	66.66%	4 Missing and 1 partial ⚠️
policyengine_api/asgi_factory.py	62.50%	3 Missing ⚠️
policyengine_api/specification.py	57.14%	2 Missing and 1 partial ⚠️
...e_api/utils/payload_validators/validate_country.py	66.66%	2 Missing and 1 partial ⚠️
policyengine_api/worker_spm.py	57.14%	1 Missing and 2 partials ⚠️
policyengine_api/data/orm.py	50.00%	1 Missing and 1 partial ⚠️
policyengine_api/data/v2/catalog/extraction.py	60.00%	1 Missing and 1 partial ⚠️
...pi/fastapi_routes/v2/households/document_models.py	60.00%	1 Missing and 1 partial ⚠️
policyengine_api/libs/gateway_auth.py	60.00%	1 Missing and 1 partial ⚠️
... and 5 more

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #3905       +/-   ##
===========================================
+ Coverage   43.80%   85.48%   +41.68%     
===========================================
  Files         183      198       +15     
  Lines       11219    12412     +1193     
  Branches     1993     2266      +273     
===========================================
+ Hits         4915    10611     +5696     
+ Misses       5812     1100     -4712     
- Partials      492      701      +209     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.