Skip to content

Commit c38e4d4

Browse files
dstansbydstansby
committed
Remove zarr_version
1 parent e0e94cc commit c38e4d4

File tree

6 files changed

+11
-81
lines changed

6 files changed

+11
-81
lines changed

‎changes/3325.removal.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ The following deprecated functions have been removed:
2828

2929
Setting ``zarr.storage.default_compressor`` is deprecated, use `zarr.config` to configure ``array.v2_default_compressor``
3030
e.g. ``zarr.config.set({'codecs.zstd':'numcodecs.Zstd', 'array.v2_default_compressor.numeric': 'zstd'})``
31+
32+
The ``zarr_version`` argument has been removed throughout the library.
33+
Use the equivalent ``zarr_format`` argument instead.

‎docs/user-guide/config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For more information, see the
2727

2828
Configuration options include the following:
2929

30-
- Default Zarr format `default_zarr_version`
30+
- Default Zarr format `default_zarr_format`
3131
- Default array order in memory `array.order`
3232
- Whether empty chunks are written to storage `array.write_empty_chunks`
3333
- Async and threading options, e.g. `async.concurrency` and `threading.max_workers`

‎docs/user-guide/v3_migration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The following sections provide details on breaking changes in Zarr-Python 3.
9797

9898
2. Defaulting to `zarr_format=3` - newly created arrays will use the version 3 of the
9999
Zarr specification. To continue using version 2, set `zarr_format=2` when creating arrays
100-
or set `default_zarr_version=2` in Zarr's runtime configuration.
100+
or set `default_zarr_format=2` in Zarr's runtime configuration.
101101

102102
### The Group class
103103

‎src/zarr/api/asynchronous.py‎

Lines changed: 3 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
ArrayNotFoundError,
4242
GroupNotFoundError,
4343
NodeTypeValidationError,
44-
ZarrDeprecationWarning,
4544
ZarrRuntimeWarning,
4645
ZarrUserWarning,
4746
)
@@ -166,22 +165,6 @@ def _like_args(a: ArrayLike) -> _LikeArgs:
166165
return new
167166

168167

