属性

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
問題を報告 ソースを表示

ルールまたはアスペクトの属性スキーマを定義する最上位モジュール。各関数は、単一の属性のスキーマを表すオブジェクトを返します。これらのオブジェクトは、rule() と aspect() の attrs 辞書引数の値として使用されます。

属性の定義と使用の詳細については、ルールページをご覧ください。

メンバー

ブール値

Attribute attr.bool(default=False, doc='', mandatory=False)

ブール値属性のスキーマを作成します。対応する ctx.attr 属性は、bool 型になります。

パラメータ

パラメータ 説明
default default = False
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。

int

Attribute attr.int(default=0, doc='', mandatory=False, values=[])

整数属性のスキーマを作成します。符号付き 32 ビット範囲内の値にする必要があります。対応する ctx.attr 属性は、int 型になります。

パラメータ

パラメータ 説明
default デフォルト = 0
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
values sequence of ints; default = []
属性で許可される値のリスト。他の値を指定すると、エラーが発生します。

int_list

Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc='')

整数のリストのスキーマを作成します。各要素は 32 ビット符号付き範囲内に置く必要があります。

パラメータ

パラメータ 説明
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
allow_empty default = True
属性を空にできる場合は true。
default sequence of ints default = []
ルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。

ラベル

Attribute attr.label(default=None, doc='', executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])

ラベル属性のスキーマを作成します。これは依存関係属性です。

この属性には、一意の Label 値が含まれます。Label の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。名前が変更された（場合によっては名前が変更された）リポジトリを含む、ラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに関して解決されます。

分析時（ルールの実装関数内）、ctx.attr から属性値を取得する際、ラベルは対応する Target に置き換えられます。これにより、現在のターゲットの依存関係のプロバイダにアクセスできます。

この種の属性は、通常のソースファイルに加えて、コンパイラなどのツールを参照するためによく使用されます。このようなツールは、ソースファイルと同様に、依存関係とみなされます。ユーザーが BUILD ファイルでルールを使用するたびにツールのラベルを指定する必要がないように、正規ツールのラベルをこの属性の default 値としてハードコードできます。ユーザーがこのデフォルトをオーバーライドできないようにするには、この属性を非公開にします。名前にはアンダースコアで始まる名前を付けます。詳細については、[ルール] ページをご覧ください。

パラメータ

パラメータ 説明
default Label; or string; or LateBoundDefault; or NativeComputedDefault; or function; or None default = None
ルールをインスタンス化する際にこの属性に値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用して、デフォルト値（attr.label(default = "//a:b") など）を指定します。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
executable default = False
依存関係を実行可能にする必要がある場合は true。つまり、ラベルは実行可能ファイルを参照するか、実行可能ファイルを出力するルールを参照する必要があります。ctx.executable.<attribute_name> でラベルにアクセスします。
allow_files bool; or sequence of strings; or None、デフォルト = なし
File ターゲットが許可されているかどうか。True、False（デフォルト）、または許可されるファイル拡張子のリスト（[".cc", ".cpp"] など）を指定できます。
allow_single_file default = None
これは allow_files と似ていますが、ラベルが 1 つの File に対応しなければならないという制限があります。ctx.file.<attribute_name> からアクセスします。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
providers デフォルト = []
この属性で指定された依存関係によって提供されるプロバイダ。

この引数の形式は、プロバイダのリスト（provider()（従来のプロバイダの場合は文字列名）によって返される *Info オブジェクト）のリストです。依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数は単一レベルのプロバイダのリストであることもあります。その場合、この引数は 1 つの要素を含む外部リストでラップされます。
allow_rules sequence of strings; or None default = None
どのルール ターゲット（クラス名）を許可するか。非推奨です（互換性の確保のみ）。代わりにプロバイダを使用してください。
cfg default = None
属性の構成。"exec" は、依存関係が execution platform に対してビルドされていることを示し、"target" は、依存関係が target platform に対してビルドされていることを示します。違いの典型的な例は、モバイルアプリを作成する場合です。ここで、target platform は Android または iOS で、execution platform は Linux、macOS、または Windows です。このパラメータは、ターゲット構成でホストツールを誤ってビルドするのを防ぐために executable が true の場合は必須です。"target" にはセマンティック効果がないため、executable が False の場合は、意図を明確にしてくれる場合を除き、これを設定しないでください。
aspects sequence of Aspects default = []
この属性で指定された依存関係に適用されるアスペクト。

label_keyed_string_dict

Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc='', allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

辞書を保持する属性のスキーマを作成します。キーはラベルで、値は文字列です。これは依存関係属性です。

この属性には、一意の Label 値が含まれます。Label の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。名前が変更された（場合によっては名前が変更された）リポジトリを含む、ラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに関して解決されます。

分析時（ルールの実装関数内）、ctx.attr から属性値を取得する際、ラベルは対応する Target に置き換えられます。これにより、現在のターゲットの依存関係のプロバイダにアクセスできるようになります。

パラメータ

パラメータ 説明
allow_empty default = True
属性を空にできる場合は true。
default dict; or function; default = {}
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用してデフォルト値を指定します（例: attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"})）。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
allow_files bool; or sequence of strings; or None、デフォルト = なし
File ターゲットが許可されているかどうか。True、False（デフォルト）、または許可されるファイル拡張子のリスト（[".cc", ".cpp"] など）を指定できます。
allow_rules sequence of strings; or None default = None
どのルール ターゲット（クラス名）を許可するか。非推奨です（互換性の確保のみ）。代わりにプロバイダを使用してください。
providers デフォルト = []
この属性で指定された依存関係によって提供されるプロバイダ。

