GH-49684: [MATLAB] Introduce deprecation warnings for "legacy" Feather V1 functions featherread and featherwrite#49705
Open
kevingurney wants to merge 4 commits intoapache:mainfrom
Open
GH-49684: [MATLAB] Introduce deprecation warnings for "legacy" Feather V1 functions featherread and featherwrite#49705kevingurney wants to merge 4 commits intoapache:mainfrom
featherread and featherwrite#49705kevingurney wants to merge 4 commits intoapache:mainfrom
Conversation
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
|
|
Co-authored-by: Sarah Gilmore <sgilmore@mathworks.com>
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.
Rationale for this change
In response to #49231 and https://lists.apache.org/thread/1npvnhjb1xwz09zh8vnd079zt2q4o08l, this pull request introduces deprecation warnings for the public MATLAB
featherreadandfeatherwriteAPIs that allow reading and writing "legacy" Feather V1 files.The solution of introducing deprecation warnings follows the pyarrow approach proposed in #49590.
Examples
featherreadfeatherwriteWhat changes are included in this PR?
arrow:io:feather:v1:FeatherWriteDeprecatedwhen callingfeatherwrite.m.arrow:io:feather:v1:FeatherReadDeprecatedwhen callingfeatherread.m.Are these changes tested?
Yes.
matlab/test/tfeather.mto suppressfeatherreadandfeatherwritedeprecation warnings.tfeather.m:VerifyFeatherReadDeprecationWarningandVerifyFeatherWriteDeprecationWarning. These test cases verify that the expected deprecation warnings are issued as expected.matlab/test/arrow/io/feather/tRoundTrip.mto suppressfeatherreaddeprecation warnings.Are there any user-facing changes?
Yes.
featherreadandfeatherwritefunctions are user-facing. With these changes, deprecation warnings will be displayed when invoking either of these functions. Note: these warnings can be turned off in MATLAB by callingwarning("off", "arrow:io:feather:v1:FeatherWriteDeprecated")andwarning("off", "arrow:io:feather:v1:FeatherReadDeprecated").Future Directions
featherreadandfeatherwriteinto a package likearrow.io.feather.v1.*to mirror the rest of the mlarrow APIs. Alternatively, we could consider removing these functions entirely.Notes
featherreadandfeatherwrite#49684