wavpack-numcodecs 0.2.3__tar.gz → 0.3.0__tar.gz

{wavpack-numcodecs-0.2.3 → wavpack_numcodecs-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wavpack-numcodecs
-Version: 0.2.3
+Version: 0.3.0
 Summary: Numcodecs implementation of WavPack audio codec.
 Author-email: Alessio Buccino <alessiop.buccino@gmail.com>, David Bryant <david@wavpack.com>
 License: MIT
@@ -10,9 +10,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
-Provides-Extra: test
-Provides-Extra: test_no_cython
 License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: numcodecs
+Requires-Dist: packaging
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: zarr; extra == "test"
+Requires-Dist: Cython; extra == "test"
+Provides-Extra: test-no-cython
+Requires-Dist: pytest; extra == "test-no-cython"
+Requires-Dist: zarr; extra == "test-no-cython"
+Dynamic: license-file
 
 [![PyPI version](https://badge.fury.io/py/wavpack-numcodecs.svg)](https://badge.fury.io/py/wavpack-numcodecs) ![tests](https://github.com/AllenNeuralDynamics/wavpack-numcodecs/actions/workflows/python-package-cython.yml/badge.svg)
 
@@ -84,16 +93,24 @@ data = ... # any numpy array
 # instantiate WavPack compressor
 wv_compressor = WavPack(level=2, bps=None)
 
-z = zarr.array(data, compressor=wv_compressor)
+# v2
+group = zarr.group()
+z = group.create_dataset(name="wv_dset", data=data, compressor=wv_compressor)
+
+# v3
+zarr.config.set({"default_zarr_version": 3})
+group = zarr.group()
+z = group.create_array(name="wv_dset3", data=data, serializer=wv_compressor)
 
 data_read = z[:]
 ```
 Available `**kwargs` can be browsed with: `WavPack?`
 
-**NOTE:** 
-In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
+> **_NOTE 1:_**  In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
 installed.
 
+> **_NOTE 2:_** The Zarr v3 implementation is an `ArrayBytesCodec`. The `zarr.create_array` function only supports `ArrayArrayCodec` objects for `filters` and `BytesBytesCodecs` for `compressors`. Hence, we need to use the `WavPack` codec as a `serializer`, which is expected to be an `ArrayBytesCodec` object.
+
 # Developmers guide
 
 ## How to upgrade WavPack installation and make a new release

{wavpack-numcodecs-0.2.3 → wavpack_numcodecs-0.3.0}/README.md

@@ -68,16 +68,24 @@ data = ... # any numpy array
 # instantiate WavPack compressor
 wv_compressor = WavPack(level=2, bps=None)
 
-z = zarr.array(data, compressor=wv_compressor)
+# v2
+group = zarr.group()
+z = group.create_dataset(name="wv_dset", data=data, compressor=wv_compressor)
+
+# v3
+zarr.config.set({"default_zarr_version": 3})
+group = zarr.group()
+z = group.create_array(name="wv_dset3", data=data, serializer=wv_compressor)
 
 data_read = z[:]
 ```
 Available `**kwargs` can be browsed with: `WavPack?`
 
-**NOTE:** 
-In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
+> **_NOTE 1:_**  In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
 installed.
 
+> **_NOTE 2:_** The Zarr v3 implementation is an `ArrayBytesCodec`. The `zarr.create_array` function only supports `ArrayArrayCodec` objects for `filters` and `BytesBytesCodecs` for `compressors`. Hence, we need to use the `WavPack` codec as a `serializer`, which is expected to be an `ArrayBytesCodec` object.
+
 # Developmers guide
 
 ## How to upgrade WavPack installation and make a new release

{wavpack-numcodecs-0.2.3 → wavpack_numcodecs-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wavpack-numcodecs"
-version = "0.2.3"
+version = "0.3.0"
 description = "Numcodecs implementation of WavPack audio codec."
 authors = [
     {name = "Alessio Buccino", email = "alessiop.buccino@gmail.com"},
@@ -23,21 +23,22 @@ dependencies = [
 [project.optional-dependencies]
 test = [
     "pytest",
-    "zarr<3.0.0",
+    "zarr",
     "Cython"
 ]
 
 test_no_cython = [
     "pytest",
-    "zarr<3.0.0"
+    "zarr"
 ]
 
-
 [project.urls]
 "Homepage" = "https://github.com/AllenNeuralDynamics/wavpack-numcodecs"
 
 [project.entry-points."numcodecs.codecs"]
-wavpack = "wavpack_numcodecs:WavPack"
+wavpack = "wavpack_numcodecs.wavpack:WavPack"
+[project.entry-points."zarr.codecs"]
+wavpack = "wavpack_numcodecs.wavpackv3:WavPack"
 
 [build-system]
 requires = ["setuptools>=62.0"]

wavpack_numcodecs-0.3.0/src/wavpack_numcodecs/__init__.py

@@ -0,0 +1,36 @@
+import importlib.metadata
+import importlib.util
+import numcodecs
+from packaging.version import parse
+
+from wavpack_numcodecs.wavpack import wavpack_version
+
+
+HAVE_ZARR = importlib.util.find_spec("zarr") is not None
+
+USE_ZARR_V3 = False
+if HAVE_ZARR:
+    import zarr
+
+    if parse(zarr.__version__) >= parse("3.0.0"):
+        USE_ZARR_V3 = True
+    
+if USE_ZARR_V3:
+    from zarr.registry import register_codec
+    from wavpack_numcodecs.wavpackv3 import WavPack
+else:
+    from numcodecs import register_codec
+    from wavpack_numcodecs.wavpack import WavPack
+
+register_codec("wavpack", WavPack)
+
+from .globals import (
+    get_num_decoding_threads,
+    get_num_encoding_threads,
+    reset_num_decoding_threads,
+    reset_num_encoding_threads,
+    set_num_decoding_threads,
+    set_num_encoding_threads,
+)
+
+__version__ = importlib.metadata.version("wavpack_numcodecs")