Repository navigation
test: check the Codec contract for every codec and add static type tests - #906
Merged
Merged
Conversation
Add tests/test_codec_contract.py, which runs every registered codec through the behavior the Codec base class promises: encode and decode return buffers, decode(out=...) returns the caller's out, and get_config round-trips through from_config. Known violations are strict xfails, so fixing one forces its entry to be removed. Add tests/typing, where assert_type checks (verified by mypy and pyright in strict mode) sit next to runtime assertions (verified by pytest), and a `typing` CI job that runs both checkers plus the repository's own mypy configuration. The type checkers are pinned in a new `typing` dependency group. Assisted-by: ClaudeCode:claude-opus-5-5
This was referenced Nov 21, 2026
d-v-b
added a commit
to d-v-b/numcodecs
that referenced
this pull request
Nov 21, 2026
Resolve the conflict in src/numcodecs/pickles.py by keeping the typed signatures from zarr-developers#915 and the deprecation warning in Pickle.__init__. Two tests added upstream construct the Pickle codec and now see the deprecation warning: test_config_round_trip[pickle] (zarr-developers#906), which rebuilds the codec from its config, and the static type test test_pickle (zarr-developers#915). Both get a filterwarnings mark scoped to the deprecation message. Assisted-by: ClaudeCode:claude-opus-5.5
This was referenced Nov 21, 2026
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.
🤖 AI text below 🤖
Check the behavior every codec promises through
numcodecs.abc.Codecin a newtests/test_codec_contract.py, and add strict static type tests intests/typing, run by mypy and pyright in a newtypingCI job.Summary
This PR changes no library code. It adds the checks that the rest of the stack relies on, so that each later annotation is verified against what the code actually does.
tests/test_codec_contract.pyruns every registered codec through the behavior the base class promises:encodeanddecodereturn buffers;decode(buf, out=out)returns the caller'sout, for both an ndarray and abytearray;get_config()round-trips through JSON,get_codecandfrom_config.Known violations are listed as
xfail(strict=True), so a fix fails the test until its entry is removed. The next PR removes all of them. A guard test fails when a newly registered codec is missing from the case table.tests/typing/pairstyping.assert_type(checked by mypy and pyright, both strict) with runtime assertions (checked by pytest). An annotation that the checkers accept but the runtime contradicts fails one of the two. Both checkers read numcodecs fromsrc/.The new
typingCI job runs the repository's own mypy configuration oversrcandtests, plus both checkers overtests/typing.mypy and pyright are pinned in a new
typingdependency group.Tests
Locally on Python 3.13: the full pytest suite passes (83 contract tests pass and 26 are strict xfails). mypy (repository config), mypy strict (
tests/typing) and pyright strict (tests/typing) are all clean.Stack and merge order
The agent split honest type annotations for numcodecs into a stack of 10 PRs, following an audit of the existing annotations and of the earlier attempts (#443, #698, #701, #702). Each PR is opened from the fork against
main, so until the PRs before it merge, its diff also contains their commits. The change specific to this PR starts at commit ff36c01; later commits on its branch are follow-up fixes and merges of the PR below it. Merge in this order:typing/01-harness: test: check the Codec contract for every codec and add static type tests ← this PRtyping/02-out-contract: fix: return the caller's out from decode(buf, out=out) in every codectyping/03-fix-annotations: fix(typing): correct registry, compat and NDArrayLike annotations and add alltyping/04-base-class: feat(abc): annotate the Codec base class and add structural codec protocolstyping/05-cython-stubs: feat(typing): ship .pyi stubs for the Cython extension modulestyping/06a-compressors: feat(typing): annotate the compressor codecs with per-codec config TypedDictstyping/06b-checksums: feat(typing): annotate the checksum codecs and make JenkinsLookup3 configs JSONtyping/06c-filters: feat(typing): annotate the filter codecstyping/06d-object-codecs: feat(typing): annotate the object and array-to-bytes codecstyping/07-py-typed: feat(typing): ship py.typed and check numcodecs with strict mypy🤖 Generated with Claude Code