ネイティブ ルールやその他のパッケージ ヘルパー関数をサポートする組み込みモジュール。すべてのネイティブルールは、このモジュールの関数として表示されます(例: native.cc_library
)。なお、ネイティブ モジュールは読み込みフェーズでのみ使用できます(つまり、ルールの実装には使用できません)。属性は None
値を無視し、属性が未設定の場合と同様に扱います。
次の関数も使用できます。
メンバー
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- サブパッケージ
existing_rule
unknown native.existing_rule(name)
None
を返します。ここで、不変の dict に似たオブジェクトとは、辞書に似た反復処理(len(x)
、name in x
、x[name]
、x.get(name)
、x.items()
、x.keys()
、x.values()
をサポートする、高度に不変のオブジェクト x
)を意味します。
結果には、非公開の属性(名前が文字で始まらない)と、表現できないレガシー属性タイプを除き、各属性のエントリが含まれます。また、この辞書にはルール インスタンスの name
と kind
のエントリが含まれます(例: 'cc_binary'
)。
結果の値は、次のように属性値を表します。
- str、int、bool 型の属性はそのまま表されます。
- ラベルは、同じパッケージ内のターゲットの場合は
':foo'
の形式、異なるパッケージ内のターゲットの場合は'//pkg:name'
の形式の文字列に変換されます。 - リストはタプルとして表され、辞書は新しい可変の辞書に変換されます。これらの要素は、同じ方法で再帰的に変換されます。
select
値は、上記のように内容が変換されて返されます。- ルールのインスタンス化時に値が指定されず、デフォルト値が計算された属性は結果から除外されます。(計算されたデフォルトは、分析フェーズまで計算できません)。
可能であれば、この関数はルール ファイナライザのシンボリック マクロの実装関数でのみ使用してください。他のコンテキストでこの関数を使用することは推奨されず、今後の Bazel リリースでは無効になります。これにより、BUILD
ファイルが脆弱になり、順序に依存するようになります。また、内部形式から Starlark へのルール属性値の他の 2 つの変換とは微妙に異なることに注意してください。1 つは計算済みデフォルトで使用され、もう 1 つは ctx.attr.foo
で使用されます。
パラメータ
パラメータ | 説明 |
---|---|
name
|
string:
必須 ターゲットの名前。 |
existing_rules
unknown native.existing_rules()
existing_rule(name)
によって返される結果にマッピングします。ここで、不変の dict に似たオブジェクトとは、辞書に似た反復処理(len(x)
、name in x
、x[name]
、x.get(name)
、x.items()
、x.keys()
、x.values()
をサポートする、高度に不変のオブジェクト x
)を意味します。
可能であれば、この関数はルール ファイナライザのシンボリック マクロの実装関数でのみ使用してください。その他のコンテキストでこの機能を使用することはおすすめしません。この機能は、Bazel の今後のリリースで無効になります。使用すると、BUILD
ファイルが脆弱になり、順序に依存してしまいます。
exports_files
None
native.exports_files(srcs, visibility=None, licenses=None)
パラメータ
パラメータ | 説明 |
---|---|
srcs
|
文字列のシーケンス。必須 エクスポートするファイルのリスト。 |
visibility
|
シーケンス、または None (デフォルトは None )可視性宣言を指定できます。ファイルは、指定したターゲットに表示されます。公開設定を指定しない場合は、すべてのパッケージにファイルが表示されます。 |
licenses
|
文字列のシーケンス。または None 。デフォルトは None 指定するライセンス。 |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
include
の少なくとも 1 つのパターンと一致します。exclude
のどのパターンとも一致しない(デフォルトは[]
)。
exclude_directories
引数が有効になっている(1
に設定されている)場合、ディレクトリ タイプのファイルは結果から除外されます(デフォルト 1
)。
パラメータ
パラメータ | 説明 |
---|---|
include
|
文字列のシーケンス。デフォルトは [] 。含める glob パターンのリスト。 |
exclude
|
文字列のシーケンス。デフォルトは [] 。除外する glob パターンのリスト。 |
exclude_directories
|
int;
デフォルトは 1 ディレクトリを除外するかどうかを示すフラグ。 |
allow_empty
|
デフォルトは unbound glob パターンで何も一致しないようにするかどうか。「allow_empty」が False の場合、各個別の含めるパターンが何かに一致する必要があり、また最終的な結果が空でないこと(「除外」パターンの一致が除外された後)も必要です。 |
module_name
string native.module_name()
module_ctx.modules
の module.name
フィールドと同じです。
None
が返されることがあります。
module_version
string native.module_version()
module_ctx.modules
の module.version
フィールドと同じです。
None
が返されることがあります。
package_group
None
native.package_group(name, packages=[], includes=[])
visibility
属性で参照できます。
パラメータ
パラメータ | 説明 |
---|---|
name
|
string;
必須 このルールの一意の名前。 |
packages
|
文字列のシーケンス。デフォルトは [] 。このグループ内のパッケージの完全な列挙。 |
includes
|
文字列のシーケンス。デフォルトは [] 。このパッケージ グループに含まれる他のパッケージ グループ。 |
package_name
string native.package_name()
some/package/BUILD
では、その値は some/package
になります。ビルド ファイルが .bzl ファイルで定義された関数を呼び出す場合、package_name()
は呼び出し元の BUILD ファイル パッケージと一致します。
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、または Label。必須 入力ラベル文字列または Label オブジェクト。Label オブジェクトが渡された場合は、そのまま返されます。 |
repo_name
string native.repo_name()
repository_name
string native.repository_name()
--+incompatible_enable_deprecated_label_apis
を設定することで、試験運用版として有効にできます。非推奨代わりに
repo_name
を使用することをおすすめします。この文字列には不要な先頭のアットマークが含まれていませんが、それ以外は同じ動作をします。現在評価中のパッケージを含むリポジトリの正規名。先頭に 1 つのアットマーク(@
)が付いています。たとえば、WORKSPACE スタンザ local_repository(name='local', path=...)
によって呼び出されたパッケージでは、@local
に設定されます。メイン リポジトリのパッケージでは、@
に設定されます。
サブパッケージ
sequence native.subpackages(include, exclude=[], allow_empty=False)
パラメータ
パラメータ | 説明 |
---|---|
include
|
文字列のシーケンス。必須 サブパッケージ スキャンに含める glob パターンのリスト。 |
exclude
|
文字列のシーケンス。デフォルトは [] 。サブパッケージ スキャンから除外する glob パターンのリスト。 |
allow_empty
|
bool: デフォルトは False 呼び出しが空のリストを返した場合に失敗するかどうか。デフォルトでは、空のリストは、subpackages() の呼び出しが不要な BUILD ファイルでエラーが発生する可能性があることを示します。true に設定すると、その場合、この関数は成功します。 |