プロトコル バッファ ルール

問題を報告 ソースを表示 ナイトリー · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ルール

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 ライブラリを生成します。 通常、`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 = "foo_proto", srcs = ["foo.proto"], ) ```

引数

属性
name

名前: 必須

このターゲットの一意の名前。

deps

ラベルのリスト。デフォルトは [] です。

Python ライブラリを生成する「proto_library」ルールのリスト。通常、これは 1 つのターゲット(対象のプロトライブラリ)のみです。これは、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)はプロトコンパイラを呼び出す必要があります。一部の LANG_proto_library ルールでは、コマンドライン フラグを使用して使用するツールチェーンを指定できます。ドキュメントをご覧ください。

通常、Java コンパイラをチューニングする場合を除き、このようなルールは記述しないでください。

コンパイラはありません。proto コンパイラは、アタッチする proto_library ルールから取得されます。これは、コマンドライン フラグとして Blaze に渡されます。一部の機能では、proto_library ルール自体でプロトコル コンパイラを呼び出す必要があります。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_protossrcs 属性のファイルにはコードは生成されません。これは、any.proto など、proto ランタイムにすでにリンクされている .proto ファイルに使用されます。
command_line

文字列(必須)

この値は、コードを生成するためにプロト コンパイラに渡されます。このコード生成ツールまたはプラグインに固有の部分のみを含めます(たとえば、-I パラメータを含めないでください)。
  • $(OUT) は LANG_proto_library 固有です。ルールでは、この変数の解釈方法を定義する必要があります。たとえば、Java の場合、$(OUT) は作成する src-jar ファイル名に置き換えられます。
mnemonic

文字列。デフォルトは "GenProto"

この値は、protoc アクションの頭字語として設定されます。
output_files

文字列。デフォルトは "legacy" です。

command_line$(OUT) の形式を制御します。単一ファイルの場合はパス、複数ファイルの場合は出力ディレクトリです。有効な値は「single」、「multiple」です。
plugin

ラベル(デフォルトは None

指定されている場合、プロトコル コンパイラを呼び出すアクションで使用可能になり、プロトコル コンパイラに渡されます。 --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

文字列。デフォルトは "" です。

指定すると、この値が proto-compiler に渡され、プラグインが使用されます。値には、プラグインの実行可能ファイルに置き換えられる %s を 1 つ含める必要があります。--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