Skip to content

Commit fa343f5

Browse files
committed
sync funcs
1 parent fd6ecd1 commit fa343f5

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

src/zarr/api/synchronous.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,16 @@ def open(
9090
return Group(obj)
9191

9292

93+
def read(
94+
store: StoreLike,
95+
*,
96+
zarr_format: ZarrFormat | None = None,
97+
path: str | None = None,
98+
**kwargs: Any,
99+
) -> Array | Group:
100+
return open(store=store, mode="r", zarr_format=zarr_format, path=path, **kwargs)
101+
102+
93103
def open_consolidated(*args: Any, use_consolidated: Literal[True] = True, **kwargs: Any) -> Group:
94104
return Group(
95105
sync(async_api.open_consolidated(*args, use_consolidated=use_consolidated, **kwargs))
@@ -232,11 +242,32 @@ def open_group(
232242
)
233243

234244

245+
def read_group(
246+
store: StoreLike | None = None,
247+
path: str | None = None,
248+
storage_options: dict[str, Any] | None = None, # not used in async api
249+
zarr_format: ZarrFormat | None = None,
250+
use_consolidated: bool | str | None = None,
251+
) -> Group:
252+
return open_group(
253+
store=store,
254+
path=path,
255+
mode="r",
256+
zarr_format=zarr_format,
257+
use_consolidated=use_consolidated,
258+
storage_options=storage_options,
259+
)
260+
261+
235262
# TODO: add type annotations for kwargs
236263
def create(*args: Any, **kwargs: Any) -> Array:
237264
return Array(sync(async_api.create(*args, **kwargs)))
238265

239266

267+
def read_array(*args: Any, **kwargs: Any) -> Array:
268+
return Array(sync(async_api.read_array(*args, **kwargs)))
269+
270+
240271
# TODO: add type annotations for kwargs
241272
def empty(shape: ChunkCoords, **kwargs: Any) -> Array:
242273
return Array(sync(async_api.empty(shape, **kwargs)))
@@ -295,6 +326,7 @@ def zeros_like(a: async_api.ArrayLike, **kwargs: Any) -> Array:
295326
copy_store.__doc__ = async_api.copy_store.__doc__
296327
load.__doc__ = async_api.load.__doc__
297328
open.__doc__ = async_api.open.__doc__
329+
read.__doc__ = async_api.read.__doc__
298330
open_consolidated.__doc__ = async_api.open_consolidated.__doc__
299331
save.__doc__ = async_api.save.__doc__
300332
save_array.__doc__ = async_api.save_array.__doc__
@@ -303,7 +335,9 @@ def zeros_like(a: async_api.ArrayLike, **kwargs: Any) -> Array:
303335
array.__doc__ = async_api.array.__doc__
304336
group.__doc__ = async_api.group.__doc__
305337
open_group.__doc__ = async_api.open_group.__doc__
338+
read_group.__doc__ = async_api.read_group.__doc__
306339
create.__doc__ = async_api.create.__doc__
340+
read_array.__doc__ = async_api.read_array.__doc__
307341
empty.__doc__ = async_api.empty.__doc__
308342
empty_like.__doc__ = async_api.empty_like.__doc__
309343
full.__doc__ = async_api.full.__doc__

0 commit comments

Comments
 (0)