ヘルパー関数を含むモジュール拡張機能のコンテキストと、依存関係グラフ全体の関連タグに関する情報。モジュール拡張機能を作成するときに、module_LookML オブジェクトを implementation 関数の引数として取得します。
メンバー
- ダウンロード
- download_and_extract
- 実行
- extension_metadata
- ファイル
- is_dev_dependency
- モジュール
- OS
- パス
- 読み取り
- 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
|
string;文字列の Iterable。
必須 同じファイルを参照するミラー URL のリスト。 |
output
|
string;またはラベルまたは path
デフォルトは '' です出力ファイルのパス（リポジトリ ディレクトリを基準とする相対パス）。 |
sha256
|
デフォルトは ''ダウンロードしたファイルの想定される SHA-256 ハッシュダウンロードしたファイルの SHA-256 ハッシュと一致している必要があります。リモート ファイルは変更される可能性があるため、SHA-256 を省略するとセキュリティ リスクが発生します。このフィールドを省略すると、ビルドが非密閉型のものになります。開発を容易にするためのオプションですが、リリース前に設定する必要があります。 |
executable
|
デフォルトは False作成されたファイルの実行可能フラグをデフォルトで false に設定します。 |
allow_fail
|
デフォルトは False設定すると、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示す |
canonical_id
|
デフォルトは ''設定すると、キャッシュ ヒットは、同じ正規 ID でファイルがキャッシュに追加された場合にのみ制限されます |
auth
|
デフォルトは {}一部の URL の認証情報を指定する辞書（省略可）。 |
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
|
string;文字列の Iterable。
必須 同じファイルを参照するミラー URL のリスト。 |
output
|
string;またはラベルまたは path
デフォルトは '' ですアーカイブを展開するディレクトリへのパス（リポジトリ ディレクトリを基準とする相対パス）。 |
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、.t.deb のいずれかを明示的に指定できます。見てみましょう。 |
stripPrefix
|
デフォルトは ''抽出されたファイルから削除するディレクトリ接頭辞。 多くのアーカイブには、アーカイブ内のすべてのファイルを含む最上位ディレクトリがあります。このフィールドを使用すると、この接頭辞を build_file で何度も指定しなくても、抽出されたファイルから削除できます。
|
allow_fail
|
デフォルトは False設定すると、ダウンロードに失敗した場合にエラーを返すのではなく、戻り値でエラーを示す |
canonical_id
|
デフォルトは ''設定すると、キャッシュ ヒットは、同じ正規 ID でファイルがキャッシュに追加された場合にのみ制限されます |
auth
|
デフォルトは {}一部の URL の認証情報を指定する辞書（省略可）。 |
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
|
デフォルトは Truestdout と 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。または None
デフォルトは None です拡張機能がルート モジュールの直接的な依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートする場合や、 use_repo を介してこれらのリポジトリをすべてインポートしていない場合、拡張機能が評価されると、Bazel は警告と修正コマンドを出力します。
|
root_module_direct_dev_deps
|
文字列のシーケンス。または string。または None
デフォルトは None です拡張機能がルート モジュールの直接的な開発依存関係と見なすリポジトリの名前。ルート モジュールが追加のリポジトリをインポートする場合や、 use_extension(..., dev_dependency = True) で作成した拡張機能プロキシの use_repo を介してこれらのリポジトリをすべてインポートしていない場合、拡張機能の評価時に Bazel は警告と修正コマンドを出力します。
|
あなた宛てに表示されます。
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)パラメータ
| パラメータ | 説明 |
|---|---|
path
|
string;またはラベルまたは 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 がパスの場合は、そのパスをそのまま返します。
パラメータ
| パラメータ | 説明 |
|---|---|
path
|
string;またはラベルまたは path
必須 パスの作成元となる文字列、ラベル、またはパス |
read
string module_ctx.read(path)ファイル システム上のファイルの内容を読み取ります。
パラメータ
| パラメータ | 説明 |
|---|---|
path
|
string;またはラベルまたは path
必須 読み取り元のファイルのパスです。 |
report_progress
None module_ctx.report_progress(status='')パラメータ
| パラメータ | 説明 |
|---|---|
status
|
string;
デフォルトは ''です 取得の進行状況の現在のステータスを説明する文字列 |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependencyルート モジュールがこの拡張機能を非 dev 依存関係として使用するかどうか。
これは
path module_ctx.which(program)対応するプログラムのパスを返します。パス内にそのようなプログラムが存在しない場合は None を返します。
パラメータ
| パラメータ | 説明 |
|---|---|
program
|
必須 パスで見つけるプログラム。 |
None を返すことができます。