ヘルパー関数と、依存関係グラフ全体にわたる関連タグに関する情報が含まれるモジュール拡張機能のコンテキスト。モジュール拡張機能を作成すると、implementation
関数の引数として module_ctx オブジェクトが返されます。
メンバー
- ダウンロード
- download_and_extract
- 実行
- extension_metadata
- file
- getenv
- is_dev_dependency
- modules
- os
- path
- read
- report_progress
- root_module_has_non_dev_dependency
- watch
ダウンロード
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
success
を含む構造体、ダウンロードが正常に完了した場合は true
のフラグ、正常に完了した場合は sha256
フィールドと integrity
フィールドを含むファイルのハッシュを返します。
パラメータ
パラメータ | 説明 |
---|---|
url
|
文字列、または文字列の iterable。必須 同じファイルを参照するミラー URL のリスト。 |
output
|
string、Label、path。デフォルトは '' です。出力ファイルのパスは、リポジトリ ディレクトリからの相対パスです。 |
sha256
|
デフォルトは '' で、ダウンロードされたファイルの想定される SHA-256 ハッシュです。これは、ダウンロードしたファイルの SHA-256 ハッシュと一致する必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。 |
executable
|
デフォルトは False 作成されたファイルに実行可能フラグを設定します。デフォルトは false です。 |
allow_fail
|
デフォルトは False です。設定すると、ダウンロードに失敗したときにエラーをスローするのではなく、戻り値でエラーを示します。 |
canonical_id
|
デフォルトは '' です。設定すると、キャッシュ ヒットを、同じ正規 ID でキャッシュに追加されたファイルに限定します。 |
auth
|
デフォルトは {} です。一部の URL の認証情報を指定するディクショナリ(省略可)。 |
headers
|
デフォルトは {} すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
デフォルトは '' ダウンロードされたファイルの想定チェックサム(Subresource Integrity 形式)。ダウンロードしたファイルのチェックサムと一致する必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。 |
block
|
デフォルトは True です。false に設定すると、呼び出しはすぐに戻り、通常の戻り値ではなく、1 つのメソッド wait() でトークンを返します。このメソッドは、ダウンロードが完了するまでブロックし、通常の戻り値を返すか、通常どおりスローします。 |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
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 の認証情報を指定するディクショナリ(省略可)。 |
headers
|
デフォルトは {} すべての URL の HTTP ヘッダーを指定するオプションの辞書。 |
integrity
|
デフォルトは '' です。ダウンロードされるファイルの想定されるチェックサム(サブリソースの整合性形式)。これは、ダウンロードしたファイルのチェックサムと一致している必要があります。リモート ファイルは変更される可能性があるため、チェックサムを省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非ヘルメティックになります。開発を容易にするために設定できますが、出荷前に設定する必要があります。 |
rename_files
|
デフォルトは {} 抽出時に名前を変更するファイルを指定するオプションの辞書。名前がキーと完全に一致するアーカイブ エントリは、ディレクトリ接頭辞の調整の前に、値に名前が変更されます。これは、Unicode 以外のファイル名を含むアーカイブや、大文字と小文字を区別しないファイルシステム上の同じパスに抽出されるファイルを含むアーカイブの抽出に使用できます。 |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout
によって制限されます(秒単位、デフォルトは 600 秒)。このメソッドは、コマンドの出力を含む exec_result
構造体を返します。environment
マップを使用すると、プロセスに渡される一部の環境変数をオーバーライドできます。
パラメータ
パラメータ | 説明 |
---|---|
arguments
|
required 引数のリスト。最初の要素は、実行するプログラムのパスにする必要があります。 |
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, reproducible=False)
パラメータ
パラメータ | 説明 |
---|---|
root_module_direct_deps
|
文字列のシーケンス、または文字列、または None 。デフォルトは None 。拡張機能がルート モジュールの直接依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートする場合、または use_repo を介してこれらのリポジトリをすべてインポートしない場合、Bazel は拡張機能の評価時に警告を表示し、bazel mod tidy を実行して use_repo 呼び出しを自動的に修正するようユーザーに指示します。
|
root_module_direct_dev_deps
|
string のシーケンス、または string、または None 。デフォルトは None です。拡張機能がルート モジュールの直接的な開発依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートするか、 use_extension(..., dev_dependency = True) で作成した拡張機能プロキシで use_repo を介してこれらのリポジトリをすべてインポートしていない場合、Bazel は拡張機能が評価されたときに警告を表示し、use_repo 呼び出しを自動的に修正するために bazel mod tidy を実行するようにユーザーに指示します。
|
reproducible
|
bool;
デフォルトは False このモジュール拡張により完全な再現性が保証されるため、ロックファイルに保存する必要がないことを示します。 |
ファイル
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
パラメータ
パラメータ | 説明 |
---|---|
path
|
string、Label、または path。リポジトリ ディレクトリを基準とする、作成するファイルの パス(必須)。 |
content
|
デフォルトは '' 作成するファイルの内容。デフォルトでは空です。 |
executable
|
デフォルトは True です。作成されたファイルの実行可能フラグをデフォルトで true に設定します。 |
legacy_utf8
|
デフォルトは True です。ファイルのコンテンツを UTF-8 にエンコードします。デフォルトでは true です。今後のバージョンではデフォルトが変更され、このパラメータは削除されます。 |
getenv
string module_ctx.getenv(name, default=None)
name
の値を文字列として返します(存在する場合)。存在しない場合は default
を返します。増分ビルドでは、name
という名前の変数の値が変更されると、このリポジトリが再取得されます。
パラメータ
パラメータ | 説明 |
---|---|
name
|
文字列。必須 目的の環境変数の名前 |
default
|
文字列、または None 。デフォルトは None 。「name」が見つからない場合に返されるデフォルト値。 |
None
を返す場合があります。is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True
を使用した use_extension 呼び出しの結果で指定されたかどうかを返します。
パラメータ
パラメータ | 説明 |
---|---|
tag
|
bazel_module_tag;
required bazel_module.tags から取得したタグ。 |
modules
list module_ctx.modules
os
repository_os module_ctx.os
パス
path module_ctx.path(path)
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 パスを作成する文字列、ラベル、パス。 |
read
string module_ctx.read(path, *, watch='auto')
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 読み取り元のファイルのパス。 |
watch
|
デフォルトは 'auto' ファイルの監視を行うかどうか。文字列「yes」、「no」、「auto」のいずれか。「yes」を渡すと、 watch() メソッドがすぐに呼び出されます。「no」を渡すと、ファイルの監視は試行されません。「auto」を渡すと、ファイルの監視は、監視が許可されている場合にのみ試行されます(詳細については、watch() のドキュメントをご覧ください)。
|
report_progress
None
module_ctx.report_progress(status='')
パラメータ
パラメータ | 説明 |
---|---|
status
|
文字列。デフォルトは '' 。取得の進行状況の現在のステータスを示す文字列。 |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
再起動する
None
module_ctx.watch(path)
「変更」には、ファイルの内容の変更(パスがファイルの場合)、パスがファイルからディレクトリに変更された場合やその逆の場合、パスが存在しなくなった場合などが含まれます。なお、パスがディレクトリの場合、ディレクトリ内のファイルの変更は含まれません。その場合は、代わりに path.readdir()
を使用します。
ただし、現在フェッチ中のリポジトリ内または現在のモジュール拡張機能の作業ディレクトリ内のパスを監視しようとすると、エラーが発生します。現在の Bazel ワークスペース外のパスをモニタリングしようとするモジュール拡張機能でも、エラーが発生します。
パラメータ
パラメータ | 説明 |
---|---|
path
|
文字列、ラベル、パス。必須 監視するファイルのパス。 |
これは
path module_ctx.which(program)
パラメータ
パラメータ | 説明 |
---|---|
program
|
必須 パス内で検索するプログラム。 |
None
を返す場合があります。