ENH: add type stubs from numpy-stubs #16515
DOC: Add a release note about types being added
- Loading branch information
commit 7c0d99d99c2034930e558d8b0fb48869964a41f0
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| NumPy is now typed | ||
| ------------------ | ||
| Type annotations have been added for large parts of NumPy. There is | ||
| also a new `numpy.typing` module that contains useful types for | ||
| end-users. The currently available types are | ||
|
|
||
| - ``ArrayLike``: for objects that can be coerced to an array | ||
| - ``DtypeLike``: for objects that can be coerced to a dtype | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@person142, sorry for being late to the party. Should we make this DTypeLike with a capital T? I have been using DType for the dtype classes (I guess as a short form of the camel-case DataType. I am happy to use this one as well, would be good to keep it in sync).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is, unless this actually includes concrete instances, such as strings of specific length. In that case it may actually be better to use different spellings. I would have to review the discussion on that...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm @seberg could you open an issue? I think “DtypeLike” was originally “things that can be passed into
np.dtype“, and with the dtype changes we should think carefully about what makes sense...