Python - 打字 - 可下标类型的联合

Question

我想创建一个

Array

类型，它应该是 subscriptable 并且是

typing.List

和

numpy.ndarray

类型的联合。 我知道

numpy

没有带有存根，但是 那些 numpy 存根（由 Machinalis）应该可以正常工作，因为它们是可订阅的。

这是预期的行为：

def foo(bar: Array[int])->None:
    pass

foo([1,2,3])          # No typing error
foo(numpy.arange(4))  # No typing error
foo((1,2,3))          # Error: Expected Array[int], got Tuple[int]
foo([1.,2.,3.])       # Error: Expected Array[int], got Array[float]

我尝试了一些方法，但没有一个能按预期工作。

你会如何在 Python 3.7 中做到这一点？

我也会接受某种鸭子类型解决方案，即使它不满足元组错误。主要关注点是创建可下标类型的可下标联合。

谢谢。

我最好的尝试：（评论中的我的错误）

class _meta_getitem(type):
    def __getitem__(cls, x):
        return cls.__getitem__(cls, x)

class Array(metaclass=_meta_getitem):

    def __getitem__(self, element_type: type) -> type:
        array_type = typing.Union[List[element_type],  # error: Invalid type "element_type"
                                  numpy.ndarray[element_type]]
        return typing.NewType("Array[{}]".format(element_type.__name__), 
                              array_type)  # The type alias to Union is invalid in runtime context

if __name__ == "__name__":
    x: Array[int] = numpy.arange(4) # "Array" expects no type arguments, but 1 given

Answer 1

创建

Union[List[T], Array[T]]

的类型别名应该可以工作：

from typing import TypeVar, Union, List

T = TypeVar('T')
Array = Union[List[T], numpy.ndarray[T]]

def foo(bar: Array[int]) -> None: pass

有关此技术的更多信息，请参阅通用类型别名上的 mypy 文档。

此代码可能在运行时失败，因为

numpy.ndarray

在运行时实际上不可订阅，仅在类型提示世界中。您可以通过将自定义类型提示隐藏在

typing.TYPE_CHECKING

防护后面来解决此问题，该提示在运行时始终为 false，在类型检查时始终为 true。

您可以在 Python 3.7+ 中相对干净地完成此操作：

from __future__ import annotations
from typing import TypeVar, Union, List, TYPE_CHECKING

if TYPE_CHECKING:
    T = TypeVar('T')
    Array = Union[List[T], numpy.ndarray[T]]

def foo(bar: Array[int]) -> None: pass

对于旧版本的 Python 3，您必须将

Array[int]

包装在字符串内：

from typing import TypeVar, Union, List, TYPE_CHECKING

if TYPE_CHECKING:
    T = TypeVar('T')
    Array = Union[List[T], numpy.ndarray[T]]

def foo(bar: "Array[int]") -> None: pass

---

请注意，尝试通过在运行时组合其他几个类型提示来构建自己的

Array

类型提示不太可能起作用：像 mypy 这样的静态分析工具通过实际分析代码而不运行它来工作：它实际上不会尝试评估您的自定义

Array

类中的任何内容。

更一般地说，尝试在运行时“使用”类型提示往往充满危险：它们实际上只是用作类型提示。

最后，您似乎误解了

NewType

的用途。我建议阅读相关文档以获取更多信息。