Merge branch 'main' into clean-create

Author: dstansby

docs/conf.py

@@ -105,7 +105,8 @@ def skip_submodules(
      "roadmap": "developers/roadmap.html",
      "installation": "user-guide/installation.html",
      "api": "api/zarr/index",
-     "release": "release-notes"
+     "release": "release-notes.html",
+     "release-notes": "release-notes.html"
 }
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/developers/contributing.rst

@@ -251,14 +251,11 @@ See the `towncrier`_ docs for more.
 
 .. _towncrier: https://towncrier.readthedocs.io/en/stable/tutorial.html
 
-Development best practices, policies and procedures
----------------------------------------------------
-
 The following information is mainly for core developers, but may also be of interest to
 contributors.
 
 Merging pull requests
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
 
 Pull requests submitted by an external contributor should be reviewed and approved by at least
 one core developer before being merged. Ideally, pull requests submitted by a core developer
@@ -268,10 +265,10 @@ Pull requests should not be merged until all CI checks have passed (GitHub Actio
 Codecov) against code that has had the latest main merged in.
 
 Compatibility and versioning policies
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------
 
 Versioning
-""""""""""
+~~~~~~~~~~
 Versions of this library are identified by a triplet of integers with the form
 ``<major>.<minor>.<patch>``, for example ``3.0.4``. A release of ``zarr-python`` is associated with a new
 version identifier. That new identifier is generated by incrementing exactly one of the components of
@@ -323,7 +320,7 @@ backwards-compatible changes wherever possible. When a backwards-incompatible ch
 users should be notified well in advance, e.g. via informative deprecation warnings.
 
 Data format compatibility
-^^^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""""
 
 The Zarr library is an implementation of a file format standard defined externally --
 see the `Zarr specifications website <https://zarr-specs.readthedocs.io>`_ for the list of
@@ -340,36 +337,28 @@ breaking changes may be more frequent than usual.
 
 
 Release procedure
-~~~~~~~~~~~~~~~~~
-
-.. note::
-
-   Most of the release process is now handled by GitHub workflow which should
-   automatically push a release to PyPI if a tag is pushed.
+-----------------
 
 Pre-release
-"""""""""""
+~~~~~~~~~~~
 1. Make sure that all pull requests which will be included in the release
-   have been properly documented as changelog files in :file:`changes`.
-2. Run ``towncrier build --version x.y.z`` to create the changelog.
+   have been properly documented as changelog files in the :file:`changes/` directory.
+2. Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result
+   to the main branch.
 
 Releasing
-"""""""""
-To make a new release, go to
-https://github.com/zarr-developers/zarr-python/releases and
-click "Draft a new release". Choose a version number prefixed
-with a `v` (e.g. `v0.0.0`). For pre-releases, include the
-appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
-
-
-Set the description of the release to::
+~~~~~~~~~
+1. Go to https://github.com/zarr-developers/zarr-python/releases
+2. Click "Draft a new release".
+3. Choose a version number prefixed with a `v` (e.g. `v0.0.0`).
+   For pre-releases, include the appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
+4. Set the description of the release to::
 
     See release notes https://zarr.readthedocs.io/en/stable/release-notes.html#release-0-0-0
 
-replacing the correct version numbers. For pre-release versions,
-the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
-
-Click on "Generate release notes" to auto-file the description.
+   replacing the correct version numbers. For pre-release versions,
+   the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
+5. Click on "Generate release notes" to auto-fill the description.
 
 After creating the release, the documentation will be built on
 https://readthedocs.io. Full releases will be available under
@@ -378,9 +367,8 @@ pre-releases will be available under
 `/latest <https://zarr.readthedocs.io/en/latest>`_.
 
 Post-release
-""""""""""""
+~~~~~~~~~~~~
 
 - Review and merge the pull request on the
   `conda-forge feedstock <https://github.com/conda-forge/zarr-feedstock>`_ that will be
   automatically generated.
-- Create a new "Unreleased" section in the release notes

pyproject.toml

