先住民

ネイティブ ルールやその他のパッケージ ヘルパー関数をサポートする組み込みモジュール。すべてのネイティブルールは、このモジュールの関数として表示されます(例: native.cc_library)。なお、ネイティブ モジュールは読み込みフェーズでのみ使用できます(つまり、ルールの実装には使用できません)。属性は None 値を無視し、属性が未設定の場合と同様に扱います。
次の関数も使用できます。

メンバー

existing_rule

unknown native.existing_rule(name)

このスレッドのパッケージでインスタンス化されたルールの属性を記述する変更不能な辞書型オブジェクトを返します。その名前のルール インスタンスが存在しない場合は None を返します。

ここで、変更不可の辞書型オブジェクトとは、辞書型の反復処理(len(x)name in xx[name]x.get(name)x.items()x.keys()x.values())をサポートする、変更不可のオブジェクト x を意味します。

--noincompatible_existing_rules_immutable_view フラグが設定されている場合は、同じ内容の新しい変更可能な辞書を返します。

結果には、非公開の属性(名前が文字で始まらない)と、表現できないレガシー属性タイプを除き、各属性のエントリが含まれます。さらに、この辞書には、ルール インスタンスの namekind のエントリ('cc_binary' など)が含まれています。

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

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

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

パラメータ

パラメータ 説明
name 必須
ターゲットの名前。

existing_rules

unknown native.existing_rules()

このスレッドのパッケージでこれまでインスタンス化されたルールを記述する不変の辞書型オブジェクトを返します。辞書型オブジェクトの各エントリは、ルール インスタンスの名前を existing_rule(name) によって返される結果にマッピングします。

ここで、変更不可の辞書型オブジェクトとは、辞書型の反復処理(len(x)name in xx[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 native.exports_files(srcs, visibility=None, licenses=None)

このパッケージに属し、他のパッケージにエクスポートされるファイルのリストを指定します。

パラメータ

パラメータ 説明
srcs sequence of strings(必須)
エクスポートするファイルのリスト。
visibility sequence; or None; デフォルト = None
公開設定を指定できます。ファイルは、指定したターゲットに表示されます。公開設定を指定しない場合は、すべてのパッケージにファイルが表示されます。
licenses sequence of strings; or None; デフォルト = None
指定するライセンス。

glob

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

Glob は、現在のパッケージ内の次の条件を満たすすべてのファイルの新しい変更可能な並べ替え済みリストを返します。
  • include の少なくとも 1 つのパターンと一致します。
  • exclude(デフォルト [])のどのパターンにも一致しません。
exclude_directories 引数が有効(1 に設定)の場合、ディレクトリ型のファイルは結果から除外されます(デフォルトは 1)。

パラメータ

パラメータ 説明
include sequence of strings; デフォルト = []
含める glob パターンのリスト。
exclude sequence of strings; default = []
除外する glob パターンのリスト。
exclude_directories デフォルト = 1
ディレクトリを除外するかどうかを示すフラグ。
allow_empty デフォルト = 無制限
glob パターンが何も一致しないように許可するかどうか。「allow_empty」が False の場合、各個別の含めるパターンが何かに一致する必要があり、また最終的な結果が空でないこと(「除外」パターンの一致が除外された後)も必要です。

module_name

string native.module_name()

このパッケージが含まれているリポジトリに関連付けられている Bazel モジュールの名前。このパッケージが MODULE.bazel ではなく WORKSPACE で定義されたリポジトリのものである場合、これは空になります。モジュール拡張機能によって生成されたリポジトリの場合、拡張機能をホストするモジュールの名前です。これは、module_ctx.modulesmodule.name フィールドと同じです。 None が返されることがあります。

module_version

string native.module_version()

このパッケージが含まれているリポジトリに関連付けられている Bazel モジュールのバージョン。このパッケージが MODULE.bazel ではなく WORKSPACE で定義されたリポジトリのものである場合、これは空になります。モジュール拡張機能によって生成されたリポジトリの場合、これは拡張機能をホストするモジュールのバージョンです。これは、module_ctx.modulesmodule.version フィールドと同じです。None が返されることがあります。

package_group

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

この関数は一連のパッケージを定義し、グループにラベルを割り当てます。ラベルは visibility 属性で参照できます。

パラメータ

パラメータ 説明
name required
このルールの一意の名前。
packages sequence of strings; デフォルト = []
このグループ内のパッケージの完全な列挙。
includes sequence of strings; default = []
これに含まれる他のパッケージ グループ。

package_name

string native.package_name()

評価対象のパッケージの名前。たとえば、ビルド ファイル some/package/BUILD では、値は some/package になります。BUILD ファイルが .bzl ファイルで定義された関数を呼び出す場合、package_name() は呼び出し元の BUILD ファイル パッケージと一致します。この関数は、非推奨の変数 PACKAGE_NAME と同等です。

package_relative_label

Label native.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; or Label(必須)
入力ラベル文字列または Label オブジェクト。Label オブジェクトが渡された場合は、そのまま返されます。

repository_name

string native.repository_name()

ルールまたはビルド拡張機能が呼び出されるリポジトリの名前。たとえば、WORKSPACE スタンザ local_repository(name='local', path=...) によって呼び出されたパッケージでは、@local に設定されます。メイン リポジトリのパッケージでは、@ に設定されます。この関数は、非推奨の変数 REPOSITORY_NAME と同等です。

サブパッケージ

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

ファイル システムのディレクトリの深さに関係なく、現在のパッケージのすべての直接サブパッケージの新しい変更可能なリストを返します。返されるリストは並べ替えられ、現在のパッケージに関連するサブパッケージの名前が含まれています。この関数を直接呼び出すのではなく、bazel_skylib.subpackages モジュールのメソッドを使用することをおすすめします。

パラメータ

パラメータ 説明
include sequence of strings; 必須
サブパッケージ スキャンに含める glob パターンのリスト。
exclude sequence of strings; デフォルト = []
サブパッケージ スキャンから除外する glob パターンのリスト。
allow_empty default = False
呼び出しが空のリストを返した場合に失敗するかどうか。デフォルトでは、空のリストは、subpackages() の呼び出しが不要な BUILD ファイルでエラーが発生する可能性があることを示します。true に設定すると、その場合、この関数は成功します。