Skip to content

Add with_read_only() convenience method to store #3138

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

Merged
merged 13 commits into from
Jun 19, 2025

Conversation

maxrjones
Copy link
Member

This PR adds a Store.with_read_only() convenience method to create a new store with a different read mode. By default, the method raises a NotImplementedError. The motivation is to make it simpler for downstream libraries to adapt to the changes in #3068. For example, this would make it much simpler to address the 269 failures in Xarray's upstream test suite and the failures in VirtualiZarr's upstream test suite.

This is similar to the functionality added in #2249 and removed in #2442. @jhamman would you be able to offer any details on the motivation for previously removing the similar functionality?

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 Jun 17, 2025
@github-actions github-actions bot removed the needs release notes Automatically applied to PRs which haven't added release notes label Jun 18, 2025
Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice - looks great overall, have left some minor suggestions.

@dstansby dstansby added this to the 3.1.0 milestone Jun 19, 2025
@dstansby dstansby merged commit 286bef8 into zarr-developers:main Jun 19, 2025
30 checks passed
@maxrjones maxrjones deleted the with-read-only branch June 19, 2025 16:10
@d-v-b d-v-b modified the milestones: 3.1.0, 3.0.9 Jun 30, 2025
@d-v-b
Copy link
Contributor

d-v-b commented Jun 30, 2025

@meeseeksdev backport to 3.0.9

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.

3 participants