Skip to content

feat(abc): annotate the Codec base class and add structural codec protocols - #909

Open
d-v-b wants to merge 9 commits into
zarr-developers:mainfrom
d-v-b:typing/04-base-class
Open

d-v-b wants to merge 9 commits into
zarr-developers:mainfrom
d-v-b:typing/04-base-class

Conversation

@d-v-b

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

Copy link
Copy Markdown
Contributor

🤖 AI text below 🤖

Annotate numcodecs.abc.Codec: encode and decode take and return BufferLike, and decode(buf, out=out) is typed to return the type of out. Add structural protocols CodecProtocol, BytesBytesCodec, ArrayArrayCodec and ArrayBytesCodec; previously pyright inferred that encode and decode return None.

Summary
  • Why: Codec.encode and decode had docstring-only bodies. mypy therefore saw them as Any, and pyright inferred that both return None, which made every typed subclass an "incompatible override".
  • encode and decode take and return BufferLike. buf is positional-only in the base, so subclasses may rename it (some plugins already do).
  • decode is overloaded so that decode(buf, out=out) returns the type of out, which every codec honors after the previous PR.
  • codec_id is declared str with no default, replacing str | None = None. This is the substance of (chore) Type hints for abc codec codec_id attribute #702, except that it is not a ClassVar: with ClassVar, Codec instances match neither protocols that declare codec_id as a plain attribute (zarr-python's Numcodec) nor ones that declare it as a property, under either checker. Abstract intermediates such as Checksum32 leave it unset.
  • Config methods: get_config returns Mapping[str, Any], so concrete codecs can return per-codec TypedDicts later in the stack, and from_config returns Self.
  • Protocols: CodecProtocol and the three Zarr v3 codec kinds are exported as structural protocols. Consumers can type code that accepts any codec-like object; zarr-python could use them in place of its private Numcodec protocol.

This supersedes #702 and the base-class part of #701.

Tests

Full suite passes locally; tests/typing/test_abc_types.py covers the methods through a Codec reference, a third-party subclass typed as precisely as numcodecs, and one annotated with Any (imagecodecs style).

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 c26d438; 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 ← this PR
  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
  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
@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 (05dabce).

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

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