Python中带**kwargs的函数参数编辑器提示配置方法

要让编辑器识别**kwargs里的key1、key2并给出补全提示，单纯调整编辑器设置不够，得先给函数添加类型注解，再配合编辑器的语言服务配置，具体步骤如下：

VS Code 操作步骤 #

1. 确认安装最新版的Python插件（VS Code默认自带，可在扩展市场检查更新）
2. 切换到更智能的语言服务：
   • 按Ctrl+,打开设置，搜索Python › Language Server，选择Pylance（它对复杂类型提示的支持比默认Jedi更好）
3. 给函数添加类型注解，用TypedDict明确kwargs的结构：

   from typing import TypedDict
   
   # 定义支持的关键字参数及其类型
   class FunctionAllowedKwargs(TypedDict):
       key1: str  # 按实际参数类型修改，比如int、bool等
       key2: str
   
   def function(**kwargs: FunctionAllowedKwargs):
       for key, value in kwargs.items():
           if key == "key1":
               print(value)
           if key == "key2":
               print(value)
       print("Done")
   

   如果你用的是Python 3.11及以上版本，可以用Unpack让注解更严谨：

   from typing import TypedDict, Unpack
   
   class FunctionAllowedKwargs(TypedDict):
       key1: str
       key2: str
   
   def function(**kwargs: Unpack[FunctionAllowedKwargs]):
       # 函数体保持不变
   

4. 完成后输入function(，VS Code会自动弹出key1、key2的补全提示

Spyder 操作步骤 #

1. 启用智能代码分析：
   • 打开工具 > 偏好设置 > 编辑器 > 代码分析，勾选启用代码分析，并将分析器设置为Pyright（Spyder 5.3及以上版本支持，解析类型注解的能力更强）
2. 同样给函数添加上面的TypedDict类型注解
3. 验证：在编辑器输入function(，Spyder的补全菜单就会显示key1和key2

重要提示 #

编辑器本身没法凭空识别**kwargs里的具体参数，必须通过类型注解明确声明支持的关键字，编辑器的语言服务才能解析并提供补全。如果你的Python版本低于3.8，可以安装typing_extensions库，用里面的TypedDict来实现兼容。

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