如何为VSCode中已知的外部Python类添加自定义自动补全？

1. 编写类型存根文件（.pyi） #

这是最规范的解决方案。针对无法访问源码的外部类，创建对应的.pyi类型存根文件，只需要定义类的结构、属性和方法的类型签名，不需要实现具体逻辑。

比如你导入的类是from external_module import RemoteClass，就可以在项目根目录下创建external_module.pyi文件，内容示例：

class RemoteClass:
    # 定义属性的类型
    id: int
    name: str

    # 定义方法的参数和返回值类型
    def __init__(self, id: int, name: str) -> None: ...
    def do_something(self, param: str) -> bool: ...

VSCode的Python语言服务会自动识别这些存根文件，提供和本地类一致的自动补全。

2. 手动添加类型注释 #

如果不想写完整的存根文件，可以在使用外部类的代码里直接添加类型注释，告诉VSCode变量的类型：

from external_module import RemoteClass

# 显式指定变量类型
obj: RemoteClass = RemoteClass(1, "test")
# 此时输入obj.就能触发自动补全
obj.do_something("hello")

如果是动态获取的实例，还可以用typing.cast强制指定类型：

from typing import cast
from external_module import RemoteClass

def get_remote_obj() -> object:
    # 模拟动态获取外部类实例的场景
    return RemoteClass(2, "demo")

# 强制转换类型
obj = cast(RemoteClass, get_remote_obj())
obj.do_something("test")

3. 配置VSCode的分析路径（仅当能间接获取路径时适用） #

如果外部类的安装路径实际存在，但VSCode没自动识别，可以在VSCode的settings.json里添加python.analysis.extraPaths，把外部类所在的目录加进去：

{
    "python.analysis.extraPaths": [
        "/path/to/external_module_directory"
    ]
}

不过如果完全无法访问定义文件，这个方法就不适用了。

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