模組擴充功能的內容，其中包含輔助函式和相依關係圖中相關標記的資訊。建立模組擴充功能時，您會取得 module_ctx 物件做為 implementation 函式的引數。
成員
- 下載
- 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
|
字串；或 字串的可迭代項目；
必要 參照相同檔案的鏡像網址清單。 |
output
|
字串；或標籤；或路徑；預設為 ''輸出檔案的路徑，相對於存放區目錄。 |
sha256
|
預設值為 ''下載檔案的預期 SHA-256 雜湊值。這個檔案必須與下載檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會造成安全性風險。即使您省略這個欄位，建構作業仍會變得不完整。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。 |
executable
|
預設為 False在建立的檔案上設定可執行標記，預設為 false。 |
allow_fail
|
預設值為 False如果已設定，請在傳回值中指出錯誤，而非針對下載失敗的情況擲回錯誤 |
canonical_id
|
預設為 ''如果設為此值，快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況 |
auth
|
預設為 {}(選用) 指定部分網址的驗證資訊的字典。 |
headers
|
預設為 {}(可選) 指定所有網址的 HTTP 標頭。 |
integrity
|
預設值為 ''預期的下載檔案總和檢查碼，格式為子資源完整性。這個 ID 必須與下載檔案的總和檢查碼相符。由於遠端檔案可能會變更，因此省略總和檢查碼會造成安全風險。即使您省略這個欄位，建構作業仍會變得不完整。您可選擇是否簡化開發作業，但應在出貨前設定。 |
block
|
預設值為 True如果設為 false，呼叫會立即傳回，而非一般的傳回值，而是透過單一方法 (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
|
string；或者可疊代字串；必要 參照相同檔案的鏡像網址清單。 |
output
|
string；或是 Label；或是 path；預設為 ''路徑，指向要解壓縮封存的目錄路徑 (相對於存放區目錄)。 |
sha256
|
預設值為 ''下載檔案的預期 SHA-256 雜湊值。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會造成安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。如果提供，系統會先檢查儲存庫快取是否有指定雜湊的檔案；如果在快取中找不到檔案，系統才會嘗試下載。下載成功後，檔案會新增至快取。 |
type
|
預設值為 ''所下載檔案的封存類型。根據預設，系統會根據網址的副檔名判斷封存檔案類型。如果檔案沒有副檔名，您可以在此處明確指定「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
|
預設為 {}(選用) 指定部分網址的驗證資訊的字典。 |
headers
|
預設為 {}(可選) 指定所有網址的 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
|
字串的序列；或 字串；或 None；預設為 None。 擴充功能視為根模組直接開發依附元件的存放區名稱。如果根模組匯入其他存放區，或是未透過 use_extension(..., dev_dependency = True) 建立的擴充功能 Proxy 使用 use_repo 匯入所有這些存放區，Bazel 會在評估擴充功能時顯示警告，指示使用者執行 bazel mod tidy 來自動修正 use_repo 呼叫。如果指定
|
reproducible
|
bool；預設值為 False，指出這個模組擴充功能可確保完整可重現性，因此不應儲存在 Lockfile 中。 |
檔案
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)參數
| 參數 | 說明 |
|---|---|
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)傳回 use_extension 呼叫 (使用
devDependency = True) 結果中是否指定了指定的標記。
參數
| 參數 | 說明 |
|---|---|
tag
|
bazel_module_tag;
required 從 bazel_module.tags 取得的標記。 |
模組
list module_ctx.modules外部相依關係圖中使用此模組擴充功能的所有 Bazel 模組清單，每個模組都是 bazel_module 物件，可公開為此擴充功能指定的所有標記。這個字典的疊代順序保證與從根模組開始的廣度優先搜尋相同。
os
repository_os module_ctx.os用於存取系統資訊的結構體。
路徑
path module_ctx.path(path)傳回字串、標籤或路徑的路徑。如果路徑為相對路徑，則會相對於存放區目錄解析。如果路徑是標籤，則會解析為對應檔案的路徑。請注意，遠端存放區是在分析階段執行，因此不能取決於目標結果 (標籤應指向一個未產生的檔案)。如果 path 是路徑，則會原封不動地傳回該路徑。
參數
| 參數 | 說明 |
|---|---|
path
|
string；或 Label；或 path；必要 字串、標籤或路徑，從中建立路徑 |
read
string module_ctx.read(path, *, watch='auto')讀取檔案系統中的檔案內容。
參數
| 參數 | 說明 |
|---|---|
path
|
字串；或標籤；或路徑；
必要 要讀取的檔案路徑。 |
watch
|
預設為 'auto'是否要監控檔案。可以是「yes」、「no」或「auto」字串。傳遞「是」等同於立即叫用 watch() 方法；傳遞「否」則不會嘗試監控檔案；傳遞「自動」只會在合法情況下嘗試監控檔案 (詳情請參閱 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)傳回對應程式的路徑，或若路徑中沒有這類程式，則傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
必要 程式，在這個路徑找到產品。 |
None。