rename methods

Author: d-v-b

src/zarr/abc/store.py

@@ -209,7 +209,7 @@ async def get(
         """
         ...
 
-    async def get_bytes_async(
+    async def get_bytes(
         self, key: str, *, prototype: BufferPrototype, byte_range: ByteRequest | None = None
     ) -> bytes:
         """
@@ -242,7 +242,7 @@ async def get_bytes_async(
         --------
         get : Lower-level method that returns a Buffer object.
         get_bytes : Synchronous version of this method.
-        get_json_async : Asynchronous method for retrieving and parsing JSON data.
+        get_json : Asynchronous method for retrieving and parsing JSON data.
 
         Examples
         --------
@@ -257,7 +257,7 @@ async def get_bytes_async(
             raise FileNotFoundError(key)
         return buffer.to_bytes()
 
-    def get_bytes(
+    def get_bytes_sync(
         self, key: str = "", *, prototype: BufferPrototype, byte_range: ByteRequest | None = None
     ) -> bytes:
         """
@@ -289,7 +289,7 @@ def get_bytes(
 
         Warnings
         --------
-        Do not call this method from async functions. Use ``get_bytes_async()`` instead
+        Do not call this method from async functions. Use ``get_bytes()`` instead
         to avoid blocking the event loop.
 
         See Also
@@ -300,23 +300,22 @@ def get_bytes(
         Examples
         --------
         >>> store = MemoryStore()
-        >>> store.set("data", Buffer.from_bytes(b"hello world"))
-        >>> data = store.get_bytes("data", prototype=default_buffer_prototype())
+        >>> await store.set("data", Buffer.from_bytes(b"hello world"))
+        >>> data = store.get_bytes_sync("data", prototype=default_buffer_prototype())
         >>> print(data)
         b'hello world'
         """
 
-        return sync(self.get_bytes_async(key, prototype=prototype, byte_range=byte_range))
+        return sync(self.get_bytes(key, prototype=prototype, byte_range=byte_range))
 
-    async def get_json_async(
+    async def get_json(
         self, key: str, *, prototype: BufferPrototype, byte_range: ByteRequest | None = None
     ) -> Any:
         """
         Retrieve and parse JSON data from the store asynchronously.
 
         This is a convenience method that retrieves bytes from the store and
-        parses them as JSON. Commonly used for reading Zarr metadata files
-        like ``zarr.json``.
+        parses them as JSON.
 
         Parameters
         ----------
@@ -344,31 +343,29 @@ async def get_json_async(
 
         See Also
         --------
-        get_bytes_async : Method for retrieving raw bytes without parsing.
-        get_json : Synchronous version of this method.
+        get_bytes : Method for retrieving raw bytes.
+        get_json_sync : Synchronous version of this method.
 
         Examples
         --------
         >>> store = await MemoryStore.open()
         >>> metadata = {"zarr_format": 3, "node_type": "array"}
         >>> await store.set("zarr.json", Buffer.from_bytes(json.dumps(metadata).encode()))
-        >>> data = await store.get_json_async("zarr.json", prototype=default_buffer_prototype())
+        >>> data = await store.get_json("zarr.json", prototype=default_buffer_prototype())
         >>> print(data)
         {'zarr_format': 3, 'node_type': 'array'}
         """
 
-        return json.loads(
-            await self.get_bytes_async(key, prototype=prototype, byte_range=byte_range)
-        )
+        return json.loads(await self.get_bytes(key, prototype=prototype, byte_range=byte_range))
 
-    def get_json(
+    def get_json_sync(
         self, key: str = "", *, prototype: BufferPrototype, byte_range: ByteRequest | None = None
     ) -> Any:
         """
         Retrieve and parse JSON data from the store synchronously.
 
-        This is a synchronous wrapper around ``get_json_async()``. It should only
-        be called from non-async code. For async contexts, use ``get_json_async()``
+        This is a synchronous wrapper around ``get_json()``. It should only
+        be called from non-async code. For async contexts, use ``get_json()``
         instead.
 
         Parameters
@@ -397,25 +394,25 @@ def get_json(
 
         Warnings
         --------
-        Do not call this method from async functions. Use ``get_json_async()`` instead
+        Do not call this method from async functions. Use ``get_json()`` instead
         to avoid blocking the event loop.
 
         See Also
         --------
-        get_json_async : Asynchronous version of this method.
-        get_bytes : Synchronous method for retrieving raw bytes without parsing.
+        get_json : Asynchronous version of this method.
+        get_bytes_sync : Synchronous method for retrieving raw bytes without parsing.
 
         Examples
         --------
         >>> store = MemoryStore()
         >>> metadata = {"zarr_format": 3, "node_type": "array"}
         >>> store.set("zarr.json", Buffer.from_bytes(json.dumps(metadata).encode()))
-        >>> data = store.get_json("zarr.json", prototype=default_buffer_prototype())
+        >>> data = store.get_json_sync("zarr.json", prototype=default_buffer_prototype())
         >>> print(data)
         {'zarr_format': 3, 'node_type': 'array'}
         """
 
-        return sync(self.get_json_async(key, prototype=prototype, byte_range=byte_range))
+        return sync(self.get_json(key, prototype=prototype, byte_range=byte_range))
 
     @abstractmethod
     async def get_partial_values(

src/zarr/storage/_local.py

@@ -306,7 +306,7 @@ async def list_dir(self, prefix: str) -> AsyncIterator[str]:
         except (FileNotFoundError, NotADirectoryError):
             pass
 
-    async def get_bytes_async(
+    async def get_bytes(
         self,
         key: str = "",
         *,
@@ -356,9 +356,9 @@ async def get_bytes_async(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return await super().get_bytes_async(key, prototype=prototype, byte_range=byte_range)
+        return await super().get_bytes(key, prototype=prototype, byte_range=byte_range)
 
-    def get_bytes(
+    def get_bytes_sync(
         self,
         key: str = "",
         *,
@@ -412,9 +412,9 @@ def get_bytes(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return super().get_bytes(key, prototype=prototype, byte_range=byte_range)
+        return super().get_bytes_sync(key, prototype=prototype, byte_range=byte_range)
 
-    async def get_json_async(
+    async def get_json(
         self,
         key: str = "",
         *,
@@ -425,7 +425,7 @@ async def get_json_async(
         Retrieve and parse JSON data from the local store asynchronously.
 
         This is a convenience override that makes the ``prototype`` parameter optional
-        by defaulting to the standard buffer prototype. See the base ``Store.get_json_async``
+        by defaulting to the standard buffer prototype. See the base ``Store.get_json``
         for full documentation.
 
         Parameters
@@ -454,7 +454,7 @@ async def get_json_async(
 
         See Also
         --------
-        Store.get_json_async : Base implementation with full documentation.
+        Store.get_json : Base implementation with full documentation.
         get_json : Synchronous version of this method.
         get_bytes_async : Method for retrieving raw bytes without parsing.
 
@@ -465,15 +465,15 @@ async def get_json_async(
         >>> metadata = {"zarr_format": 3, "node_type": "array"}
         >>> await store.set("zarr.json", Buffer.from_bytes(json.dumps(metadata).encode()))
         >>> # No need to specify prototype for LocalStore
-        >>> data = await store.get_json_async("zarr.json")
+        >>> data = await store.get_json("zarr.json")
         >>> print(data)
         {'zarr_format': 3, 'node_type': 'array'}
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return await super().get_json_async(key, prototype=prototype, byte_range=byte_range)
+        return await super().get_json(key, prototype=prototype, byte_range=byte_range)
 
-    def get_json(
+    def get_json_sync(
         self,
         key: str = "",
         *,
@@ -513,12 +513,12 @@ def get_json(
 
         Warnings
         --------
-        Do not call this method from async functions. Use ``get_json_async()`` instead.
+        Do not call this method from async functions. Use ``get_json()`` instead.
 
         See Also
         --------
         Store.get_json : Base implementation with full documentation.
-        get_json_async : Asynchronous version of this method.
+        get_json : Asynchronous version of this method.
         get_bytes : Method for retrieving raw bytes without parsing.
 
         Examples
@@ -534,7 +534,7 @@ def get_json(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return super().get_json(key, prototype=prototype, byte_range=byte_range)
+        return super().get_json_sync(key, prototype=prototype, byte_range=byte_range)
 
     async def move(self, dest_root: Path | str) -> None:
         """

src/zarr/storage/_memory.py

@@ -175,7 +175,7 @@ async def list_dir(self, prefix: str) -> AsyncIterator[str]:
         for key in keys_unique:
             yield key
 
-    async def get_bytes_async(
+    async def get_bytes(
         self,
         key: str = "",
         *,
@@ -225,9 +225,9 @@ async def get_bytes_async(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return await super().get_bytes_async(key, prototype=prototype, byte_range=byte_range)
+        return await super().get_bytes(key, prototype=prototype, byte_range=byte_range)
 
-    def get_bytes(
+    def get_bytes_sync(
         self,
         key: str = "",
         *,
@@ -281,9 +281,9 @@ def get_bytes(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return super().get_bytes(key, prototype=prototype, byte_range=byte_range)
+        return super().get_bytes_sync(key, prototype=prototype, byte_range=byte_range)
 
-    async def get_json_async(
+    async def get_json(
         self,
         key: str = "",
         *,
@@ -294,7 +294,7 @@ async def get_json_async(
         Retrieve and parse JSON data from the memory store asynchronously.
 
         This is a convenience override that makes the ``prototype`` parameter optional
-        by defaulting to the standard buffer prototype. See the base ``Store.get_json_async``
+        by defaulting to the standard buffer prototype. See the base ``Store.get_json``
         for full documentation.
 
         Parameters
@@ -323,7 +323,7 @@ async def get_json_async(
 
         See Also
         --------
-        Store.get_json_async : Base implementation with full documentation.
+        Store.get_json : Base implementation with full documentation.
         get_json : Synchronous version of this method.
         get_bytes_async : Method for retrieving raw bytes without parsing.
 
@@ -334,15 +334,15 @@ async def get_json_async(
         >>> metadata = {"zarr_format": 3, "node_type": "array"}
         >>> await store.set("zarr.json", Buffer.from_bytes(json.dumps(metadata).encode()))
         >>> # No need to specify prototype for MemoryStore
-        >>> data = await store.get_json_async("zarr.json")
+        >>> data = await store.get_json("zarr.json")
         >>> print(data)
         {'zarr_format': 3, 'node_type': 'array'}
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return await super().get_json_async(key, prototype=prototype, byte_range=byte_range)
+        return await super().get_json(key, prototype=prototype, byte_range=byte_range)
 
-    def get_json(
+    def get_json_sync(
         self,
         key: str = "",
         *,
@@ -382,12 +382,12 @@ def get_json(
 
         Warnings
         --------
-        Do not call this method from async functions. Use ``get_json_async()`` instead.
+        Do not call this method from async functions. Use ``get_json()`` instead.
 
         See Also
         --------
         Store.get_json : Base implementation with full documentation.
-        get_json_async : Asynchronous version of this method.
+        get_json : Asynchronous version of this method.
         get_bytes : Method for retrieving raw bytes without parsing.
 
         Examples
@@ -403,7 +403,7 @@ def get_json(
         """
         if prototype is None:
             prototype = default_buffer_prototype()
-        return super().get_json(key, prototype=prototype, byte_range=byte_range)
+        return super().get_json_sync(key, prototype=prototype, byte_range=byte_range)
 
 
 class GpuMemoryStore(MemoryStore):

src/zarr/testing/store.py

@@ -534,9 +534,9 @@ async def test_get_bytes_async(self, store: S) -> None:
         data = b"hello world"
         key = "zarr.json"
         await self.set(store, key, self.buffer_cls.from_bytes(data))
-        assert await store.get_bytes_async(key, prototype=default_buffer_prototype()) == data
+        assert await store.get_bytes(key, prototype=default_buffer_prototype()) == data
         with pytest.raises(FileNotFoundError):
-            await store.get_bytes_async("nonexistent_key", prototype=default_buffer_prototype())
+            await store.get_bytes("nonexistent_key", prototype=default_buffer_prototype())
 
     def test_get_bytes_sync(self, store: S) -> None:
         """
@@ -545,17 +545,17 @@ def test_get_bytes_sync(self, store: S) -> None:
         data = b"hello world"
         key = "zarr.json"
         sync(self.set(store, key, self.buffer_cls.from_bytes(data)))
-        assert store.get_bytes(key, prototype=default_buffer_prototype()) == data
+        assert store.get_bytes_sync(key, prototype=default_buffer_prototype()) == data
 
-    async def test_get_json_async(self, store: S) -> None:
+    async def test_get_json(self, store: S) -> None:
         """
         Test that the get_bytes_async method reads json.
         """
         data = {"foo": "bar"}
         data_bytes = json.dumps(data).encode("utf-8")
         key = "zarr.json"
         await self.set(store, key, self.buffer_cls.from_bytes(data_bytes))
-        assert await store.get_json_async(key, prototype=default_buffer_prototype()) == data
+        assert await store.get_json(key, prototype=default_buffer_prototype()) == data
 
     def test_get_json_sync(self, store: S) -> None:
         """
@@ -565,7 +565,7 @@ def test_get_json_sync(self, store: S) -> None:
         data_bytes = json.dumps(data).encode("utf-8")
         key = "zarr.json"
         sync(self.set(store, key, self.buffer_cls.from_bytes(data_bytes)))
-        assert store.get_json(key, prototype=default_buffer_prototype()) == data
+        assert store.get_json_sync(key, prototype=default_buffer_prototype()) == data
 
 
 class LatencyStore(WrapperStore[Store]):