この引数の形式は、プロバイダのリスト（provider()（従来のプロバイダの場合は文字列名）によって返される *Info オブジェクト）のリストです。依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数は単一レベルのプロバイダのリストであることもあります。その場合、この引数は 1 つの要素を含む外部リストでラップされます。
flags sequence of strings; default = []
非推奨。削除されます。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
cfg default = None
属性の構成。"exec" は、依存関係が execution platform に対してビルドされていることを示し、"target" は、依存関係が target platform に対してビルドされていることを示します。違いの典型的な例は、モバイルアプリをビルドする場合です。ここで、target platform は Android または iOS で、execution platform は Linux、macOS、または Windows です。
aspects sequence of Aspects default = []
この属性で指定された依存関係に適用されるアスペクト。

label_list

Attribute attr.label_list(allow_empty=True, *, default=[], doc='', allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

ラベルのリスト属性のスキーマを作成します。これは依存関係属性です。対応する ctx.attr 属性は、Target の list 型になります。

この属性には、一意の Label 値が含まれます。Label の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。名前が変更された（場合によっては名前が変更された）リポジトリを含む、ラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに関して解決されます。

分析時（ルールの実装関数内）、ctx.attr から属性値を取得する際、ラベルは対応する Target に置き換えられます。これにより、現在のターゲットの依存関係のプロバイダにアクセスできるようになります。

パラメータ

パラメータ 説明
allow_empty default = True
属性を空にできる場合は true。
default sequence of Labels; or function; default = []
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用して、デフォルト値を指定します（例: attr.label_list(default = ["//a:b", "//a:c"])）。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
allow_files bool; or sequence of strings; or None、デフォルト = なし
File ターゲットが許可されているかどうか。True、False（デフォルト）、または許可されるファイル拡張子のリスト（[".cc", ".cpp"] など）を指定できます。
allow_rules sequence of strings; or None default = None
どのルール ターゲット（クラス名）を許可するか。非推奨です（互換性の確保のみ）。代わりにプロバイダを使用してください。
providers デフォルト = []
この属性で指定された依存関係によって提供されるプロバイダ。

この引数の形式は、プロバイダのリスト（provider()（従来のプロバイダの場合は文字列名）によって返される *Info オブジェクト）のリストです。依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数は単一レベルのプロバイダのリストであることもあります。その場合、この引数は 1 つの要素を含む外部リストでラップされます。
flags sequence of strings; default = []
非推奨。削除されます。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
cfg default = None
属性の構成。"exec" は、依存関係が execution platform に対してビルドされていることを示し、"target" は、依存関係が target platform に対してビルドされていることを示します。違いの典型的な例は、モバイルアプリをビルドする場合です。ここで、target platform は Android または iOS で、execution platform は Linux、macOS、または Windows です。
aspects sequence of Aspects default = []
この属性で指定された依存関係に適用されるアスペクト。

出力

Attribute attr.output(doc='', mandatory=False)

出力（ラベル）属性のスキーマを作成します。

この属性には、一意の Label 値が含まれます。Label の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。名前が変更された（場合によっては名前が変更された）リポジトリを含む、ラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに関して解決されます。

分析時に、対応する File を ctx.outputs を使用して取得できます。

パラメータ

パラメータ 説明
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。

出力リスト

Attribute attr.output_list(allow_empty=True, *, doc='', mandatory=False)

出力のリストの属性のスキーマを作成します。

この属性には、一意の Label 値が含まれます。Label の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。名前が変更された（場合によっては名前が変更された）リポジトリを含む、ラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに関して解決されます。

分析時に、対応する File を ctx.outputs を使用して取得できます。

パラメータ

パラメータ 説明
allow_empty default = True
属性を空にできる場合は true。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。

文字列

Attribute attr.string(default='', doc='', mandatory=False, values=[])

string 属性のスキーマを作成します。

パラメータ

パラメータ 説明
default string; or NativeComputedDefault default = ''
ルールをインスタンス化する際に、この属性に値が指定されていない場合に使うデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
values sequence of strings; default = []
属性で許可される値のリスト。他の値を指定すると、エラーが発生します。

文字列辞書

Attribute attr.string_dict(allow_empty=True, *, default={}, doc='', mandatory=False)

辞書を保持する属性のスキーマを作成します。キーと値は文字列です。

パラメータ

パラメータ 説明
allow_empty default = True
属性を空にできる場合は true。
default デフォルト = {}
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。

文字列リスト

Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc='')

文字列のリスト属性のスキーマを作成します。

パラメータ

パラメータ 説明
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。
allow_empty default = True
属性を空にできる場合は true。
default sequence of strings; or NativeComputedDefault default = []
ルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。

文字列リスト

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc='', mandatory=False)

辞書を保持する属性のスキーマを作成します。ここで、キーは文字列で、値は文字列のリストです。

パラメータ

パラメータ 説明
allow_empty default = True
属性を空にできる場合は true。
default デフォルト = {}
ルールをインスタンス化する際にこの属性の値が指定されていない場合に使用するデフォルト値。
doc default = ''
ドキュメント生成ツールで抽出できる属性の説明。
mandatory default = False
true の場合、値を明示的に指定する必要があります（default が設定されている場合も同様）。