键入numpy.ndarray的提示/注释（PEP 484）

有没有人为特定的numpy.ndarray类实现类型提示？

现在，我正在使用typing.Any，但是最好有更具体的内容。

例如，如果NumPy人们为其array_like对象类添加了类型别名。更好的是，在dtype级别实现支持，以便支持其他对象以及ufunc。

看起来typing模块是在以下位置开发的：

https://github.com/python/typing

主numpy存储库位于

https://github.com/numpy/numpy

可以在以下位置跟踪Python错误和提交：

http://bugs.python.org/

添加功能的通常方法是派生主存储库，开发功能直至防炸弹，然后提交拉取请求。显然，在此过程的各个阶段，您都需要其他开发人员的反馈。如果您不能自己进行开发，则必须说服其他人，这是一个有价值的项目。

cython具有一种注释形式，可用于生成有效的C代码。

您引用了文档中的array-like段落numpy。注意其typing信息：

查找是否可以使用array（）将对象转换为numpy数组的简单方法是，以交互方式尝试并查看其是否有效！（Python方式）。

换句话说，numpy开发商拒绝被钉住。他们无法或无法用文字描述可以或不能转换为哪种对象np.ndarray。

In [586]: np.array({'test':1})   # a dictionary
Out[586]: array({'test': 1}, dtype=object)

In [587]: np.array(['one','two'])  # a list
Out[587]: 
array(['one', 'two'], 
      dtype='<U3')

In [589]: np.array({'one','two'})  # a set
Out[589]: array({'one', 'two'}, dtype=object)

对于您自己的功能，像这样的注释

def foo(x: np.ndarray) -> np.ndarray:

作品。当然，如果您的函数最终调用某个numpy传递其参数的函数asanyarray（就像许多人一样），则这样的注释将是不完整的，因为您的输入可能是list，或np.matrix，等等。

在评估此问题和答案时，请注意日期。484当时是相对较新的PEP，并且仍在开发中的用于标准Python的代码。但是看起来提供的链接仍然有效。

签出DataShape。它使用数据类型以及一些语法来确定输入和输出数组的大小。

在我公司，我们一直在使用：

from typing import TypeVar, Generic, Tuple, Union, Optional
import numpy as np

Shape = TypeVar("Shape")
DType = TypeVar("DType")


class Array(np.ndarray, Generic[Shape, DType]):
    """
    Use this to type-annotate numpy arrays, e.g.

        def transform_image(image: Array['H,W,3', np.uint8], ...):
            ...

    """
    pass


def func(arr: Array['N,2', int]):
    return arr*2


print(func(arr = np.array([(1, 2), (3, 4)])))

实际上，我们周围有一个MyPy检查器，用于检查形状是否正常（我们应该在某个时候释放它）。唯一的事情是它并不能使PyCharm开心（即，您仍然会收到讨厌的警告行）：

我所做的就是将其定义为

Dict [Tuple [int，int]，TYPE]

因此，例如，如果您想要一个浮点数数组，则可以执行以下操作：

a = numpy.empty(shape=[2, 2], dtype=float) # type: Dict[Tuple[int, int], float]

从文档的角度来看，这当然不是完全正确的，但是对于分析正确的用法并使用pyCharm正确完成它，它的工作原理非常好！

nptyping为指定numpy类型提示增加了很多灵活性。