WIP - backwards compat

Author: TomAugspurger

pyproject.toml

@@ -66,7 +66,8 @@ test = [
     "flask",
     "requests",
     "mypy",
-    "hypothesis"
+    "hypothesis",
+    "universal-pathlib",
 ]
 
 jupyter = [

src/zarr/api/asynchronous.py

@@ -468,7 +468,7 @@ async def group(
     try:
         return await AsyncGroup.open(store=store_path, zarr_format=zarr_format)
     except (KeyError, FileNotFoundError):
-        return await AsyncGroup.create(
+        return await AsyncGroup.from_store(
             store=store_path,
             zarr_format=zarr_format,
             exists_ok=overwrite,
@@ -477,8 +477,8 @@ async def group(
 
 
 async def open_group(
-    *,  # Note: this is a change from v2
     store: StoreLike | None = None,
+    *,  # Note: this is a change from v2
     mode: AccessModeLiteral | None = None,  # not used
     cache_attrs: bool | None = None,  # not used, default changed
     synchronizer: Any = None,  # not used
@@ -550,7 +550,7 @@ async def open_group(
     try:
         return await AsyncGroup.open(store_path, zarr_format=zarr_format)
     except (KeyError, FileNotFoundError):
-        return await AsyncGroup.create(
+        return await AsyncGroup.from_store(
             store_path, zarr_format=zarr_format, exists_ok=True, attributes=attributes
         )
 

src/zarr/api/synchronous.py

@@ -62,8 +62,8 @@ def load(
 
 
 def open(
-    *,
     store: StoreLike | None = None,
+    *,
     mode: AccessModeLiteral | None = None,  # type and value changed
     zarr_version: ZarrFormat | None = None,  # deprecated
     zarr_format: ZarrFormat | None = None,
@@ -187,8 +187,8 @@ def group(
 
 
 def open_group(
-    *,  # Note: this is a change from v2
     store: StoreLike | None = None,
+    *,  # Note: this is a change from v2
     mode: AccessModeLiteral | None = None,  # not used in async api
     cache_attrs: bool | None = None,  # default changed, not used in async api
     synchronizer: Any = None,  # not used in async api

src/zarr/core/attributes.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from collections.abc import MutableMapping
+from collections.abc import Mapping, MutableMapping
 from typing import TYPE_CHECKING
 
 from zarr.core.common import JSON
@@ -35,3 +35,9 @@ def __iter__(self) -> Iterator[str]:
 
     def __len__(self) -> int:
         return len(self._obj.metadata.attributes)
+
+    def put(self, d: Mapping[str, JSON]) -> None:
+        # Backwards compat for 2.x API.
+        new_attrs = dict(self._obj.metadata.attributes)
+        new_attrs.update(d)
+        self._obj = self._obj.update_attributes(new_attrs)

src/zarr/core/group.py

@@ -12,7 +12,7 @@
 
 from zarr.abc.codec import Codec
 from zarr.abc.metadata import Metadata
-from zarr.abc.store import set_or_delete
+from zarr.abc.store import Store, set_or_delete
 from zarr.core.array import Array, AsyncArray
 from zarr.core.attributes import Attributes
 from zarr.core.buffer import default_buffer_prototype
@@ -122,8 +122,12 @@ class AsyncGroup:
     metadata: GroupMetadata
     store_path: StorePath
 
+    @property
+    def store(self) -> Store:
+        return self.store_path.store
+
     @classmethod
-    async def create(
+    async def from_store(
         cls,
         store: StoreLike,
         *,
@@ -316,7 +320,7 @@ async def create_group(
         attributes: dict[str, Any] | None = None,
     ) -> AsyncGroup:
         attributes = attributes or {}
-        return await type(self).create(
+        return await type(self).from_store(
             self.store_path / path,
             attributes=attributes,
             exists_ok=exists_ok,
@@ -533,8 +537,24 @@ async def move(self, source: str, dest: str) -> None:
 class Group(SyncMixin):
     _async_group: AsyncGroup
 
+    @property
+    def store(self) -> Store:
+        # Backwards compatibility for 2.x
+        return self._async_group.store
+
+    @property
+    def read_only(self) -> bool:
+        # Backwards compatibility for 2.x
+        return self._async_group.store.mode.readonly
+
+    @property
+    def synchronizer(self) -> None:
+        # Backwards compatibility for 2.x
+        # Not implemented in 3.x yet.
+        return None
+
     @classmethod
-    def create(
+    def from_store(
         cls,
         store: StoreLike,
         *,
@@ -544,7 +564,7 @@ def create(
     ) -> Group:
         attributes = attributes or {}
         obj = sync(
-            AsyncGroup.create(
+            AsyncGroup.from_store(
                 store,
                 attributes=attributes,
                 exists_ok=exists_ok,
@@ -665,6 +685,10 @@ def tree(self, expand: bool = False, level: int | None = None) -> Any:
     def create_group(self, name: str, **kwargs: Any) -> Group:
         return Group(self._sync(self._async_group.create_group(name, **kwargs)))
 
+    def create(self, *args: Any, **kwargs: Any) -> Array:
+        # Backwards compatibility for 2.x
+        return self.create_array(*args, **kwargs)
+
     def create_array(
         self,
         name: str,

src/zarr/store/consolidated.py

@@ -98,7 +98,7 @@ def arrays(
     expected_attrs = {} if attributes is None else attributes
 
     array_path = path + ("/" if not path.endswith("/") else "") + name
-    root = Group.create(store)
+    root: Group = Group.from_store(store)
     fill_value_args: tuple[Any, ...] = tuple()
     if nparray.dtype.kind == "M":
         fill_value_args = ("ns",)

src/zarr/testing/strategies.py

@@ -81,7 +81,7 @@ async def async_group(request: pytest.FixtureRequest, tmpdir: LEGACY_PATH) -> As
     param: AsyncGroupRequest = request.param
 
     store = await parse_store(param.store, str(tmpdir))
-    agroup = await AsyncGroup.create(
+    agroup = await AsyncGroup.from_store(
         store,
         attributes=param.attributes,
         zarr_format=param.zarr_format,

tests/v3/conftest.py

@@ -24,7 +24,7 @@ def test_array_creation_existing_node(
     Check that an existing array or group is handled as expected during array creation.
     """
     spath = StorePath(store)
-    group = Group.create(spath, zarr_format=zarr_format)
+    group = Group.from_store(spath, zarr_format=zarr_format)
     expected_exception: type[ContainsArrayError] | type[ContainsGroupError]
     if extant_node == "array":
         expected_exception = ContainsArrayError
@@ -75,7 +75,7 @@ def test_array_name_properties_no_group(
 def test_array_name_properties_with_group(
     store: LocalStore | MemoryStore, zarr_format: ZarrFormat
 ) -> None:
-    root = Group.create(store=store, zarr_format=zarr_format)
+    root = Group.from_store(store=store, zarr_format=zarr_format)
     foo = root.create_array("foo", shape=(100,), chunks=(10,), dtype="i4")
     assert foo.path == "foo"
     assert foo.name == "/foo"