模組擴充功能的內容，包含輔助函式和依附元件圖表中的相關標記資訊。建立模組擴充功能時，您會取得 module_ctx 物件，做為 implementation 函式的引數。
成員
- 下載
- download_and_extract
- 執行
- extension_metadata
- extract
- 檔案
- getenv
- is_dev_dependency
- modules
- os
- 路徑
- 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 欄位。如果使用者指定 sha256 或 integrity，強烈建議您明確設定 canonical_id。例如 get_default_canonical_id
參數
| 參數 | 說明 |
|---|---|
url
|
字串；或可疊代的 字串；
必要 參照相同檔案的鏡像網址清單。 |
output
|
字串；或 Label；或 path；
預設為 ''輸出檔案的路徑，相對於存放區目錄。 |
sha256
|
字串；
預設為 ''下載檔案的預期 SHA-256 雜湊值。這必須與下載檔案的 SHA-256 雜湊值相符。省略 SHA-256 可能會造成安全風險，因為遠端檔案可能會變更。如果省略這個欄位，建構作業最多只會變成非密封式。這項設定可簡化開發作業，但必須在出貨前設定。如果提供存放區快取，系統會先檢查快取中是否有具有指定雜湊的檔案；只有在快取中找不到檔案時，才會嘗試下載。下載成功後，檔案會新增至快取。 |
executable
|
bool;
default is FalseSet the executable flag on the created file, false by default. |
allow_fail
|
bool;
default is FalseIf set, indicate the error in the return value instead of raising an error for failed downloads. |
canonical_id
|
字串；
預設為 ''如果設定，則將快取命中限制為檔案以相同標準 ID 新增至快取的情況。根據預設，快取會使用檢查碼 ( sha256 或 integrity)。
|
auth
|
dict;
default is {}An optional dict specifying authentication information for some of the URLs. |
headers
|
dict;
default is {}An optional dict specifying http headers for all URLs. |
integrity
|
string;
default is ''Expected checksum of the file downloaded, in Subresource Integrity format. 這必須與下載檔案的總和檢查碼相符。省略總和檢查碼會造成安全風險，因為遠端檔案可能會變更。如果省略這個欄位，建構作業最多只會變成非密封式。這項設定可簡化開發作業，但必須在出貨前設定。如果提供，系統會先檢查存放區快取中是否有具有指定總和檢查碼的檔案；只有在快取中找不到檔案時，才會嘗試下載。下載成功後，檔案會新增至快取。 |
block
|
bool；
預設為 True如果設為 false，呼叫會立即傳回，並傳回具有單一方法 wait() 的權杖，而非一般傳回值。wait() 會封鎖，直到下載完成並傳回一般傳回值或照常擲回為止。 |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', strip_prefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success 的結構體，如果下載完成，則為 true，如果下載成功，則為檔案的雜湊，並包含 sha256 和 integrity 欄位。如果使用者指定 sha256 或 integrity，強烈建議您明確設定 canonical_id。例如 get_default_canonical_id
參數
| 參數 | 說明 |
|---|---|
url
|
字串；或可疊代的 字串；
必要 參照相同檔案的鏡像網址清單。 |
output
|
字串；或 Label；或 path；
預設值為 ''封存檔解壓縮目錄的路徑 (相對於存放區目錄)。 |
sha256
|
字串；
預設為 ''下載檔案的預期 SHA-256 雜湊值。這必須與下載檔案的 SHA-256 雜湊值相符。省略 SHA-256 可能會造成安全風險，因為遠端檔案可能會變更。如果省略這個欄位，建構作業最多只會變成非密封式。這項設定可簡化開發作業，但必須在出貨前設定。如果提供存放區快取，系統會先檢查快取中是否有具有指定雜湊的檔案；只有在快取中找不到檔案時，才會嘗試下載。下載成功後，檔案會新增至快取。 |
type
|
string；
預設為 ''下載檔案的封存類型。根據預設，系統會根據網址的副檔名判斷封存類型。如果檔案沒有副檔名，您可以在這裡明確指定「zip」、「jar」、「war」、「aar」、「nupkg」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tzst」、「tar.bz2」、「.tbz」、「.ar」或「.deb」。 |
strip_prefix
|
string;
預設為 ''要從解壓縮的檔案中移除的目錄前置字串。許多封存檔都包含頂層目錄，內含封存檔中的所有檔案。不必在 build_file 中重複指定這個前置字元，這個欄位可用於從擷取的檔案中移除前置字元。為確保相容性，這個參數也可能以已淘汰的名稱 |
allow_fail
|
bool;
default is FalseIf set, indicate the error in the return value instead of raising an error for failed downloads. |
canonical_id
|
字串；
預設為 ''如果設定，則將快取命中限制為檔案以相同標準 ID 新增至快取的情況。根據預設，快取會使用總和檢查碼「( sha256 或 integrity)」。
|
auth
|
dict;
default is {}An optional dict specifying authentication information for some of the URLs. |
headers
|
dict;
default is {}An optional dict specifying http headers for all URLs. |
integrity
|
string;
default is ''Expected checksum of the file downloaded, in Subresource Integrity format. 這必須與下載檔案的總和檢查碼相符。省略總和檢查碼會造成安全風險，因為遠端檔案可能會變更。如果省略這個欄位，建構作業最多只會變成非密封式。這項設定可簡化開發作業，但必須在出貨前設定。如果提供，系統會先檢查存放區快取中是否有具有指定總和檢查碼的檔案；只有在快取中找不到檔案時，才會嘗試下載。下載成功後，檔案會新增至快取。 |
rename_files
|
dict；
預設為 {}選用字典，用於指定要在解壓縮期間重新命名的檔案。如果封存檔項目名稱與金鑰完全相符，系統會先將項目名稱改為金鑰值，再調整目錄前置字串。這項功能可用於解壓縮含有非 Unicode 檔案名稱的封存檔，或解壓縮檔案時，檔案會解壓縮到不區分大小寫的檔案系統上相同路徑。 |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout (以秒為單位，預設為 600 秒) 限制。這個方法會傳回包含指令輸出內容的 exec_result 結構。environment 對應項可用於覆寫要傳遞至程序的某些環境變數。
參數
| 參數 | 說明 |
|---|---|
arguments
|
sequence;
required 引數清單，第一個元素應為要執行的程式路徑。 |
timeout
|
int;
default is 600Maximum duration of the command in seconds (default is 600 seconds). |
environment
|
dict；
預設為 {}強制設定部分環境變數，以便傳遞至程序。值可以是 None，用來移除環境變數。
|
quiet
|
bool;
預設為 True是否應將 stdout 和 stderr 列印至終端機。 |
working_directory
|
string；
預設值為 ""執行指令的工作目錄。可以是相對於存放區根目錄的路徑，也可以是絕對路徑。 預設為存放區根目錄。 |
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
|
字串序列；或字串；或 None；
預設值為 None擴充功能視為根模組直接開發依附元件的存放區名稱。如果根模組匯入其他存放區，或未透過使用 use_extension(..., dev_dependency = True) 建立的擴充功能 Proxy 上的 use_repo 匯入所有這些存放區，Bazel 會在評估擴充功能時列印警告，指示使用者執行 bazel mod tidy，自動修正 use_repo 呼叫。如果指定
|
reproducible
|
bool;
default is FalseStates that this module extension ensures complete reproducibility, thereby it should not be stored in the lockfile. |
extract
None module_ctx.extract(archive, output='', strip_prefix='', *, rename_files={}, watch_archive='auto')參數
| 參數 | 說明 |
|---|---|
archive
|
字串；或 Label；或 path；
必要 相對於存放區目錄的封存檔解壓縮路徑。 |
output
|
字串；或 Label；或 path；
預設值為 ''封存檔解壓縮目錄的路徑，相對於存放區目錄。 |
strip_prefix
|
string；
預設為 ''要從解壓縮檔案中移除的目錄前置字串。許多封存檔都包含頂層目錄，內含封存檔中的所有檔案。您不必在 build_file 中重複指定這個前置字元，而是使用這個欄位從擷取的檔案中移除前置字元。
為確保相容性，這個參數也可能以已淘汰的名稱 |
rename_files
|
dict；
預設為 {}選用字典，用於指定要在解壓縮期間重新命名的檔案。如果封存檔項目名稱與金鑰完全相符，系統會先將項目名稱改為金鑰值，再調整目錄前置字串。這項功能可用於解壓縮含有非 Unicode 檔案名稱的封存檔，或解壓縮檔案時，檔案會解壓縮到不區分大小寫的檔案系統上相同路徑。 |
watch_archive
|
string；
預設為 'auto'是否監控封存檔案。可以是字串「yes」、「no」或「auto」。傳遞「yes」相當於立即叫用 watch() 方法；傳遞「no」不會嘗試監看檔案；傳遞「auto」只會在合法的情況下嘗試監看檔案 (詳情請參閱 watch() 文件)。
|
檔案
None module_ctx.file(path, content='', executable=True, legacy_utf8=False)參數
| 參數 | 說明 |
|---|---|
path
|
字串；或 Label；或 path；
必要 要建立的檔案路徑 (相對於存放區目錄)。 |
content
|
string;
default is ''The content of the file to create, empty by default. |
executable
|
bool;
預設值為 True在建立的檔案上設定可執行檔標記，預設為 true。 |
legacy_utf8
|
bool;
default is FalseNo-op. This parameter is deprecated and will be removed in a future version of Bazel. |
getenv
string module_ctx.getenv(name, default=None)
name 存在，則以字串形式傳回該變數的值；如果不存在，則傳回 default。以累加方式建構時，如果變數 (由 name 命名) 的值有任何變更，系統就會重新擷取這個存放區。
參數
可能會傳回None。
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True。
參數
| 參數 | 說明 |
|---|---|
tag
|
bazel_module_tag;
required 從 bazel_module.tags 取得的標記。 |
模組
list module_ctx.modules
os
repository_os module_ctx.os
路徑
path module_ctx.path(path)
參數
read
string module_ctx.read(path, *, watch='auto')
參數
| 參數 | 說明 |
|---|---|
path
|
字串；或 Label；或 path；
必要 要讀取的檔案路徑。 |
watch
|
string;
預設值為 'auto'是否監控檔案。可以是字串「yes」、「no」或「auto」。傳遞「yes」相當於立即叫用 watch() 方法；傳遞「no」不會嘗試監看檔案；傳遞「auto」只會在合法的情況下嘗試監看檔案 (詳情請參閱 watch() 文件)。
|
report_progress
None module_ctx.report_progress(status='')參數
| 參數 | 說明 |
|---|---|
status
|
string;
預設為 ''string 說明擷取進度的目前狀態。
|
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
手錶
None module_ctx.watch(path)「變更」包括檔案內容的變更 (如果路徑是檔案)、路徑從檔案變更為目錄 (反之亦然)，以及路徑開始或停止存在。請注意，如果路徑是目錄，這不包括目錄下任何檔案的變更。請改用 path.readdir()。
請注意，如果嘗試監看正在擷取的存放區內路徑，或目前模組擴充功能的作業目錄內路徑，系統會傳回錯誤。如果模組擴充功能嘗試監看目前 Bazel 工作區以外的路徑，也會導致錯誤。
參數
哪一個？
path module_ctx.which(program)
path，如果路徑中沒有這類程式，則傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
字串；
必要 要在路徑中尋找的程式。 |
None。