Skip to content

Commit 0322bbb

Browse files
author
maximeoliv
committed
docs: note LRUStoreCache removal in the 3.0 migration guide
LRUStoreCache was removed in Zarr-Python 3.0 without a deprecation warning in 2.x. The migration guide lists the other removed stores but not this one, so a user whose import fails has nothing to find. Point it at zarr.experimental.cache_store.CacheStore, which covers the same use case, and flag that it is experimental. Closes zarr-developers#2857
1 parent 7431699 commit 0322bbb

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

‎changes/2857.doc.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Note the removal of `LRUStoreCache` in the 3.0 migration guide, and point to `zarr.experimental.cache_store.CacheStore` as the closest replacement.

‎docs/user-guide/v3_migration.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,13 @@ If you are interested in developing a custom store that targets these backends,
184184
[developing custom stores](storage.md#developing-custom-stores) or open an
185185
[issue](https://github.com/zarr-developers/zarr-python/issues) to discuss your use case.
186186

187+
`LRUStoreCache` was also removed, without a deprecation warning in Zarr-Python 2. The
188+
closest replacement is [`zarr.experimental.cache_store.CacheStore`][], which wraps a
189+
source store and uses a second store as the cache backend, with size-based LRU eviction
190+
and optional time-based expiry. See [`CacheStore`](experimental.md#cachestore) in the
191+
experimental features guide; note that it carries no stability guarantees while it
192+
remains in `zarr.experimental`.
193+
187194
### Codecs
188195

189196
Codecs defined in ``numcodecs`` (and also imported into the ``zarr.codecs`` namespace in Zarr-Python 2)

0 commit comments

Comments
 (0)