属性

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

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

メンバー

• bool
• int
• int_list
• label
• label_keyed_string_dict
• label_list
• output
• output_list
• 文字列
• string_dict
• string_list
• string_list_dict

bool

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

ブール値属性のスキーマを作成します。

パラメータ

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

int

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

整数属性のスキーマを作成します。値は符号付き 32 ビット範囲内でなければなりません。

パラメータ

パラメータ	説明
default	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='')

list-of-integers 属性のスキーマを作成します。各要素は符号付き 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; default = 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	default = [] この属性に現れる依存関係によって指定される必要があるプロバイダ。 この引数の形式は、プロバイダのリストです。つまり、provider() から返される *Info オブジェクト（以前のプロバイダの場合は文字列名）です。この依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数はプロバイダの単一レベルのリストにもできます。その場合は、1 つの要素を持つ外側のリストにラップされます。
allow_rules	sequence of strings; or None; default = None 許可されるルール ターゲット（クラスの名前）です。これは非推奨となっています（互換性のためだけに残しています）。代わりにプロバイダを使用してください。
cfg	default = None 属性の構成。依存関係が execution platform に対してビルドされることを示す "exec" か、依存関係が target platform に対してビルドされることを示す "target" のいずれかになります。相違点の典型的な例は、モバイルアプリをビルドする場合です。この場合、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; default = None File ターゲットを許可するかどうか。True、False（デフォルト）、または許可されているファイル拡張子のリスト（[".cc", ".cpp"] など）を指定できます。
allow_rules	sequence of strings; or None; default = None 許可されるルール ターゲット（クラスの名前）です。これは非推奨となっています（互換性のためだけに残しています）。代わりにプロバイダを使用してください。
providers	default = [] この属性に現れる依存関係によって指定される必要があるプロバイダ。 この引数の形式は、プロバイダのリストです。つまり、provider() から返される *Info オブジェクト（以前のプロバイダの場合は文字列名）です。この依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数はプロバイダの単一レベルのリストにもできます。その場合は、1 つの要素を持つ外側のリストにラップされます。
flags	sequence of strings; default = [] 非推奨。今後削除されます。
mandatory	default = False true の場合、（default がある場合でも）値を明示的に指定する必要があります。
cfg	default = None 属性の構成。依存関係が execution platform に対してビルドされることを示す "exec" か、依存関係が target platform に対してビルドされることを示す "target" のいずれかになります。相違点の典型的な例は、モバイルアプリをビルドする場合です。この場合、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=[])

list-of-labels 属性のスキーマを作成します。これは依存関係属性です。

この属性には一意の 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; default = None File ターゲットを許可するかどうか。True、False（デフォルト）、または許可されているファイル拡張子のリスト（[".cc", ".cpp"] など）を指定できます。
allow_rules	sequence of strings; or None; default = None 許可されるルール ターゲット（クラスの名前）です。これは非推奨となっています（互換性のためだけに残しています）。代わりにプロバイダを使用してください。
providers	default = [] この属性に現れる依存関係によって指定される必要があるプロバイダ。 この引数の形式は、プロバイダのリストです。つまり、provider() から返される *Info オブジェクト（以前のプロバイダの場合は文字列名）です。この依存関係は、少なくとも 1 つの内部リストに記載されているすべてのプロバイダを返す必要があります。便宜上、この引数はプロバイダの単一レベルのリストにもできます。その場合は、1 つの要素を持つ外側のリストにラップされます。
flags	sequence of strings; default = [] 非推奨。今後削除されます。
mandatory	default = False true の場合、（default がある場合でも）値を明示的に指定する必要があります。
cfg	default = None 属性の構成。依存関係が execution platform に対してビルドされることを示す "exec" か、依存関係が target platform に対してビルドされることを示す "target" のいずれかになります。相違点の典型的な例は、モバイルアプリをビルドする場合です。この場合、target platform は Android または iOS であるのに対し、execution platform は Linux、macOS、または Windows です。
aspects	sequence of Aspects; default = [] この属性で指定された依存関係に適用されるアスペクト。

出力

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

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

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

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

パラメータ

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

output_list

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

list-of-outputs 属性のスキーマを作成します。

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

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

パラメータ

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

string

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

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

パラメータ

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

string_dict

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

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

パラメータ

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

string_list

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 = '' ドキュメント生成ツールで抽出できる属性の説明。

string_list_dict

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

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

パラメータ

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