BUILD ファイル

BUILD ファイルで使用できるメソッド。BUILD ファイルで使用できる追加の関数とビルドルールについては、ビルド百科事典もご覧ください。

メンバー

• depset
• existing_rule
• existing_rules
• exports_files
• glob
• module_name
• module_version
• package_group
• package_name
• package_relative_label
• repo_name
• repository_name
• select
• サブパッケージ

depset

depset depset(direct=None, order="default", *, transitive=None)

deps のすべての要素（直接および間接）は、式 type(x) で取得される同じ型でなければなりません。

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

また、現時点では要素は不変である必要がありますが、この制限は将来緩和される予定です。

作成された depset の順序は、その transitive depset の順序と互換性がある必要があります。"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 フラグが設定されている場合、代わりに同じ内容の新しいミュータブルな辞書を返します。

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

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

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

可能な限り、この関数の使用は避けてください。これにより、BUILD ファイルが脆弱になり、順序依存になります。また、ルール属性値を内部形式から Starlark に変換する他の 2 つの変換（計算されたデフォルトで使用されるものと 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 に変換する方法はありません。そのため、外部マクロは常に、ラベル文字列ではなく Label オブジェクトを内部マクロに渡すことを優先する必要があります）。

パラメータ

repo_name

string repo_name()

repository_name

string repository_name()

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

選択

unknown select(x, no_match_error='')

パラメータ

サブパッケージ

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

パラメータ