Skip to content

feat(typing): annotate the compressor codecs with per-codec config TypedDicts - #911

Open
d-v-b wants to merge 18 commits into
zarr-developers:mainfrom
d-v-b:typing/06a-compressors
Open

d-v-b wants to merge 18 commits into
zarr-developers:mainfrom
d-v-b:typing/06a-compressors

Conversation

@d-v-b

@d-v-b d-v-b commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

🤖 AI text below 🤖

Annotate Zlib, GZip, BZ2, LZMA, Base64, Blosc, Zstd and LZ4. Each get_config returns a TypedDict of the codec's parameters, a subclass of the new numcodecs.abc.CodecConfig; typing_extensions >= 4.13 is now required.

Summary
  • Annotations: each codec annotates __init__, encode (-> bytes) and decode (overloaded: bytes without out, the type of out with it). Blosc, Zstd and LZ4 do the same through their stubs.
  • Config types: get_config returns ZlibConfig, BloscConfig and so on. For codecs that inherit the base implementation, this is a cast of the inherited dict, so a subclass that adds attributes keeps them in its configuration, as before.
  • numcodecs.abc.CodecConfig is the common base: id: str, with PEP 728 extra_items=ReadOnly[JSON].
    • pyright implements PEP 728 and treats any codec configuration as Mapping[str, JSON]. mypy doesn't yet, and sees a plain TypedDict; that needs one # type: ignore[call-arg] on the class.
    • numcodecs.abc.JSON uses Sequence/Mapping, the same definition as zarr-metadata's JSONValue.
    • At runtime, extra_items needs typing_extensions >= 4.13.
  • Cython modules define their config TypedDicts with the functional syntax, which Cython compiles, and the stubs declare the same types with the class syntax.

zarr-metadata cross-reference (in the agent's notes, not in this PR):

  • GZipConfig and ZstdConfig match zarr-metadata's v3 gzip/zstd configurations field for field.
  • BloscConfig uses the v2 encoding: shuffle is an int, cname is a free string, and typesize is left out ((fix): ensure no typesize in the Blosc config #739).
  • pyright rejects numcodecs configs as zarr-metadata's ZarrV2CodecMetadata, because that type declares its extra items mutable. Declaring them ReadOnly[JSONValue] there would accept them.
Tests

Full suite passes locally; tests/typing/test_compressor_types.py checks returns, out identity, config field types, and (pyright only) that configs are Mapping[str, JSON].

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 2dcbbcd; later commits on its branch are follow-up fixes and merges of the PR below it. Merge in this order:

  1. test: check the Codec contract for every codec and add static type tests #906 typing/01-harness: test: check the Codec contract for every codec and add static type tests
  2. fix: return the caller's out from decode(buf, out=out) in every codec #907 typing/02-out-contract: fix: return the caller's out from decode(buf, out=out) in every codec
  3. fix(typing): correct registry, compat and NDArrayLike annotations and add __all__ #908 typing/03-fix-annotations: fix(typing): correct registry, compat and NDArrayLike annotations and add all
  4. feat(abc): annotate the Codec base class and add structural codec protocols #909 typing/04-base-class: feat(abc): annotate the Codec base class and add structural codec protocols
  5. feat(typing): ship .pyi stubs for the Cython extension modules #910 typing/05-cython-stubs: feat(typing): ship .pyi stubs for the Cython extension modules
  6. feat(typing): annotate the compressor codecs with per-codec config TypedDicts #911 typing/06a-compressors: feat(typing): annotate the compressor codecs with per-codec config TypedDicts ← this PR
  7. feat(typing): annotate the checksum codecs and make JenkinsLookup3 configs JSON #912 typing/06b-checksums: feat(typing): annotate the checksum codecs and make JenkinsLookup3 configs JSON
  8. feat(typing): annotate the filter codecs #913 typing/06c-filters: feat(typing): annotate the filter codecs
  9. feat(typing): annotate the object and array-to-bytes codecs #914 typing/06d-object-codecs: feat(typing): annotate the object and array-to-bytes codecs
  10. feat(typing): ship py.typed and check numcodecs with strict mypy #915 typing/07-py-typed: feat(typing): ship py.typed and check numcodecs with strict mypy

🤖 Generated with Claude Code

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
…pedDicts

Zlib, GZip, BZ2, LZMA and Base64 annotate __init__, encode (-> bytes) and
decode (overloaded: bytes without `out`, the type of `out` with it), and
Blosc, Zstd and LZ4 get the same through their stubs. Each get_config
returns a TypedDict of the codec's parameters; for codecs that inherit the
base implementation it is a cast of the inherited dict, so subclasses that
add attributes keep them in their configuration as before.

numcodecs.abc.CodecConfig is the common base: `id: str`, with PEP 728
`extra_items=ReadOnly[JSON]`, which lets pyright treat any codec
configuration as a Mapping[str, JSON] (and as Zarr v2 codec metadata).
mypy does not implement PEP 728 yet and sees a plain TypedDict. JSON uses
Sequence/Mapping, matching zarr_metadata's JSONValue. `extra_items` needs
typing_extensions >= 4.13 at runtime.

The Cython modules define their config TypedDicts with the functional syntax,
which Cython compiles; the stubs declare the same types with the class
syntax.

Assisted-by: ClaudeCode:claude-opus-5-5
@codecov

codecov Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1d2229f) to head (bc90f92).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #911   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           27        27           
  Lines          922      1008   +86     
=========================================
+ Hits           922      1008   +86     
Files with missing lines Coverage Δ
src/numcodecs/__init__.py 100.00% <100.00%> (ø)
src/numcodecs/abc.py 100.00% <100.00%> (ø)
src/numcodecs/base64.py 100.00% <100.00%> (ø)
src/numcodecs/bz2.py 100.00% <100.00%> (ø)
src/numcodecs/checksum32.py 100.00% <100.00%> (ø)
src/numcodecs/compat.py 100.00% <100.00%> (ø)
src/numcodecs/gzip.py 100.00% <100.00%> (ø)
src/numcodecs/lzma.py 100.00% <100.00%> (ø)
src/numcodecs/ndarray_like.py 100.00% <100.00%> (ø)
src/numcodecs/registry.py 100.00% <100.00%> (ø)
... and 1 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

d-v-b added 12 commits November 21, 2026 17:04
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
…dDicts

The Cython modules create their config TypedDicts at runtime with
typing.TypedDict, which adds __mutable_keys__ and __readonly_keys__;
stubtest does not expect them on the stubs' class-syntax TypedDicts.
The allowlist entry was only added in the py.typed change, but it is
needed from the commit that introduced the TypedDicts.

Assisted-by: ClaudeCode:claude-opus-5-5
…ations

# Conflicts:
#	docs/release.md
#	src/numcodecs/compat.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant