diff --git a/changes/3118.doc.md b/changes/3118.doc.md deleted file mode 100644 index 58adb1db76..0000000000 --- a/changes/3118.doc.md +++ /dev/null @@ -1 +0,0 @@ -Use mkdocs-material for Zarr-Python documentation \ No newline at end of file diff --git a/changes/3303.doc.md b/changes/3303.doc.md deleted file mode 100644 index ebae05f7e4..0000000000 --- a/changes/3303.doc.md +++ /dev/null @@ -1 +0,0 @@ -Document different values of StoreLike with examples in the user guide. \ No newline at end of file diff --git a/changes/3304.feature.md b/changes/3304.feature.md deleted file mode 100644 index 45dbd85731..0000000000 --- a/changes/3304.feature.md +++ /dev/null @@ -1,2 +0,0 @@ -The `Array` class can now also be parametrized in the same manner as the `AsyncArray` class, allowing Zarr format v2 and v3 `Array`s to be distinguished. -New types have been added to `zarr.types` to help with this. diff --git a/changes/3366.feature.md b/changes/3366.feature.md deleted file mode 100644 index 550c9f4436..0000000000 --- a/changes/3366.feature.md +++ /dev/null @@ -1 +0,0 @@ -Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. \ No newline at end of file diff --git a/changes/3483.bugfix.md b/changes/3483.bugfix.md deleted file mode 100644 index b6672d348a..0000000000 --- a/changes/3483.bugfix.md +++ /dev/null @@ -1 +0,0 @@ -Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. \ No newline at end of file diff --git a/changes/3490.feature.md b/changes/3490.feature.md deleted file mode 100644 index 899cdcf75d..0000000000 --- a/changes/3490.feature.md +++ /dev/null @@ -1 +0,0 @@ -Adds a `zarr.experimental` module for unstable user-facing features. \ No newline at end of file diff --git a/changes/3502.doc.md b/changes/3502.doc.md deleted file mode 100644 index 031c046bf4..0000000000 --- a/changes/3502.doc.md +++ /dev/null @@ -1 +0,0 @@ -Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. \ No newline at end of file diff --git a/changes/3515.misc.md b/changes/3515.misc.md deleted file mode 100644 index 06a94c98a0..0000000000 --- a/changes/3515.misc.md +++ /dev/null @@ -1 +0,0 @@ -Replace `crc32c` dependency with `google-crc32c` to resolve licensing concerns. The `crc32c` library uses LGPL license, while `google-crc32c` uses the more permissive Apache 2.0 license. This change maintains full backward compatibility with existing CRC32C-encoded data. diff --git a/changes/3530.bugfix.md b/changes/3530.bugfix.md deleted file mode 100644 index 36a1787a3a..0000000000 --- a/changes/3530.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained - extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). \ No newline at end of file diff --git a/changes/3532.misc.md b/changes/3532.misc.md deleted file mode 100644 index 0249aa899c..0000000000 --- a/changes/3532.misc.md +++ /dev/null @@ -1,2 +0,0 @@ -Accept `"bytes"` as an alias for `"variable_length_bytes"` when parsing `JSON`-encoded Zarr V3 -data types. \ No newline at end of file diff --git a/changes/3533.misc.md b/changes/3533.misc.md deleted file mode 100644 index 237efc9b5b..0000000000 --- a/changes/3533.misc.md +++ /dev/null @@ -1 +0,0 @@ -Reduced the runtime of the test suite by simplifying test cases. \ No newline at end of file diff --git a/changes/3535.bugfix.md b/changes/3535.bugfix.md deleted file mode 100644 index 7e1ce8f834..0000000000 --- a/changes/3535.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when -consolidated metadata was not used, resulting in invalid metadata documents. \ No newline at end of file diff --git a/changes/3536.doc.md b/changes/3536.doc.md deleted file mode 100644 index 742a0cc3db..0000000000 --- a/changes/3536.doc.md +++ /dev/null @@ -1 +0,0 @@ -Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. diff --git a/changes/3547.feature.md b/changes/3547.feature.md deleted file mode 100644 index 280f577804..0000000000 --- a/changes/3547.feature.md +++ /dev/null @@ -1 +0,0 @@ -Add a `array.target_shard_size_bytes` to [`zarr.config`][] to allow users to set a maximum number of bytes per-shard when `shards="auto"` in, for example, [`zarr.create_array`][]. \ No newline at end of file diff --git a/changes/3553.misc.md b/changes/3553.misc.md deleted file mode 100644 index 1354b2da56..0000000000 --- a/changes/3553.misc.md +++ /dev/null @@ -1 +0,0 @@ -Changes the internal logic of the `BloscCodec` class to ensure that the `typesize` and `shuffle` parameters are not set to `None` when creating a new instance of `BloscCodec`. \ No newline at end of file diff --git a/changes/3556.feature.md b/changes/3556.feature.md deleted file mode 100644 index 3b51c2c99e..0000000000 --- a/changes/3556.feature.md +++ /dev/null @@ -1 +0,0 @@ -Make `async_array` on the [`zarr.Array`][] class public (`_async_array` will remain untouched, but its stability is not guaranteed). diff --git a/changes/3560.bugfix.md b/changes/3560.bugfix.md deleted file mode 100644 index c3306cb6ac..0000000000 --- a/changes/3560.bugfix.md +++ /dev/null @@ -1 +0,0 @@ -Improve write performance to large shards by up to 10x. diff --git a/docs/release-notes.md b/docs/release-notes.md index 9e809f194e..6ac2f0100f 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,6 +2,38 @@ +# 3.14 (2025-11-20) + +### Features + +- The `Array` class can now also be parametrized in the same manner as the `AsyncArray` class, allowing Zarr format v2 and v3 `Array`s to be distinguished. + New types have been added to `zarr.types` to help with this. ([#3304](https://github.com/zarr-developers/zarr-python/issues3304)) +- Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/issues3366)) +- Adds a `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) +- Add a `array.target_shard_size_bytes` to [`zarr.config`][] to allow users to set a maximum number of bytes per-shard when `shards="auto"` in, for example, [`zarr.create_array`][]. ([#3547](https://github.com/zarr-developers/zarr-python/issues3547)) +- Make `async_array` on the [`zarr.Array`][] class public (`_async_array` will remain untouched, but its stability is not guaranteed). ([#3556](https://github.com/zarr-developers/zarr-python/issues3556)) + +### Bugfixes + +- Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) +- Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained + extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). ([#3530](https://github.com/zarr-developers/zarr-python/issues3530)) +- Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when + consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/issues3535)) +- Improve write performance to large shards by up to 10x. ([#3560](https://github.com/zarr-developers/zarr-python/issues3560)) + +### Improved Documentation + +- Use mkdocs-material for Zarr-Python documentation ([#3118](https://github.com/zarr-developers/zarr-python/issues3118)) +- Document different values of StoreLike with examples in the user guide. ([#3303](https://github.com/zarr-developers/zarr-python/issues3303)) +- Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. ([#3502](https://github.com/zarr-developers/zarr-python/issues3502)) +- Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. ([#3536](https://github.com/zarr-developers/zarr-python/issues3536)) + +### Misc + +- [#3515](https://github.com/zarr-developers/zarr-python/issues3515), [#3532](https://github.com/zarr-developers/zarr-python/issues3532), [#3533](https://github.com/zarr-developers/zarr-python/issues3533), [#3553](https://github.com/zarr-developers/zarr-python/issues3553) + + # zarr 3.1.3 (2025-09-18) ## Features