Skip to content

Commit bd0dc84

Browse files
nuglifeleojiLeo Jid-v-bmaxrjones
authored
DOC: fix v3 migration guide store table (#3850)
* DOC: remove result="ansi" causing empty code blocks in user guide Closes #3506. Made-with: Cursor * DOC: fix store migration guide: remove broken row, add LRUStoreCache note Removes truncated table row and adds migration note for LRUStoreCache. Closes #2699. Closes #2857. Made-with: Cursor * docs: point LRUStoreCache migration note at CacheStore Move `LRUStoreCache` into the renamed-stores table, since it was never deprecated in 2.x, and point it at the experimental `zarr.experimental.cache_store.CacheStore`. Replace the nonexistent `fsspec.implementations.caching` module with `fsspec.implementations.cached`, and add the changelog fragment. Assisted-by: ClaudeCode:claude-opus-5-5 --------- Co-authored-by: Leo Ji <[email protected]> Co-authored-by: Davis Bennett <[email protected]> Co-authored-by: Max Jones <[email protected]>
1 parent 6599477 commit bd0dc84

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

‎changes/3850.doc.md‎

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

‎docs/user-guide/v3_migration.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,13 @@ The following stores have been renamed or changed:
165165
| `DirectoryStore` | [`zarr.storage.LocalStore`][] |
166166
| `FSStore` | [`zarr.storage.FsspecStore`][] |
167167
| `TempStore` | Use [`tempfile.TemporaryDirectory`][] with [`LocalStore`][zarr.storage.LocalStore] |
168+
| `LRUStoreCache` | [`zarr.experimental.cache_store.CacheStore`][] (experimental) |
169+
170+
`LRUStoreCache` has no stable equivalent in Zarr-Python 3. The experimental
171+
[`CacheStore`](experimental.md#cachestore) wraps a store and caches its contents in a second
172+
store, evicting the least recently used entries once `max_size` is reached. For remote data read
173+
through [`FsspecStore`][zarr.storage.FsspecStore], fsspec's caching filesystems
174+
(`fsspec.implementations.cached`, e.g. a `simplecache::s3://...` URL) are another option.
168175

169176
A number of deprecated stores were also removed.
170177
See [issue #1274](https://github.com/zarr-developers/zarr-python/issues/1274) for more details on the removal of these stores.

0 commit comments

Comments
 (0)