PyCharm无法识别Protobuf响应类型，如何开启代码自动补全？

问题详情 #

调用gRPC服务可正常获取CountResponse类型响应，但在PyCharm中输入response.并按Ctrl+Enter时，无法弹出response.count等属性的自动补全选项。已生成对应的.pyi类型文件，且文件包含正确的属性定义。

直接调用服务的代码示例 #

with grpc.insecure_channel('localhost:4443') as channel:
     stub = SERVICESgrpc.CountServiceStub(channel)
     response = stub.GetCount(SERVICES.CountRequest())
     print(type(response))
     # 打印结果显示类型为CountResponse，但IDE无法识别

先初始化响应对象的尝试 #

with grpc.insecure_channel('localhost:4443') as channel:
         stub = SERVICESgrpc.CountServiceStub(channel)
         response = SERVICES.CountResponse()
         # 此处response.count可自动补全
         response = stub.GetCount(SERVICES.CountRequest())
         # 打印显示类型为CountResponse，但IDE仍无法识别
         print(type(response))
         # 可正常运行，但无法自动补全response.count
         print(response.count)

原型文件编译命令 #

python -m grpc_tools.protoc -I../../../../googleapis -I../../protos --python_out=. --pyi_out=. --grpc_python_out=. ../../protos/mypackage/serviceapis.proto

解决方法 #

1. 给响应变量添加类型注解 #

PyCharm无法自动推断stub方法的返回类型，手动给response变量指定类型：

with grpc.insecure_channel('localhost:4443') as channel:
     stub = SERVICESgrpc.CountServiceStub(channel)
     response: SERVICES.CountResponse = stub.GetCount(SERVICES.CountRequest())
     print(response.count)  # 此时可触发自动补全

2. 确保PyCharm正确识别.pyi文件 #

• 确认.pyi文件与对应的.py文件在同一目录，且文件名完全匹配（如serviceapis_pb2.pyi对应serviceapis_pb2.py）
• 打开PyCharm的File > Settings > Project: [你的项目名称] > Project Structure，将proto生成文件所在目录标记为Sources Root
• 执行File > Invalidate Caches... > Invalidate and Restart，清除缓存后重启IDE

3. 更新grpc相关依赖 #

旧版本的grpc-tools可能生成不兼容的.pyi文件，升级依赖：

pip install --upgrade grpc-tools grpcio grpcio-tools

4. 补全stub方法的类型注解（可选） #

如果上述方法无效，可手动修改生成的_pb2_grpc.pyi文件，给GetCount方法添加返回类型注解：

class CountServiceStub:
    def GetCount(self, request: SERVICES.CountRequest, *, timeout: float | None = ..., metadata: ... = ...) -> SERVICES.CountResponse:
        ...

注意：手动修改后，下次重新编译proto文件会覆盖该内容，建议通过自定义编译脚本自动添加注解。

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