Deprecate the experimental v3 implementation #1802
Merged
Conversation
This file contains 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
…the experimental v3 implementation
joshmoore
approved these changes
Apr 19, 2024
| @@ -22,9 +23,21 @@ | |||
| DEFAULT_ZARR_VERSION = 2 | |||
|
|
|||
| v3_api_available = os.environ.get("ZARR_V3_EXPERIMENTAL_API", "0").lower() not in ["0", "false"] | |||
| _has_warned_about_v3 = False # to avoid printing the warning multiple times | |||
There was a problem hiding this comment.
I thought this was the default but 🤷🏽
https://docs.python.org/3/library/warnings.html#the-warnings-filter
There was a problem hiding this comment.
I certainly tried this first. It's possible this would have worked if I had put warning elsewhere, but as implemented, the warning is emitted multiple times without this switch. I think this is due to the fact that assert_zarr_v3_api_available is used in various places around the library.
| global _has_warned_about_v3 | ||
| if v3_api_available and not _has_warned_about_v3: | ||
| warnings.warn( | ||
| "The experimental Zarr V3 implementation in this version of Zarr-Python is not " |
There was a problem hiding this comment.
❤️
(TIL emoji names are case sensitive)
…into dep/experimental-v3-impl
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1802 +/- ##
=======================================
Coverage 99.98% 99.98%
=======================================
Files 38 38
Lines 14640 14655 +15
=======================================
+ Hits 14638 14653 +15
Misses 2 2
|
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a FutureWarning to
assert_zarr_v3_api_availableto alert users that this version of Zarr is being replaced with a spec complaint v3 version.TODO: