ヘルパー関数を含むモジュール拡張のコンテキストと、依存関係グラフ全体の関連タグに関する情報。モジュール拡張機能を作成すると、implementation 関数の引数として module_ctx オブジェクトが返されます。
メンバー
- ダウンロード
- download_and_extract
- 実行
- extension_metadata
- ファイル
- is_dev_dependency
- modules
- os
- path
- read
- report_progress
- root_module_has_non_dev_dependency
ダウンロード
struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')指定された URL の出力パスにファイルをダウンロードし、
success を含む構造体、ダウンロードが正常に完了した場合は true のフラグ、正常に完了した場合は sha256 フィールドと integrity フィールドを含むファイルのハッシュを返します。
パラメータ
| パラメータ | 説明 |
|---|---|
url
|
文字列、または文字列の iterable。必須 同じファイルを参照するミラー URL のリスト。 |
output
|
文字列、ラベル、パス。デフォルトは ''。リポジトリ ディレクトリを基準とする出力ファイルのパス。 |
sha256
|
デフォルトは ''で、ダウンロードされたファイルの想定される SHA-256 ハッシュです。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが生じます。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。 |
executable
|
デフォルトは False作成されたファイルに実行可能フラグを設定します。デフォルトは false です。 |
allow_fail
|
デフォルトは Falseです。設定すると、ダウンロードに失敗したときにエラーをスローするのではなく、戻り値でエラーを示します。 |
canonical_id
|
デフォルトは ''です。設定すると、キャッシュ ヒットを、同じ正規 ID でキャッシュに追加されたファイルに限定します。 |
auth
|
デフォルトは {}URL の認証情報を指定するオプションの辞書。 |
integrity
|
デフォルトは ''ダウンロードされたファイルの想定チェックサム（Subresource Integrity 形式）。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルが変更される可能性があるため、チェックサムを省略することはセキュリティ上のリスクになります。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。 |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})指定された URL の出力パスにファイルをダウンロードして抽出し、
success を含む構造体を返します。フラグ（ダウンロードが正常に完了した場合は true、成功した場合は sha256 と integrity を含むファイルのハッシュ）が含まれます。
パラメータ
| パラメータ | 説明 |
|---|---|
url
|
文字列、または文字列の iterable。必須 同じファイルを参照するミラー URL のリスト。 |
output
|
文字列、ラベル、パス。デフォルトは ''。アーカイブを展開するディレクトリのパス（リポジトリ ディレクトリからの相対パス）。 |
sha256
|
デフォルトは '' です。ダウンロードしたファイルの想定される SHA-256 ハッシュです。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。指定されている場合、まずリポジトリ キャッシュで指定されたハッシュのファイルがチェックされます。キャッシュにファイルが見つからない場合のみ、ダウンロードが試行されます。ダウンロードが正常に完了すると、ファイルはキャッシュに追加されます。 |
type
|
デフォルトは ''ダウンロードしたファイルのアーカイブ タイプ。デフォルトでは、アーカイブ タイプは URL のファイル拡張子から判断されます。ファイルに拡張子がない場合は、ここで「zip」、「jar」、「war」、「aar」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tzst」、「tar.bz2」、「.tbz」、「.ar」、「.deb」のいずれかを明示的に指定できます。 |
stripPrefix
|
デフォルトは ''です。解凍されたファイルから削除するディレクトリ接頭辞です。多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリが含まれています。この接頭辞を build_file で何度も指定する代わりに、このフィールドを使用して、抽出されたファイルから削除できます。 |
allow_fail
|
デフォルトは Falseです。設定すると、ダウンロードに失敗したときにエラーをスローするのではなく、戻り値でエラーを示します。 |
canonical_id
|
デフォルトは ''です。設定すると、キャッシュ ヒットを、同じ正規 ID でキャッシュに追加されたファイルに限定します。 |
auth
|
デフォルトは {}URL の認証情報を指定するオプションの辞書。 |
integrity
|
デフォルトは ''ダウンロードされたファイルの想定チェックサム（Subresource Integrity 形式）。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドは非密封になります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。 |
rename_files
|
デフォルトは {} です。抽出時に名前を変更するファイルを指定する辞書（省略可）。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞の調整の前に、値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイル システムで同じパスに抽出されるファイルを抽出する場合に使用できます。 |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")引数のリストで指定されたコマンドを実行します。コマンドの実行時間は
timeout によって制限されます（秒単位、デフォルトは 600 秒）。このメソッドは、コマンドの出力を含む exec_result 構造体を返します。environment マップを使用すると、プロセスに渡される一部の環境変数をオーバーライドできます。
パラメータ
| パラメータ | 説明 |
|---|---|
arguments
|
必須 引数のリスト。最初の要素は、実行するプログラムのパスにする必要があります。 |
timeout
|
デフォルトは 600 です。コマンドの最大時間（秒）です（デフォルトは 600 秒）。 |
environment
|
デフォルトは {}です。一部の環境変数を強制的に設定してプロセスに渡します。 |
quiet
|
デフォルトは Trueです。stdout と stderr をターミナルに出力するかどうか。 |
working_directory
|
デフォルトは ""コマンド実行の作業ディレクトリ。リポジトリのルート相対または絶対にできます。 |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)モジュール拡張機能の実装関数から返され、拡張機能によって生成されたリポジトリに関するメタデータを Bazel に提供する不透明なオブジェクトを構築します。
パラメータ
| パラメータ | 説明 |
|---|---|
root_module_direct_deps
|
string のシーケンス、または string、または None。デフォルトは None です。拡張機能がルート モジュールの直接的な依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートする場合、または use_repo を介してこれらのリポジトリをすべてインポートしない場合、拡張機能が評価されると、Bazel は警告と修正コマンドを出力します。
|
root_module_direct_dev_deps
|
文字列のシーケンス、または文字列、または None。デフォルトは None。拡張機能がルート モジュールの直接的な開発依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートする場合や、 use_extension(..., dev_dependency = True) で作成した拡張機能プロキシの use_repo を介してこれらのリポジトリをすべてインポートしていない場合、拡張機能の評価時に Bazel は警告と修正コマンドを出力します。
|
ファイル
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)パラメータ
| パラメータ | 説明 |
|---|---|
path
|
文字列、ラベル、パス。必須 リポジトリ ディレクトリを基準とする、作成するファイルのパス。 |
content
|
デフォルトは '' です。作成するファイルの内容。デフォルトでは空です。 |
executable
|
デフォルトは True です。作成されたファイルの実行可能フラグをデフォルトで true に設定します。 |
legacy_utf8
|
デフォルトは Trueファイル コンテンツを UTF-8 にエンコードします。デフォルトは true です。今後のバージョンではデフォルトが変更され、このパラメータは削除されます。 |
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)指定されたタグが、
devDependency = True を使用した use_extension 呼び出しの結果で指定されたかどうかを返します。
パラメータ
| パラメータ | 説明 |
|---|---|
tag
|
bazel_module_tag;
必須 bazel_module.tags から取得したタグ。 |
modules
list module_ctx.modulesこのモジュール拡張機能を使用する外部依存関係グラフ内のすべての Bazel モジュールのリスト。それぞれが bazel_module オブジェクトで、この拡張機能に指定されたすべてのタグを公開します。この辞書の反復処理順序は、ルート モジュールから開始する幅優先探索と同じになることが保証されます。
os
repository_os module_ctx.osシステムからの情報にアクセスするための構造体。
パス
path module_ctx.path(path)文字列、ラベル、またはパスからパスを返します。パスが相対パスの場合、リポジトリ ディレクトリを基準に解決されます。パスがラベルの場合は、対応するファイルのパスに変換されます。リモート・リポジトリは分析フェーズで実行されるため、ターゲットの結果に依存できません（ラベルは、生成されていないファイルを指している必要があります）。パスにパスを指定した場合は、パスをそのまま返します。
パラメータ
| パラメータ | 説明 |
|---|---|
path
|
文字列、ラベル、パス。必須 パスを作成する文字列、ラベル、パス。 |
read
string module_ctx.read(path)ファイル システム上のファイルの内容を読み取ります。
パラメータ
| パラメータ | 説明 |
|---|---|
path
|
文字列、ラベル、パス。必須 読み取り元のファイルのパス。 |
report_progress
None module_ctx.report_progress(status='')パラメータ
| パラメータ | 説明 |
|---|---|
status
|
文字列。デフォルトは ''。取得の進行状況の現在のステータスを示す文字列。 |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependencyルート モジュールがこの拡張機能を非デベロッパー依存関係として使用しているかどうか。
これは
path module_ctx.which(program)対応するプログラムのパスを返します。パス内にそのようなプログラムが存在しない場合は None を返します。
パラメータ
| パラメータ | 説明 |
|---|---|
program
|
required プログラムはパス内で検出します。 |
None を返す場合があります。