如何为Protocol方法仅标注第一个位置参数类型，其余参数不限制？

需求 #

我们需要实现一个名为MyProtocol的Protocol，要求实现类的my_method方法满足：

• 第一个位置参数必须为int类型
• 后续参数的数量、类型、命名无任何限制
• 返回值必须是int类型

正确与错误实现示例 #

正确实现

class Imp1(MyProtocol):
    def my_method(self, first_param: int, x: float, y: float) -> int:
        return int(first_param - x + y)

错误实现（第一个参数类型不匹配）

class Imp2(MyProtocol):
    def my_method(self, x: float, y: float) -> int:  # 错误：第一个参数需为int
        return int(x + y)

问题分析 #

直接在Protocol中通过*args: Any和**kwargs: Any定义方法，会被mypy强制要求实现类也显式声明这两个参数，不符合“后续参数任意”的需求；而用抽象类加额外方法的方案会修改原API，破坏代码的直观性。

解决方案 #

使用typing.ParamSpec和TypeVar来约束第一个参数，同时允许后续参数任意变化：

from typing import Protocol, ParamSpec, TypeVar

# 用于匹配任意后续参数的规格变量
P = ParamSpec("P")
# 约束返回值必须为int类型
T = TypeVar("T", bound=int)

class MyProtocol(Protocol[P, T]):
    def my_method(self, first_param: int, *args: P.args, **kwargs: P.kwargs) -> T:
        ...

验证效果 #

• 对于Imp1，mypy会自动匹配后续参数的规格与返回值类型，符合约束，无报错。
• 对于Imp2，因第一个参数为float而非int，mypy会直接抛出类型错误，符合预期。

注意事项 #

• 该方案要求Python 3.9+（你的测试环境Python 3.9.13、mypy 0.991完全支持）
• 若使用Python 3.8及以下版本，需安装typing_extensions库来使用ParamSpec

内容的提问来源于stack exchange，提问作者giuliano-macedo