python - 将类型指定为数字列表(整数和/或 float )？

Question

我如何指定一个函数可以获取一个可以是整数或 float 的列表？

我尝试像这样使用 Union 创建一个新类型:

num = Union[int, float]

def quick_sort(arr: List[num]) -> List[num]:
    ...

但是，mypy 不喜欢这样:

 quickSortLomutoFirst.py:32: error: Argument 1 to "quickSortOuter" has
 incompatible type List[int]; expected List[Union[int, float]]  

是否有包含整数和 float 的类型？

Answer 1

对您的问题的简短回答是您应该使用 TypeVars 或 Sequence - 使用 List[Union[int, float]] 实际上可能会在您的代码中引入错误!

简而言之，问题在于，根据 PEP 484 类型系统(以及在许多其他类型系统中，例如 Java、C#...)，列表是不变的。您正在尝试使用该列表，就好像它是 covariant 一样。您可以了解有关协方差和不变性的更多信息 here和 here ，但也许你的代码可能是非类型安全的示例可能会有用。

考虑以下代码:

from typing import Union, List

Num = Union[int, float]

def quick_sort(arr: List[Num]) -> List[Num]:
    arr.append(3.14)  # We deliberately append a float
    return arr

foo = [1, 2, 3, 4]  # type: List[int]

quick_sort(foo)

# Danger!!!
# Previously, `foo` was of type List[int], but now
# it contains a float!? 

如果允许此代码进行类型检查，我们只是破坏了我们的代码!任何依赖于 foo 的代码完全属于 List[int] 类型的代码现在都会中断。

或者更准确地说，即使 int 是 Union[int, float] 的合法子类型，但这并不意味着 List[int] 是 List[Union[int, float]] 的子类型，反之亦然。

---

如果我们可以接受这种行为(我们可以接受 quick_sort 决定将任意整数或 float 注入(inject)输入数组)，解决方法是手动注释 foo 与 List[Union[int, float]]:

foo = [1, 2, 3, 4]  # type: List[Union[int, float]]

# Or, in Python 3.6+
foo: List[Union[int, float]] = [1, 2, 3, 4]

也就是说，预先声明 foo 尽管只包含整数，但也意味着包含 float 。这可以防止我们在调用 quick_sort 后错误地使用列表，从而完全回避这个问题。

在某些情况下，这可能是您想要做的。不过对于这种方法，可能不会。

---

如果我们不接受这种行为，并希望 quick_sort 保留列表中最初存在的任何类型，我会想到两种解决方案:

第一种是使用协变类型而不是列表——例如，Sequence :

from typing import Union, Sequence

Num = Union[int, float]

def quick_sort(arr: Sequence[Num]) -> Sequence[Num]:
    return arr

事实证明，Sequence 或多或少类似于 List，除了它是不可变的(或者更准确地说，Sequence 的 API 不包含任何让您改变列表的方式)。这让我们可以安全地避开上面提到的错误。

第二种解决方案是更精确地键入您的数组，并坚持它必须包含所有整数或所有 float ，不允许两者混合。我们可以使用 TypeVars with value restrictions :

from typing import Union, List, TypeVar 

# Note: The informal convention is to prefix all typevars with
# either 'T' or '_T' -- so 'TNum' or '_TNum'.
TNum = TypeVar('TNum', int, float)

def quick_sort(arr: List[TNum]) -> List[TNum]:
    return arr

foo = [1, 2, 3, 4]  # type: List[int]
quick_sort(foo)

bar = [1.0, 2.0, 3.0, 4.0]  # type: List[float]
quick_sort(foo)

这也将防止我们像上面提到的那样意外地“混合”类型。

我建议使用第二种方法——它更精确一些，并且可以防止您在通过快速排序函数传递列表时丢失有关列表包含的确切类型的信息。