BUILD ファイル

BUILD ファイルで使用できるメソッド。BUILD ファイルでも使用できる追加の関数とビルドルールについては、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)

depset のすべての要素（直接的および間接的）は、式 type(x) によって取得されるものと同じ型である必要があります。

ハッシュベースのセットを使用してイテレーション中に重複を排除するため、depset のすべての要素をハッシュ可能にする必要があります。ただし、現在のところ、この不変条件はすべてのコンストラクタで一貫してチェックされていません。--incompatible_always_check_depset_elements フラグを使用して、一貫したチェックを有効にします。これは今後のリリースのデフォルトの動作になります。問題 10313 をご覧ください。

また、現在のところ要素は不変である必要がありますが、この制限は今後緩和される予定です。

作成されるデプセットの順序は、transitive デプセットの順序と互換性がある必要があります。"default" オーダーは他のオーダーと互換性がありますが、他のオーダーは互換性がありません。

パラメータ

existing_rule

unknown 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 フラグが設定されている場合は、同じ内容の新しい変更可能な辞書を返します。

結果には、非公開の属性（名前が文字で始まらない）と、表現できないレガシー属性タイプを除き、各属性のエントリが含まれます。また、この辞書にはルール インスタンスの name と kind のエントリが含まれます（例: 'cc_binary'）。

結果の値は、次のように属性値を表します。

• str、int、bool 型の属性はそのまま表されます。
• ラベルは、同じパッケージ内のターゲットの場合は ':foo' の形式、異なるパッケージ内のターゲットの場合は '//pkg:name' の形式の文字列に変換されます。
• リストはタプルとして表され、辞書は新しい可変辞書に変換されます。要素は同じ方法で再帰的に変換されます。
• select 値は、その内容が前述のように変換された状態で返されます。
• ルールのインスタンス化時に値が指定されず、デフォルト値が計算された属性は結果から除外されます。（計算されたデフォルトは、分析フェーズまで計算できません）。

可能な限り、この関数は使用しないでください。これにより、BUILD ファイルが脆弱になり、順序に依存するようになります。また、内部形式から Starlark へのルール属性値の他の 2 つの変換とは微妙に異なることに注意してください。1 つは計算されたデフォルトで使用され、もう 1 つは ctx.attr.foo で使用されます。

パラメータ

existing_rules

unknown existing_rules()

ここで、変更不可の辞書型オブジェクトとは、辞書型の反復処理（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)

パラメータ

glob

sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

• include の少なくとも 1 つのパターンと一致します。
• exclude（デフォルト []）のどのパターンにも一致しません。

パラメータ

module_name

string module_name()

module_version

string module_version()

package_group

None package_group(name, packages=[], includes=[])

パラメータ

package_name

string package_name()

package_relative_label

Label package_relative_label(input)

この関数は、BUILD ファイルと、そのファイルが直接または間接的に呼び出すマクロの評価中にのみ呼び出されます。たとえば、ルール実装関数では呼び出せません。

この関数の結果は、指定された文字列を BUILD ファイルで宣言されたターゲットのラベル値属性に渡すことで生成される Label 値と同じです。

使用上の注意: この関数と Label() の違いは、Label() が BUILD ファイルのパッケージではなく、呼び出した .bzl ファイルのパッケージのコンテキストを使用する点です。コンパイラなど、マクロにハードコードされた固定ターゲットを参照する必要がある場合は、Label() を使用します。BUILD ファイルが提供するラベル文字列を Label オブジェクトに正規化する必要がある場合は、package_relative_label() を使用します。（BUILD ファイルまたは呼び出し元の .bzl ファイル以外のパッケージのコンテキストで文字列を Label に変換する方法はありません。そのため、外部マクロは、ラベル文字列ではなく、常にラベル オブジェクトを内部マクロに渡す必要があります）。

パラメータ

repo_name

string repo_name()

repository_name

string repository_name()

現在評価中のパッケージを含むリポジトリの正規名。先頭に 1 つのアットマーク（@）が付いています。たとえば、WORKSPACE スタンザ local_repository(name='local', path=...) によって呼び出されるパッケージでは、@local に設定されます。メイン リポジトリのパッケージでは、@ に設定されます。

選択

unknown select(x, no_match_error='')

パラメータ

サブパッケージ

sequence subpackages(include, exclude=[], allow_empty=False)

パラメータ