diff --git a/changes/3900.misc.md b/changes/3900.misc.md new file mode 100644 index 0000000000..d38de0ce2e --- /dev/null +++ b/changes/3900.misc.md @@ -0,0 +1 @@ +Remove deprecated `zarr.convenience` and `zarr.creation` modules. \ No newline at end of file diff --git a/docs/api/zarr/convenience.md b/docs/api/zarr/convenience.md deleted file mode 100644 index f2614e3724..0000000000 --- a/docs/api/zarr/convenience.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: convenience ---- - -::: zarr.consolidate_metadata -::: zarr.copy -::: zarr.copy_all -::: zarr.copy_store -::: zarr.print_debug_info -::: zarr.tree diff --git a/docs/api/zarr/deprecated/convenience.md b/docs/api/zarr/deprecated/convenience.md deleted file mode 100644 index 91bcb15f71..0000000000 --- a/docs/api/zarr/deprecated/convenience.md +++ /dev/null @@ -1 +0,0 @@ -::: zarr.convenience \ No newline at end of file diff --git a/docs/api/zarr/deprecated/creation.md b/docs/api/zarr/deprecated/creation.md deleted file mode 100644 index 5d18a06a4a..0000000000 --- a/docs/api/zarr/deprecated/creation.md +++ /dev/null @@ -1 +0,0 @@ -::: zarr.creation diff --git a/docs/api/zarr/index.md b/docs/api/zarr/index.md index f6ae2bda83..194edb7913 100644 --- a/docs/api/zarr/index.md +++ b/docs/api/zarr/index.md @@ -21,7 +21,6 @@ Complete reference documentation for the Zarr-Python API. - **[Load](load.md)** - Loading data from Zarr stores - **[Save](save.md)** - Saving data to Zarr format -- **[Convenience](convenience.md)** - High-level convenience functions ### Data Types and Configuration @@ -55,13 +54,6 @@ The ABC module defines interfaces for extending Zarr: - **[Testing](testing/index.md)** - Utilities for testing Zarr-based code -## Migration and Compatibility - -- **[Deprecated Functions](deprecated/convenience.md)** - Legacy convenience functions -- **[Deprecated Creation](deprecated/creation.md)** - Legacy array creation functions - -These deprecated modules are maintained for backward compatibility but should be avoided in new code. - ## Getting Help - Check the [User Guide](../../user-guide/index.md) for tutorials and examples diff --git a/mkdocs.yml b/mkdocs.yml index ce39fd0f2e..7a4bfa35ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,7 +43,6 @@ nav: - api/zarr/codecs.md - api/zarr/codecs/numcodecs.md - api/zarr/config.md - - api/zarr/convenience.md - api/zarr/errors.md - api/zarr/metadata.md - api/zarr/registry.md @@ -72,9 +71,6 @@ nav: - api/zarr/testing/store.md - api/zarr/testing/strategies.md - api/zarr/testing/utils.md - - deprecated: - - Convenience sub-module: api/zarr/deprecated/convenience.md - - Creation sub-module: api/zarr/deprecated/creation.md - release-notes.md - contributing.md watch: @@ -221,7 +217,6 @@ plugins: 'developers/contributing.html.md': 'contributing.md' 'developers/index.html.md': 'contributing.md' 'developers/roadmap.html.md': 'https://zarr.readthedocs.io/en/v3.0.8/developers/roadmap.html' - 'api/zarr/creation.md': 'api/zarr/deprecated/creation.md' 'api.md': 'api/zarr/index.md' 'api/zarr/metadata/migrate_v3.md': 'api/zarr/metadata.md' diff --git a/src/zarr/api/asynchronous.py b/src/zarr/api/asynchronous.py index c776176665..60c0e6c97a 100644 --- a/src/zarr/api/asynchronous.py +++ b/src/zarr/api/asynchronous.py @@ -359,8 +359,8 @@ async def open( If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs - Additional parameters are passed through to [`zarr.creation.open_array`][] or - [`open_group`][zarr.api.asynchronous.open_group]. + Additional parameters are passed through to `zarr.open_array` or + `zarr.open_group`. Returns ------- diff --git a/src/zarr/api/synchronous.py b/src/zarr/api/synchronous.py index a865f97646..688f2a110d 100644 --- a/src/zarr/api/synchronous.py +++ b/src/zarr/api/synchronous.py @@ -206,8 +206,8 @@ def open( If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise. **kwargs - Additional parameters are passed through to [`zarr.creation.open_array`][] or - [`open_group`][zarr.api.asynchronous.open_group]. + Additional parameters are passed through to `zarr.open_array` or + `zarr.open_group`. Returns ------- diff --git a/src/zarr/convenience.py b/src/zarr/convenience.py deleted file mode 100644 index 391ffc5186..0000000000 --- a/src/zarr/convenience.py +++ /dev/null @@ -1,44 +0,0 @@ -""" -Convenience helpers. - -!!! warning "Deprecated" - This sub-module is deprecated. All functions here are defined in the top level zarr namespace instead. -""" - -import warnings - -from zarr.api.synchronous import ( - consolidate_metadata, - copy, - copy_all, - copy_store, - load, - open, - open_consolidated, - save, - save_array, - save_group, - tree, -) -from zarr.errors import ZarrDeprecationWarning - -__all__ = [ - "consolidate_metadata", - "copy", - "copy_all", - "copy_store", - "load", - "open", - "open_consolidated", - "save", - "save_array", - "save_group", - "tree", -] - -warnings.warn( - "zarr.convenience is deprecated. " - "Import these functions from the top level zarr. namespace instead.", - ZarrDeprecationWarning, - stacklevel=2, -) diff --git a/src/zarr/creation.py b/src/zarr/creation.py deleted file mode 100644 index 605b5af5de..0000000000 --- a/src/zarr/creation.py +++ /dev/null @@ -1,47 +0,0 @@ -""" -Helpers for creating arrays. - -!!! warning "Deprecated" - This sub-module is deprecated. All functions here are defined in the top level zarr namespace instead. - -""" - -import warnings - -from zarr.api.synchronous import ( - array, - create, - empty, - empty_like, - full, - full_like, - ones, - ones_like, - open_array, - open_like, - zeros, - zeros_like, -) -from zarr.errors import ZarrDeprecationWarning - -__all__ = [ - "array", - "create", - "empty", - "empty_like", - "full", - "full_like", - "ones", - "ones_like", - "open_array", - "open_like", - "zeros", - "zeros_like", -] - -warnings.warn( - "zarr.creation is deprecated. " - "Import these functions from the top level zarr. namespace instead.", - ZarrDeprecationWarning, - stacklevel=2, -)