装饰器的 Python 3 类型提示

Question

考虑以下代码：

from typing import Callable, Any

TFunc = Callable[..., Any]

def get_authenticated_user(): return "John"

def require_auth() -> Callable[TFunc, TFunc]:
    def decorator(func: TFunc) -> TFunc:
        def wrapper(*args, **kwargs) -> Any:
            user = get_authenticated_user()
            if user is None:
                raise Exception("Don't!")
            return func(*args, **kwargs)
        return wrapper
    return decorator

@require_auth()
def foo(a: int) -> bool:
    return bool(a % 2)

foo(2)      # Type check OK
foo("no!")  # Type check failing as intended

这段代码正在按预期工作。现在想象一下我想扩展它，而不是仅仅执行

func(*args, **kwargs)

我想在参数中注入用户名。因此，我修改了函数签名。

from typing import Callable, Any

TFunc = Callable[..., Any]

def get_authenticated_user(): return "John"

def inject_user() -> Callable[TFunc, TFunc]:
    def decorator(func: TFunc) -> TFunc:
        def wrapper(*args, **kwargs) -> Any:
            user = get_authenticated_user()
            if user is None:
                raise Exception("Don't!")
            return func(*args, user, **kwargs)  # <- call signature modified

        return wrapper

    return decorator


@inject_user()
def foo(a: int, username: str) -> bool:
    print(username)
    return bool(a % 2)


foo(2)      # Type check OK
foo("no!")  # Type check OK <---- UNEXPECTED

我不知道输入此内容的正确方法。我知道在这个例子中，装饰函数和返回函数在技术上应该具有相同的签名（但即使这样也没有被检测到）。

Answer 1

PEP 612在接受答案后被接受，现在我们在Python 3.10中有

typing.ParamSpec

和

typing.Concatenate

。有了这些变量，我们就可以正确输入一些操纵位置参数的装饰器。

有问题的代码可以这样输入：

from typing import Callable, ParamSpec, Concatenate, TypeVar

Param = ParamSpec("Param")
RetType = TypeVar("RetType")
OriginalFunc = Callable[Param, RetType]
DecoratedFunc = Callable[Concatenate[str, Param], RetType]

def get_authenticated_user()->str:
    return "John"

def inject_user() -> Callable[[Callable[Param, RetType]], Callable[Concatenate[str, Param], RetType]]:
    def decorator(func: Callable[Param, RetType]) -> Callable[Concatenate[str, Param], RetType]:
        def wrapper(user: str, *args:Param.args, **kwargs:Param.kwargs) -> RetType:
            user = get_authenticated_user()
            if user is None:
                raise Exception("Don't!")
            return func(*args, **kwargs)

        return wrapper

    return decorator


@inject_user()
def foo(a: int) -> bool:
    return bool(a % 2)


reveal_type(foo)  #  # I: Revealed type is "def (builtins.str, a: builtins.int) -> builtins.bool"

foo("user", 2)  # Type check OK
foo("no!")  # E: Missing positional argument "a" in call to "foo"  [call-arg]
foo(3)  # # E: Missing positional argument "a" in call to "foo"  [call-arg] # E: Argument 1 to "foo" has incompatible type "int"; expected "str"  [arg-type]

Answer 2

您不能使用

Callable

来表达任何有关附加参数的内容；它们不是通用的。您唯一的选择是说您的装饰器采用

Callable

并返回不同的

Callable

。

在你的情况下，你可以用 typevar 确定返回类型：

RT = TypeVar('RT')  # return type

def inject_user() -> Callable[[Callable[..., RT]], Callable[..., RT]]:
    def decorator(func: Callable[..., RT]) -> Callable[..., RT]:
        def wrapper(*args, **kwargs) -> RT:
            # ...

即使如此，当您使用

foo()

时，所得到的装饰

def (*Any, **Any) -> builtins.bool*

函数的键入签名为

reveal_type()

。

目前正在讨论各种提案，以使

Callable

更加灵活，但尚未实现。参见

• 允许可变参数泛型
• 建议：泛化

  Callable

  以便能够指定参数名称和种类
• TypeVar 代表 Callable 的参数
• 出色地支持函数装饰器

举一些例子。该列表中的最后一个是一张伞票，其中包括您的特定用例，即更改可调用签名的装饰器：

返回类型或参数混乱

对于任意函数，你根本无法做到这一点——甚至没有语法。这是我为其编写的一些语法。

Answer 3

我在 Pyright 中对此进行了测试。

from typing import Any, Callable, Type, TypeVar

T = TypeVar('T')

def typing_decorator(rtype: Type[T]) -> Callable[..., Callable[..., T]]:
    """
    Useful function to typing a previously decorated func.
    ```
    @typing_decorator(rtype = int)
    @my_decorator()
    def my_func(a, b, *c, **d):
        ...
    ```
    In Pyright the return typing of my_func will be int.
    """
    def decorator(function: Any) -> Any:
        def wrapper(*args: Any, **kwargs: Any) -> Any:
            return function(*args, **kwargs)
        return wrapper
    return decorator  # type: ignore

Answer 4

使用

decohints

库解决了问题：

pip install decohints

以下是它如何与您的代码配合使用：

from decohints import decohints


def get_authenticated_user():
    return "John"


@decohints
def inject_user():
    def decorator(func):
        def wrapper(*args, **kwargs):
            user = get_authenticated_user()
            if user is None:
                raise Exception("Don't!")
            return func(*args, user, **kwargs)  # <- call signature modified

        return wrapper

    return decorator


@inject_user()
def foo(a: int, username: str) -> bool:
    print(username)
    return bool(a % 2)

如果您在 PyCharm 中输入

foo()

并等待，它将显示

foo

函数参数提示

(a: int, username: str)

。

这里是

decohints

来源的链接，还有其他解决此问题的选项：https://github.com/gri-gus/decohints