Skip to content

Commit a0b8bf0

Browse files
Fix the return type of Store list methods
`None` was added in 0e035fb, let's try to remove it.
1 parent 6ccf706 commit a0b8bf0

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

src/zarr/abc/store.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ def supports_listing(self) -> bool:
329329
...
330330

331331
@abstractmethod
332-
async def list(self) -> AsyncGenerator[str, None]:
332+
async def list(self) -> AsyncGenerator[str]:
333333
"""Retrieve all keys in the store.
334334
335335
Returns
@@ -339,7 +339,7 @@ async def list(self) -> AsyncGenerator[str, None]:
339339
yield ""
340340

341341
@abstractmethod
342-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
342+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
343343
"""
344344
Retrieve all keys in the store that begin with a given prefix. Keys are returned with the
345345
common leading prefix removed.
@@ -355,7 +355,7 @@ async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
355355
yield ""
356356

357357
@abstractmethod
358-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
358+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
359359
"""
360360
Retrieve all keys and prefixes with a given prefix and which do not contain the character
361361
“/” after the given prefix.

src/zarr/storage/local.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,21 +217,21 @@ async def exists(self, key: str) -> bool:
217217
path = self.root / key
218218
return await asyncio.to_thread(path.is_file)
219219

220-
async def list(self) -> AsyncGenerator[str, None]:
220+
async def list(self) -> AsyncGenerator[str]:
221221
# docstring inherited
222222
to_strip = str(self.root) + "/"
223223
for p in list(self.root.rglob("*")):
224224
if p.is_file():
225225
yield str(p).replace(to_strip, "")
226226

227-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
227+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
228228
# docstring inherited
229229
to_strip = os.path.join(str(self.root / prefix))
230230
for p in (self.root / prefix).rglob("*"):
231231
if p.is_file():
232232
yield str(p.relative_to(to_strip))
233233

234-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
234+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
235235
# docstring inherited
236236
base = self.root / prefix
237237
to_strip = str(base) + "/"

src/zarr/storage/logging.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,19 +204,19 @@ async def set_partial_values(
204204
with self.log(keys):
205205
return await self._store.set_partial_values(key_start_values=key_start_values)
206206

207-
async def list(self) -> AsyncGenerator[str, None]:
207+
async def list(self) -> AsyncGenerator[str]:
208208
# docstring inherited
209209
with self.log():
210210
async for key in self._store.list():
211211
yield key
212212

213-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
213+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
214214
# docstring inherited
215215
with self.log(prefix):
216216
async for key in self._store.list_prefix(prefix=prefix):
217217
yield key
218218

219-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
219+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
220220
# docstring inherited
221221
with self.log(prefix):
222222
async for key in self._store.list_dir(prefix=prefix):

src/zarr/storage/memory.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,18 +143,18 @@ async def set_partial_values(self, key_start_values: Iterable[tuple[str, int, by
143143
# docstring inherited
144144
raise NotImplementedError
145145

146-
async def list(self) -> AsyncGenerator[str, None]:
146+
async def list(self) -> AsyncGenerator[str]:
147147
# docstring inherited
148148
for key in self._store_dict:
149149
yield key
150150

151-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
151+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
152152
# docstring inherited
153153
for key in self._store_dict:
154154
if key.startswith(prefix):
155155
yield key.removeprefix(prefix)
156156

157-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
157+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
158158
# docstring inherited
159159
if prefix.endswith("/"):
160160
prefix = prefix[:-1]

src/zarr/storage/remote.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,13 +280,13 @@ async def set_partial_values(
280280
# docstring inherited
281281
raise NotImplementedError
282282

283-
async def list(self) -> AsyncGenerator[str, None]:
283+
async def list(self) -> AsyncGenerator[str]:
284284
# docstring inherited
285285
allfiles = await self.fs._find(self.path, detail=False, withdirs=False)
286286
for onefile in (a.replace(self.path + "/", "") for a in allfiles):
287287
yield onefile
288288

289-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
289+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
290290
# docstring inherited
291291
prefix = f"{self.path}/{prefix.rstrip('/')}"
292292
try:
@@ -296,7 +296,7 @@ async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
296296
for onefile in (a.replace(prefix + "/", "") for a in allfiles):
297297
yield onefile.removeprefix(self.path).removeprefix("/")
298298

299-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
299+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
300300
# docstring inherited
301301
find_str = f"{self.path}/{prefix}"
302302
for onefile in await self.fs._find(find_str, detail=False, maxdepth=None, withdirs=False):

src/zarr/storage/zip.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,19 +231,19 @@ async def exists(self, key: str) -> bool:
231231
else:
232232
return True
233233

234-
async def list(self) -> AsyncGenerator[str, None]:
234+
async def list(self) -> AsyncGenerator[str]:
235235
# docstring inherited
236236
with self._lock:
237237
for key in self._zf.namelist():
238238
yield key
239239

240-
async def list_prefix(self, prefix: str) -> AsyncGenerator[str, None]:
240+
async def list_prefix(self, prefix: str) -> AsyncGenerator[str]:
241241
# docstring inherited
242242
async for key in self.list():
243243
if key.startswith(prefix):
244244
yield key.removeprefix(prefix)
245245

246-
async def list_dir(self, prefix: str) -> AsyncGenerator[str, None]:
246+
async def list_dir(self, prefix: str) -> AsyncGenerator[str]:
247247
# docstring inherited
248248
if prefix.endswith("/"):
249249
prefix = prefix[:-1]

0 commit comments

Comments
 (0)