Python中为Callable定义可变参数类型提示的问题与解决

需求背景 #

我需要为一个类中的事件处理器函数添加类型提示，这些函数会被外部调用，参数数量不固定：

• 有的调用方传入(event, int, str)
• 有的传入(event, str, bool, dict)

核心要求是：所有合法的处理器函数必须以Event对象（或其子类）作为第一个参数，后续参数无任何限制。比如以下两个函数都符合要求：

def foo(event: Event, a: int, b: bool):
    pass

async def bar(event: ClickEvent, c: dict, *args, **kwargs) -> typing.Coroutine[Any, Any, str]:
    pass

原定义的问题 #

最初我用下面的方式定义HANDLER类型：

HANDLER = Callable[[Event, PARAMS], Union[Any, Coroutine]]

但在PyCharm中触发了多处类型提示警告，包括false_control_value、async_function_value等赋值语句，以及EventHandlerWhatsit初始化时的赋值操作都有警告。我尝试了多种定义方式都无法解决，当前使用Python 3.8。

最终解决方案 #

使用Concatenate改写HANDLER的定义，就能完美适配这种参数签名存在差异的场景：

from typing_extensions import ParamSpec, Concatenate
from typing import Callable, Union, Coroutine, Any

# 假设这里是你的Event类及其子类定义
class Event:
    pass

class ClickEvent(Event):
    pass

PARAMS = ParamSpec("PARAMS")
HANDLER = Callable[
    Concatenate[
        Event,
        PARAMS
    ], Union[Any, Coroutine[Any, Any, Any]]
]

关键说明 #

• ParamSpec和Concatenate是Python 3.10才正式加入标准库typing模块的特性
• 如果你使用Python 3.8，需要先安装typing_extensions包（pip install typing-extensions），再从该包中导入这两个工具

内容的提问来源于stack exchange，提问作者Tubbs