协议缓冲区规则

报告问题 查看源代码 每夜 build · 7.4 .

规则

• py_proto_library
• proto_lang_toolchain
• proto_toolchain

py_proto_library

查看规则来源

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

使用“py_proto_library”从“.proto”文件生成 Python 库。 惯例是，当 `py_proto_library` 规则封装 `proto_library` 规则 `foo_proto` 时，将 `py_proto_library` 规则命名为 `foo_py_pb2`。 `deps` 必须指向 `proto_library` 规则。 示例： ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "s_foo)"

参数

属性
name	名称；必需 此目标的唯一名称。
deps	标签列表；默认值为 [] 要为其生成 Python 库的“proto_library”规则列表。 通常，这只是一个目标：感兴趣的 proto 库。它可以是提供 `ProtoInfo` 的任何目标。

proto_lang_toolchain

查看规则来源

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

如果使用 Bazel，请从 https://github.com/bazelbuild/rules_proto 加载规则。

指定 LANG_proto_library 规则（例如，java_proto_library) 应调用 proto 编译器。某些 LANG_proto_library 规则允许使用命令行标志指定要使用的工具链；请参阅相关文档。

通常，除非您想要调整 Java 编译器，否则不应编写这些规则。

没有编译器。proto-compiler 取自我们附加到的 proto_library 规则。它会作为命令行标志传递给 Blaze。 若要使用某些功能，需要对 proto_library 规则本身调用 proto 编译器。强制使 LANG_proto_library 使用的编译器与 proto_library 使用的编译器相同。

示例

下面是一个简单示例：

proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

参数

属性
name	名称；必需 此目标的唯一名称。
allowlist_different_package	标签；默认值为 None
blacklisted_protos	标签列表；默认值为 [] 系统不会为 blacklisted_protos 的 srcs 属性中的文件生成任何代码。这适用于已链接到 proto 运行时（例如 any.proto）的 .proto 文件。
command_line	字符串；必需 此值将传递给 proto-compiler 以生成代码。仅包含特定于此代码生成器/插件的部分（例如，不包含 -I 参数） $(OUT) 特定于 LANG_proto_library。规则应定义如何解读此变量。例如，对于 Java，$(OUT) 将替换为要创建的 src-jar 文件名。
mnemonic	字符串；默认值为 "GenProto" 此值将设置为 protoc 操作的助记符。
output_files	字符串；默认值为 "legacy" 用于控制 command_line 中的 $(OUT) 的格式，可以是单个文件的路径，也可以是多个文件的输出目录。可能的值包括“single”和“multiple”。
plugin	标签；默认值为 None 如果提供，将可用于调用 proto 编译器的操作，并将被传递给 proto 编译器： --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag	字符串；默认值为 "" 如果提供，此值将传递给 proto-compiler 以使用该插件。该值必须包含一个由插件可执行文件替换的 %s。 --plugin=protoc-gen-PLUGIN=<executable>.
progress_message	字符串；默认值为 "Generating proto_library %{label}" 此值将设置为 protoc 操作的进度消息。
protoc_minimal_do_not_use	标签；默认值为 None
runtime	标签；默认值为 None 生成的代码要针对哪个语言专用库进行编译。确切行为因 LANG_proto_library 而异。 例如，Java 应针对运行时进行编译。
toolchain_type	标签；默认值为 None

proto_toolchain

查看规则来源

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

参数

属性
name	名称；必需 此目标的唯一名称。
command_line	字符串；默认值为 "--descriptor_set_out=%s"
mnemonic	字符串；默认值为 "GenProtoDescriptorSet"
output_files	字符串；默认值为 "single"
progress_message	字符串；默认值为 "Generating Descriptor Set proto_library %{label}"
proto_compiler	标签；默认值为 None