python - 如何从 protobuf 生成 python 类文件

Question

我正在尝试将大量结构化数据从 Java 传输到 Python。这包括许多以某种形式相互关联的对象。当我在我的 Python 代码中收到它们时，使用 protobuf 提供的类型是非常丑陋的。当尝试对类型使用自动完成时，我的 VIM IDE 崩溃了，PyCharm 没有完成任何东西，而且它们没有为不同的类型。

在 python 中处理 protobuf 消息时，有没有办法获得 IDE 支持？我正在查看 20 多种处理复杂消息的方法，如果没有 IDE 支持，我还不如使用记事本进行编码。

我知道 protobuf 正在使用元类(虽然我不知道他们为什么这样做)。也许有一种方法可以从该数据生成 python 类文件，或者可能有类似于 typescript typing files 的东西.

我可能误用了 protobuf 吗？我相信我会以一种可以跨语言使用的方式来描述我的领域模型。在 Java 中，我对生成的类很满意，我可以轻松地使用它们。我是否应该使用类似 swagger.io 的东西？相反？

Answer 1

如果您使用的是最新的 Python (3.7+)，那么 https://github.com/danielgtaylor/python-betterproto (免责声明:我是作者)将生成非常干净的 Python 数据类作为输出，这将为您提供正确的输入和 IDE 完成支持。

例如，这个输入:

syntax = "proto3";

package hello;

// Greeting represents a message you can tell a user.
message Greeting {
  string message = 1;
}

将生成以下输出:

# Generated by the protocol buffer compiler.  DO NOT EDIT!
# sources: hello.proto
# plugin: python-betterproto
from dataclasses import dataclass

import betterproto


@dataclass
class Hello(betterproto.Message):
    """Greeting represents a message you can tell a user."""

    message: str = betterproto.string_field(1)

一般来说，此插件的输出模仿 *.proto 输入，如果您碰巧跳转到消息或字段的定义，则非常容易阅读。对我个人而言，相对于官方 Google 编译器插件，这是一个 巨大 改进，并且还支持开箱即用的 async gRPC。