MAINT: simplifying annotations for np.core.from_numeric #16556
Merged
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
added 4 commits
June 9, 2020 23:29
* Affects a set of <20 functions from ``np.core.fromnumeric``. * Based on feedback from numpy/numpy-stubs#71.
* Continuation of 09c2204.
|
The tests have been fixed as of 0f7f6a9. If there are no further comments then the pull request can be merged, as far as I'm concerned. |
|
Thanks @BvB93! |
eric-wieser
reviewed
Jun 10, 2020
| ) -> Union[integer, bool_]: ... | ||
| @overload | ||
| def choose( | ||
| a: _ArrayLikeIntOrBool, | ||
| choices: Union[Sequence[ArrayLike], ndarray], | ||
| choices: ArrayLike, |
There was a problem hiding this comment.
Suggested change
| choices: ArrayLike, | |
| choices: Sequence[ArrayLike], |
I think it's important to emphasize that this input is not an array, as it means shapes like (0, 3) are not handled sensibly.
There was a problem hiding this comment.
Same for the other overload
There was a problem hiding this comment.
The tricky part is that, without proper shape support, expressing this will be either very difficult and/or verbose.
For example even Sequence[ArrayLike] does not include the likes of np.ndarray or pd.DataFrane, both of which are (strictly speaking) not proper sequences.
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.
In one of the last pull requests over at numpy-stubs (numpy/numpy-stubs#71) we had a discussion about the complexity of the pull requests' respective annotations, more specifically about the ones trying to express >0D array-like objects (vectors, matrices, etc.).
As the complexity of the annotations came at the detriment of their readability, we arrived at the conclusion that it would be best to simplify them in a future pull request.
This pull request thus addresses aforementioned issue:
ArrayLike.See Also