如何在Google Cloud Build中用Python插件编译Protobuf并解决导入报错

错误原因 #

你推送到GCR的protoc镜像未正确将protoc二进制文件放入系统PATH路径，导致容器启动时找不到可执行文件。

解决方案（可选，更推荐grpcio-tools方案） #

重新按社区protoc镜像构建流程编译镜像，确保构建脚本中将protoc二进制复制到/usr/local/bin目录，同时安装Python对应的protobuf编译插件。

错误原因 #

有两个常见触发点：

1. 你的配置存在拼写错误：输入proto文件路径写为./protots/A.proto，应为./protos/A.proto，即使你实际环境中拼写正确，核心问题是Cloud Build的Python容器默认未将工作区路径加入Python模块搜索路径。
2. Cloud Build每个步骤运行在独立容器中，默认Python的sys.path不包含工作区根目录/workspace，也不包含protos目录，而protoc默认生成的Python代码采用绝对导入，A_pb2.py导入B_pb2.py时会直接从sys.path搜索对应模块，找不到就报错。本地能正常运行是因为你本地执行时当前目录默认在sys.path中。

修复方案 #

步骤1：修正拼写错误 #

把两个protoc编译步骤的输入路径从./protots/*.proto改为./protos/*.proto。

步骤2：给测试步骤添加Python路径环境变量 #

在unittest步骤中配置env字段，将工作区根目录和protos目录加入PYTHONPATH，修改后的配置如下：

- name: python:3.7
  args: ["python", "-m", "grpc_tools.protoc",  "-I", "./protos",
         "--python_out=./protos", "./protos/A.proto"]
- name: python:3.7
  args: ["python", "-m", "grpc_tools.protoc",  "-I", "./protos",
         "--python_out=./protos", "./protos/B.proto"]

- name: python:3.7
  env:
    - PYTHONPATH=/workspace:/workspace/protos
  args: ["python","-m","unittest","discover","--verbose","-s","./tests/",
        "-p","test.py"]
  id: unittest

可选调试方法 #

如果修改后仍报错，可在测试步骤打印当前Python搜索路径排查问题：

- name: python:3.7
  env:
    - PYTHONPATH=/workspace:/workspace/protos
  args: ["sh", "-c", "python -c 'import sys; print(sys.path)' && ls -la /workspace/protos && python -m unittest discover --verbose -s ./tests/ -p test.py"]
  id: unittest

上述配置会同时打印Python搜索路径、protos目录下的文件列表，快速定位问题。

内容的提问来源于stack exchange，提问作者king-network