169-
def _handle_zarr_version_or_format(
170-
*, zarr_version: ZarrFormat | None, zarr_format: ZarrFormat | None
171-
) -> ZarrFormat | None:
172-
"""Handle the deprecated zarr_version kwarg and return zarr_format"""
173-
if zarr_format is not None and zarr_version is not None and zarr_format != zarr_version:
174-
raise ValueError(
175-
f"zarr_format {zarr_format} does not match zarr_version {zarr_version}, please only set one"
176-
)
177-
if zarr_version is not None:
178-
warnings.warn(
179-
"zarr_version is deprecated, use zarr_format", ZarrDeprecationWarning, stacklevel=2
180-
)
181-
return zarr_version
182-
return zarr_format
183-
184-
185168
async def consolidate_metadata(
186169
store: StoreLike,
187170
path: str | None = None,
@@ -286,7 +269,6 @@ async def load(
286269
store: StoreLike,
287270
path: str | None = None,
288271
zarr_format: ZarrFormat | None = None,
289-
zarr_version: ZarrFormat | None = None,
290272
) -> NDArrayLikeOrScalar | dict[str, NDArrayLikeOrScalar]:
291273
"""Load data from an array or group into memory.
292274
@@ -315,8 +297,6 @@ async def load(
315297
If loading data from a group of arrays, data will not be immediately loaded into
316298
memory. Rather, arrays will be loaded into memory as they are requested.
317299
"""
318-
zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
319-
320300
obj = await open(store=store, path=path, zarr_format=zarr_format)
321301
if isinstance(obj, AsyncArray):
322302
return await obj.getitem(slice(None))
@@ -328,7 +308,6 @@ async def open(
328308
*,
329309
store: StoreLike | None = None,
330310
mode: AccessModeLiteral | None = None,
331-
zarr_version: ZarrFormat | None = None, # deprecated
332311
zarr_format: ZarrFormat | None = None,
333312
path: str | None = None,
334313
storage_options: dict[str, Any] | None = None,
@@ -364,7 +343,6 @@ async def open(
364343
z : array or group
365344
Return type depends on what exists in the given store.
366345
"""
367-
zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
368346
if mode is None:
369347
if isinstance(store, (Store, StorePath)) and store.read_only:
370348
mode = "r"
@@ -415,7 +393,6 @@ async def open_consolidated(
415393
async def save(
416394
store: StoreLike,
417395
*args: NDArrayLike,
418-
zarr_version: ZarrFormat | None = None, # deprecated
419396
zarr_format: ZarrFormat | None = None,
420397
path: str | None = None,
421398
**kwargs: Any, # TODO: type kwargs as valid args to save
@@ -437,7 +414,6 @@ async def save(
437414
**kwargs
438415
NumPy arrays with data to save.
439416
"""
440-
zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
441417

442418
if len(args) == 0 and len(kwargs) == 0:
443419
raise ValueError("at least one array must be provided")
@@ -451,7 +427,6 @@ async def save_array(
451427
store: StoreLike,
452428
arr: NDArrayLike,
453429
*,
454-
zarr_version: ZarrFormat | None = None, # deprecated
455430
zarr_format: ZarrFormat | None = None,
456431
path: str | None = None,
457432
storage_options: dict[str, Any] | None = None,
@@ -479,10 +454,7 @@ async def save_array(
479454
**kwargs
480455
Passed through to [`create`][zarr.api.asynchronous.create], e.g., compressor.
481456
"""
482-
zarr_format = (
483-
_handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
484-
or _default_zarr_format()
485-
)
457+
zarr_format = zarr_format or _default_zarr_format()
486458
if not isinstance(arr, NDArrayLike):
487459
raise TypeError("arr argument must be numpy or other NDArrayLike array")
488460

@@ -509,7 +481,6 @@ async def save_array(
509481
async def save_group(
510482
store: StoreLike,
511483
*args: NDArrayLike,
512-
zarr_version: ZarrFormat | None = None, # deprecated
513484
zarr_format: ZarrFormat | None = None,
514485
path: str | None = None,
515486
storage_options: dict[str, Any] | None = None,
@@ -539,13 +510,7 @@ async def save_group(
539510

540511
store_path = await make_store_path(store, path=path, mode="w", storage_options=storage_options)
541512

542-
zarr_format = (
543-
_handle_zarr_version_or_format(
544-
zarr_version=zarr_version,
545-
zarr_format=zarr_format,
546-
)
547-
or _default_zarr_format()
548-
)
513+
zarr_format = zarr_format or _default_zarr_format()
549514

550515
for arg in args:
551516
if not isinstance(arg, NDArrayLike):
@@ -636,7 +601,6 @@ async def group(
636601
cache_attrs: bool | None = None, # not used, default changed
637602
synchronizer: Any | None = None, # not used
638603
path: str | None = None,
639-
zarr_version: ZarrFormat | None = None, # deprecated
640604
zarr_format: ZarrFormat | None = None,
641605
meta_array: Any | None = None, # not used
642606
attributes: dict[str, JSON] | None = None,
@@ -689,7 +653,6 @@ async def group(
689653
cache_attrs=cache_attrs,
690654
synchronizer=synchronizer,
691655
path=path,
692-
zarr_version=zarr_version,
693656
zarr_format=zarr_format,
694657
meta_array=meta_array,
695658
attributes=attributes,
@@ -758,7 +721,6 @@ async def open_group(
758721
path: str | None = None,
759722
chunk_store: StoreLike | None = None, # not used
760723
storage_options: dict[str, Any] | None = None,
761-
zarr_version: ZarrFormat | None = None, # deprecated
762724
zarr_format: ZarrFormat | None = None,
763725
meta_array: Any | None = None, # not used
764726
attributes: dict[str, JSON] | None = None,
@@ -820,8 +782,6 @@ async def open_group(
820782
The new group.
821783
"""
822784

823-
zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
824-
825785
if cache_attrs is not None:
826786
warnings.warn("cache_attrs is not yet implemented", ZarrRuntimeWarning, stacklevel=2)
827787
if synchronizer is not None:
@@ -875,7 +835,6 @@ async def create(
875835
object_codec: Codec | None = None, # TODO: type has changed
876836
dimension_separator: Literal[".", "/"] | None = None,
877837
write_empty_chunks: bool | None = None,
878-
zarr_version: ZarrFormat | None = None, # deprecated
879838
zarr_format: ZarrFormat | None = None,
880839
meta_array: Any | None = None, # TODO: need type
881840
attributes: dict[str, JSON] | None = None,
@@ -1017,10 +976,7 @@ async def create(
1017976
z : array
1018977
The array.
1019978
"""
1020-
zarr_format = (
1021-
_handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
1022-
or _default_zarr_format()
1023-
)
979+
zarr_format = zarr_format or _default_zarr_format()
1024980

1025981
if synchronizer is not None:
1026982
warnings.warn("synchronizer is not yet implemented", ZarrRuntimeWarning, stacklevel=2)
@@ -1224,7 +1180,6 @@ async def ones_like(
12241180
async def open_array(
12251181
*, # note: this is a change from v2
12261182
store: StoreLike | None = None,
1227-
zarr_version: ZarrFormat | None = None, # deprecated
12281183
zarr_format: ZarrFormat | None = None,
12291184
path: PathLike = "",
12301185
storage_options: dict[str, Any] | None = None,
@@ -1238,8 +1193,6 @@ async def open_array(
12381193
StoreLike object to open. See the
12391194
[storage documentation in the user guide][user-guide-store-like]
12401195
for a description of all valid StoreLike values.
1241-
zarr_version : {2, 3, None}, optional
1242-
The zarr format to use when saving. Deprecated in favor of zarr_format.
12431196
zarr_format : {2, 3, None}, optional
12441197
The zarr format to use when saving.
12451198
path : str, optional
@@ -1259,8 +1212,6 @@ async def open_array(
12591212
mode = kwargs.pop("mode", None)
12601213
store_path = await make_store_path(store, path=path, mode=mode, storage_options=storage_options)
12611214

1262-
zarr_format = _handle_zarr_version_or_format(zarr_version=zarr_version, zarr_format=zarr_format)
1263-
12641215
if "write_empty_chunks" in kwargs:
12651216
_warn_write_empty_chunks_kwarg()
12661217

‎src/zarr/api/synchronous.py‎

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,6 @@ def load(
134134
store: StoreLike,
135135
path: str | None = None,
136136
zarr_format: ZarrFormat | None = None,
137-
zarr_version: ZarrFormat | None = None,
138137
) -> NDArrayLikeOrScalar | dict[str, NDArrayLikeOrScalar]:
139138
"""Load data from an array or group into memory.
140139
@@ -163,16 +162,13 @@ def load(
163162
If loading data from a group of arrays, data will not be immediately loaded into
164163
memory. Rather, arrays will be loaded into memory as they are requested.
165164
"""
166-
return sync(
167-
async_api.load(store=store, zarr_version=zarr_version, zarr_format=zarr_format, path=path)
168-
)
165+
return sync(async_api.load(store=store, zarr_format=zarr_format, path=path))
169166

170167

171168
def open(
172169
store: StoreLike | None = None,
173170
*,
174171
mode: AccessModeLiteral | None = None,
175-
zarr_version: ZarrFormat | None = None, # deprecated
176172
zarr_format: ZarrFormat | None = None,
177173
path: str | None = None,
178174
storage_options: dict[str, Any] | None = None,
@@ -212,7 +208,6 @@ def open(
212208
async_api.open(
213209
store=store,
214210
mode=mode,
215-
zarr_version=zarr_version,
216211
zarr_format=zarr_format,
217212
path=path,
218213
storage_options=storage_options,
@@ -237,7 +232,6 @@ def open_consolidated(*args: Any, use_consolidated: Literal[True] = True, **kwar
237232
def save(
238233
store: StoreLike,
239234
*args: NDArrayLike,
240-
zarr_version: ZarrFormat | None = None, # deprecated
241235
zarr_format: ZarrFormat | None = None,
242236
path: str | None = None,
243237
**kwargs: Any, # TODO: type kwargs as valid args to async_api.save
@@ -259,18 +253,13 @@ def save(
259253
**kwargs
260254
NumPy arrays with data to save.
261255
"""
262-
return sync(
263-
async_api.save(
264-
store, *args, zarr_version=zarr_version, zarr_format=zarr_format, path=path, **kwargs
265-
)
266-
)
256+
return sync(async_api.save(store, *args, zarr_format=zarr_format, path=path, **kwargs))
267257

268258

269259
def save_array(
270260
store: StoreLike,
271261
arr: NDArrayLike,
272262
*,
273-
zarr_version: ZarrFormat | None = None, # deprecated
274263
zarr_format: ZarrFormat | None = None,
275264
path: str | None = None,
276265
storage_options: dict[str, Any] | None = None,
@@ -303,7 +292,6 @@ def save_array(
303292
async_api.save_array(
304293
store=store,
305294
arr=arr,
306-
zarr_version=zarr_version,
307295
zarr_format=zarr_format,
308296
path=path,
309297
storage_options=storage_options,
@@ -315,7 +303,6 @@ def save_array(
315303
def save_group(
316304
store: StoreLike,
317305
*args: NDArrayLike,
318-
zarr_version: ZarrFormat | None = None, # deprecated
319306
zarr_format: ZarrFormat | None = None,
320307
path: str | None = None,
321308
storage_options: dict[str, Any] | None = None,
@@ -348,7 +335,6 @@ def save_group(
348335
async_api.save_group(
349336
store,
350337
*args,
351-
zarr_version=zarr_version,
352338
zarr_format=zarr_format,
353339
path=path,
354340
storage_options=storage_options,
@@ -385,7 +371,6 @@ def group(
385371
cache_attrs: bool | None = None, # not used, default changed
386372
synchronizer: Any | None = None, # not used
387373
path: str | None = None,
388-
zarr_version: ZarrFormat | None = None, # deprecated
389374
zarr_format: ZarrFormat | None = None,
390375
meta_array: Any | None = None, # not used
391376
attributes: dict[str, JSON] | None = None,
@@ -435,7 +420,6 @@ def group(
435420
cache_attrs=cache_attrs,
436421
synchronizer=synchronizer,
437422
path=path,
438-
zarr_version=zarr_version,
439423
zarr_format=zarr_format,
440424
meta_array=meta_array,
441425
attributes=attributes,
@@ -454,7 +438,6 @@ def open_group(
454438
path: str | None = None,
455439
chunk_store: StoreLike | None = None, # not used in async api
456440
storage_options: dict[str, Any] | None = None, # not used in async api
457-
zarr_version: ZarrFormat | None = None, # deprecated
458441
zarr_format: ZarrFormat | None = None,
459442
meta_array: Any | None = None, # not used in async api
460443
attributes: dict[str, JSON] | None = None,
@@ -525,7 +508,6 @@ def open_group(
525508
path=path,
526509
chunk_store=chunk_store,
527510
storage_options=storage_options,
528-
zarr_version=zarr_version,
529511
zarr_format=zarr_format,
530512
meta_array=meta_array,
531513
attributes=attributes,
@@ -606,7 +588,6 @@ def create(
606588
object_codec: Codec | None = None, # TODO: type has changed
607589
dimension_separator: Literal[".", "/"] | None = None,
608590
write_empty_chunks: bool | None = None, # TODO: default has changed
609-
zarr_version: ZarrFormat | None = None, # deprecated
610591
zarr_format: ZarrFormat | None = None,
611592
meta_array: Any | None = None, # TODO: need type
612593
attributes: dict[str, JSON] | None = None,
@@ -769,7 +750,6 @@ def create(
769750
object_codec=object_codec,
770751
dimension_separator=dimension_separator,
771752
write_empty_chunks=write_empty_chunks,
772-
zarr_version=zarr_version,
773753
zarr_format=zarr_format,
774754
meta_array=meta_array,
775755
attributes=attributes,
@@ -1309,7 +1289,6 @@ def ones_like(a: ArrayLike, **kwargs: Any) -> Array:
13091289
def open_array(
13101290
store: StoreLike | None = None,
13111291
*,
1312-
zarr_version: ZarrFormat | None = None,
13131292
zarr_format: ZarrFormat | None = None,
13141293
path: PathLike = "",
13151294
storage_options: dict[str, Any] | None = None,
@@ -1323,8 +1302,6 @@ def open_array(
13231302
StoreLike object to open. See the
13241303
[storage documentation in the user guide][user-guide-store-like]
13251304
for a description of all valid StoreLike values.
1326-
zarr_version : {2, 3, None}, optional
1327-
The zarr format to use when saving. Deprecated in favor of zarr_format.
13281305
zarr_format : {2, 3, None}, optional
13291306
The zarr format to use when saving.
13301307
path : str, optional
@@ -1345,7 +1322,6 @@ def open_array(
13451322
sync(
13461323
async_api.open_array(
13471324
store=store,
1348-
zarr_version=zarr_version,
13491325
zarr_format=zarr_format,
13501326
path=path,
13511327
storage_options=storage_options,

‎src/zarr/core/common.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,5 +221,5 @@ def _warn_order_kwarg() -> None:
221221

222222

223223
def _default_zarr_format() -> ZarrFormat:
224-
"""Return the default zarr_version"""
224+
"""Return the default zarr format"""
225225
return cast("ZarrFormat", int(zarr_config.get("default_zarr_format", 3)))

0 commit comments

Comments
 (0)