docs

Author: normanrz

numcodecs/tests/test_zarr3.py

@@ -28,37 +28,20 @@ def store() -> Store:
     return StorePath(MemoryStore(mode="w"))
 
 
-@pytest.mark.parametrize(
-    ("codec_name", "codec_class"),
-    [
-        ("numcodecs.blosc", numcodecs.zarr3.Blosc),
-        ("numcodecs.lz4", numcodecs.zarr3.LZ4),
-        ("numcodecs.zstd", numcodecs.zarr3.Zstd),
-        ("numcodecs.zlib", numcodecs.zarr3.Zlib),
-        ("numcodecs.gzip", numcodecs.zarr3.GZip),
-        ("numcodecs.bz2", numcodecs.zarr3.BZ2),
-        ("numcodecs.lzma", numcodecs.zarr3.LZMA),
-        ("numcodecs.shuffle", numcodecs.zarr3.Shuffle),
-        ("numcodecs.delta", numcodecs.zarr3.Delta),
-        ("numcodecs.bitround", numcodecs.zarr3.BitRound),
-        ("numcodecs.fixedscaleoffset", numcodecs.zarr3.FixedScaleOffset),
-        ("numcodecs.quantize", numcodecs.zarr3.Quantize),
-        ("numcodecs.packbits", numcodecs.zarr3.PackBits),
-        ("numcodecs.astype", numcodecs.zarr3.AsType),
-        ("numcodecs.crc32", numcodecs.zarr3.CRC32),
-        ("numcodecs.crc32c", numcodecs.zarr3.CRC32C),
-        ("numcodecs.adler32", numcodecs.zarr3.Adler32),
-        ("numcodecs.fletcher32", numcodecs.zarr3.Fletcher32),
-        ("numcodecs.jenkins_lookup3", numcodecs.zarr3.JenkinsLookup3),
-        ("numcodecs.pcodec", numcodecs.zarr3.PCodec),
-        ("numcodecs.zfpy", numcodecs.zarr3.ZFPY),
-    ],
-)
-def test_entry_points(codec_name: str, codec_class: type[numcodecs.zarr3._NumcodecsCodec]):
-    assert codec_class.codec_name == codec_name
+ALL_CODECS = [getattr(numcodecs.zarr3, cls_name) for cls_name in numcodecs.zarr3.__all__]
+
+
+@pytest.mark.parametrize("codec_class", ALL_CODECS)
+def test_entry_points(codec_class: type[numcodecs.zarr3._NumcodecsCodec]):
+    codec_name = codec_class.codec_name
     assert get_codec_class(codec_name) == codec_class
 
 
