模組擴充功能的內容，包含輔助函式和依附元件圖表中相關標記的資訊。建立模組擴充功能時，您會取得 module_ctx 物件做為 implementation 函式的引數。
成員
- download
- download_and_extract
- execute
- extension_metadata
- extract
- file
- getenv
- is_dev_dependency
- modules
- os
- 路徑
- read
- report_progress
- root_module_has_non_dev_dependency
- watch
- which
下載
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
|
string；或 string 的可迭代項目；必要
列出參照相同檔案的鏡像網址。 |
output
|
string；或 Label；或 path；預設為 ''
輸出檔案的路徑，相對於存放區目錄。 |
sha256
|
string；預設值為 ''
下載檔案的預期 SHA-256 雜湊值。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會造成安全性風險。即使您省略這個欄位，建構作業仍會變得不完整。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。如果提供，系統會先檢查儲存庫快取是否有指定雜湊的檔案；如果在快取中找不到檔案，系統才會嘗試下載。下載成功後，檔案就會加入快取。 |
executable
|
bool；預設為 False
在建立的檔案上設定可執行旗標，預設為 false。 |
allow_fail
|
bool；預設值為 False
如果已設定，請在傳回值中指出錯誤，而非針對下載失敗提出錯誤。 |
canonical_id
|
string；預設為 ''
如果設定此屬性，快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況。根據預設，快取會使用總和檢查碼 ( sha256 或 integrity)。 |
auth
|
dict；預設為 {}
可選的 dict，可指定部分網址的驗證資訊。 |
headers
|
dict；預設為 {}
可選的 dict，指定所有網址的 HTTP 標頭。 |
integrity
|
string；預設值為 ''
下載檔案的預期總和檢查碼，以子資源完整性格式表示。此值必須與下載的檔案檢查和總和相符。由於遠端檔案可能會變更，因此省略總和檢查碼會造成安全風險。即使您省略這個欄位，建構作業仍會變得不完整。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。如果提供，系統會先檢查存放區快取是否有指定總和檢查碼的檔案；如果在快取中找不到檔案，系統才會嘗試下載。下載成功後，檔案就會加入快取。 |
block
|
bool；預設為 True
如果設為 false，呼叫會立即傳回，並傳回一個代碼，其中包含單一方法 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
|
string；或 string 的可迭代項目；必要
列出參照相同檔案的鏡像網址 |
output
|
string；或 Label；或 path；預設為 ''
相對於存放區目錄的封存檔案解開目錄路徑。 |
sha256
|
string；預設值為 ''
下載檔案的預期 SHA-256 雜湊值。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會造成安全性風險。即使您省略這個欄位，建構作業仍會變得不完整。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。如果提供，系統會先檢查儲存庫快取是否有指定雜湊的檔案；如果在快取中找不到檔案，系統才會嘗試下載。下載成功後，檔案就會加入快取。 |
type
|
string；預設為 ''
下載檔案的封存類型。根據預設，系統會根據網址的副檔名判斷封存檔案類型。如果檔案沒有副檔名，您可以在這裡明確指定「zip」、「jar」、「war」、「aar」、「nupkg」、「whl」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tzst」、「tar.bz2」、「.tbz」、「.ar」或「.deb」。 |
strip_prefix
|
string；預設為 ''
從解壓縮的檔案中移除的目錄前置字串。許多封存檔都包含頂層目錄，內含封存檔中的所有檔案。您不必在 build_file 中不斷指定這個前置字串，而是可以使用這個欄位從擷取的檔案中移除前置字串。為求相容性，這個參數也可能以已淘汰的名稱 |
allow_fail
|
bool；預設值為 False
如果已設定，請在傳回值中指出錯誤，而非針對下載失敗提出錯誤。 |
canonical_id
|
string；預設為 ''
如果設定此屬性，快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況。根據預設，快取會使用總和檢查碼 ( sha256 或 integrity)。 |
auth
|
dict；預設為 {}
可選的 dict，可指定部分網址的驗證資訊。 |
headers
|
dict；預設為 {}
可選的 dict，指定所有網址的 HTTP 標頭。 |
integrity
|
string；預設值為 ''
下載檔案的預期總和檢查碼，以子資源完整性格式表示。此值必須與下載的檔案檢查和總和相符。由於遠端檔案可能會變更，因此省略總和檢查碼會造成安全風險。即使您省略這個欄位，建構作業仍會變得不完整。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。如果提供，系統會先檢查存放區快取是否有指定總和檢查碼的檔案；如果在快取中找不到檔案，系統才會嘗試下載。下載成功後，檔案就會加入快取。 |
rename_files
|
dict；預設為 {}
可選的 dict，指定在擷取期間要重新命名的檔案。在任何目錄前置字串調整之前，名稱與鍵完全相符的封存項目會改為該值。這可用於解壓縮包含非 Unicode 檔案名稱的封存檔，或在大小寫不敏感的檔案系統中，將檔案解壓縮至相同路徑。 |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout 限制 (以秒為單位，預設為 600 秒)。這個方法會傳回包含指令輸出的 exec_result 結構。environment 對應項目可用於覆寫要傳遞至程序的部分環境變數。
參數
| 參數 | 說明 |
|---|---|
arguments
|
sequence；必要
引數清單，第一個元素應為要執行的程式路徑。 |
timeout
|
int；預設值為 600
指令的最大時間長度 (以秒為單位)，預設為 600 秒。 |
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;
預設為 False指出這個模組擴充功能可確保完整重現，因此不應儲存在鎖定檔案中。 |
extract
None module_ctx.extract(archive, output='', strip_prefix='', *, rename_files={}, watch_archive='auto')參數
| 參數 | 說明 |
|---|---|
archive
|
string；或 Label；或 path；必要
相對於存放區目錄的封存檔案路徑。 |
output
|
string；或 Label；或 path；預設為 ''
相對於存放區目錄的路徑，指向封存檔案解壓縮的目錄。 |
strip_prefix
|
string；預設為 ''
從解壓縮的檔案中移除的目錄前置字串。許多封存檔都包含頂層目錄，內含封存檔中的所有檔案。您不必在 build_file 中不斷指定這個前置字串，而是可以使用這個欄位從擷取的檔案中移除前置字串。為求相容性，這個參數也可能以已淘汰的名稱 |
rename_files
|
dict；預設為 {}
可選的 dict，指定在擷取期間要重新命名的檔案。在任何目錄前置字串調整之前，名稱與鍵完全相符的封存項目會改為該值。這可用於解壓縮包含非 Unicode 檔案名稱的封存檔，或在大小寫不敏感的檔案系統中，將檔案解壓縮至相同路徑。 |
watch_archive
|
string；預設值為 'auto'
表示是否要監控封存檔案。可以是 'yes'、'no' 或 'auto' 字串。傳遞 'yes' 等同於立即叫用 watch() 方法；傳遞 'no' 則不會嘗試監控檔案；傳遞 'auto' 只會在合法情況下嘗試監控檔案 (詳情請參閱 watch() 文件)。
|
file
None module_ctx.file(path, content='', executable=True, legacy_utf8=False)參數
| 參數 | 說明 |
|---|---|
path
|
string；或 Label；或 path；必要
相對於存放區目錄的要建立的檔案路徑。 |
content
|
string；預設為 ''
要建立的檔案內容，預設為空白。 |
executable
|
bool；預設為 True
在建立的檔案上設定可執行的標記，預設為 true。 |
legacy_utf8
|
bool；預設值為 False
無操作。此參數已淘汰，並會在日後的 Bazel 版本中移除。 |
getenv
string module_ctx.getenv(name, default=None)
name 存在，則以字串形式傳回該變數的值；如果不存在，則傳回 default。以累加方式建構時，如果變數 name 的值有任何變更，系統就會重新擷取這個存放區。
參數
| 參數 | 說明 |
|---|---|
name
|
string；必要
所需環境變數的名稱。 |
default
|
string 或 None；預設值為 None
如果找不到 name，則傳回預設值。 |
None。
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True。
參數
| 參數 | 說明 |
|---|---|
tag
|
bazel_module_tag;
required A tag obtained from bazel_module.tags. |
模組
list module_ctx.modules
os
repository_os module_ctx.os
路徑
path module_ctx.path(path)
repository_ctx，相對路徑會相對於存放區目錄解析。如果是 module_ctx，相對路徑會相對於這個模組擴充功能的暫時工作目錄解析。如果路徑是標籤，則會解析為對應檔案的路徑。請注意，遠端存放區和模組擴充功能會在分析階段執行，因此無法依賴目標結果 (標籤應指向未產生的檔案)。如果路徑是路徑，則會原封不動地傳回該路徑。
參數
| 參數 | 說明 |
|---|---|
path
|
string；或 Label；或 path；必要
string、Label 或 path，用於建立路徑。 |
read
string module_ctx.read(path, *, watch='auto')
參數
| 參數 | 說明 |
|---|---|
path
|
string；或 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
|
string；或 Label；或 path；必要
要監控的檔案路徑。 |
哪一個？
path module_ctx.which(program)
path，如果路徑中沒有這類程式，則傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
string；必要
要在路徑中尋找的程式。 |
None。