chore!: remove zarr.tree and the Array.compressor properties

changes/4521.removal.md

@@ -0,0 +1,4 @@
+The following have been removed, having been deprecated since Zarr-Python 3.0.0:
+
+- `zarr.tree`, `zarr.api.synchronous.tree` and `zarr.api.asynchronous.tree`. Use `Group.tree` / `AsyncGroup.tree` instead.
+- The `Array.compressor` and `AsyncArray.compressor` properties. Use `Array.compressors` instead (for Zarr format 2 arrays, `compressors[0]` is the old `compressor`, and an empty tuple means no compressor).

src/zarr/__init__.py

@@ -30,7 +30,6 @@
     save,
     save_array,
     save_group,
-    tree,
     zeros,
     zeros_like,
 )
@@ -179,7 +178,6 @@ def set_format(log_format: str) -> None:
     "save",
     "save_array",
     "save_group",
-    "tree",
     "zeros",
     "zeros_like",
 ]

src/zarr/api/asynchronous.py

@@ -7,7 +7,6 @@
 
 import numpy as np
 import numpy.typing as npt
-from typing_extensions import deprecated
 
 from zarr.abc.store import Store
 from zarr.core.array import (
@@ -43,7 +42,6 @@
     ArrayNotFoundError,
     GroupNotFoundError,
     NodeTypeValidationError,
-    ZarrDeprecationWarning,
     ZarrRuntimeWarning,
     ZarrUserWarning,
 )
@@ -91,7 +89,6 @@
     "save",
     "save_array",
     "save_group",
-    "tree",
     "zeros",
     "zeros_like",
 ]
@@ -615,31 +612,6 @@ async def save_group(
     await asyncio.gather(*aws)
 
 
-@deprecated("Use AsyncGroup.tree instead.", category=ZarrDeprecationWarning)
-async def tree(grp: AsyncGroup, expand: bool | None = None, level: int | None = None) -> Any:
-    """Provide a rich display of the hierarchy.
-
-    !!! warning "Deprecated"
-        `zarr.tree()` is deprecated since v3.0.0 and will be removed in a future release.
-        Use `group.tree()` instead.
-
-    Parameters
-    ----------
-    grp : Group
-        Zarr or h5py group.
-    expand : bool, optional
-        Only relevant for HTML representation. If True, tree will be fully expanded.
-    level : int, optional
-        Maximum depth to descend into hierarchy.
-
-    Returns
-    -------
-    TreeRepr
-        A pretty-printable object displaying the hierarchy.
-    """
-    return await grp.tree(expand=expand, level=level)
-
-
 async def array(data: npt.ArrayLike | AnyArray, **kwargs: Any) -> AnyAsyncArray:
     """Create an array filled with `data`.
 

src/zarr/api/synchronous.py

@@ -2,15 +2,12 @@
 
 from typing import TYPE_CHECKING, Any, Literal
 
-from typing_extensions import deprecated
-
 import zarr.api.asynchronous as async_api
 import zarr.core.array
 from zarr.core.array import DEFAULT_FILL_VALUE, Array, AsyncArray, CompressorLike
 from zarr.core.group import Group
 from zarr.core.sync import sync
 from zarr.core.sync_group import create_hierarchy
-from zarr.errors import ZarrDeprecationWarning
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -69,7 +66,6 @@
     "save",
     "save_array",
     "save_group",
-    "tree",
     "zeros",
     "zeros_like",
 ]
@@ -382,31 +378,6 @@ def save_group(
     )
 
 
-@deprecated("Use Group.tree instead.", category=ZarrDeprecationWarning)
-def tree(grp: Group, expand: bool | None = None, level: int | None = None) -> Any:
-    """Provide a rich display of the hierarchy.
-
-    !!! warning "Deprecated"
-        `zarr.tree()` is deprecated since v3.0.0 and will be removed in a future release.
-        Use `group.tree()` instead.
-
-    Parameters
-    ----------
-    grp : Group
-        Zarr or h5py group.
-    expand : bool, optional
-        Only relevant for HTML representation. If True, tree will be fully expanded.
-    level : int, optional
-        Maximum depth to descend into hierarchy.
-
-    Returns
-    -------
-    TreeRepr
-        A pretty-printable object displaying the hierarchy.
-    """
-    return sync(async_api.tree(grp._async_group, expand=expand, level=level))
-
-
 # TODO: add type annotations for kwargs
 def array(data: npt.ArrayLike | AnyArray, **kwargs: Any) -> AnyArray:
     """Create an array filled with `data`.

src/zarr/core/array.py

@@ -1004,20 +1004,6 @@ def serializer(self) -> ArrayBytesCodec | None:
             codec for codec in self.metadata.inner_codecs if isinstance(codec, ArrayBytesCodec)
         )
 