@@ -112,7 +112,7 @@ docs = [
 
 [project.urls]
 "Bug Tracker" = "https://github.com/zarr-developers/zarr-python/issues"
-Changelog = "https://zarr.readthedocs.io/en/stable/release.html"
+Changelog = "https://zarr.readthedocs.io/en/stable/release-notes.html"
 Discussions = "https://github.com/zarr-developers/zarr-python/discussions"
 Documentation = "https://zarr.readthedocs.io/"
 Homepage = "https://github.com/zarr-developers/zarr-python"

src/zarr/core/sync.py

@@ -6,7 +6,7 @@
 import os
 import threading
 from concurrent.futures import ThreadPoolExecutor, wait
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
 from typing_extensions import ParamSpec
 

src/zarr/storage/_obstore.py

@@ -4,8 +4,7 @@
 import contextlib
 import pickle
 from collections import defaultdict
-from collections.abc import Iterable
-from typing import TYPE_CHECKING, Any, TypedDict
+from typing import TYPE_CHECKING, TypedDict
 
 from zarr.abc.store import (
     ByteRequest,
@@ -14,7 +13,6 @@
     Store,
     SuffixByteRequest,
 )
-from zarr.core.buffer.core import BufferPrototype
 from zarr.core.config import config
 
 if TYPE_CHECKING:

tests/test_group.py

@@ -1519,7 +1519,6 @@ def test_create_nodes_concurrency_limit(store: MemoryStore) -> None:
     # if create_nodes is sensitive to IO latency,
     # this should take (num_groups * get_latency) seconds
     # otherwise, it should take only marginally more than get_latency seconds
-
     with zarr_config.set({"async.concurrency": 1}):
         start = time.time()
         _ = tuple(sync_group.create_nodes(store=latency_store, nodes=groups))
@@ -2024,9 +2023,7 @@ def test_group_members_concurrency_limit(store: MemoryStore) -> None:
     # if .members is sensitive to IO latency,
     # this should take (num_groups * get_latency) seconds
     # otherwise, it should take only marginally more than get_latency seconds
-    from zarr.core.config import config
-
-    with config.set({"async.concurrency": 1}):
+    with zarr_config.set({"async.concurrency": 1}):
         start = time.time()
         _ = group_read.members()
         elapsed = time.time() - start

tests/test_store/test_core.py

@@ -18,6 +18,26 @@
 )
 
 
+@pytest.fixture(
+    params=["none", "temp_dir_str", "temp_dir_path", "store_path", "memory_store", "dict"]
+)
+def store_like(request):
+    if request.param == "none":
+        yield None
+    elif request.param == "temp_dir_str":
+        with tempfile.TemporaryDirectory() as temp_dir:
+            yield temp_dir
+    elif request.param == "temp_dir_path":
+        with tempfile.TemporaryDirectory() as temp_dir:
+            yield Path(temp_dir)
+    elif request.param == "store_path":
+        yield StorePath(store=MemoryStore(store_dict={}), path="/")
+    elif request.param == "memory_store":
+        yield MemoryStore(store_dict={})
+    elif request.param == "dict":
+        yield {}
+
+
 @pytest.mark.parametrize("path", ["foo", "foo/bar"])
 @pytest.mark.parametrize("write_group", [True, False])
 @pytest.mark.parametrize("zarr_format", [2, 3])
@@ -134,17 +154,6 @@ async def test_make_store_path_fsspec(monkeypatch) -> None:
     assert isinstance(store_path.store, FsspecStore)
 
 
-@pytest.mark.parametrize(
-    "store_like",
-    [
-        None,
-        tempfile.TemporaryDirectory().name,
-        Path(tempfile.TemporaryDirectory().name),
-        StorePath(store=MemoryStore(store_dict={}), path="/"),
-        MemoryStore(store_dict={}),
-        {},
-    ],
-)
 async def test_make_store_path_storage_options_raises(store_like: StoreLike) -> None:
     with pytest.raises(TypeError, match="storage_options"):
         await make_store_path(store_like, storage_options={"foo": "bar"})