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

时间:2017-05-13 19:10:24

标签: python types type-hinting mypy

如何具体定义一个函数可以获取可以是整数或浮点数的列表?

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

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

2 个答案:

答案 0 :(得分:26)

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

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

请考虑以下代码:

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]的代码现在都会中断。

或者更准确地说,即使intUnion[int, float]的合法子类型,也不代表List[int]List[Union[int, float]]的子类型,或者副作用反之亦然。

如果我们对此行为感到满意(我们确定quick_sort决定将任意整数或浮点数注入输入数组),则修复是手动注释fooList[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,除了它是不可变的(或者更确切地说,序列的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)

这也可以防止我们意外地混合"像我们上面那样的类型。

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

答案 1 :(得分:10)

来自PEP 484,提出类型提示:

  

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

不要为Union而烦恼。坚持Sequence[float]

编辑:感谢Michael抓住ListSequence之间的区别。