将类型指定为数字列表（整数和/或浮点数）？

Posted 2023-02-16

【中文标题】将类型指定为数字列表（整数和/或浮点数）？

【英文标题】：Specifying a type to be a List of numbers (ints and/or floats)?

【发布时间】：2017-10-12 21:54:41

【问题描述】：

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

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

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

【参考方案1】：

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

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

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

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

【讨论】：

我试过了，但是当我输入一个整数列表时 mypy 给出了这个错误： quickSortLomutoFirst.py:32: error: Argument 1 to "quickSortOuter" has incompat ible type List[int];预期列表[float]

@aryamccarthy -- 这有点微妙，但事实证明 mypy 实际上是正确的，并且可以防止 OP 意外将错误引入他们的代码 -- 有关详细信息，请参阅下面的答案。

【参考方案2】：

对您的问题的简短回答是您应该使用 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 决定将任意整数或浮点数注入输入数组），解决方法是手动使用 List[Union[int, float]] 注释 foo：

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 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)

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

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

【讨论】：

可能的第三种解决方案和第二种解决方案的替代方案（不允许在列表中混合类型）是Union[List[int], List[float]]

为什么不直接使用typing.List[numbers.Real]？

@actual_panda -- 出于类型检查的目的，整数和浮点数都不是 Real 的子类型，因为 Real 是 ABC 并且 PEP 484 类型系统不理解动态 ABC 注册。但即使整数/浮点数是 Real 的子类型，List[Real] 仍然无法工作，因为上面讨论的方差问题相同。在 T = TypeVar('T', bound=Real) 处执行 Sequence[Real] 或 List[T] 会起作用，但前提是您可以接受任意实数，这不是每个人都想要的。但是 IMO 这些细节有点不重要：OP 的核心问题是关于泛型的差异。

所以即使isinstance(1, numbers.Real) -> True 和isinstance(1.1, numbers.Real) -> True 类型系统不能按预期工作？这似乎是一个主要缺点。

@actual_panda 您确定您了解编程语言中的方差和列表类型的根本问题吗？似乎您的困惑以及输入列表的公认不直观的方式将得到解答。