Deprecate v3 code in v2 branch

Author: dstansby

docs/release.rst

@@ -23,6 +23,10 @@ Unreleased
 Deprecations
 ~~~~~~~~~~~~
 
+* Deprecated ``zarr._storage.v3`` and ``zarr._storage.v3_storage_transformers``.
+  This functionality and will be removed in ``zarr-python`` 2.19.0.
+  For Zarr format 3 support, use the v3 release of ``zarr-python``.
+  By :user:`David Stansby <dstansby>`
 * Deprecated support for ``partial_decompress`` when creating an array.
   This functionality is no longer supported in ``numcodecs``, and will be removed
   in ``zarr-python`` 2.19.0.

zarr/_storage/v3.py

@@ -1,3 +1,6 @@
+import warnings
+
+
 import os
 import shutil
 from collections import OrderedDict
@@ -49,6 +52,14 @@
     _getsize,
 )
 
+warnings.warn(
+    "zarr._storage.v3 is deprecated, and will be removed in zarr-python 2.19.0. "
+    "Use zarr-python 3 instead for Zarr format 3 support.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+
 __doctest_requires__ = {
     ("RedisStore", "RedisStore.*"): ["redis"],
     ("MongoDBStore", "MongoDBStore.*"): ["pymongo"],

zarr/_storage/v3_storage_transformers.py

@@ -2,6 +2,7 @@
 import itertools
 import os
 from typing import NamedTuple, Tuple, Optional, Union, Iterator
+import warnings
 
 from numcodecs.compat import ensure_bytes
 import numpy as np
@@ -11,6 +12,14 @@
 from zarr.types import DIMENSION_SEPARATOR
 
 
+warnings.warn(
+    "zarr._storage.v3 is deprecated, and will be removed in zarr-python 2.19.0. "
+    "Use zarr-python 3 instead for Zarr format 3 support.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+
 MAX_UINT_64 = 2**64 - 1
 
 

zarr/tests/test_storage_v3.py

@@ -67,7 +67,10 @@
 from .test_storage import dimension_separator_fixture, s3, skip_if_nested_chunks  # noqa
 
 
-pytestmark = pytest.mark.skipif(not v3_api_available, reason="v3 api is not available")
+pytestmark = [
+    pytest.mark.skipif(not v3_api_available, reason="v3 api is not available"),
+    pytest.mark.filterwarnings("ignore:zarr.*v3 is deprecated:DeprecationWarning"),
+]
 
 
 @pytest.fixture(