+@pytest.mark.parametrize("codec_class", ALL_CODECS)
+def test_docstring(codec_class: type[numcodecs.zarr3._NumcodecsCodec]):
+    assert "See :class:`numcodecs." in codec_class.__doc__
+
+
 @pytest.mark.parametrize(
     "codec_class",
     [

numcodecs/zarr3.py

@@ -26,8 +26,9 @@
 
 import asyncio
 import math
+from collections.abc import Callable
 from dataclasses import dataclass, replace
-from functools import cached_property
+from functools import cached_property, partial
 from typing import Any, Self, TypeVar
 from warnings import warn
 
@@ -180,6 +181,10 @@ def _add_docstring(cls: type[T], ref_class_name: str) -> type[T]:
     return cls
 
 
+def _add_docstring_wrapper(ref_class_name: str) -> Callable[[type[T]], type[T]]:
+    return partial(_add_docstring, ref_class_name=ref_class_name)
+
+
 def _make_bytes_bytes_codec(codec_name: str, cls_name: str) -> type[_NumcodecsBytesBytesCodec]:
     # rename for class scope
     _codec_name = CODEC_PREFIX + codec_name
@@ -249,6 +254,7 @@ def compute_encoded_size(self, input_byte_length: int, chunk_spec: ArraySpec) ->
 LZMA = _add_docstring(_make_bytes_bytes_codec("lzma", "LZMA"), "numcodecs.lzma.LZMA")
 
 
+@_add_docstring_wrapper("numcodecs.shuffle.Shuffle")
 class Shuffle(_NumcodecsBytesBytesCodec):
     codec_name = f"{CODEC_PREFIX}shuffle"
 
@@ -261,15 +267,14 @@ def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self:
         return self  # pragma: no cover
 
 
-Shuffle = _add_docstring(Shuffle, "numcodecs.shuffle.Shuffle")
-
 # array-to-array codecs ("filters")
 Delta = _add_docstring(_make_array_array_codec("delta", "Delta"), "numcodecs.delta.Delta")
 BitRound = _add_docstring(
     _make_array_array_codec("bitround", "BitRound"), "numcodecs.bitround.BitRound"
 )
 
 
+@_add_docstring_wrapper("numcodecs.fixedscaleoffset.FixedScaleOffset")
 class FixedScaleOffset(_NumcodecsArrayArrayCodec):
     codec_name = f"{CODEC_PREFIX}fixedscaleoffset"
 
@@ -287,9 +292,7 @@ def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self:
         return self
 
 
-FixedScaleOffset = _add_docstring(FixedScaleOffset, "numcodecs.fixedscaleoffset.FixedScaleOffset")
-
-
+@_add_docstring_wrapper("numcodecs.quantize.Quantize")
 class Quantize(_NumcodecsArrayArrayCodec):
     codec_name = f"{CODEC_PREFIX}quantize"
 
@@ -302,9 +305,7 @@ def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self:
         return self
 
 
-_add_docstring(Quantize, "numcodecs.quantize.Quantize")
-
-
+@_add_docstring_wrapper("numcodecs.packbits.PackBits")
 class PackBits(_NumcodecsArrayArrayCodec):
     codec_name = f"{CODEC_PREFIX}packbits"
 
@@ -323,9 +324,7 @@ def validate(self, *, dtype: np.dtype[Any], **_kwargs) -> None:
             raise ValueError(f"Packbits filter requires bool dtype. Got {dtype}.")
 
 
-PackBits = _add_docstring(PackBits, "numcodecs.packbits.PackBits")
-
-
+@_add_docstring_wrapper("numcodecs.astype.AsType")
 class AsType(_NumcodecsArrayArrayCodec):
     codec_name = f"{CODEC_PREFIX}astype"
 
@@ -342,8 +341,6 @@ def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self:
         return self
 
 
-AsType = _add_docstring(AsType, "numcodecs.astype.AsType")
-
 # bytes-to-bytes checksum codecs
 CRC32 = _add_docstring(_make_checksum_codec("crc32", "CRC32"), "numcodecs.checksum32.CRC32")
 CRC32C = _add_docstring(_make_checksum_codec("crc32c", "CRC32C"), "numcodecs.checksum32.CRC32C")
@@ -358,3 +355,27 @@ def evolve_from_array_spec(self, array_spec: ArraySpec) -> Self:
 # array-to-bytes codecs
 PCodec = _add_docstring(_make_array_bytes_codec("pcodec", "PCodec"), "numcodecs.pcodec.PCodec")
 ZFPY = _add_docstring(_make_array_bytes_codec("zfpy", "ZFPY"), "numcodecs.zfpy.ZFPY")
+
+__all__ = [
+    "Blosc",
+    "LZ4",
+    "Zstd",
+    "Zlib",
+    "GZip",
+    "BZ2",
+    "LZMA",
+    "Shuffle",
+    "Delta",
+    "BitRound",
+    "FixedScaleOffset",
+    "Quantize",
+    "PackBits",
+    "AsType",
+    "CRC32",
+    "CRC32C",
+    "Adler32",
+    "Fletcher32",
+    "JenkinsLookup3",
+    "PCodec",
+    "ZFPY",
+]