BUILD ファイルで使用できるメソッド。BUILD ファイルでも使用できる追加のfunctionsとビルドルールについては、Build Encyclopedia もご覧ください。
メンバー
- depset
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- 選択
- サブパッケージ
depset
depset depset(direct=None, order="default", *, transitive=None)
direct パラメータは depset の直接要素のリストであり、transitive パラメータは、要素が作成された depset の間接要素となる depset のリストです。depset がリストに変換されたときに要素が返される順序は、order パラメータで指定します。詳細については、Depset の概要をご覧ください。depset のすべての要素（直接的および間接的）は、式 type(x) によって取得されるものと同じ型である必要があります。
ハッシュベースのセットを使用してイテレーション中に重複を排除するため、depset のすべての要素をハッシュ可能にする必要があります。ただし、現在のところ、この不変条件はすべてのコンストラクタで常にチェックされているわけではありません。--incompatible_always_check_depset_elements フラグを使用して、一貫したチェックを有効にします。これは今後のリリースのデフォルトの動作になります。問題 10313 をご覧ください。
また、現在のところ要素は不変である必要がありますが、この制限は今後緩和される予定です。
作成された depset の順序は、transitive depset の順序と互換性がある必要があります。"default" 順序は他のすべての順序と互換性がありますが、他のすべての順序は互換性がありません。
パラメータ
| パラメータ | 説明 |
|---|---|
direct
|
シーケンス、または None。デフォルトは None。depset の直接要素のリスト。 |
order
|
デフォルトは "default"です。新しい depset の走査戦略。有効な値については、こちらをご覧ください。 |
transitive
|
depset のシーケンス、または None。デフォルトは None です。要素が depset の間接要素になる depset のリスト。 |
existing_rule
unknown existing_rule(name)
None を返します。ここで、変更不可の辞書型オブジェクトとは、辞書型の反復処理（len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys()、x.values()）をサポートする、変更不可のオブジェクト x を意味します。
--noincompatible_existing_rules_immutable_view フラグが設定されている場合は、同じ内容の新しい変更可能な辞書を返します。
結果には、非公開の属性（名前が文字で始まらない）と、表現できないレガシー属性タイプを除き、各属性のエントリが含まれます。さらに、この辞書には、ルール インスタンスの name と kind のエントリ（'cc_binary' など）が含まれています。
結果の値は、次のように属性値を表します。
- str、int、bool タイプの属性はそのまま表現されます。
- ラベルは、同じパッケージ内のターゲットの場合は
':foo'の形式、異なるパッケージ内のターゲットの場合は'//pkg:name'の形式の文字列に変換されます。 - リストはタプルとして表され、辞書は新しい可変辞書に変換されます。要素は同じ方法で再帰的に変換されます。
select値は、上記のように内容が変換されて返されます。- ルールのインスタンス化時に値が指定されず、デフォルト値が計算された属性は結果から除外されます。（計算されたデフォルトは、分析フェーズまで計算できません）。
可能な限り、この関数は使用しないでください。これにより、BUILD ファイルが脆弱になり、順序に依存するようになります。また、内部形式から Starlark へのルール属性値の他の 2 つの変換とは微妙に異なることに注意してください。1 つは計算されたデフォルトで使用され、もう 1 つは ctx.attr.foo で使用されます。
パラメータ
| パラメータ | 説明 |
|---|---|
name
|
必須 ターゲットの名前。 |
existing_rules
unknown existing_rules()
existing_rule(name) によって返される結果にマッピングします。ここで、変更不可の辞書型オブジェクトとは、辞書型の反復処理（len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys()、x.values()）をサポートする、変更不可のオブジェクト x を意味します。
--noincompatible_existing_rules_immutable_view フラグが設定されている場合は、同じ内容の新しい変更可能な辞書を返します。
注: 可能であれば、この関数を使用しないでください。これにより、BUILD ファイルが脆弱になり、順序に依存するようになります。さらに、 --noincompatible_existing_rules_immutable_view フラグが設定されている場合、この関数は非常にコストが高くなる可能性があります（特にループ内で呼び出される場合は顕著です）。
exports_files
None exports_files(srcs, visibility=None, licenses=None)パラメータ
| パラメータ | 説明 |
|---|---|
srcs
|
文字列のシーケンス。必須 エクスポートするファイルのリスト。 |
visibility
|
シーケンス、または None（デフォルトは None）可視性宣言を指定できます。指定したターゲットにはファイルが表示されます。公開設定を指定しない場合は、すべてのパッケージにファイルが表示されます。 |
licenses
|
文字列のシーケンス。または None。デフォルトは None指定するライセンス。 |
glob
sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
includeの少なくとも 1 つのパターンと一致します。exclude（デフォルト[]）のどのパターンにも一致しません。
exclude_directories 引数が有効になっている（1 に設定されている）場合、ディレクトリ タイプのファイルは結果から除外されます（デフォルト 1）。
パラメータ
| パラメータ | 説明 |
|---|---|
include
|
文字列のシーケンス。デフォルトは []。含める glob パターンのリスト。 |
exclude
|
文字列のシーケンス。デフォルトは []。除外する glob パターンのリスト。 |
exclude_directories
|
デフォルトは 1ディレクトリを除外するかどうかを示すフラグ。 |
allow_empty
|
デフォルトは unboundです。glob パターンで何も一致しないように許可するかどうか。「allow_empty」が False の場合、各個別の含めるパターンが何かに一致する必要があり、また最終的な結果が空でないこと（「除外」パターンの一致が除外された後）も必要です。 |
module_name
string module_name()
module_ctx.modules の module.name フィールドと同じです。
None を返す場合があります。module_version
string module_version()
module_ctx.modules の module.version フィールドと同じです。
None を返す場合があります。package_group
None package_group(name, packages=[], includes=[])visibility 属性で参照できます。
パラメータ
| パラメータ | 説明 |
|---|---|
name
|
必須 このルールの一意の名前。 |
packages
|
文字列のシーケンス。デフォルトは []。このグループ内のパッケージの完全な列挙。 |
includes
|
文字列のシーケンス。デフォルトは []。このパッケージ グループに含まれる他のパッケージ グループ。 |
package_name
string package_name()
some/package/BUILD では、その値は some/package になります。BUILD ファイルが .bzl ファイルで定義された関数を呼び出す場合、package_name() は呼び出し元の BUILD ファイル パッケージと一致します。package_relative_label
Label package_relative_label(input)
BUILD ファイル）のコンテキストで Label オブジェクトに変換します。入力がすでに Label の場合は、変更されずに返されます。この関数は、BUILD ファイルと、そのファイルが直接または間接的に呼び出すマクロの評価中にのみ呼び出すことができます。たとえば、ルール実装関数では呼び出せません。
この関数の結果は、指定された文字列を BUILD ファイルで宣言されたターゲットのラベル値属性に渡すことで生成される Label 値と同じです。
使用上の注意: この関数と Label() の違いは、Label() が BUILD ファイルのパッケージではなく、呼び出した .bzl ファイルのパッケージのコンテキストを使用する点です。コンパイラなど、マクロにハードコードされた固定ターゲットを参照する必要がある場合は、Label() を使用します。BUILD ファイルから提供されたラベル文字列を Label オブジェクトに正規化する必要がある場合は、package_relative_label() を使用します。（BUILD ファイルまたは呼び出し元の .bzl ファイル以外のパッケージのコンテキストで文字列を Label に変換する方法はありません。そのため、外部マクロは、ラベル文字列ではなく、常にラベル オブジェクトを内部マクロに渡す必要があります）。
パラメータ
| パラメータ | 説明 |
|---|---|
input
|
string、または Label。必須 入力ラベル文字列または Label オブジェクト。Label オブジェクトが渡された場合は、そのまま返されます。 |
repo_name
string repo_name()
repository_name
string repository_name()
--+incompatible_enable_deprecated_label_apis を設定することで、試験運用版として有効にできます。非推奨代わりに
repo_name を使用することをおすすめします。この文字列には不要な先頭のアットマークは含まれませんが、それ以外は同じ動作をします。現在評価中のパッケージを含むリポジトリの正規名。先頭に 1 つのアットマーク（@）が付いています。たとえば、WORKSPACE スタンザ local_repository(name='local', path=...) によって呼び出されるパッケージでは、@local に設定されます。メイン リポジトリのパッケージでは、@ に設定されます。
選択
unknown select(x, no_match_error='')
select() は、ルール属性を構成可能にするヘルパー関数です。詳しくは、百科事典を作成をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
x
|
required 構成条件を値にマッピングする辞書。各キーは、config_setting インスタンスまたは constraint_value インスタンスを識別するラベルまたはラベル文字列です。文字列の代わりにラベルを使用する場合は、マクロに関するドキュメントをご覧ください。 |
no_match_error
|
デフォルトは ''条件が一致しない場合の報告に使用するカスタム エラー（省略可）。 |
サブパッケージ
sequence subpackages(include, exclude=[], allow_empty=False)
パラメータ
| パラメータ | 説明 |
|---|---|
include
|
文字列のシーケンス。必須 サブパッケージ スキャンに含める glob パターンのリスト。 |
exclude
|
文字列のシーケンス。デフォルトは []。サブパッケージ スキャンから除外する glob パターンのリスト。 |
allow_empty
|
デフォルトは False呼び出しが空のリストを返した場合に失敗するかどうか。デフォルトでは、空のリストは、BUILD ファイルで subpackages() の呼び出しが不要な場合に発生する可能性のあるエラーを示します。true に設定すると、その場合、この関数は成功します。 |