如何在生成的gRPC Python代码中添加PEP兼容类型提示

1. 原生工具生成类型存根（推荐） #

从protobuf 3.19+和grpcio-tools 1.40+版本开始，官方工具支持直接生成符合PEP标准的类型存根文件（.pyi），IDE会自动识别这些文件提供类型提示和检查。

生成protobuf类型存根 #

执行以下命令生成*_pb2.py和对应的类型存根*_pb2.pyi：

protoc --python_out=. --pyi_out=. your_proto_file.proto

生成gRPC Stub类型存根 #

结合grpc工具生成服务端/客户端Stub的类型存根：

python -m grpc_tools.protoc -I./proto --python_out=. --grpc_python_out=. --pyi_out=. ./proto/your_proto_file.proto

生成的*_pb2_grpc.pyi会为Stub的方法（比如GetFeature）标注精确的参数类型（Point）和返回值类型（Feature），IDE就能自动完成类型检查。

2. 第三方工具补全类型提示 #

如果使用旧版本的protobuf/grpc工具，可以用mypy-protobuf生成类型存根：

1. 安装工具：

pip install mypy-protobuf

2. 生成类型存根：

mypy-protobuf --python_out=. your_proto_file.proto

3. 手动添加局部类型注解 #

如果不想生成存根文件，也可以在业务代码中手动添加类型注解，让IDE识别：

from your_proto_pb2 import Point, Feature
from your_proto_pb2_grpc import RouteGuideStub

def fetch_feature(stub: RouteGuideStub, point: Point) -> Feature:
    return stub.GetFeature(point)

注意事项 #

• 确保安装了最新版的protobuf和grpcio-tools，原生支持最稳定；
• 生成的.pyi文件需与对应.py文件放在同一目录，IDE会自动加载；
• 部分IDE（如PyCharm）可能需要重启或重新索引项目，才能识别新生成的类型存根。

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