ルールまたはアスペクトの属性スキーマを定義するための最上位モジュールです。各関数は、単一属性のスキーマを表すオブジェクトを返します。これらのオブジェクトは、rule()
と aspect()
の attrs
ディクショナリ引数の値として使用されます。
属性の定義と使用の詳細については、ルール ページをご覧ください。
メンバー
- bool
- int
- int_list
- ラベル
- label_keyed_string_dict
- label_list
- 出力
- output_list
- 文字列
- string_dict
- string_list
- string_list_dict
ブール値
Attribute attr.bool(default=False, doc=None, mandatory=False)ブール値属性のスキーマを作成します。対応する
ctx.attr
属性は bool
型です。
パラメータ
パラメータ | 説明 |
---|---|
default
|
デフォルトは False Rule のインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
int
Attribute attr.int(default=0, doc=None, mandatory=False, values=[])整数属性のスキーマを作成します。値は符号付き 32 ビット範囲内にする必要があります。対応する
ctx.attr
属性の型は int
です。
パラメータ
パラメータ | 説明 |
---|---|
default
|
デフォルトは 0 ルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。 |
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
mandatory
|
デフォルトは False です。true の場合、値は明示的に指定する必要があります( default が含まれている場合でも)。 |
values
|
int のシーケンス。
デフォルトは [] 属性で許可される値のリスト。他の値を指定すると、エラーが発生します。 |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)整数のリスト属性のスキーマを作成します。各要素は符号付き 32 ビットの範囲内にする必要があります。
パラメータ
パラメータ | 説明 |
---|---|
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
allow_empty
|
デフォルトは True 属性が空の可能性がある場合は true。 |
default
|
int のシーケンス。デフォルトは [] 。ルールのインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。 |
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
ラベル
Attribute attr.label(default=None, doc=None, 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
|
ラベル、文字列、LateBoundDefault、NativeComputedDefault、関数、None 。デフォルトは None 。ルールのインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用してデフォルト値を指定します(例: attr.label(default = "//a:b") )。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
executable
|
デフォルトは False 依存関係を実行可能にする必要がある場合は true に設定します。つまり、ラベルは実行可能ファイル、または実行可能ファイルを出力するルールを参照する必要があります。 ctx.executable.<attribute_name> を使用してラベルにアクセスします。 |
allow_files
|
bool;または文字列のシーケンス。または None
デフォルトは None ですFile ターゲットを許可するかどうか。True 、False (デフォルト)、または許可されるファイル拡張子のリスト([".cc", ".cpp"] など)を指定できます。
|
allow_single_file
|
デフォルトは None これは allow_files と似ていますが、ラベルは単一の File に対応している必要があります。ctx.file.<attribute_name> からアクセスしてください。
|
mandatory
|
デフォルトは False です。true の場合、値は明示的に指定する必要があります( default が含まれている場合でも)。 |
providers
|
デフォルトは [] この属性に含まれる依存関係によって指定する必要があるプロバイダ。 この引数の形式は、プロバイダのリスト( |
allow_rules
|
文字列のシーケンス、または None 。デフォルトは None です。許可されるルールのターゲット(クラス名)。これは非推奨です(互換性確保のためだけに維持されます)。代わりにプロバイダを使用してください。 |
cfg
|
デフォルトは None 属性の構成。 "exec" (依存関係が execution platform 用にビルドされたことを示す)か、"target" (依存関係が target platform 用にビルドされたことを示す)のいずれかになります。違いの典型的な例は、モバイルアプリの作成です。target platform は Android または iOS で、execution platform は Linux 、macOS 、または Windows です。このパラメータは、executable が true の場合に、ターゲット構成でホストツールが誤ってビルドされないようにするために必要です。"target" は意味的な効果がないため、意図を明確にするために本当に必要でない限り、executable が False の場合に設定しないでください。
|
aspects
|
Aspect のシーケンス。
デフォルトは [] この属性で指定された依存関係に適用する必要があるアスペクト。 |
label_keyed_string_dict
Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
ディクショナリを保持する属性のスキーマを作成します。キーはラベルで、値は文字列です。これは依存関係属性です。
この属性には一意の Label
値が含まれます。Label
の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。ラベルパスの相対部分(名前が変更されている場合もあるリポジトリを含む)は、インスタンス化されたターゲットのパッケージを基準に解決されます。
分析時(ルールの実装関数内)で ctx.attr
から属性値を取得する際に、ラベルが対応する Target
に置き換えられます。これにより、現在のターゲットの依存関係のプロバイダにアクセスできます。
パラメータ
パラメータ | 説明 |
---|---|
allow_empty
|
デフォルトは True 属性を空にできる場合は true。 |
default
|
dict、または function。デフォルトは {} 。ルールのインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用してデフォルト値を指定します(例: attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}) )。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
allow_files
|
bool;または文字列のシーケンス。または None
デフォルトは None ですFile ターゲットを許可するかどうか。True 、False (デフォルト)、または許可されているファイル拡張子のリスト(例: [".cc", ".cpp"] )を指定できます。
|
allow_rules
|
文字列のシーケンス、または None 。デフォルトは None です。許可されるルールのターゲット(クラス名)。これは非推奨です(互換性のためのみ保持されています)。代わりにプロバイダを使用してください。 |
providers
|
デフォルトは [] この属性に表示される依存関係によって指定する必要があるプロバイダ。 この引数の形式は、プロバイダのリスト( |
flags
|
文字列のシーケンス。デフォルトは [] 。非推奨で、削除される予定です。 |
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
cfg
|
デフォルトは None です。属性の構成。 "exec" (依存関係が execution platform 用にビルドされていることを示す)または "target" (依存関係が target platform 用にビルドされていることを示す)のいずれかです。違いの典型的な例は、モバイルアプリの作成です。target platform は Android または iOS で、execution platform は Linux 、macOS 、または Windows です。
|
aspects
|
アスペクトのシーケンス。デフォルトは [] 。この属性で指定された依存関係に適用するアスペクト。 |
label_list
Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
list-of-labels 属性のスキーマを作成します。これは依存関係属性です。対応する ctx.attr
属性は、Target
の list 型です。
この属性には一意の Label
値が含まれます。Label
の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。ラベルパスの相対部分(名前が変更されている場合もあるリポジトリを含む)は、インスタンス化されたターゲットのパッケージを基準に解決されます。
分析時(ルールの実装関数内)で ctx.attr
から属性値を取得する際に、ラベルが対応する Target
に置き換えられます。これにより、現在のターゲットの依存関係のプロバイダにアクセスできます。
パラメータ
パラメータ | 説明 |
---|---|
allow_empty
|
デフォルトは True 属性が空の可能性がある場合は true。 |
default
|
ラベルのシーケンス。または関数
デフォルトは [] ですルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。文字列または Label 関数を使用して、デフォルト値を指定します(例: attr.label_list(default = ["//a:b", "//a:c"]) )。
|
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
allow_files
|
bool、文字列のシーケンス、または None 。デフォルトは None 。File ターゲットが許可されるかどうか。True 、False (デフォルト)、または許可されているファイル拡張子のリスト(例: [".cc", ".cpp"] )を指定できます。
|
allow_rules
|
文字列のシーケンス。または None
デフォルトは None 許可されるルール ターゲット(クラスの名前)これは非推奨です(互換性確保のためだけに維持されます)。代わりにプロバイダを使用してください。 |
providers
|
デフォルトは [] この属性に表示される依存関係によって指定する必要があるプロバイダ。 この引数の形式はプロバイダのリストです。 |
flags
|
文字列のシーケンス。デフォルトは [] 。非推奨で、削除される予定です。 |
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
cfg
|
デフォルトは None です。属性の構成。 "exec" (依存関係が execution platform 用にビルドされたことを示す)か、"target" (依存関係が target platform 用にビルドされたことを示す)のいずれかになります。違いの典型的な例は、モバイルアプリの作成です。target platform は Android または iOS で、execution platform は Linux 、macOS 、または Windows です。
|
aspects
|
アスペクトのシーケンス。デフォルトは [] 。この属性で指定された依存関係に適用するアスペクト。 |
output
Attribute attr.output(doc=None, mandatory=False)
出力(ラベル)属性のスキーマを作成します。
この属性には一意の Label
値が含まれます。Label
の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。ラベルパスの相対部分(名前が変更されている場合もあるリポジトリを含む)は、インスタンス化されたターゲットのパッケージを基準に解決されます。
分析時に、ctx.outputs
を使用して、対応する File
を取得できます。
パラメータ
パラメータ | 説明 |
---|---|
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
mandatory
|
デフォルトは False です。true の場合、値は明示的に指定する必要があります( default が含まれている場合でも)。 |
output_list
Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)list-of-outputs 属性のスキーマを作成します。
この属性には一意の Label
値が含まれます。Label
の代わりに文字列を指定すると、ラベル コンストラクタを使用して変換されます。リポジトリを含むラベルパスの相対部分は、インスタンス化されたターゲットのパッケージに対して解決されます。
分析時に、対応する File
は ctx.outputs
を使用して取得できます。
パラメータ
パラメータ | 説明 |
---|---|
allow_empty
|
デフォルトは True 属性を空にできる場合は true。 |
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
mandatory
|
デフォルトは False です。true の場合、値は明示的に指定する必要があります( default が含まれている場合でも)。 |
文字列
Attribute attr.string(default='', doc=None, mandatory=False, values=[])string 属性のスキーマを作成します。
パラメータ
パラメータ | 説明 |
---|---|
default
|
string、または NativeComputedDefault。デフォルトは '' 。ルールのインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
mandatory
|
デフォルトは False です。true の場合、値は明示的に指定する必要があります( default が含まれている場合でも)。 |
values
|
文字列のシーケンス。
デフォルトは [] 属性で許可される値のリスト。他の値が指定された場合はエラーが発生します。 |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)キーと値は文字列であるディクショナリを保持する属性のスキーマを作成します。
パラメータ
パラメータ | 説明 |
---|---|
allow_empty
|
デフォルトは True 属性が空の可能性がある場合は true。 |
default
|
デフォルトは {} Rule のインスタンス化時にこの属性の値が指定されていない場合に使用するデフォルト値。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
string_list
Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)文字列のリスト属性のスキーマを作成します。
パラメータ
パラメータ | 説明 |
---|---|
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|
allow_empty
|
デフォルトは True 属性を空にできる場合は true。 |
default
|
文字列のシーケンス。または NativeComputedDefault です。
デフォルトは [] ルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。 |
doc
|
string;または None
デフォルトは None です ドキュメント生成ツールで抽出できる属性の説明。 |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)ディクショナリを保持する属性のスキーマを作成します。キーは文字列で、値は文字列のリストです。
パラメータ
パラメータ | 説明 |
---|---|
allow_empty
|
デフォルトは True 属性が空の可能性がある場合は true。 |
default
|
デフォルトは {} ルールをインスタンス化する際に、この属性に値が指定されていない場合に使用するデフォルト値。 |
doc
|
文字列、または None 。デフォルトは None 。ドキュメント生成ツールによって抽出できる属性の説明。 |
mandatory
|
デフォルトは False true の場合、値は( default がある場合でも)明示的に指定する必要があります。
|