-    @property
-    @deprecated("Use AsyncArray.compressors instead.", category=ZarrDeprecationWarning)
-    def compressor(self) -> Numcodec | None:
-        """
-        Compressor that is applied to each chunk of the array.
-
-        !!! warning "Deprecated"
-            `Array.compressor` is deprecated since v3.0.0 and will be removed in a future release.
-            Use [`Array.compressors`][zarr.AsyncArray.compressors] instead.
-        """
-        if self.metadata.zarr_format == 2:
-            return self.metadata.compressor
-        raise TypeError("`compressor` is not available for Zarr format 3 arrays.")
-
     @property
     def compressors(self) -> tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...]:
         """
@@ -2297,18 +2283,6 @@ def serializer(self) -> ArrayBytesCodec | None:
         """
         return self.async_array.serializer
 
-    @property
-    @deprecated("Use Array.compressors instead.", category=ZarrDeprecationWarning)
-    def compressor(self) -> Numcodec | None:
-        """
-        Compressor that is applied to each chunk of the array.
-
-        !!! warning "Deprecated"
-            `array.compressor` is deprecated since v3.0.0 and will be removed in a future release.
-            Use [`array.compressors`][zarr.Array.compressors] instead.
-        """
-        return self.async_array.compressor
-
     @property
     def compressors(self) -> tuple[Numcodec, ...] | tuple[BytesBytesCodec, ...]:
         """

tests/test_api.py

@@ -51,7 +51,6 @@
     ArrayNotFoundError,
     ContainsArrayError,
     MetadataValidationError,
-    ZarrDeprecationWarning,
     ZarrUserWarning,
 )
 from zarr.storage import MemoryStore
@@ -1068,18 +1067,6 @@ def test_load_local(tmp_path: Path, path: str | None, load_read_only: bool) -> N
         assert np.array_equal(result, data)
 
 
-def test_tree() -> None:
-    g1 = zarr.group()
-    g1.create_group("foo")
-    g3 = g1.create_group("bar")
-    g3.create_group("baz")
-    g5 = g3.create_group("qux")
-    g5.create_array("baz", shape=(100,), chunks=(10,), dtype="float64")
-    with pytest.warns(ZarrDeprecationWarning, match=r"Group\.tree instead\."):  # noqa: PT031
-        assert repr(zarr.tree(g1)) == repr(g1.tree())
-        assert str(zarr.tree(g1)) == str(g1.tree())
-
-
 # @pytest.mark.parametrize("stores_from_path", [False, True])
 # @pytest.mark.parametrize(
 #     "with_chunk_store,listable",

tests/test_v2.py

@@ -144,13 +144,13 @@ def test_create_array_defaults(store: Store) -> None:
     g = zarr.open(store, mode="w", zarr_format=2)
     assert isinstance(g, Group)
     arr = g.create_array("one", dtype="i8", shape=(1,), chunks=(1,), compressor=None)
-    assert arr.async_array.compressor is None
+    assert arr.compressors == ()
     assert not (arr.filters)
     arr = g.create_array("two", dtype="i8", shape=(1,), chunks=(1,))
-    assert arr.async_array.compressor is not None
+    assert arr.compressors != ()
     assert not (arr.filters)
     arr = g.create_array("three", dtype="i8", shape=(1,), chunks=(1,), compressor=Zstd())
-    assert arr.async_array.compressor is not None
+    assert arr.compressors != ()
     assert not (arr.filters)
     with pytest.raises(ValueError):
         g.create_array(