Merge branch 'v3' of https://github.com/zarr-developers/zarr-python i…

…nto doc/storage

src/zarr/abc/store.py

@@ -62,13 +62,6 @@ def from_literal(cls, mode: AccessModeLiteral) -> Self:
 class Store(ABC):
     """
     Abstract base class for Zarr stores.
-
-    Attributes
-    ----------
-    _mode : AccessMode
-        Access mode flags.
-    _is_open : bool
-        Whether the store is open.
     """
 
     _mode: AccessMode
@@ -92,7 +85,7 @@ async def open(cls, *args: Any, **kwargs: Any) -> Self:
 
         Returns
         -------
-        store
+        Store
             The opened store instance.
         """
         store = cls(*args, **kwargs)
@@ -116,16 +109,16 @@ async def _open(self) -> None:
         """
         Open the store.
 
-        Notes
-        -----
-        * When `mode='w'` and the store already exists, it will be cleared.
-
         Raises
         ------
         ValueError
             If the store is already open.
         FileExistsError
-            If `mode='w-'` and the store already exists.
+            If ``mode='w-'`` and the store already exists.
+
+        Notes
+        -----
+        * When ``mode='w'`` and the store already exists, it will be cleared.
         """
         if self._is_open:
             raise ValueError("store is already open")
@@ -158,7 +151,6 @@ async def clear(self) -> None:
         Clear the store.
 
         Remove all keys and values from the store.
-
         """
         ...
 
@@ -427,7 +419,6 @@ async def set_or_delete(byte_setter: ByteSetter, value: Buffer | None) -> None:
     Notes
     -----
     If value is None, the key will be deleted.
-
     """
     if value is None:
         await byte_setter.delete()

src/zarr/storage/common.py

@@ -117,7 +117,7 @@ async def exists(self) -> bool:
 
         Returns
         -------
-        exists : bool
+        bool
             True if the key exists in the store, False otherwise.
         """
         return await self.store.exists(self.path)
@@ -138,7 +138,7 @@ def __eq__(self, other: object) -> bool:
 
         Returns
         -------
-        equals : bool
+        bool
             True if the two objects are equal, False otherwise.
 
         Notes

src/zarr/storage/logging.py

@@ -32,8 +32,6 @@ class LoggingStore(Store):
 
     Attributes
     ----------
-    _store: Store
-        Wrapped store
     counter: dict
         Counter of number of times each method has been called
     """
@@ -78,7 +76,7 @@ def _default_handler(self) -> logging.Handler:
 
     @contextmanager
     def log(self) -> Generator[None, None, None]:
-        """context manager to log method calls
+        """Context manager to log method calls
 
         Each call to the wrapped store is logged to the configured logger and added to
         the counter dict.

src/zarr/storage/remote.py

@@ -30,14 +30,14 @@ class RemoteStore(Store):
 
     Parameters
     ----------
-    fs: AsyncFileSystem
+    fs : AsyncFileSystem
         The Async FSSpec filesystem to use with this store.
-    mode: AccessModeLiteral
+    mode : AccessModeLiteral
         The access mode to use.
-    path: str
+    path : str
         The root path of the store.
-    allowed_exceptions: tuple[type[Exception], ...]
-        When fetching data, these cases will be deemed to correspond to missing
+    allowed_exceptions : tuple[type[Exception], ...]
+        When fetching data, these cases will be deemed to correspond to missing keys.
 
     Attributes
     ----------

src/zarr/storage/zip.py

@@ -35,10 +35,6 @@ class ZipStore(Store):
         extensions when the zipfile is larger than 2 GiB. If False
         will raise an exception when the ZIP file would require ZIP64
         extensions.
-    mode : string, optional
-        One of 'r' to read an existing file, 'w' to truncate and write a new
-        file, 'a' to append to an existing file, or 'x' to exclusively create
-        and write a new file.
 
     Attributes
     ----------