Python类型提示:将类型指定为数字列表(整数和/或浮点数)？

Question

我如何具体的函数可以采用可以是整数或浮点数的列表？

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

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

Answer 1

对你的问题的简短回答是你应该使用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)

这也将阻止我们意外地"混合"类型,就像我们上面提到的那样.

我建议使用第二种方法 - 它更精确一些,并且可以防止您在通过快速排序功能时丢失有关列表所包含的确切类型的信息.

Answer 2

从PEP 484,提出类型提示:

而不是要求用户编写导入数字然后使用numbers.Float等,这个PEP提出了一个几乎同样有效的直接快捷方式:当一个参数被注释为具有类型时float,类型的参数int是可接受的......

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

编辑:感谢Michael捕之间的差异List和Sequence.