numcodecs-combinators 0.2.0__tar.gz → 0.2.2__tar.gz

numcodecs_combinators-0.2.2/.python-version

@@ -0,0 +1 @@
+3.10

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/.readthedocs.yaml

@@ -12,4 +12,6 @@ python:
    install:
    - method: pip
      path: .
+     extra_requirements:
+      - xarray
    - requirements: docs/requirements.txt

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numcodecs-combinators
-Version: 0.2.0
+Version: 0.2.2
 Summary: Combinator codecs for the `numcodecs` buffer compression API
 License: Copyright (c) 2024, Juniper Tyree
         
@@ -378,9 +378,13 @@ License: Copyright (c) 2024, Juniper Tyree
           This Source Code Form is "Incompatible With Secondary Licenses", as
           defined by the Mozilla Public License, v. 2.0.
 License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: numcodecs~=0.13
-Requires-Dist: numpy~=2.2
+Requires-Python: >=3.10
+Requires-Dist: numcodecs<0.15,>=0.13.0
+Requires-Dist: numpy~=2.0
+Requires-Dist: typing-extensions~=4.6
+Provides-Extra: xarray
+Requires-Dist: dask>=2024.6; extra == 'xarray'
+Requires-Dist: xarray>=2024.06; extra == 'xarray'
 Description-Content-Type: text/markdown
 
 [![image](https://img.shields.io/github/actions/workflow/status/juntyr/numcodecs-combinators/ci.yml?branch=main)](https://github.com/juntyr/numcodecs-combinators/actions/workflows/ci.yml?query=branch%3Amain)

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/mkdocs.yml

@@ -54,4 +54,5 @@ plugins:
                   modules: true
           inventories:
             - https://docs.python.org/3.12/objects.inv
-            - https://numcodecs.readthedocs.io/en/v0.13.0/objects.inv
+            - https://numcodecs.readthedocs.io/en/v0.15.0/objects.inv
+            - https://docs.xarray.dev/en/v2025.01.0/objects.inv

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/pyproject.toml

@@ -4,12 +4,17 @@ build-backend = "hatchling.build"
 
 [project]
 name = "numcodecs-combinators"
-version = "0.2.0"
+version = "0.2.2"
 description = "Combinator codecs for the `numcodecs` buffer compression API"
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.12"
-dependencies = ["numcodecs~=0.13", "numpy~=2.2"]
+requires-python = ">=3.10"
+dependencies = [
+    "numcodecs>=0.13.0,<0.15",
+    "numpy~=2.0",
+    "typing-extensions~=4.6",
+]
+optional-dependencies.xarray = [ "xarray>=2024.06", "dask>=2024.6" ]
 
 [dependency-groups]
 dev = ["mypy~=1.14", "pytest~=8.3"]

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/src/numcodecs_combinators/stack.py

@@ -4,14 +4,19 @@ This module defines the [`CodecStack`][numcodecs_combinators.stack.CodecStack] c
 
 __all__ = ["CodecStack"]
 
-from collections.abc import Buffer
-from typing import Optional, Self, Callable
+from typing import Optional, Callable
+from typing_extensions import Buffer, Self  # MSPV 3.12
 
 import numcodecs
 import numcodecs.compat
 import numcodecs.registry
 import numpy as np
 
+try:
+    import xarray as xr
+except ImportError:
+    pass
+
 from numcodecs.abc import Codec
 
 from .abc import CodecCombinatorMixin
@@ -52,7 +57,7 @@ class CodecStack(Codec, CodecCombinatorMixin, tuple[Codec]):
 
     __slots__ = ()
 
-    codec_id = "combinators.stack"
+    codec_id: str = "combinators.stack"  # type: ignore
 
     def __init__(self, *args: tuple[(dict | Codec), ...]):
         pass
@@ -151,8 +156,50 @@ class CodecStack(Codec, CodecCombinatorMixin, tuple[Codec]):
             out = np.empty(shape=shape, dtype=dtype)
             decoded = codec.decode(decoded, out).reshape(shape)
 
+        if isinstance(decoded, type(buf)):
+            return decoded
+
         return type(buf)(decoded)  # type: ignore
 
+    def encode_decode_data_array(self, da: "xr.DataArray") -> "xr.DataArray":
+        """
+        Encode, then decode the data array in `da`.
+
+        The encode-decode computation may be deferred until the
+        [`compute`][xarray.DataArray.compute] method is called on the result.
+
+        This method requires the optional [`xarray`][xarray] dependency to be
+        installed.
+
+        Parameters
+        ----------
+        da : xr.DataArray
+            Data to be encoded.
+
+        Returns
+        -------
+        dec : xr.DataArray
+            Decoded data.
+        """
+
+        import xarray as xr
+
+        def encode_decode_data_array_single_chunk(
+            da: xr.DataArray,
+        ) -> xr.DataArray:
+            single_chunk = {dim: -1 for dim in da.dims}
+
+            # return early for zero-sized arrays
+            if da.size == 0:
+                return da.copy(deep=False).chunk(single_chunk)
+
+            # eagerly compute the input chunk and encode and decode it
+            decoded = self.encode_decode(da.values)  # type: ignore
+
+            return da.copy(deep=False, data=decoded).chunk(single_chunk)
+
+        return xr.map_blocks(encode_decode_data_array_single_chunk, da)
+
     def get_config(self) -> dict:
         """
         Returns the configuration of the codec stack.

{numcodecs_combinators-0.2.0 → numcodecs_combinators-0.2.2}/tests/test_stack.py

@@ -1,5 +1,6 @@
 import numcodecs
 import numpy as np
+import xarray as xr
 
 import numcodecs_combinators
 from numcodecs_combinators.stack import CodecStack
@@ -41,6 +42,14 @@ def test_encode_decode():
     encoded_decoded = stack.encode_decode(b"abc")
     assert encoded_decoded == b"abc"
 
+    encoded_decoded = stack.encode_decode_data_array(xr.DataArray([1.0, 2.0, 3.0]))
+    assert encoded_decoded.equals(xr.DataArray([1.0, 2.0, 3.0]))
+
+    encoded_decoded = stack.encode_decode_data_array(
+        xr.DataArray([1.0, 2.0, 3.0]).chunk(1)
+    )
+    assert encoded_decoded.equals(xr.DataArray([1.0, 2.0, 3.0]))
+
 
 def test_map():
     stack = CodecStack(numcodecs.Zlib(level=9), numcodecs.CRC32())

numcodecs_combinators-0.2.0/.python-version

@@ -1 +0,0 @@
-3.12