rule()
と aspect()
の辞書引数 attrs
の値として使用されます。属性の定義と使用について詳しくは、[ルール] ページをご覧ください。
メンバー
- bool
- int
- int_list
- label
- label_keyed_string_dict
- label_list
- 出力
- 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='')整数のリストの属性のスキーマを作成します。各要素は 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 = NoneFile ターゲットを許可するかどうか。True 、False (デフォルト)、または許可されるファイル拡張子のリスト(例: [".cc", ".cpp"] )を指定できます。 |
allow_single_file
|
default = Noneallow_files と似ていますが、ラベルは 1 つの File に対応する必要があるという制限があります。アクセスには ctx.file.<attribute_name> を使用します。
|
mandatory
|
default = False true の場合、値を明示的に指定する必要があります( default がある場合も同様です)。
|
providers
|
default = [] この属性に登場する依存関係によって提供される必要のあるプロバイダ。 この引数の形式は、 |
allow_rules
|
sequence of strings; or None ;
default = なしどのルール ターゲット(クラスの名前)が許可されるか。これは非推奨です(互換性のためのみに残しています)。代わりにプロバイダを使用してください。 |
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 = NoneFile ターゲットを許可するかどうか。True 、False (デフォルト)、または許可されるファイル拡張子のリスト(例: [".cc", ".cpp"] )を指定できます。 |
allow_rules
|
sequence of strings; or None ;
default = なしどのルール ターゲット(クラスの名前)が許可されるか。これは非推奨です(互換性のためのみに残しています)。代わりにプロバイダを使用してください。 |
providers
|
default = [] この属性に登場する依存関係によって提供される必要のあるプロバイダ。 この引数の形式は、 |
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=[])
ラベルのリスト属性のスキーマを作成します。これは依存関係属性です。
この属性には一意の 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 = NoneFile ターゲットを許可するかどうか。True 、False (デフォルト)、または許可されるファイル拡張子のリスト(例: [".cc", ".cpp"] )を指定できます。 |
allow_rules
|
sequence of strings; or None ;
default = なしどのルール ターゲット(クラスの名前)が許可されるか。これは非推奨です(互換性のためのみに残しています)。代わりにプロバイダを使用してください。 |
providers
|
default = [] この属性に登場する依存関係によって提供される必要のあるプロバイダ。 この引数の形式は、 |
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
の代わりに文字列が指定された場合、ラベル コンストラクタを使用して変換されます。ラベルパスの相対部分は、(名前が変更された可能性のある)リポジトリを含めて、インスタンス化されたターゲットのパッケージに対して解決されます。
分析時には、対応する File
を ctx.outputs
を使用して取得できます。
パラメータ
パラメータ | 説明 |
---|---|
doc
|
default = '' ドキュメント生成ツールで抽出できる属性の説明。 |
mandatory
|
default = False true の場合、値を明示的に指定する必要があります( default がある場合も同様です)。
|
output_list
Attribute attr.output_list(allow_empty=True, *, doc='', mandatory=False)list-of-outputs 属性のスキーマを作成します。
この属性には一意の Label
値が含まれます。Label
の代わりに文字列が指定された場合、ラベル コンストラクタを使用して変換されます。ラベルパスの相対部分は、(名前が変更された可能性のある)リポジトリを含めて、インスタンス化されたターゲットのパッケージに対して解決されます。
分析時には、対応する File
を ctx.outputs
を使用して取得できます。
パラメータ
パラメータ | 説明 |
---|---|
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 がある場合も同様です)。
|