Consistent signatures for listdir() and rmdir()

Author: DimitriPapadopoulos

zarr/_storage/store.py

@@ -9,6 +9,8 @@
 group_meta_key = '.zgroup'
 attrs_key = '.zattrs'
 
+Path = Union[str, bytes, None]
+
 
 class BaseStore(MutableMapping):
     """Abstract base class for store implementations.
@@ -118,11 +120,11 @@ class Store(BaseStore):
 
     """
 
-    def listdir(self, path: str = "") -> List[str]:
+    def listdir(self, path: Path = None) -> List[str]:
         path = normalize_storage_path(path)
         return _listdir_from_keys(self, path)
 
-    def rmdir(self, path: str = "") -> None:
+    def rmdir(self, path: Path = None) -> None:
         if not self.is_erasable():
             raise NotImplementedError(
                 f'{type(self)} is not erasable, cannot call "rmdir"'
@@ -150,15 +152,7 @@ def _rename_from_keys(store: BaseStore, src_path: str, dst_path: str) -> None:
             store[new_key] = store.pop(key)
 
 
-def _rmdir_from_keys(store: Union[BaseStore, MutableMapping], path: Optional[str] = None) -> None:
-    # assume path already normalized
-    prefix = _path_to_prefix(path)
-    for key in list(store.keys()):
-        if key.startswith(prefix):
-            del store[key]
-
-
-def _listdir_from_keys(store: BaseStore, path: Optional[str] = None) -> List[str]:
+def _listdir_from_keys(store: BaseStore, path: Optional[Path] = None) -> List[str]:
     # assume path already normalized
     prefix = _path_to_prefix(path)
     children = set()
@@ -168,3 +162,11 @@ def _listdir_from_keys(store: BaseStore, path: Optional[str] = None) -> List[str
             child = suffix.split('/')[0]
             children.add(child)
     return sorted(children)
+
+
+def _rmdir_from_keys(store: Union[BaseStore, MutableMapping], path: Optional[Path] = None) -> None:
+    # assume path already normalized
+    prefix = _path_to_prefix(path)
+    for key in list(store.keys()):
+        if key.startswith(prefix):
+            del store[key]

zarr/storage.py

@@ -2157,7 +2157,7 @@ def _keys(self):
             self._keys_cache = list(self._store.keys())
         return self._keys_cache
 
-    def listdir(self, path: Path = None):
+    def listdir(self, path: Path = None) -> List[str]:
         with self._mutex:
             try:
                 return self._listdir_cache[path]
@@ -2682,5 +2682,5 @@ def __setitem__(self, key, value):
     def getsize(self, path):
         return getsize(self.meta_store, path)
 
-    def listdir(self, path):
+    def listdir(self, path=None):
         return listdir(self.meta_store, path)