summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorSebastian Berg <sebastian@sipsolutions.net>2020-11-03 09:05:52 -0600
committerGitHub <noreply@github.com>2020-11-03 09:05:52 -0600
commit4c83c0444c68b89b051f7ef8d8eb1a2276439d78 (patch)
tree96303e2aa21c616b6a2379489e83ad47371aeeed /numpy
parent9dca4085c724b3e62d54dee33e42ebdba3bb975c (diff)
parentc4684bb542db2690e678d22bf32745e484ef04e3 (diff)
downloadnumpy-4c83c0444c68b89b051f7ef8d8eb1a2276439d78.tar.gz
Merge pull request #17699 from BvB93/DTypeLike
MAINT: Rename `DtypeLike` to `DTypeLike`
Diffstat (limited to 'numpy')
-rw-r--r--numpy/__init__.pyi98
-rw-r--r--numpy/core/_asarray.pyi14
-rw-r--r--numpy/core/fromnumeric.pyi30
-rw-r--r--numpy/core/function_base.pyi10
-rw-r--r--numpy/core/numeric.pyi22
-rw-r--r--numpy/core/numerictypes.pyi10
-rw-r--r--numpy/typing/__init__.py6
-rw-r--r--numpy/typing/_array_like.py6
-rw-r--r--numpy/typing/_dtype_like.py34
-rw-r--r--numpy/typing/tests/data/fail/flatiter.py2
-rw-r--r--numpy/typing/tests/data/pass/array_like.py4
11 files changed, 118 insertions, 118 deletions
diff --git a/numpy/__init__.pyi b/numpy/__init__.pyi
index 612e56084..750216342 100644
--- a/numpy/__init__.pyi
+++ b/numpy/__init__.pyi
@@ -6,7 +6,7 @@ from abc import abstractmethod
from numpy.core._internal import _ctypes
from numpy.typing import (
ArrayLike,
- DtypeLike,
+ DTypeLike,
_Shape,
_ShapeLike,
_CharLike,
@@ -15,8 +15,8 @@ from numpy.typing import (
_FloatLike,
_ComplexLike,
_NumberLike,
- _SupportsDtype,
- _VoidDtypeLike,
+ _SupportsDType,
+ _VoidDTypeLike,
NBitBase,
_64Bit,
_32Bit,
@@ -827,11 +827,11 @@ class dtype(Generic[_DTypeScalar]):
align: bool = ...,
copy: bool = ...,
) -> dtype[_DTypeScalar]: ...
- # TODO: handle _SupportsDtype better
+ # TODO: handle _SupportsDType better
@overload
def __new__(
cls,
- dtype: _SupportsDtype,
+ dtype: _SupportsDType,
align: bool = ...,
copy: bool = ...,
) -> dtype[Any]: ...
@@ -847,16 +847,16 @@ class dtype(Generic[_DTypeScalar]):
@overload
def __new__(
cls,
- dtype: _VoidDtypeLike,
+ dtype: _VoidDTypeLike,
align: bool = ...,
copy: bool = ...,
) -> dtype[void]: ...
- def __eq__(self, other: DtypeLike) -> bool: ...
- def __ne__(self, other: DtypeLike) -> bool: ...
- def __gt__(self, other: DtypeLike) -> bool: ...
- def __ge__(self, other: DtypeLike) -> bool: ...
- def __lt__(self, other: DtypeLike) -> bool: ...
- def __le__(self, other: DtypeLike) -> bool: ...
+ def __eq__(self, other: DTypeLike) -> bool: ...
+ def __ne__(self, other: DTypeLike) -> bool: ...
+ def __gt__(self, other: DTypeLike) -> bool: ...
+ def __ge__(self, other: DTypeLike) -> bool: ...
+ def __lt__(self, other: DTypeLike) -> bool: ...
+ def __le__(self, other: DTypeLike) -> bool: ...
@property
def alignment(self) -> int: ...
@property
@@ -905,7 +905,7 @@ class dtype(Generic[_DTypeScalar]):
@property
def type(self) -> Type[generic]: ...
-_Dtype = dtype # to avoid name conflicts with ndarray.dtype
+_DType = dtype # to avoid name conflicts with ndarray.dtype
class _flagsobj:
aligned: bool
@@ -964,7 +964,7 @@ class flatiter(Generic[_ArraySelf]):
def __getitem__(
self, key: Union[_ArrayLikeInt, slice, ellipsis],
) -> _ArraySelf: ...
- def __array__(self, __dtype: DtypeLike = ...) -> ndarray: ...
+ def __array__(self, __dtype: DTypeLike = ...) -> ndarray: ...
_OrderKACF = Optional[Literal["K", "A", "C", "F"]]
_OrderACF = Optional[Literal["A", "C", "F"]]
@@ -993,7 +993,7 @@ class _ArrayOrScalarCommon:
@property
def base(self) -> Optional[ndarray]: ...
@property
- def dtype(self) -> _Dtype: ...
+ def dtype(self) -> _DType: ...
@property
def data(self) -> memoryview: ...
@property
@@ -1010,7 +1010,7 @@ class _ArrayOrScalarCommon:
def shape(self) -> _Shape: ...
@property
def strides(self) -> _Shape: ...
- def __array__(self, __dtype: DtypeLike = ...) -> ndarray: ...
+ def __array__(self, __dtype: DTypeLike = ...) -> ndarray: ...
def __bool__(self) -> bool: ...
def __bytes__(self) -> bytes: ...
def __str__(self) -> str: ...
@@ -1025,7 +1025,7 @@ class _ArrayOrScalarCommon:
def __ge__(self, other): ...
def astype(
self: _ArraySelf,
- dtype: DtypeLike,
+ dtype: DTypeLike,
order: _OrderKACF = ...,
casting: _Casting = ...,
subok: bool = ...,
@@ -1040,7 +1040,7 @@ class _ArrayOrScalarCommon:
def flat(self: _ArraySelf) -> flatiter[_ArraySelf]: ...
def flatten(self: _ArraySelf, order: _OrderKACF = ...) -> _ArraySelf: ...
def getfield(
- self: _ArraySelf, dtype: DtypeLike, offset: int = ...
+ self: _ArraySelf, dtype: DTypeLike, offset: int = ...
) -> _ArraySelf: ...
@overload
def item(self, *args: int) -> Any: ...
@@ -1085,10 +1085,10 @@ class _ArrayOrScalarCommon:
@overload
def view(self, type: Type[_NdArraySubClass]) -> _NdArraySubClass: ...
@overload
- def view(self: _ArraySelf, dtype: DtypeLike = ...) -> _ArraySelf: ...
+ def view(self: _ArraySelf, dtype: DTypeLike = ...) -> _ArraySelf: ...
@overload
def view(
- self, dtype: DtypeLike, type: Type[_NdArraySubClass]
+ self, dtype: DTypeLike, type: Type[_NdArraySubClass]
) -> _NdArraySubClass: ...
# TODO: Add proper signatures
@@ -1210,24 +1210,24 @@ class _ArrayOrScalarCommon:
def conjugate(self: _ArraySelf) -> _ArraySelf: ...
@overload
def cumprod(
- self, axis: Optional[int] = ..., dtype: DtypeLike = ..., out: None = ...,
+ self, axis: Optional[int] = ..., dtype: DTypeLike = ..., out: None = ...,
) -> ndarray: ...
@overload
def cumprod(
self,
axis: Optional[int] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
) -> _NdArraySubClass: ...
@overload
def cumsum(
- self, axis: Optional[int] = ..., dtype: DtypeLike = ..., out: None = ...,
+ self, axis: Optional[int] = ..., dtype: DTypeLike = ..., out: None = ...,
) -> ndarray: ...
@overload
def cumsum(
self,
axis: Optional[int] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
) -> _NdArraySubClass: ...
@overload
@@ -1261,7 +1261,7 @@ class _ArrayOrScalarCommon:
def mean(
self,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: Literal[False] = ...,
) -> number: ...
@@ -1269,7 +1269,7 @@ class _ArrayOrScalarCommon:
def mean(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: bool = ...,
) -> Union[number, ndarray]: ...
@@ -1277,7 +1277,7 @@ class _ArrayOrScalarCommon:
def mean(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
keepdims: bool = ...,
) -> _NdArraySubClass: ...
@@ -1313,7 +1313,7 @@ class _ArrayOrScalarCommon:
def prod(
self,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: Literal[False] = ...,
initial: _NumberLike = ...,
@@ -1323,7 +1323,7 @@ class _ArrayOrScalarCommon:
def prod(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -1333,7 +1333,7 @@ class _ArrayOrScalarCommon:
def prod(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -1367,7 +1367,7 @@ class _ArrayOrScalarCommon:
def std(
self,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: Literal[False] = ...,
@@ -1376,7 +1376,7 @@ class _ArrayOrScalarCommon:
def std(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: bool = ...,
@@ -1385,7 +1385,7 @@ class _ArrayOrScalarCommon:
def std(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
ddof: int = ...,
keepdims: bool = ...,
@@ -1394,7 +1394,7 @@ class _ArrayOrScalarCommon:
def sum(
self,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: Literal[False] = ...,
initial: _NumberLike = ...,
@@ -1404,7 +1404,7 @@ class _ArrayOrScalarCommon:
def sum(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -1414,7 +1414,7 @@ class _ArrayOrScalarCommon:
def sum(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -1448,7 +1448,7 @@ class _ArrayOrScalarCommon:
def var(
self,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: Literal[False] = ...,
@@ -1457,7 +1457,7 @@ class _ArrayOrScalarCommon:
def var(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: bool = ...,
@@ -1466,7 +1466,7 @@ class _ArrayOrScalarCommon:
def var(
self,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
ddof: int = ...,
keepdims: bool = ...,
@@ -1487,14 +1487,14 @@ class ndarray(_ArrayOrScalarCommon, Iterable, Sized, Container):
def __new__(
cls: Type[_ArraySelf],
shape: Sequence[int],
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
buffer: _BufferType = ...,
offset: int = ...,
strides: _ShapeLike = ...,
order: _OrderKACF = ...,
) -> _ArraySelf: ...
@property
- def dtype(self) -> _Dtype: ...
+ def dtype(self) -> _DType: ...
@property
def ctypes(self) -> _ctypes: ...
@property
@@ -1540,7 +1540,7 @@ class ndarray(_ArrayOrScalarCommon, Iterable, Sized, Container):
sorter: Optional[_ArrayLikeIntOrBool] = ..., # 1D int array
) -> ndarray: ...
def setfield(
- self, val: ArrayLike, dtype: DtypeLike, offset: int = ...
+ self, val: ArrayLike, dtype: DTypeLike, offset: int = ...
) -> None: ...
def sort(
self,
@@ -1554,7 +1554,7 @@ class ndarray(_ArrayOrScalarCommon, Iterable, Sized, Container):
offset: int = ...,
axis1: int = ...,
axis2: int = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
) -> Union[number, ndarray]: ...
@overload
@@ -1563,7 +1563,7 @@ class ndarray(_ArrayOrScalarCommon, Iterable, Sized, Container):
offset: int = ...,
axis1: int = ...,
axis2: int = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: _NdArraySubClass = ...,
) -> _NdArraySubClass: ...
# Many of these special methods are irrelevant currently, since protocols
@@ -1923,7 +1923,7 @@ class void(flexible):
@property
def imag(self: _ArraySelf) -> _ArraySelf: ...
def setfield(
- self, val: ArrayLike, dtype: DtypeLike, offset: int = ...
+ self, val: ArrayLike, dtype: DTypeLike, offset: int = ...
) -> None: ...
class character(flexible): # type: ignore
@@ -1961,7 +1961,7 @@ unicode_ = str0 = str_
def array(
object: object,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
*,
copy: bool = ...,
order: _OrderKACF = ...,
@@ -1971,14 +1971,14 @@ def array(
) -> ndarray: ...
def zeros(
shape: _ShapeLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderCF = ...,
*,
like: ArrayLike = ...,
) -> ndarray: ...
def empty(
shape: _ShapeLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderCF = ...,
*,
like: ArrayLike = ...,
@@ -2055,7 +2055,7 @@ class ufunc:
keepdims: bool = ...,
casting: _Casting = ...,
order: _OrderKACF = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
subok: bool = ...,
signature: Union[str, Tuple[str]] = ...,
# In reality this should be a length of list 3 containing an
diff --git a/numpy/core/_asarray.pyi b/numpy/core/_asarray.pyi
index e074d69d2..8c200ba22 100644
--- a/numpy/core/_asarray.pyi
+++ b/numpy/core/_asarray.pyi
@@ -2,7 +2,7 @@ import sys
from typing import TypeVar, Union, Iterable, overload
from numpy import ndarray, _OrderKACF
-from numpy.typing import ArrayLike, DtypeLike
+from numpy.typing import ArrayLike, DTypeLike
if sys.version_info >= (3, 8):
from typing import Literal
@@ -13,7 +13,7 @@ _ArrayType = TypeVar("_ArrayType", bound=ndarray)
def asarray(
a: object,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
*,
like: ArrayLike = ...
@@ -29,16 +29,16 @@ def asanyarray(
@overload
def asanyarray(
a: object,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
*,
like: ArrayLike = ...
) -> ndarray: ...
def ascontiguousarray(
- a: object, dtype: DtypeLike = ..., *, like: ArrayLike = ...
+ a: object, dtype: DTypeLike = ..., *, like: ArrayLike = ...
) -> ndarray: ...
def asfortranarray(
- a: object, dtype: DtypeLike = ..., *, like: ArrayLike = ...
+ a: object, dtype: DTypeLike = ..., *, like: ArrayLike = ...
) -> ndarray: ...
_Requirements = Literal[
@@ -62,7 +62,7 @@ def require(
@overload
def require(
a: object,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
requirements: Union[_E, Iterable[_RequirementsWithE]] = ...,
*,
like: ArrayLike = ...
@@ -70,7 +70,7 @@ def require(
@overload
def require(
a: object,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
requirements: Union[None, _Requirements, Iterable[_Requirements]] = ...,
*,
like: ArrayLike = ...
diff --git a/numpy/core/fromnumeric.pyi b/numpy/core/fromnumeric.pyi
index 3167d12b9..66eb3bfb8 100644
--- a/numpy/core/fromnumeric.pyi
+++ b/numpy/core/fromnumeric.pyi
@@ -18,7 +18,7 @@ from numpy import (
_SortSide,
)
from numpy.typing import (
- DtypeLike,
+ DTypeLike,
ArrayLike,
_ShapeLike,
_Shape,
@@ -198,7 +198,7 @@ def trace(
offset: int = ...,
axis1: int = ...,
axis2: int = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
) -> Union[number, ndarray]: ...
def ravel(a: ArrayLike, order: _OrderKACF = ...) -> ndarray: ...
@@ -246,7 +246,7 @@ def clip(
def sum(
a: _Number,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -256,7 +256,7 @@ def sum(
def sum(
a: ArrayLike,
axis: _ShapeLike = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -293,7 +293,7 @@ def any(
def cumsum(
a: ArrayLike,
axis: Optional[int] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
) -> ndarray: ...
@overload
@@ -383,7 +383,7 @@ def amin(
def prod(
a: _Number,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -393,7 +393,7 @@ def prod(
def prod(
a: ArrayLike,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: Literal[False] = ...,
initial: _NumberLike = ...,
@@ -403,7 +403,7 @@ def prod(
def prod(
a: ArrayLike,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
keepdims: bool = ...,
initial: _NumberLike = ...,
@@ -412,7 +412,7 @@ def prod(
def cumprod(
a: ArrayLike,
axis: Optional[int] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
) -> ndarray: ...
def ndim(a: ArrayLike) -> int: ...
@@ -433,7 +433,7 @@ def around(
def mean(
a: ArrayLike,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
keepdims: Literal[False] = ...,
) -> number: ...
@@ -441,7 +441,7 @@ def mean(
def mean(
a: ArrayLike,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
keepdims: bool = ...,
) -> Union[number, ndarray]: ...
@@ -449,7 +449,7 @@ def mean(
def std(
a: ArrayLike,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: Literal[False] = ...,
@@ -458,7 +458,7 @@ def std(
def std(
a: ArrayLike,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
ddof: int = ...,
keepdims: bool = ...,
@@ -467,7 +467,7 @@ def std(
def var(
a: ArrayLike,
axis: None = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: None = ...,
ddof: int = ...,
keepdims: Literal[False] = ...,
@@ -476,7 +476,7 @@ def var(
def var(
a: ArrayLike,
axis: Optional[_ShapeLike] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
out: Optional[ndarray] = ...,
ddof: int = ...,
keepdims: bool = ...,
diff --git a/numpy/core/function_base.pyi b/numpy/core/function_base.pyi
index 705712253..1490bed4a 100644
--- a/numpy/core/function_base.pyi
+++ b/numpy/core/function_base.pyi
@@ -2,7 +2,7 @@ import sys
from typing import overload, Tuple, Union, Sequence, Any
from numpy import ndarray, inexact
-from numpy.typing import ArrayLike, DtypeLike, _SupportsArray, _NumberLike
+from numpy.typing import ArrayLike, DTypeLike, _SupportsArray, _NumberLike
if sys.version_info >= (3, 8):
from typing import SupportsIndex, Literal
@@ -24,7 +24,7 @@ def linspace(
num: SupportsIndex = ...,
endpoint: bool = ...,
retstep: Literal[False] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
axis: SupportsIndex = ...,
) -> ndarray: ...
@overload
@@ -34,7 +34,7 @@ def linspace(
num: SupportsIndex = ...,
endpoint: bool = ...,
retstep: Literal[True] = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
axis: SupportsIndex = ...,
) -> Tuple[ndarray, inexact]: ...
def logspace(
@@ -43,7 +43,7 @@ def logspace(
num: SupportsIndex = ...,
endpoint: bool = ...,
base: _ArrayLikeNumber = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
axis: SupportsIndex = ...,
) -> ndarray: ...
def geomspace(
@@ -51,6 +51,6 @@ def geomspace(
stop: _ArrayLikeNumber,
num: SupportsIndex = ...,
endpoint: bool = ...,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
axis: SupportsIndex = ...,
) -> ndarray: ...
diff --git a/numpy/core/numeric.pyi b/numpy/core/numeric.pyi
index de80cfe08..d91cb31c2 100644
--- a/numpy/core/numeric.pyi
+++ b/numpy/core/numeric.pyi
@@ -13,7 +13,7 @@ from typing import (
)
from numpy import ndarray, generic, dtype, bool_, signedinteger, _OrderKACF, _OrderCF
-from numpy.typing import ArrayLike, DtypeLike, _ShapeLike
+from numpy.typing import ArrayLike, DTypeLike, _ShapeLike
if sys.version_info >= (3, 8):
from typing import Literal
@@ -36,14 +36,14 @@ def zeros_like(
@overload
def zeros_like(
a: ArrayLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
subok: bool = ...,
shape: Optional[_ShapeLike] = ...,
) -> ndarray: ...
def ones(
shape: _ShapeLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderCF = ...,
*,
like: ArrayLike = ...,
@@ -59,7 +59,7 @@ def ones_like(
@overload
def ones_like(
a: ArrayLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
subok: bool = ...,
shape: Optional[_ShapeLike] = ...,
@@ -75,7 +75,7 @@ def empty_like(
@overload
def empty_like(
a: ArrayLike,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
subok: bool = ...,
shape: Optional[_ShapeLike] = ...,
@@ -83,7 +83,7 @@ def empty_like(
def full(
shape: _ShapeLike,
fill_value: Any,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderCF = ...,
*,
like: ArrayLike = ...,
@@ -101,7 +101,7 @@ def full_like(
def full_like(
a: ArrayLike,
fill_value: Any,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
order: _OrderKACF = ...,
subok: bool = ...,
shape: Optional[_ShapeLike] = ...,
@@ -150,27 +150,27 @@ def cross(
@overload
def indices(
dimensions: Sequence[int],
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
sparse: Literal[False] = ...,
) -> ndarray: ...
@overload
def indices(
dimensions: Sequence[int],
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
sparse: Literal[True] = ...,
) -> Tuple[ndarray, ...]: ...
def fromfunction(
function: Callable[..., _T],
shape: Sequence[int],
*,
- dtype: DtypeLike = ...,
+ dtype: DTypeLike = ...,
like: ArrayLike = ...,
**kwargs: Any,
) -> _T: ...
def isscalar(element: Any) -> bool: ...
def binary_repr(num: int, width: Optional[int] = ...) -> str: ...
def base_repr(number: int, base: int = ..., padding: int = ...) -> str: ...
-def identity(n: int, dtype: DtypeLike = ..., *, like: ArrayLike = ...) -> ndarray: ...
+def identity(n: int, dtype: DTypeLike = ..., *, like: ArrayLike = ...) -> ndarray: ...
def allclose(
a: ArrayLike,
b: ArrayLike,
diff --git a/numpy/core/numerictypes.pyi b/numpy/core/numerictypes.pyi
index 0aba5f1d1..192015ff1 100644
--- a/numpy/core/numerictypes.pyi
+++ b/numpy/core/numerictypes.pyi
@@ -1,11 +1,11 @@
from typing import TypeVar, Optional, Type, Union, Tuple, Sequence, overload, Any
from numpy import generic, ndarray, dtype
-from numpy.typing import DtypeLike
+from numpy.typing import DTypeLike
_DefaultType = TypeVar("_DefaultType")
-def maximum_sctype(t: DtypeLike) -> dtype: ...
+def maximum_sctype(t: DTypeLike) -> dtype: ...
def issctype(rep: object) -> bool: ...
@overload
def obj2sctype(rep: object) -> Optional[generic]: ...
@@ -17,12 +17,12 @@ def obj2sctype(
) -> Union[generic, Type[_DefaultType]]: ...
def issubclass_(arg1: object, arg2: Union[object, Tuple[object, ...]]) -> bool: ...
def issubsctype(
- arg1: Union[ndarray, DtypeLike], arg2: Union[ndarray, DtypeLike]
+ arg1: Union[ndarray, DTypeLike], arg2: Union[ndarray, DTypeLike]
) -> bool: ...
-def issubdtype(arg1: DtypeLike, arg2: DtypeLike) -> bool: ...
+def issubdtype(arg1: DTypeLike, arg2: DTypeLike) -> bool: ...
def sctype2char(sctype: object) -> str: ...
def find_common_type(
- array_types: Sequence[DtypeLike], scalar_types: Sequence[DtypeLike]
+ array_types: Sequence[DTypeLike], scalar_types: Sequence[DTypeLike]
) -> dtype: ...
# TODO: Add annotations for the following objects:
diff --git a/numpy/typing/__init__.py b/numpy/typing/__init__.py
index 2738da071..cbde75462 100644
--- a/numpy/typing/__init__.py
+++ b/numpy/typing/__init__.py
@@ -14,10 +14,10 @@ Large parts of the NumPy API have PEP-484-style type annotations. In
addition, the following type aliases are available for users.
- ``typing.ArrayLike``: objects that can be converted to arrays
-- ``typing.DtypeLike``: objects that can be converted to dtypes
+- ``typing.DTypeLike``: objects that can be converted to dtypes
Roughly speaking, ``typing.ArrayLike`` is "objects that can be used as
-inputs to ``np.array``" and ``typing.DtypeLike`` is "objects that can
+inputs to ``np.array``" and ``typing.DTypeLike`` is "objects that can
be used as inputs to ``np.dtype``".
.. _typing-extensions: https://pypi.org/project/typing-extensions/
@@ -184,7 +184,7 @@ from ._scalars import (
)
from ._array_like import _SupportsArray, ArrayLike
from ._shape import _Shape, _ShapeLike
-from ._dtype_like import _SupportsDtype, _VoidDtypeLike, DtypeLike
+from ._dtype_like import _SupportsDType, _VoidDTypeLike, DTypeLike
from numpy._pytesttester import PytestTester
test = PytestTester(__name__)
diff --git a/numpy/typing/_array_like.py b/numpy/typing/_array_like.py
index 1c00b200f..a1a604239 100644
--- a/numpy/typing/_array_like.py
+++ b/numpy/typing/_array_like.py
@@ -3,7 +3,7 @@ from typing import Any, overload, Sequence, TYPE_CHECKING, Union
from numpy import ndarray
from ._scalars import _ScalarLike
-from ._dtype_like import DtypeLike
+from ._dtype_like import DTypeLike
if sys.version_info >= (3, 8):
from typing import Protocol
@@ -19,9 +19,9 @@ else:
if TYPE_CHECKING or HAVE_PROTOCOL:
class _SupportsArray(Protocol):
@overload
- def __array__(self, __dtype: DtypeLike = ...) -> ndarray: ...
+ def __array__(self, __dtype: DTypeLike = ...) -> ndarray: ...
@overload
- def __array__(self, dtype: DtypeLike = ...) -> ndarray: ...
+ def __array__(self, dtype: DTypeLike = ...) -> ndarray: ...
else:
_SupportsArray = Any
diff --git a/numpy/typing/_dtype_like.py b/numpy/typing/_dtype_like.py
index 5bfd8ffdc..1953bd5fc 100644
--- a/numpy/typing/_dtype_like.py
+++ b/numpy/typing/_dtype_like.py
@@ -15,36 +15,36 @@ else:
else:
HAVE_PROTOCOL = True
-_DtypeLikeNested = Any # TODO: wait for support for recursive types
+_DTypeLikeNested = Any # TODO: wait for support for recursive types
if TYPE_CHECKING or HAVE_PROTOCOL:
# Mandatory keys
- class _DtypeDictBase(TypedDict):
+ class _DTypeDictBase(TypedDict):
names: Sequence[str]
- formats: Sequence[_DtypeLikeNested]
+ formats: Sequence[_DTypeLikeNested]
# Mandatory + optional keys
- class _DtypeDict(_DtypeDictBase, total=False):
+ class _DTypeDict(_DTypeDictBase, total=False):
offsets: Sequence[int]
titles: Sequence[Any] # Only `str` elements are usable as indexing aliases, but all objects are legal
itemsize: int
aligned: bool
# A protocol for anything with the dtype attribute
- class _SupportsDtype(Protocol):
- dtype: _DtypeLikeNested
+ class _SupportsDType(Protocol):
+ dtype: _DTypeLikeNested
else:
- _DtypeDict = Any
- _SupportsDtype = Any
+ _DTypeDict = Any
+ _SupportsDType = Any
# Would create a dtype[np.void]
-_VoidDtypeLike = Union[
+_VoidDTypeLike = Union[
# (flexible_dtype, itemsize)
- Tuple[_DtypeLikeNested, int],
+ Tuple[_DTypeLikeNested, int],
# (fixed_dtype, shape)
- Tuple[_DtypeLikeNested, _ShapeLike],
+ Tuple[_DTypeLikeNested, _ShapeLike],
# [(field_name, field_dtype, field_shape), ...]
#
# The type here is quite broad because NumPy accepts quite a wide
@@ -53,29 +53,29 @@ _VoidDtypeLike = Union[
List[Any],
# {'names': ..., 'formats': ..., 'offsets': ..., 'titles': ...,
# 'itemsize': ...}
- _DtypeDict,
+ _DTypeDict,
# (base_dtype, new_dtype)
- Tuple[_DtypeLikeNested, _DtypeLikeNested],
+ Tuple[_DTypeLikeNested, _DTypeLikeNested],
]
# Anything that can be coerced into numpy.dtype.
# Reference: https://docs.scipy.org/doc/numpy/reference/arrays.dtypes.html
-DtypeLike = Union[
+DTypeLike = Union[
dtype,
# default data type (float64)
None,
# array-scalar types and generic types
type, # TODO: enumerate these when we add type hints for numpy scalars
# anything with a dtype attribute
- _SupportsDtype,
+ _SupportsDType,
# character codes, type strings or comma-separated fields, e.g., 'float64'
str,
- _VoidDtypeLike,
+ _VoidDTypeLike,
]
# NOTE: while it is possible to provide the dtype as a dict of
# dtype-like objects (e.g. `{'field1': ..., 'field2': ..., ...}`),
# this syntax is officially discourged and
-# therefore not included in the Union defining `DtypeLike`.
+# therefore not included in the Union defining `DTypeLike`.
#
# See https://github.com/numpy/numpy/issues/16891 for more details.
diff --git a/numpy/typing/tests/data/fail/flatiter.py b/numpy/typing/tests/data/fail/flatiter.py
index e8a82344f..544ffbe4a 100644
--- a/numpy/typing/tests/data/fail/flatiter.py
+++ b/numpy/typing/tests/data/fail/flatiter.py
@@ -1,7 +1,7 @@
from typing import Any
import numpy as np
-from numpy.typing import DtypeLike, _SupportsArray
+from numpy.typing import _SupportsArray
class Index:
diff --git a/numpy/typing/tests/data/pass/array_like.py b/numpy/typing/tests/data/pass/array_like.py
index 6b823ca7e..f85724267 100644
--- a/numpy/typing/tests/data/pass/array_like.py
+++ b/numpy/typing/tests/data/pass/array_like.py
@@ -1,7 +1,7 @@
from typing import Any, List, Optional
import numpy as np
-from numpy.typing import ArrayLike, DtypeLike, _SupportsArray
+from numpy.typing import ArrayLike, DTypeLike, _SupportsArray
x1: ArrayLike = True
x2: ArrayLike = 5
@@ -18,7 +18,7 @@ x12: ArrayLike = memoryview(b'foo')
class A:
- def __array__(self, dtype: DtypeLike = None) -> np.ndarray:
+ def __array__(self, dtype: DTypeLike = None) -> np.ndarray:
return np.array([1, 2, 3])