首页 > 解决方案 > python 3键入可变参数“应用”样式定义

问题描述

我一直在努力编写“可变”参数列表类型定义。

例如,将类型赋予:

def foo(fn, *args):
    return fn(*args)

我能做的最好的就是使用这里的建议

from typing import overload, Callable, TypeVar

A = TypeVar('A')
B = TypeVar('B')
C = TypeVar('C')
R = TypeVar('R')

@overload
def foo(fn: Callable[[A], R], a: A) -> R: ...
@overload
def foo(fn: Callable[[A, B], R], a: A, b: B) -> R: ...
@overload
def foo(fn: Callable[[A, B, C], R], a: A, b: B, c: C) -> R: ...

def foo(fn, *args):
    return fn(*args)

这主要是做正确的事情......例如,给定:

def bar(i: int, j: int) -> None:
    print(i)

以下成功:

foo(bar, 10, 12)

虽然这些失败:

foo(bar, 10)
foo(bar, 10, 'a')
foo(bar, 10, 12) + 1

但如果我检查mypy --strict我会得到:

test.py:15: error: Function is missing a type annotation

(也就是说最终foo定义本身没有任何类型)

我可以重新定义foo为:

def foo(fn: Callable[..., R], *args: Any) -> R:
    return fn(*args)

但是当我跑步时,mypy --strict我得到:

test.py:15: error: Overloaded function implementation does not accept all possible arguments of signature 1
test.py:15: error: Overloaded function implementation does not accept all possible arguments of signature 2
test.py:15: error: Overloaded function implementation does not accept all possible arguments of signature 3

我真的不明白。

如果有人可以提出一种更好的方法来为这种函数提供类型,那将不胜感激!如果我也可以在不列出很多overload很好的情况下做到这一点,那么真正的定义也有一些“仅限关键字”的论点,不必每次都重复

标签: pythonpython-3.xtypestype-hintingpython-typing

解决方案


您收到“重载函数实现不接受所有可能的参数...”错误的原因是您的重载实现无法正确处理如下所示的调用:foo(my_callable, a=3, b=4).

毕竟,根据您的重载签名,理论上用户可以为 a、b、c 等显式使用命名参数——因此,您的实现需要支持这些类型的调用。

有两种不同的方法可以解决此问题。

第一种方法是添加**kwargs: Any并修改你的重载实现,如下所示:

def foo(fn: Callable[..., R], *args: Any, **kwargs: Any) -> Any:
    return fn(*args, **kwargs)

现在您的实现将正确处理这些类型的调用。

第二种方法是在每个参数前面加上两个下划线,如下所示:

@overload
def foo(fn: Callable[[A], R], __a: A) -> R: ...
@overload
def foo(fn: Callable[[A, B], R], __a: A, __b: B) -> R: ...
@overload
def foo(fn: Callable[[A, B, C], R], __a: A, __b: B, __c: C) -> R: ...

def foo(fn: Callable[..., R], *args: Any) -> Any:
    return fn(*args)

当 mypy 看到一个以两个下划线开头的参数时,它会理解该参数是仅限位置的。所以,mypy 会拒绝像foo(my_fn, __a=3, __b=4).

不过,这只是打字的事情。使用两个下划线作为参数前缀在运行时没有特殊意义。


关于您不必重复如此多的重载的更广泛的问题:不幸的是,处理一堆重载是我们目前能做的最好的事情。您使用的技术与 typeshed 用于键入函数(例如map(...)filter(...))的技术相同。

为了做得更好,我们需要一个称为可变参数泛型的特性——但它们是一个复杂的特性,不幸的是 mypy 还不支持它们。不过,计划是希望它们在 2019 年晚些时候的某个时候实施,这样你就可以在那时消除过载。


推荐阅读