DEP: Deprecate 'fix_imports' flag in numpy.save #26452
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
seberg
reviewed
May 16, 2024
numpy/lib/_npyio_impl.py
Outdated
| will try to map the new Python 3 names to the old module names used in | ||
| Python 2, so that the pickle data stream is readable with Python 2. | ||
| The `fix_imports` flag is deprecated and has no effect. | ||
| .. deprecated:: 2.0 |
There was a problem hiding this comment.
I would lean towards just not backporting, doesn't seem much of a deal. @charris want to make the call?
numpy/lib/_npyio_impl.py
Outdated
| Historically, this flag was used to control compatibility support | ||
| for objects saved in Python 3 to be loadable in Python 2. This flag | ||
| is ignored after NumPy 1.17, and deprecated in NumPy 2.0. It will | ||
| be removed in a future release. |
There was a problem hiding this comment.
Looks good as is, might suggest to shorten it a bit: This flag is ignored since NumPy 1.17 and was only needed to support loading some files in Python 2 written in Python 3.
seberg
reviewed
May 16, 2024
|
Thanks @vxst! |
|
Was about to merge and then I realized that this needs a release note too. Can you add one? |
ngoldbaum
added
the
56 - Needs Release Note.
|
Of course |
|
Sorry that I forgot deprecation needs a release note. |
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.
Since NumPy upgraded the pickle protocol version to 3 in version 1.17, the
fix_importsflag is ignored by the pickle library. To reduce confusion, I propose removing this flag in a future release.However, since many people actually use
numpy.save(..., allow_pickle=True, fix_imports=True)as default behavior (for example, see this example: intel/intel-extension-for-transformers), removing thefix_importskeyword may break compatibility with existing code.Following NEP 23, I suggest adding a check for the usage of the
fix_importskeyword and emitting aDeprecationWarningfor any usage.