Remove deprecated API

Author: dstansby

changes/3325.removal.rst

@@ -0,0 +1,30 @@
+The deprecated ``zarr.convenience`` sub-module has been removed.
+All functions are available in the top-level `zarr` namespace.
+
+The following deprecated methods have been removed:
+
+- ``AsyncArray.create`` - use `zarr.api.asynchronous.create_array` instead.
+- ``Array.create`` - use `zarr.create_array` instead.
+
+The ``codecs`` argument on the removed methods corresponds to a combination of the ``compressors`` and ``serializer`` arguments on their replacements,
+and the ``chunk_shape`` argument on the removed methods corresponds to the ``chunks`` argument on their replacements.
+
+The following deprecated properties have been removed:
+
+- ``AsyncArray.compressor`` - use ``AsyncArray.compressors[0]`` instead for Zarr format 2 arrays.
+- ``Array.compressor`` - use ``Array.compressors[0]`` instead for Zarr format 2 arrays.
+- ``AsyncGroup.create_dataset`` - use `AsyncGroup.create_array` instead
+- ``AsyncGroup.require_dataset`` - use `AsyncGroup.require_array` instead
+- ``Group.create_dataset`` - use `Group.create_array` instead
+- ``Group.require_dataset`` - use `Group.require_array` instead
+- ``Group.array`` - use `Group.create_array` instead
+
+The following deprecated functions have been removed:
+
+- ``zarr.api.asynchronous.tree`` - use `AsyncGroup.tree` instead
+- ``zarr.api.synchronous.tree`` - use `Group.tree` instead
+- ``zarr.tree`` - use `Group.tree` instead
+
+
+Setting ``zarr.storage.default_compressor`` is deprecated, use `zarr.config` to configure ``array.v2_default_compressor``
+e.g. ``zarr.config.set({'codecs.zstd':'numcodecs.Zstd', 'array.v2_default_compressor.numeric': 'zstd'})``

src/zarr/__init__.py

@@ -30,7 +30,6 @@
     save,
     save_array,
     save_group,
-    tree,
     zeros,
     zeros_like,
 )
@@ -177,7 +176,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 (
@@ -89,7 +88,6 @@
     "save",
     "save_array",
     "save_group",
-    "tree",
     "zeros",
     "zeros_like",
 ]
@@ -564,31 +562,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 | Array, **kwargs: Any
 ) -> AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata]:

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
@@ -67,7 +64,6 @@
     "save",
     "save_array",
     "save_group",
-    "tree",
     "zeros",
     "zeros_like",
 ]
@@ -349,31 +345,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 | Array, **kwargs: Any) -> Array:
     """Create an array filled with `data`.