Repository navigation
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
The Codec docstring says decode writes into `out`, and callers expect `out` back. Ten codecs (Zlib, BZ2, LZMA, Base64, Shuffle, ZFPY, PCodec and the three VLen codecs) rebound `out` to a flattened view and returned that, and numcodecs.compat.ndarray_copy did the same for any `out` that was not an ndarray, which every filter and checksum codec inherited. The decoded bytes were already in the caller's buffer; only the returned object changes. JenkinsLookup3.decode now accepts any contiguous writable buffer as `out` and checks its size, and Fletcher32.decode returns a uint8 ndarray instead of a Cython memoryview slice that no type annotation could name. The strict xfails in tests/test_codec_contract.py are removed. Assisted-by: ClaudeCode:claude-opus-5-5
… add __all__ Several annotations described something other than what the code does: - codec_registry holds classes: dict[str, type[Codec]], not dict[str, Codec]. - entries holds single entry points: dict[str, EntryPoint]. - ndarray_copy returned NDArrayLike, but hands back `src` unchanged (often bytes) when `dst` is None. It is now overloaded on `dst`. - NDArrayLike, DType and FlagsObj declared settable attributes, so no numpy.ndarray satisfied NDArrayLike under mypy or pyright. They now declare read-only properties. The isinstance cache moves to module level, because a protocol without annotations of its own would otherwise pick up the metaclass's annotation as a required member. The compat functions annotate their parameters with a new BufferLike alias (collections.abc.Buffer | NDArrayLike), is_ndarray_like returns TypeIs, and get_codec/register_codec are annotated. register_codec now refuses a class without a codec_id instead of registering it under None, and get_codec warns (DeprecationWarning) when an entry point loads a class that does not subclass Codec, so that `-> Codec` can become true. numcodecs/__init__.py defines __all__, so that type checkers treat the re-exported codec classes as public once numcodecs ships py.typed. mypy now checks against Python 3.12, the oldest supported version; doing so caught `typing.TypeIs`, which only exists from 3.13 and now comes from typing_extensions. Assisted-by: ClaudeCode:claude-opus-5-5
…tocols Codec.encode and Codec.decode were unannotated with docstring-only bodies, so mypy saw them as Any and pyright inferred that both return None, which made every typed subclass an "incompatible override" under pyright. - encode/decode take and return BufferLike (collections.abc.Buffer | NDArrayLike), with `buf` positional-only so that subclasses may rename it. - decode is overloaded so that decode(buf, out=out) returns the type of `out`, which every codec now honors. - codec_id is declared `str` without a default instead of `str | None = None`. It is not a ClassVar: with ClassVar, Codec instances do not match protocols that declare codec_id as a plain attribute (zarr-python's Numcodec) or as a property, under mypy or pyright. - get_config returns Mapping[str, Any], so that concrete codecs can later return per-codec TypedDicts, and from_config returns Self. numcodecs.abc also exports CodecProtocol and the three Zarr v3 codec kinds (BytesBytesCodec, ArrayArrayCodec, ArrayBytesCodec) as structural protocols, so consumers can type code that accepts any codec-like object. Assisted-by: ClaudeCode:claude-opus-5-5
blosc, zstd, lz4, vlen, fletcher32, jenkins, compat_ext and _shuffle had no stubs, so type checkers saw Blosc, Zstd, LZ4, Fletcher32 and the VLen codecs as unknown, and numcodecs' own mypy run silently treated them as Any. Each module now has a stub next to its .pyx, installed by meson. The stubs follow probed behavior: the compressors return bytes, or `out` itself when it is given; Fletcher32.decode returns a uint8 ndarray; the VLen codecs encode to bytearray and decode to object arrays. VLenArray.encode takes an object array only, since numpy turns a list of equal-length arrays into a 2-D array. The typing CI job runs mypy.stubtest against the installed extensions, with an allowlist for Cython artifacts (__test__, __pyx_capi__, and the `(self, /)` signature Cython reports for argument-less module functions). Checksum32.checksum is declared positional-only, so that JenkinsLookup3 can use jenkins_lookup3 (whose parameters are named differently) as its checksum; it is wrapped in staticmethod so type checkers do not bind it as a method. It was never bound at runtime, being a builtin function. Assisted-by: ClaudeCode:claude-opus-5-5
This was referenced Nov 21, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #910 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 27 27
Lines 922 951 +29
=========================================
+ Hits 922 951 +29
🚀 New features to boost your workflow:
|
With .pyi stubs next to the .pyx sources, ruff resolves numcodecs.blosc, numcodecs.zstd, numcodecs.fletcher32 and numcodecs.jenkins as first-party modules and wants them grouped with the other numcodecs imports. Assisted-by: ClaudeCode:claude-opus-5-5
# Conflicts: # tests/test_codec_contract.py
…ations # Conflicts: # docs/release.md # src/numcodecs/compat.py
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 🤖
Ship
.pyitype stubs for the Cython extension modules (blosc,zstd,lz4,vlen,fletcher32,jenkins,compat_extand_shuffle), checked against the compiled modules withmypy.stubtestin CI. Type checkers previously saw the Blosc, Zstd, LZ4, Fletcher32 and VLen codecs as unknown.Summary
Any(throughignore_missing_imports)..pyx, is installed by meson, and follows behavior the agent probed:bytes, oroutitself when it is given;uint8ndarray;bytearrayand decode to object arrays.VLenArray.encodetakes an object array only, because numpy turns a list of equal-length arrays into a 2-D array.typingjob runsmypy.stubtestagainst the installed extensions. The allowlist covers Cython artifacts:__test__,__pyx_capi__, and the(self, /)signature Cython reports for argument-less module functions. Until numcodecs shipspy.typed(last PR of the stack), mypy ignores inline stubs in an installed package, so this step reads them fromsrc/viaMYPYPATH.Checksum32.checksumis declared positional-only so thatJenkinsLookup3can usejenkins_lookup3, whose parameters have other names. It is wrapped instaticmethod, which changes nothing at runtime, since it is a builtin and was never bound.Tests
stubtest is clean against an installed wheel;
tests/typing/test_cython_types.pychecks the stubbed types at runtime.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 3220705; 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 teststyping/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 modules ← this PRtyping/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