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

問題を報告 ソースを表示 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

ルール

cc_proto_library

ルールソースを表示 
cc_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library は .proto ファイルから C++ コードを生成します。

deps は proto_library ルールを指している必要があります。

例: 


cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引数

属性
name

名前（必須）

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

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

C++ コードを生成する proto_library ルールのリスト。

java_lite_proto_library

ルールソースを表示 
java_lite_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library は .proto ファイルから Java コードを生成します。

deps は proto_library ルールを指している必要があります。

例: 


java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

引数

属性
name

名前（必須）

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

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

Java コードを生成する proto_library ルールのリスト。

java_proto_library

ルールソースを表示 
java_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, licenses, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library は .proto ファイルから Java コードを生成します。

deps は proto_library ルールを指している必要があります。

例: 


java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

引数

属性
name

名前（必須）

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

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

Java コードを生成する proto_library ルールのリスト。

proto_library

ルールソースを表示 
proto_library(name, deps, srcs, data, allow_exports, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, exports, features, import_prefix, licenses, package_metadata, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

proto_library を使用して、複数の言語で使用できるプロトコル バッファのライブラリを定義します。proto_library は、java_proto_library などのサポートされているルールの deps 句にリストされている場合があります。

コマンドラインでコンパイルすると、proto_library は foo-descriptor-set.proto.bin という名前のファイルを作成します。これは、ルールがソースとするメッセージの記述子セットです。このファイルは、 https://developers.google.com/protocol-buffers/docs/techniques#self-description で説明されているシリアル化された FileDescriptorSet です。

これには、proto_library ルールで直接言及されている .proto ファイルに関する情報のみが含まれます。推移的記述子セットのコレクションは、[ProtoInfo].transitive_descriptor_sets Starlark プロバイダから取得できます。proto_info.bzl のドキュメントをご覧ください。

推奨されるコード構成:

  • .proto ファイルごとに 1 つの proto_library ルール。
  • foo.proto という名前のファイルは、同じパッケージにある foo_proto という名前のルールにあります。
  • foo_proto という名前の proto_library をラップする [language]_proto_library は foo_[language]_proto と呼び、同じパッケージに配置する必要があります。

引数

属性
name

名前（必須）

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

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

ターゲットが依存する他の proto_library ルールのリスト。proto_library は、他の proto_library ターゲットにのみ依存できます。言語固有のライブラリに依存しない場合があります。
srcs

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

ターゲットの作成のために処理される .proto ファイルと .protodevel ファイルのリスト。通常、これは空でないリストです。srcs が空になるユースケースの 1 つは、エイリアス ライブラリです。これは、deps に 1 つ以上の他の proto_library を持つ proto_library ルールです。このパターンは、永続名で公開 API をエクスポートする場合などに使用できます。
allow_exports

ラベル。デフォルトは None です。

proto ライブラリが再エクスポートされたり、リストにないパッケージの lang_proto_library で使用されたりするのを防ぐための許可リスト（省略可）。
exports

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

proto ソースの「import public」で参照できる proto_library ターゲットのリスト。「import public」を使用しているにもかかわらず、対応するライブラリを exports 属性にリストしていない場合はエラーになります。すべての lang_proto_library 実装がまだ変更されていないため、deps と exports の両方でライブラリをリストする必要があります。
import_prefix

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

このルール内の .proto ファイルのパスに追加する接頭辞。

設定すると、このルールの srcs 属性の .proto ソースファイルは、この属性の値がリポジトリ相対パスの前に付加されたパスでアクセスできるようになります。

strip_import_prefix 属性の接頭辞は、この接頭辞が追加される前に削除されます。
strip_import_prefix

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

このルールの .proto ファイルのパスから削除する接頭辞。

設定すると、このルールの srcs 属性にある .proto ソースファイルは、この接頭辞が切り捨てられたパスでアクセス可能になります。

相対パス（スラッシュで始まらない）の場合は、パッケージ相対パスとして扱われます。絶対パスの場合は、リポジトリ相対パスとして解釈されます。

import_prefix 属性の接頭辞は、この接頭辞が削除された後に追加されます。

py_proto_library

ルールソースを表示 
py_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, 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 つのターゲット（対象の proto ライブラリ）のみです。`ProtoInfo` を提供する任意のターゲットを指定できます。

proto_lang_toolchain

ルールソースを表示 
proto_lang_toolchain(name, allowlist_different_package, aspect_hints, blacklisted_protos, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, 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-compiler は、アタッチする proto_library ルールから取得されます。これは、Blaze にコマンドライン フラグとして渡されます。一部の機能では、proto_library ルール自体で proto-compiler を呼び出す必要があります。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 属性にあるファイルに対してコードは生成されません。これは、any.proto など、すでに 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 です。

指定された場合、プロトコンパイラを呼び出すアクションで使用可能になり、プロトコンパイラに渡されます。 --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, aspect_hints, command_line, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, 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 です。