skills/zarr-python/references/v3_migration.md
Targets zarr 3.2.x (PyPI stable, May 2026). Official guide: 3.0 Migration Guide.
| Topic | Zarr-Python 2 | Zarr-Python 3 |
|---|---|---|
| Pin while migrating downstream | zarr>=2,<3 | zarr>=3,<4 |
| Default on-disk format | Zarr v2 | Zarr v3 (zarr_format=3) |
| Write v2-compatible data | default | zarr_format=2 on create/open |
| Python requirement | 3.9–3.11 (late 2.x) | 3.12+ (3.2.1 on PyPI) |
# Keep writing Zarr format 2 arrays (interop with older tools)
z = zarr.create_array(store="data.zarr", shape=(1000, 1000), chunks=(100, 100),
dtype="f4", zarr_format=2)
# v3 — stores live under zarr.storage
from zarr.storage import LocalStore, MemoryStore, ZipStore, FsspecStore
| v2 | v3 |
|---|---|
DirectoryStore | LocalStore |
FSStore | FsspecStore |
TempStore | tempfile.TemporaryDirectory + LocalStore |
S3Map / GCSMap (s3fs/gcsfs) | Prefer FsspecStore or URI strings (see below) |
DBMStore, LMDBStore, SQLiteStore, RedisStore, MongoDBStore | Removed — use FsspecStore or custom store |
import zarr
# URI + storage_options (requires s3fs for S3)
root = zarr.open_group(
store="s3://my-bucket/path/data.zarr",
mode="r",
storage_options={"anon": False}, # uses AWS_* env vars via fsspec
)
# Explicit FsspecStore
from zarr.storage import FsspecStore
store = FsspecStore.from_url("s3://my-bucket/path/data.zarr", storage_options={"anon": False})
root = zarr.open_group(store=store, mode="r")
Install remote I/O extras: uv pip install "zarr[remote]" (pulls fsspec). Add s3fs or gcsfs for the target protocol.
zarr.codecs.* (e.g. BloscCodec, GzipCodec, BytesCodec) via compressors= on create_array.numcodecs codecs still work; import from numcodecs, not zarr.*.compressor= kwarg on creation functions → use compressors= in v3.from zarr.codecs import BloscCodec
z = zarr.create_array(
store="data.zarr", shape=(1000, 1000), chunks=(100, 100), dtype="f4",
compressors=BloscCodec(cname="zstd", clevel=5, shuffle="shuffle"),
)
| v2 (removed in v3) | v3 replacement |
|---|---|
group.create_dataset(...) | group.create_array(...) |
group.require_dataset(...) | group.require_array(...) |
group.foo attribute access | group["foo"] only |
# resize — pass a shape tuple, not separate dimension args
z.resize((15000, 15000)) # not z.resize(15000, 15000)
Advanced indexing: vindex, oindex, and blocks remain as convenience properties; equivalent methods are get_coordinate_selection, get_orthogonal_selection, etc.
From the migration guide WIP list:
synchronizer argument (ThreadSynchronizer, ProcessSynchronizer) — use separate chunks per writer or external coordination; see performance guide — thread safety.zarr.copy, zarr.copy_all, zarr.copy_store, Group.movecache_attrs, cache_metadata, chunk_storeInstall last 2.x: uv pip install "zarr==2.*". Maintenance lives on the support/v2 branch (security fixes for ~6 months after 3.0).