Skip to content

Improve deprecation of zarr.creation and zarr.convenience #2609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 2, 2025
Merged

Improve deprecation of zarr.creation and zarr.convenience #2609

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b511085
Add better deprecation method for zarr.creation
dstansby Dec 31, 2024
714ad6a
Add deprecation warning to zarr creation docstring
dstansby Dec 31, 2024
9c8a087
Improve zarr.convenience deprecation
dstansby Jan 2, 2025
80d526f
Merge branch 'main' into creation-doc
dcherian Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/zarr/creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
"""
Helpers for creating arrays.

.. warning::

This sub-module is deprecated. All functions here are defined
in the top level zarr namespace instead.
"""

import warnings

from zarr.api.synchronous import (
Expand Down Expand Up @@ -31,7 +40,8 @@
]

warnings.warn(
"zarr.creation is deprecated, use zarr.api.synchronous",
"zarr.creation is deprecated. "
"Import these functions from the top level zarr. namespace instead.",
DeprecationWarning,
stacklevel=2,
)
Loading