Skip to content

Add full copy of zarr-python v2.18.7 under src/zarr/v2 #3075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jni
Copy link
Contributor

@jni jni commented May 21, 2025

This proposes to include a complete copy of zarr v2.18.7 under the zarr.v2
namespace. The goal is for libraries using the v2 API to be able to migrate
gradually, and not have to be environment-incompatible with libraries that have
fully migrated to v3. Such libraries could then do:

import zarr

if not zarr.__version__.startswith('2.'):
    import zarr.v2 as zarr

It would also buy us more time to improve the migration guide.

For more discussion, see this Zulip thread.

Currently, I have not imported it in zarr.__init__.py, so one would have to
explicitly import it to discover it. I think that's probably the right thing.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.rst
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label May 21, 2025
@jni
Copy link
Contributor Author

jni commented May 21, 2025

Hmm looks like I have a lot of test fixing in my future. 😂

@jeromekelleher
Copy link
Member

Thanks for doing this @jni - I think would personally very much appreciate this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs release notes Automatically applied to PRs which haven't added release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants