如何为透传参数到其他函数的Python函数添加注解实现IDE补全

现有如下Python代码：

def foo(myarg, **other_args):
    # do something
    return bar(**other_args)

请问是否可以为foo函数添加对应的类型注解，使IDE能够识别到foo的**other_args参数对应函数bar的入参，从而在调用foo时给出bar相关参数的智能代码补全提示？

是可以实现的，根据你使用的Python版本不同，有两种常用实现方案：

方案1：Python 3.11+ 直接透传bar的参数签名 #

用typing.ParamSpec和typing.Unpack可以直接把bar的入参类型1:1同步到foo的参数上，IDE可以完全识别补全，不需要手动维护参数列表：

from typing import Callable, ParamSpec, Unpack, Any

# 定义ParamSpec捕获bar的参数类型
P = ParamSpec("P")
# 标注bar的类型，返回值可以换成bar实际的返回类型，这里用Any示例
bar: Callable[P, Any]

def foo(myarg: str, **other_args: Unpack[P.kwargs]) -> Any:
    # 这里的myarg类型可以换成你实际需要的类型
    return bar(**other_args)

如果需要同时支持位置参数透传给bar，把*args: P.args加到foo的参数列表里即可。

方案2：低版本Python兼容方案 #

如果使用Python 3.10及更早版本，可以通过TypedDict限定bar的参数类型，配合typing_extensions.Unpack实现识别：

from typing import TypedDict
from typing_extensions import Unpack

# 按bar的实际参数定义TypedDict，total=False表示所有字段都是可选的
class BarParams(TypedDict, total=False):
    # 这里的字段和类型要和bar的入参完全对应
    param1: int
    param2: str
    param3: bool

def bar(param1: int, param2: str, param3: bool = True):
    # bar的原有实现
    pass

def foo(myarg: str, **other_args: Unpack[BarParams]):
    return bar(**other_args)

这种方案需要手动维护TypedDict和bar的参数一致性，目前PyCharm、VS Code（带Pylance插件）都支持这种写法的参数补全。

小提示：如果bar的参数后续会频繁变动，优先选方案1，可以省去手动同步参数的成本。

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