8000 ENH: make typing module available at runtime by person142 · Pull Request #16558 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

ENH: make typing module available at runtime #16558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 17, 2020
Merged

ENH: make typing module available at runtime #16558

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e8a8f1
MAINT: make typing module available at runtime
person142 Jun 10, 2020
70130f8
DOC: add documentation for the numpy.typing module
person142 Jun 11, 2020
4a120f0
DOC: add warning about typing-extensions module to numpy.typing docs
person142 Jun 11, 2020
c88f5a2
DOC: add release note about `np.typing` being available at runtime
person142 Jun 14, 2020
c63f233
DOC: clarify `ArrayLike` example in typing docs
person142 Jun 16, 2020
347a368
DOC: add note about supporting buffer protocols in `ArrayLike`
person142 Jun 16, 2020
d985e8c
DOC: add reference to Python issue about buffer protocols
person142 Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
DOC: add reference to Python issue about buffer protocols
  • Loading branch information
@person142
person142 committed Jun 17, 2020
commit d985e8ca2fca154d3770c842a2da1ba6dc3aaf1c
6 changes: 4 additions & 2 deletions numpy/typing/_array_like.py
View file
Open 8000 in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ def __array__(self, dtype: DtypeLike = ...) -> ndarray: ...

# TODO: support buffer protocols once
#
# https://github.com/python/typing/issues/593
# https://bugs.python.org/issue27501
#
# is resolved. See also the mypy issue:
#
# is resolved.
# https://github.com/python/typing/issues/593
ArrayLike = Union[bool, int, float, complex, _SupportsArray, Sequence]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to support buffer protocols, but Python's typing doesn't support that yet. In the meantime I would suggest adding memoryview and a comment referencing python/typing#593

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since memoryviews are Sequences we do allow them currently, e.g.

import numpy as np

x = b'foobar'
v = memoryview(x)
np.array(v)

passes mypy. I will add the comment though.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a test explicitly for memoryviews though; I'll open an issue.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd highly recommend commenting on this B.P.O issue asking for support for a Buffer protocol in typing, as that is the better place than the typing issue: https://bugs.python.org/issue27501

0