Repository navigation
Conversation
`synchronizer`, `chunk_store`, `cache_metadata`, `cache_attrs`, `object_codec`, `read_only` and `meta_array` are accepted by `create`, `group` and `open_group` (and by everything that wraps them, such as `zeros`) but have never done anything in Zarr-Python 3. Passing one used to emit a `ZarrRuntimeWarning` saying "not yet implemented", which read as a promise to implement it. Emit a `ZarrDeprecationWarning` instead, saying the argument is ignored and will be removed in a release after April 2027, and say the same in the docstrings and the v3 migration guide. Calls that do not pass these arguments are unaffected. First step of the plan for zarr-developers#3976.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4522 +/- ##
=======================================
Coverage 94.71% 94.71%
=======================================
Files 94 94
Lines 13663 13663
=======================================
Hits 12941 12941
Misses 722 722
🚀 New features to boost your workflow:
|
Contributor
|
i love this, thank you max! |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements the first step of the plan for #3976, by starting a deprecation cycle for all the Zarr-Python 2 era parameters that have no impact on the behavior in Zarr-Python 3.
For reviewers
It would be good to get an approval on the plan. Note I think this is mutually exclusive with #3215, which instead implements cache_attrs.
I would be tempted to shorten the standard cycle from warning to removal for these to 3+ months rather than 6+months, given we can be sure they weren't succesfully used and their inclusion can be harmfully confusing (in particular the
read_onlyunimplemented parameter).Author attestation
TODO
docs/user-guide/*.mdchanges/