ENH: set correct __module__ for objects in numpy's public API #12382
Conversation
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
Fixes numpyGH-12271 Tests verify that everything in ``dir(numpy)`` either has ``__module__`` set to ``'numpy'``, or appears in an explicit whitelist of undocumented functions and exported bulitins. These should eventually be documented or removed. I also identified a handful of functions for which I had accidentally not setup dispatch for with ``__array_function__`` before, because they were listed under "ndarray methods" in ``_add_newdocs.py``. I guess that should be a lesson in trusting code comments :).
eric-wieser
reviewed
Nov 14, 2018
| 'set_string_function': 'numpy.core.arrayprint.set_string_function', | ||
| 'show_config': 'numpy.__config__.show', | ||
| 'str': 'builtins.str', | ||
| 'unicode': 'builtins.str', |
There was a problem hiding this comment.
Can you group together the builtins aliases, perhaps even as a separate dictionary?
45253eb to
fc73a3b
Compare
|
The downside is that it is harder to find the actual location. Oh, well, there is still grep. Seems like something that could use a mention in the release notes, but I can't figure where :) Maybe compatibility notes? |
|
I actually already wrote release notes for this as part of one of my |
|
OK, in it goes. Thanks Stephan. |
|
This appears to have broken PyPy support (#12740), since PyPy treats |
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.
Fixes #12271
Tests verify that everything in
dir(numpy)either has__module__set to'numpy', or appears in an explicit whitelist of undocumented functions and exported bulitins. These should eventually be documented or removed.I also identified a handful of functions for which I had accidentally not setup dispatch for with
__array_function__before, mostly because they were listed under "ndarray methods" in_add_newdocs.py. I guess that should be a lesson in trusting code comments :).