python中的函数注释

Question

我刚刚发现了Python3的函数注释(https://www.python.org/dev/peps/pep-3107/)这对于记录参数或返回类型似乎很有用。它还可以在我的pycharm IDE中提供更好的intellisense。

我有一个关于输入类型模糊的参数的问题。例如，它可以是一个列表或numpy数组或一些“类似数组”的数量。为函数注释此类输入参数的最佳方法是什么？例子：

import numpy as np

def fun(data: np.ndarray) # can also be a list
    pass

我还有一个例子，输入可以是这两种类型中的任何一种。例子：

def fun(header: Nifti1Header) # can also be Nifti2Header
    pass

记录此类参数输入的最佳方式是什么？

Answer 1

您必须计算出函数的合法输入共享哪些公共属性。对于第一个，它看起来应该是可移植的：

>>> from collections import Iterable
>>> def fun(data: Iterable):
...     pass
... 
>>> isinstance(np.ndarray(0), Iterable)
True
>>> isinstance([], Iterable)
True
>>> isinstance(23, Iterable)
False

对于您的头，它闻起来像Nifti1Header，Nifti2Header应该继承自一个公共基类。如果该函数适用于任何派生类，为什么不使用基类对其进行注释呢？

Answer 2

如果您使用的是python3。最好的方法是打字。协会

>>> from typing import Union
>>> import numpy as np
>>> def fun(data: Union[np.ndarray, list]):
        pass

你也可以使用打字。TypeVar如果您始终使用Union[t1， t2，...]。（另外，您可以比代码中的许多Unions更容易地从TypeVar中添加和删除类型）

>>> from typing import TypeVar
>>> import numpy as np
>>> import array
>>> Ar = TypeVar('Ar', np.ndarray, list, array.array)

然后，该代码将Ar与列表、数组相关联。数组和numpy数组。