协议缓冲区导入解析

Question

在阅读这个相当长的问题之前，我提出了一个bughttps://github.com/GoogleCloudPlatform/python-docs-samples/issues/1103.

原型包和名称解析的留档状态

您可以使用其他定义。通过导入原始文件。导入另一个。在proto的定义中，您可以在文件的顶部添加一条import语句。

我的example.proto依赖于annotations.proto将HTTP/JSON转码到gRPC。这是一个简单的例子，但请注意，我使用了来自googleapis/google/api Git存储库的导入路径（即google/api/annotations.proto）：

syntax = "proto3";
import "google/api/annotations.proto";

message MyExample {
  // Message definition here.
}

注意，annotations.proto取决于http.proto-他们是同一个包中的兄弟姐妹（googleapis/google/api）

我的本地项目目录包含三个。原型文件：

1. <代码>示例。协议
2. google/api/annotations。协议
3. google/api/http。协议

...或作为一棵树：

|____google
| |____api
| | |____annotations.proto
| | |____http.proto
|____example.proto

还将添加目标（或“out”）目录，以便接收生成的python文件：

|____generated_pb2
| |____google
| | |____api

我的完整项目目录结构如下：

• <代码>示例。协议
• google/api/annotations。协议
• google/api/html" target="_blank">http。协议
• 生成的pb2/google/api

...或作为一棵树：

|____example.proto
|____google
| |____api
| | |____annotations.proto
| | |____http.proto
|____generated_pb2
| |____google
| | |____api

有了这个，我可以编译我的原型（为易读性添加了格式）：

python -m grpc_tools.protoc
  --python_out=generated_pb2
  --grpc_python_out=generated_pb2
  -I ~/protoc/include/google/protobuf
  -I /google/api
  example.proto

对此进行分解：

• 生成的\u pb2-生成的python文件和gprc文件的目标
• <代码>~/protoc/include/google/protobuf-protoc二进制文件附带的常见protos的位置，自注释以来需要。proto依赖于google/protobuf/descriptor。原型
• google/api-注释的位置。proto和http。协议

这将编译示例。proto给出：

• generated_pb2/example_pb2.py
• generated_pb2/example_pb2_gprc.py

然而，的第一行生成了\u pb2/example\u pb2。py导入为注释生成的文件。协议：

from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2

此文件不存在。没问题，我会单独编译annotations.proto：

python -m grpc_tools.protoc
  --python_out=generated_pb2/google/api
  --grpc_python_out=generated_pb2/google/api
  -I ~/protoc/include/google/protobuf
  -I google/api annotations.proto

对此进行分解：

• generated\u pb2/google/api-生成的python文件和gprc文件的目标
• <代码>~/protoc/include/google/protobuf-protoc二进制文件附带的常见protos的位置，自注释以来需要。proto依赖于google/protobuf/descriptor。原型
• 谷歌/api-http的位置。proto，其上有注释。协议取决于

不幸的是，我在这一点上遇到了一个错误：

google/api/http.proto: File not found.
annotations.proto: Import "google/api/http.proto" was not found or had errors.
annotations.proto:30:3: "HttpRule" is not defined.

我猜这是因为annotations.proto在google/api中查找http.proto：

syntax = "proto3";
package google.api;

import "google/api/http.proto";
import "google/protobuf/descriptor.proto";

然而，目前尚不清楚如何解决此依赖关系。协议--help记录了-I标志：

-IPATH, --proto_path=PATH   Specify the directory in which to search for
                            imports.  May be specified multiple times;
                            directories will be searched in order.  If not
                            given, the current working directory is used.

http.proto依赖于annotations.proto，如何解决？

Answer 1

试试这个：pip install googleapis-Common-pro s。我遇到了同样的错误，并使用这种方法解决了它。

Answer 2

当我尝试和你一样的事情时，我想出了一个可能的解决方案，使用Makefile来创建适当的文件。因为我正在使用python进行测试，所以我安装了grpc python包，并通过python使用proc而不是直接使用它，但是输入和结果应该是相同的。

每个protoc调用中使用的常规protobuf标志：

GRPC_FLAGS := \
    -I. \
    -I/usr/local/include \
    -I$(GOPATH)/src \
    -I$(GOPATH)/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis

源代码特定标志：

CLIENT_FLAGS := \
    --proto_path=./protos \       <-- This is where my *.proto live
    --python_out=grpctest/client \
    --grpc_python_out=grpctest/client

调用协议从您的*. proto生成项目特定的协议

python3 -m grpc_tools.protoc $(CLIENT_FLAGS) $(GRPC_FLAGS) protos/*.proto

注释特定标志：

CLIENT_GW_FLAGS := \
    --python_out=grpctest/client \
    --grpc_python_out=grpctest/client

调用protoc生成特定于注释的文件：

python3 -m grpc_tools.protoc $(CLIENT_GW_FLAGS) $(GRPC_FLAGS) google/api/annotations.proto
python3 -m grpc_tools.protoc $(CLIENT_GW_FLAGS) $(GRPC_FLAGS) google/api/http.proto

├── client.py
├── config.yml
├── file
├── google
│   └── api
│       ├── __pycache__
│       ├── annotations_pb2.py
│       ├── annotations_pb2_grpc.py
│       ├── http_pb2.py
│       └── http_pb2_grpc.py
├── grpctest_pb2.py
└── grpctest_pb2_grpc.py