chore: make_store_path is private

Author: jhamman

src/zarr/api/asynchronous.py

@@ -27,16 +27,14 @@
 from zarr.core.metadata import ArrayMetadataDict, ArrayV2Metadata, ArrayV3Metadata
 from zarr.core.metadata.v2 import _default_filters_and_compressor
 from zarr.errors import NodeTypeValidationError
-from zarr.storage import (
-    StoreLike,
-    make_store_path,
-)
+from zarr.storage._common import _make_store_path
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
 
     from zarr.abc.codec import Codec
     from zarr.core.chunk_key_encodings import ChunkKeyEncoding
+    from zarr.storage import StoreLike
 
     # TODO: this type could use some more thought
     ArrayLike = AsyncArray[ArrayV2Metadata] | AsyncArray[ArrayV3Metadata] | Array | npt.NDArray[Any]
@@ -186,7 +184,7 @@ async def consolidate_metadata(
         The group, with the ``consolidated_metadata`` field set to include
         the metadata of each child node.
     """
-    store_path = await make_store_path(store, path=path)
+    store_path = await _make_store_path(store, path=path)
 
     group = await AsyncGroup.open(store_path, zarr_format=zarr_format, use_consolidated=False)
     group.store_path.store._check_writable()
@@ -313,7 +311,9 @@ async def open(
     """
     zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
 
-    store_path = await make_store_path(store, mode=mode, path=path, storage_options=storage_options)
+    store_path = await _make_store_path(
+        store, mode=mode, path=path, storage_options=storage_options
+    )
 
     # TODO: the mode check below seems wrong!
     if "shape" not in kwargs and mode in {"a", "r", "r+"}:
@@ -423,7 +423,9 @@ async def save_array(
         raise TypeError("arr argument must be numpy or other NDArrayLike array")
 
     mode = kwargs.pop("mode", "a")
-    store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options)
+    store_path = await _make_store_path(
+        store, path=path, mode=mode, storage_options=storage_options
+    )
     if np.isscalar(arr):
         arr = np.array(arr)
     shape = arr.shape
@@ -470,7 +472,7 @@ async def save_group(
         NumPy arrays with data to save.
     """
 
-    store_path = await make_store_path(store, path=path, mode="w", storage_options=storage_options)
+    store_path = await _make_store_path(store, path=path, mode="w", storage_options=storage_options)
 
     zarr_format = (
         _handle_zarr_version_or_format(
@@ -640,7 +642,9 @@ async def group(
         mode = "w"
     else:
         mode = "r+"
-    store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options)
+    store_path = await _make_store_path(
+        store, path=path, mode=mode, storage_options=storage_options
+    )
 
     if chunk_store is not None:
         warnings.warn("chunk_store is not yet implemented", RuntimeWarning, stacklevel=2)
@@ -754,7 +758,9 @@ async def open_group(
     if chunk_store is not None:
         warnings.warn("chunk_store is not yet implemented", RuntimeWarning, stacklevel=2)
 
-    store_path = await make_store_path(store, mode=mode, storage_options=storage_options, path=path)
+    store_path = await _make_store_path(
+        store, mode=mode, storage_options=storage_options, path=path
+    )
 
     if attributes is None:
         attributes = {}
@@ -969,7 +975,9 @@ async def create(
     mode = kwargs.pop("mode", None)
     if mode is None:
         mode = "a"
-    store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options)
+    store_path = await _make_store_path(
+        store, path=path, mode=mode, storage_options=storage_options
+    )
 
     config_dict: ArrayConfigParams = {}
 
@@ -1182,7 +1190,9 @@ async def open_array(
     """
 
     mode = kwargs.pop("mode", None)
-    store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options)
+    store_path = await _make_store_path(
+        store, path=path, mode=mode, storage_options=storage_options
+    )
 
     zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
 

src/zarr/core/array.py

@@ -85,15 +85,15 @@
 from zarr.core.sync import sync
 from zarr.errors import MetadataValidationError
 from zarr.registry import get_pipeline_class
-from zarr.storage import StoreLike, make_store_path
-from zarr.storage._common import StorePath, ensure_no_existing_node
+from zarr.storage._common import StorePath, _make_store_path, ensure_no_existing_node
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Iterator, Sequence
     from typing import Self
 
     from zarr.abc.codec import Codec, CodecPipeline
     from zarr.core.group import AsyncGroup
+    from zarr.storage import StoreLike
 
 # Array and AsyncArray are defined in the base ``zarr`` namespace
 __all__ = ["create_codec_pipeline", "parse_array_metadata"]
@@ -490,7 +490,7 @@ async def create(
         <AsyncArray memory://140349042942400 shape=(100, 100) dtype=int32>
 
         """
-        store_path = await make_store_path(store)
+        store_path = await _make_store_path(store)
 
         dtype_parsed = parse_dtype(dtype, zarr_format)
         shape = parse_shapelike(shape)
@@ -752,7 +752,7 @@ async def open(
         >>>  async_arr = await AsyncArray.open(store) # doctest: +ELLIPSIS
         <AsyncArray memory://... shape=(100, 100) dtype=int32>
         """
-        store_path = await make_store_path(store)
+        store_path = await _make_store_path(store)
         metadata_dict = await get_array_metadata(store_path, zarr_format=zarr_format)
         # TODO: remove this cast when we have better type hints
         _metadata_dict = cast(ArrayV3MetadataDict, metadata_dict)

src/zarr/core/group.py

@@ -39,8 +39,8 @@
 from zarr.core.metadata.v3 import V3JsonEncoder
 from zarr.core.sync import SyncMixin, sync
 from zarr.errors import MetadataValidationError
-from zarr.storage import StoreLike, StorePath, make_store_path
-from zarr.storage._common import ensure_no_existing_node
+from zarr.storage import StoreLike, StorePath
+from zarr.storage._common import _make_store_path, ensure_no_existing_node
 
 if TYPE_CHECKING:
     from collections.abc import AsyncGenerator, Generator, Iterable, Iterator
@@ -413,7 +413,7 @@ async def from_store(
         overwrite: bool = False,
         zarr_format: ZarrFormat = 3,
     ) -> AsyncGroup:
-        store_path = await make_store_path(store)
+        store_path = await _make_store_path(store)
 
         if overwrite:
             if store_path.store.supports_deletes:
@@ -460,7 +460,7 @@ async def open(
             (``.zmetadata`` by default). Specify the custom key as ``use_consolidated``
             to load consolidated metadata from a non-default key.
         """
-        store_path = await make_store_path(store)
+        store_path = await _make_store_path(store)
 
         consolidated_key = ZMETADATA_V2_JSON
 

src/zarr/storage/__init__.py

@@ -3,7 +3,7 @@
 from types import ModuleType
 from typing import Any
 
-from zarr.storage._common import StoreLike, StorePath, make_store_path
+from zarr.storage._common import StoreLike, StorePath
 from zarr.storage._fsspec import FsspecStore
 from zarr.storage._local import LocalStore
 from zarr.storage._logging import LoggingStore
@@ -21,7 +21,6 @@
     "StorePath",
     "WrapperStore",
     "ZipStore",
-    "make_store_path",
 ]
 
 

src/zarr/storage/_common.py

@@ -227,7 +227,7 @@ def __eq__(self, other: object) -> bool:
 StoreLike = Store | StorePath | Path | str | dict[str, Buffer]
 
 
-async def make_store_path(
+async def _make_store_path(
     store_like: StoreLike | None,
     *,
     path: str | None = "",

tests/test_group.py

@@ -21,7 +21,8 @@
 from zarr.core.group import ConsolidatedMetadata, GroupMetadata
 from zarr.core.sync import sync
 from zarr.errors import ContainsArrayError, ContainsGroupError
-from zarr.storage import LocalStore, MemoryStore, StorePath, ZipStore, make_store_path
+from zarr.storage import LocalStore, MemoryStore, StorePath, ZipStore
+from zarr.storage._common import _make_store_path
 
 from .conftest import parse_store
 
@@ -767,7 +768,7 @@ async def test_asyncgroup_create(
     )
 
     assert agroup.metadata == GroupMetadata(zarr_format=zarr_format, attributes=attributes)
-    assert agroup.store_path == await make_store_path(store)
+    assert agroup.store_path == await _make_store_path(store)
 
     if not overwrite:
         with pytest.raises(ContainsGroupError):

tests/test_store/test_core.py

@@ -5,7 +5,8 @@
 from _pytest.compat import LEGACY_PATH
 
 from zarr.core.common import AccessModeLiteral
-from zarr.storage import FsspecStore, LocalStore, MemoryStore, StoreLike, StorePath, make_store_path
+from zarr.storage import FsspecStore, LocalStore, MemoryStore, StoreLike, StorePath
+from zarr.storage._common import _make_store_path
 from zarr.storage._utils import normalize_path
 
 
@@ -14,7 +15,7 @@ async def test_make_store_path_none(path: str) -> None:
     """
     Test that creating a store_path with None creates a memorystore
     """
-    store_path = await make_store_path(None, path=path)
+    store_path = await _make_store_path(None, path=path)
     assert isinstance(store_path.store, MemoryStore)
     assert store_path.path == normalize_path(path)
 
@@ -32,7 +33,7 @@ async def test_make_store_path_local(
     Test the various ways of invoking make_store_path that create a LocalStore
     """
     store_like = store_type(str(tmpdir))
-    store_path = await make_store_path(store_like, path=path, mode=mode)
+    store_path = await _make_store_path(store_like, path=path, mode=mode)
     assert isinstance(store_path.store, LocalStore)
     assert Path(store_path.store.root) == Path(tmpdir)
     assert store_path.path == normalize_path(path)
@@ -50,7 +51,7 @@ async def test_make_store_path_store_path(
     """
     ro = mode == "r"
     store_like = await StorePath.open(LocalStore(str(tmpdir), read_only=ro), path="root", mode=mode)
-    store_path = await make_store_path(store_like, path=path, mode=mode)
+    store_path = await _make_store_path(store_like, path=path, mode=mode)
     assert isinstance(store_path.store, LocalStore)
     assert Path(store_path.store.root) == Path(tmpdir)
     path_normalized = normalize_path(path)
@@ -64,12 +65,12 @@ async def test_make_store_path_invalid() -> None:
     Test that invalid types raise TypeError
     """
     with pytest.raises(TypeError):
-        await make_store_path(1)  # type: ignore[arg-type]
+        await _make_store_path(1)  # type: ignore[arg-type]
 
 
 async def test_make_store_path_fsspec(monkeypatch) -> None:
     pytest.importorskip("fsspec")
-    store_path = await make_store_path("http://foo.com/bar")
+    store_path = await _make_store_path("http://foo.com/bar")
     assert isinstance(store_path.store, FsspecStore)
 
 
@@ -86,12 +87,12 @@ async def test_make_store_path_fsspec(monkeypatch) -> None:
 )
 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"})
+        await _make_store_path(store_like, storage_options={"foo": "bar"})
 
 
 async def test_unsupported() -> None:
     with pytest.raises(TypeError, match="Unsupported type for store_like: 'int'"):
-        await make_store_path(1)  # type: ignore[arg-type]
+        await _make_store_path(1)  # type: ignore[arg-type]
 
 
 @pytest.mark.parametrize(