Skip to content

Require zarr>=3 so environments can open v2 API exports - #189

Open
amarcozzi wants to merge 1 commit into
mainfrom
pin-zarr-v3
Open

Require zarr>=3 so environments can open v2 API exports#189
amarcozzi wants to merge 1 commit into
mainfrom
pin-zarr-v3

Conversation

@amarcozzi

Copy link
Copy Markdown
Contributor

Client-side half of silvxlabs/FastFuels-API-v2#447. Paired with the API change that pins the zarr export to format v3 explicitly.

The SDK never imports zarr — the dependency exists so that a user's environment can open the zipped-Zarr grid exports the API hands out via signed download URLs. Those exports are Zarr format v3, and zarr-python 2.x cannot read v3 at all, so an unpinned zarr that resolves to 2.x leaves the user unable to open an export the SDK just downloaded for them.

This mainly affects v1 migrants:

v1:  zarr==2.18.2   -> exports were format v2
v2:  zarr 3.x       -> exports are format v3

An environment carried over from v1 can be sitting on a zarr that silently cannot read v2 exports. zarr>=3 makes installing the SDK sufficient to open what it downloads.

Changes

  • "zarr" -> "zarr>=3" in pyproject.toml, with a comment explaining that the dep is not imported and exists to provision the user's environment.

Release

Version is dynamic via hatch-vcs, so there's no version field to bump — this needs a tag/publish to reach users.

The SDK never imports zarr; the dependency exists so that a user's
environment can open the zipped-Zarr grid exports the API hands out via
signed download URLs. Those exports are Zarr format v3, and zarr-python 2.x
cannot read v3 at all, so an unpinned `zarr` that resolves to 2.x leaves the
user unable to open an export the SDK just downloaded for them.

This mainly affects v1 migrants: v1 pinned zarr==2.18.2 and handed out format
v2, so an environment carried over from v1 can be on a zarr that silently
cannot read v2 exports.

Refs silvxlabs/FastFuels-API-v2#447
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant