Deprecate blosc helper functions#619
Merged
dstansby merged 4 commits intozarr-developers:mainfrom Jan 4, 2025
dstansby:deprecate-blosc
Merged
Deprecate blosc helper functions#619dstansby merged 4 commits intozarr-developers:mainfrom dstansby:deprecate-blosc
dstansby merged 4 commits intozarr-developers:mainfrom
dstansby:deprecate-blosc
Conversation
normanrz
reviewed
Nov 9, 2024
| """Initialize the Blosc library environment.""" | ||
| blosc_init() | ||
|
|
||
| init = deprecated(_init) |
Member
There was a problem hiding this comment.
I guess decorators don't work in .pyx files?
Contributor
Author
There was a problem hiding this comment.
They probably do, but the idea here was to leave a non-deprecated version of the functions (starting with _) that we can call internally, and a deprecated version which has the same name as previous.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #619 +/- ##
=======================================
Coverage 99.92% 99.92%
=======================================
Files 62 62
Lines 2754 2754
=======================================
Hits 2752 2752
Misses 2 2
🚀 New features to boost your workflow:
|
Contributor
Author
|
Last call for comments - if no-one objects, I'll merge this in a couple of weeks. |
normanrz
approved these changes
Dec 30, 2024
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
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.
As a pre-requisite for depending on pre-built
bloscwheels (see #571, #262, #464), this deprecates several functions. The idea would be to have one deprecation cycle (say numdocecs 0.14), then remove the public functions in the next release (say numcodecs 0.15).This uses the
deprecatedlibrary to handle the deprecations, which does add a nother dependency, but it is quite lightweight.