51

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

我尝试使用 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]]

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

4

2 回答 2

79

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

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

考虑以下代码：

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决定将任意整数或浮点数注入输入数组），修复方法是手动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尽管只包含整数，但也意味着包含浮点数。这可以防止我们在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 不包含任何让您改变列表的方法）。这让我们可以安全地避开上面提到的错误。

第二种解决方案是更精确地键入您的数组，并坚持它必须包含所有整数或所有浮点数，不允许两者混合。我们可以使用带有值限制的 TypeVars来做到这一点：

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)

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

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

于 2017-05-13T21:01:07.513 回答
29

来自PEP 484，它提出了类型提示：

numbers.Float这个 PEP 提出了一个几乎同样有效的简单快捷方式，而不是要求用户编写导入编号然后使用等：当一个参数被注释为具有 typefloat时，一个 type 的参数int是可以接受的......

不要打扰Unions。坚持下去Sequence[float]。

编辑：感谢迈克尔发现List和之间的区别Sequence。

于 2017-05-13T19:14:51.793 回答