ENH: Added annotations to 8 functions from np.core.fromnumeric #16647
Conversation
Newly annotated functions: * `clip` * `sum` * `all` * `any` * `cumsum` * `ptp` * `amax` * `amin`
| _ArrayLikeBool = Union[ | ||
| _Bool, | ||
| Sequence[_Bool], | ||
| ndarray |
There was a problem hiding this comment.
Soon we will have ndarray generic over dtype...
There was a problem hiding this comment.
Yeah, I feel this is gona be a biiiiiig help.
numpy/__init__.pyi
Outdated
| @overload | ||
| def clip( | ||
| a: _Number, | ||
| a_min: Optional[ArrayLike], |
There was a problem hiding this comment.
a_min and a_max can't both be None, so you could get more specific here with even more overloads.
There was a problem hiding this comment.
Added in 4d3641e.
mypy's error for assigning NoReturn are, unfortunately, not the most descriptive, but it will have to do.
There was a problem hiding this comment.
Can't you do better, by defining:
a_min: ArrayLike,
a_max: Optional[ArrayLike],
and an overload,
a_min: None,
a_max: ArrayLike,
There was a problem hiding this comment.
I actually hadn't considered that; good idea.
Implemented in 9e59f57.
Raise an exception if `a_min` and `a_max` are both `None`
|
Thanks for the feedback everyone! |
|
LGTM, thanks @BvB93. |
This pull request adds annotations to eight functions from
numpy.core.fromgeneric:clip()sum()all()any()cumsum()ptp()amax()amin()