MAINT: Ensure that re-exported sub-modules are properly annotated#18618
Merged
charris merged 3 commits intonumpy:mainfrom Mar 16, 2021
Merged
MAINT: Ensure that re-exported sub-modules are properly annotated#18618charris merged 3 commits intonumpy:mainfrom
charris merged 3 commits intonumpy:mainfrom
Conversation
added 2 commits
March 15, 2021 14:50
With `as_strided`, and the newly introduced `sliding_window_view` function, there are currently 2 public objects that can: a. Only be imported from a private module b. Are publicly documented to-be imported from aforementioned module Both observations are problematic and in need of rectification. This commit therefore moves `np.lib.stride_tricks` to the `PUBLIC_MODULES` list.
Ensures that type checkers will allow the likes of: >>> import numpy as np >>> out = np.lib.stride_tricks.sliding_window_view(...)
BvB93
commented
Mar 15, 2021
| "lib.mixins", | ||
| "lib.recfunctions", | ||
| "lib.scimath", | ||
| "lib.stride_tricks", |
Member
Author
There was a problem hiding this comment.
With as_strided, and the newly introduced sliding_window_view function, there are currently 2
public objects in lib.stride_tricks that can:
a. Only be imported from a private module.
b. Are publicly documented to-be imported from aforementioned module.
Because of this lib.stride_tricks has now been (formally) moved to the list of public modules.
Member
There was a problem hiding this comment.
@rgommers Thoughts about adding lib.stride_tricks to the list of public modules?
charris
reviewed
Mar 16, 2021
charris
approved these changes
Mar 16, 2021
… list Aforementioned module was accidently marked as public
Member
|
Thanks Bas. |
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
3 participants
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.
closes #18601.
Sub-modules, such as
np.linalg, must be explicitly imported in the main namespaces' stub file if one wantsto access the sub-module via a
getattroperation, i.e. so that one can directly usenp.linalg.normratherthan
import numpy.linalg; np.linalg.norm.While this was taken care of in the main numpy namespace, the relevant annotations were missing for others
such as
np.lib.*. This PR fixes aforementioned issue.Examples
The behavior prior to this PR:
Mypy output: