numcodecs 0.15.0__tar.gz → 0.15.1__tar.gz

{numcodecs-0.15.0 → numcodecs-0.15.1}/.pre-commit-config.yaml

@@ -14,19 +14,19 @@ repos:
     - id: debug-statements
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.4
+    rev: v0.9.4
     hooks:
     - id: ruff
       args: ["--fix", "--show-fixes"]
     - id: ruff-format
 
   - repo: https://github.com/scientific-python/cookie
-    rev: 2024.08.19
+    rev: 2025.01.22
     hooks:
     - id: sp-repo-review
 
   -   repo: https://github.com/pre-commit/mirrors-mypy
-      rev: v1.14.0
+      rev: v1.14.1
       hooks:
       -   id: mypy
           args: [--config-file, pyproject.toml]

{numcodecs-0.15.0/numcodecs.egg-info → numcodecs-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: numcodecs
-Version: 0.15.0
+Version: 0.15.1
 Summary: A Python package providing buffer compression and transformation codecs for use in data storage and communication applications.
 Maintainer-email: Alistair Miles <alimanfoo@googlemail.com>
 License: MIT

{numcodecs-0.15.0 → numcodecs-0.15.1}/docs/release.rst

@@ -11,6 +11,22 @@ Release notes
     Unreleased
     ----------
 
+
+.. _unreleased:
+
+Unreleased
+----------
+
+Improvements
+~~~~~~~~~~~~
+* Raise a custom `UnknownCodecError` when trying to retrieve an unavailable codec.
+  By :user:`Cas Wognum <cwognum>`.
+
+Fixes
+~~~~~
+* Remove redundant ``id`` from codec metadata serialization in Zarr3 codecs.
+  By :user:`Norman Rzepka <normanrz>`, :issue:`685`
+
 .. _release_0.15.0:
 
 0.15.0

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/checksum32.py

@@ -13,7 +13,7 @@ from .jenkins import jenkins_lookup3
 
 _crc32c: Optional[ModuleType] = None
 with suppress(ImportError):
-    import crc32c as _crc32c  # type: ignore[no-redef]
+    import crc32c as _crc32c  # type: ignore[no-redef, unused-ignore]
 
 if TYPE_CHECKING:  # pragma: no cover
     from typing_extensions import Buffer

numcodecs-0.15.1/numcodecs/errors.py

@@ -0,0 +1,26 @@
+"""
+This module defines custom exceptions that are raised in the `numcodecs` codebase.
+"""
+
+
+class UnknownCodecError(ValueError):
+    """
+    An exception that is raised when trying to receive a codec that has not been registered.
+
+    Parameters
+    ----------
+    codec_id : str
+        Codec identifier.
+
+    Examples
+    ----------
+    >>> import numcodecs
+    >>> numcodecs.get_codec({"codec_id": "unknown"})
+    Traceback (most recent call last):
+        ...
+    UnknownCodecError: codec not available: 'unknown'
+    """
+
+    def __init__(self, codec_id: str):
+        self.codec_id = codec_id
+        super().__init__(f"codec not available: '{codec_id}'")

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/json.py

@@ -68,7 +68,7 @@ class JSON(Codec):
     def encode(self, buf):
         try:
             buf = np.asarray(buf)
-        except ValueError:
+        except ValueError:  # pragma: no cover
             buf = np.asarray(buf, dtype=object)
         items = np.atleast_1d(buf).tolist()
         items.append(buf.dtype.str)

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/quantize.py

@@ -65,9 +65,9 @@ class Quantize(Codec):
         precision = 10.0**-self.digits
         exp = math.log10(precision)
         if exp < 0:
-            exp = int(math.floor(exp))
+            exp = math.floor(exp)
         else:
-            exp = int(math.ceil(exp))
+            exp = math.ceil(exp)
         bits = math.ceil(math.log2(10.0**-exp))
         scale = 2.0**bits
         enc = np.around(scale * arr) / scale

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/registry.py

@@ -5,6 +5,7 @@ import logging
 from importlib.metadata import EntryPoints, entry_points
 
 from numcodecs.abc import Codec
+from numcodecs.errors import UnknownCodecError
 
 logger = logging.getLogger("numcodecs")
 codec_registry: dict[str, Codec] = {}
@@ -50,7 +51,7 @@ def get_codec(config):
         register_codec(cls, codec_id=codec_id)
     if cls:
         return cls.from_config(config)
-    raise ValueError(f'codec not available: {codec_id!r}')
+    raise UnknownCodecError(f"{codec_id!r}")
 
 
 def register_codec(cls, codec_id=None):

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/tests/test_registry.py

@@ -3,11 +3,12 @@ import inspect
 import pytest
 
 import numcodecs
+from numcodecs.errors import UnknownCodecError
 from numcodecs.registry import get_codec
 
 
 def test_registry_errors():
-    with pytest.raises(ValueError):
+    with pytest.raises(UnknownCodecError, match='foo'):
         get_codec({'id': 'foo'})
 
 

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/tests/test_zarr3.py

@@ -91,7 +91,7 @@ def test_generic_compressor(
         (numcodecs.zarr3.Delta, {"dtype": "float32"}),
         (numcodecs.zarr3.FixedScaleOffset, {"offset": 0, "scale": 25.5}),
         (numcodecs.zarr3.FixedScaleOffset, {"offset": 0, "scale": 51, "astype": "uint16"}),
-        (numcodecs.zarr3.AsType, {"encode_dtype": "float32", "decode_dtype": "float64"}),
+        (numcodecs.zarr3.AsType, {"encode_dtype": "float32", "decode_dtype": "float32"}),
     ],
     ids=[
         "delta",
@@ -225,11 +225,11 @@ def test_generic_bytes_codec(
 ):
     try:
         codec_class()._codec  # noqa: B018
-    except ValueError as e:
+    except ValueError as e:  # pragma: no cover
         if "codec not available" in str(e):
             pytest.xfail(f"{codec_class.codec_name} is not available: {e}")
         else:
-            raise  # pragma: no cover
+            raise
     except ImportError as e:  # pragma: no cover
         pytest.xfail(f"{codec_class.codec_name} is not available: {e}")
 
@@ -272,3 +272,8 @@ def test_delta_astype(store: StorePath):
 def test_repr():
     codec = numcodecs.zarr3.LZ4(level=5)
     assert repr(codec) == "LZ4(codec_name='numcodecs.lz4', codec_config={'level': 5})"
+
+
+def test_to_dict():
+    codec = numcodecs.zarr3.LZ4(level=5)
+    assert codec.to_dict() == {"name": "numcodecs.lz4", "configuration": {"level": 5}}

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.15.0'
-__version_tuple__ = version_tuple = (0, 15, 0)
+__version__ = version = '0.15.1'
+__version_tuple__ = version_tuple = (0, 15, 1)

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs/zarr3.py

@@ -112,6 +112,7 @@ class _NumcodecsCodec(Metadata):
 
     def to_dict(self) -> dict[str, JSON]:
         codec_config = self.codec_config.copy()
+        codec_config.pop("id", None)
         return {
             "name": self.codec_name,
             "configuration": codec_config,
@@ -270,7 +271,7 @@ class Shuffle(_NumcodecsBytesBytesCodec):
         super().__init__(**codec_config)
 
     def evolve_from_array_spec(self, array_spec: ArraySpec) -> Shuffle:
-        if array_spec.dtype.itemsize != self.codec_config.get("elementsize"):
+        if self.codec_config.get("elementsize", None) is None:
             return Shuffle(**{**self.codec_config, "elementsize": array_spec.dtype.itemsize})
         return self  # pragma: no cover
 
@@ -307,7 +308,7 @@ class FixedScaleOffset(_NumcodecsArrayArrayCodec):
         return chunk_spec
 
     def evolve_from_array_spec(self, array_spec: ArraySpec) -> FixedScaleOffset:
-        if str(array_spec.dtype) != self.codec_config.get("dtype"):
+        if self.codec_config.get("dtype", None) is None:
             return FixedScaleOffset(**{**self.codec_config, "dtype": str(array_spec.dtype)})
         return self
 
@@ -320,7 +321,7 @@ class Quantize(_NumcodecsArrayArrayCodec):
         super().__init__(**codec_config)
 
     def evolve_from_array_spec(self, array_spec: ArraySpec) -> Quantize:
-        if str(array_spec.dtype) != self.codec_config.get("dtype"):
+        if self.codec_config.get("dtype", None) is None:
             return Quantize(**{**self.codec_config, "dtype": str(array_spec.dtype)})
         return self
 
@@ -355,8 +356,7 @@ class AsType(_NumcodecsArrayArrayCodec):
         return replace(chunk_spec, dtype=np.dtype(self.codec_config["encode_dtype"]))  # type: ignore[arg-type]
 
     def evolve_from_array_spec(self, array_spec: ArraySpec) -> AsType:
-        decode_dtype = self.codec_config.get("decode_dtype")
-        if str(array_spec.dtype) != decode_dtype:
+        if self.codec_config.get("decode_dtype", None) is None:
             return AsType(**{**self.codec_config, "decode_dtype": str(array_spec.dtype)})
         return self
 

{numcodecs-0.15.0 → numcodecs-0.15.1/numcodecs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: numcodecs
-Version: 0.15.0
+Version: 0.15.1
 Summary: A Python package providing buffer compression and transformation codecs for use in data storage and communication applications.
 Maintainer-email: Alistair Miles <alimanfoo@googlemail.com>
 License: MIT

{numcodecs-0.15.0 → numcodecs-0.15.1}/numcodecs.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ setup.py
 ./numcodecs/checksum32.py
 ./numcodecs/compat.py
 ./numcodecs/delta.py
+./numcodecs/errors.py
 ./numcodecs/fixedscaleoffset.py
 ./numcodecs/gzip.py
 ./numcodecs/json.py
@@ -2060,6 +2061,7 @@ numcodecs/compat.py
 numcodecs/compat_ext.pxd
 numcodecs/compat_ext.pyx
 numcodecs/delta.py
+numcodecs/errors.py
 numcodecs/fixedscaleoffset.py
 numcodecs/fletcher32.pyx
 numcodecs/gzip.py

{numcodecs-0.15.0 → numcodecs-0.15.1}/pyproject.toml

@@ -219,8 +219,6 @@ ignore = [
     "Q003",
     "COM812",
     "COM819",
-    "ISC001",
-    "ISC002",
 ]
 
 [tool.ruff.lint.extend-per-file-ignores]
@@ -237,3 +235,6 @@ enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 # TODO: set options below to true
 strict = false
 warn_unreachable = false
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_unused_configs = true