diff options
author | Bas van Beek <b.f.van.beek@vu.nl> | 2021-04-30 22:09:41 +0200 |
---|---|---|
committer | Bas van Beek <b.f.van.beek@vu.nl> | 2021-04-30 22:09:51 +0200 |
commit | 0a045bb31eb0503969352be4071cb0c848176427 (patch) | |
tree | a50daee07732e79fde5775a77bc33f49a5cbaaa6 /numpy | |
parent | a90cbc7476902811f94044cbfedaeb6bbcd17413 (diff) | |
download | numpy-0a045bb31eb0503969352be4071cb0c848176427.tar.gz |
DOC: Add a segment to the `numpy.typing` docs about 0D arrays
Diffstat (limited to 'numpy')
-rw-r--r-- | numpy/typing/__init__.py | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/numpy/typing/__init__.py b/numpy/typing/__init__.py index 88a568537..a2d4c60fb 100644 --- a/numpy/typing/__init__.py +++ b/numpy/typing/__init__.py @@ -140,6 +140,20 @@ Timedelta64 The `~numpy.timedelta64` class is not considered a subclass of `~numpy.signedinteger`, the former only inheriting from `~numpy.generic` while static type checking. +0D arrays +~~~~~~~~~ + +During runtime numpy aggressively casts any passed 0D arrays into their +corresponding `~numpy.generic` instance. Until the introduction of shape +typing (see :pep:`646`) it is unfortunately not possible to make the +necessary distinction between 0D and >0D arrays. While thus not strictly +correct, all operations are that can potentially perform a 0D-array -> scalar +cast are currently annotated as exclusively returning an `ndarray`. + +If it is known in advance that an operation _will_ perform a +0D-array -> scalar cast, then one can consider manually remedying the +situation with either `typing.cast` or a ``# type: ignore`` comment. + API --- |