模組 _ 字元

模組擴充功能的結構定義 (包含輔助函式，以及依附元件圖表上相關標記的相關資訊)。建立模組擴充功能時，您會取得 module_ctx 物件做為 implementation 函式的引數。

會員

下載

struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

將檔案下載至提供網址的輸出路徑，並傳回包含 success 的結構。如果下載成功，則會傳回 true 旗標；如果成功，也會傳回包含 sha256 和 integrity 欄位的檔案雜湊。

參數

參數 說明
url string; or Iterable of strings；必要
參照相同檔案的鏡像網址清單。
output string; or Label; or path; default = ''
輸出檔案的路徑 (相對於存放區目錄)。
sha256 default = '
下載檔案的預期 SHA-256 雜湊。這必須與下載檔案的 SHA-256 雜湊值相符。由於遠端檔案可能會變更，省略 SHA-256 會帶來安全風險。盡量省略這個欄位，會導致建構作業不一致。您可以選擇輕鬆開發，但應在運送前進行設定。
executable default = False
針對已建立的檔案設定可執行標記，預設為 false。
allow_fail default = False
如果已設定，請在傳回值中指定錯誤，而非引發下載失敗的錯誤
canonical_id default = ''
如果已設定，請將快取命中限制在將檔案新增至快取，且具有相同標準 ID 的情況
auth default = {}
這是選用的字典，指定部分網址的驗證資訊。
integrity default = ''
下載檔案的預期檢查碼，採用子資源完整性格式。這必須與下載檔案的總和檢查碼相符。由於遠端檔案可能會變更，因此省略總和檢查碼會帶來安全性風險。盡量省略這個欄位，會導致建構作業不一致。您可以選擇輕鬆開發，但應在運送前進行設定。

download_and_extract

struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

將檔案下載至所提供網址的輸出路徑、擷取該檔案並傳回包含 success 的結構。如果下載成功，則為 true 旗標 (如果下載成功，則為具有 sha256 和 integrity 欄位的檔案雜湊)。

參數

參數 說明
url string; or Iterable of strings；必要
參照相同檔案的鏡像網址清單。
output string; or Label; or path; default = ''
指向要解壓縮封存的目錄路徑 (相對於存放區目錄)。
sha256 default = '
下載檔案的預期 SHA-256 雜湊。這必須與下載檔案的 SHA-256 雜湊值相符。由於遠端檔案可能會變更，省略 SHA-256 會帶來安全風險。盡量省略這個欄位，會導致建構作業不一致。您可以選擇輕鬆開發，但應在運送前進行設定。若提供，將先檢查存放區快取，找出具有指定雜湊的檔案；只有在快取中找不到該檔案時，系統才會嘗試下載。成功下載後，系統會將該檔案新增到快取中。
type default = ''
下載檔案的封存類型。根據預設，封存類型取決於網址的副檔名。如果檔案沒有副檔名，您可以明確指定「zip」、「jar」、「war」、「aar」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tar.zst」、「tar.bz2」、「.tz.」或「.tz.
stripPrefix default = ''
要從擷取的檔案中移除的目錄前置字串。 許多封存檔案包含頂層目錄，內含封存中的所有檔案。您不需要在 build_file 中反覆指定此前置字串，而且可以使用這個欄位從擷取的檔案中移除該前置字串。
allow_fail default = False
如果已設定，請在傳回值中指定錯誤，而非引發下載失敗的錯誤
canonical_id default = ''
如果已設定，請將快取命中限制在將檔案新增至快取，且具有相同標準 ID 的情況
auth default = {}
這是選用的字典，指定部分網址的驗證資訊。
integrity default = ''
下載檔案的預期檢查碼，採用子資源完整性格式。這必須與下載檔案的總和檢查碼相符。由於遠端檔案可能會變更，因此省略總和檢查碼會帶來安全性風險。盡量省略這個欄位，會導致建構作業不一致。您可以選擇輕鬆開發，但應在運送前進行設定。
rename_files default = {}
這是選用的字典，用來指定在擷取期間重新命名的檔案。系統會先將名稱完全相符的封存項目重新命名為值，再調整任何目錄前置字串。這可用於擷取含有非萬國碼 (Unicode) 檔案名稱的封存，或是這類檔案會在不區分大小寫的檔案系統中擷取至相同路徑的檔案。

execute

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

這個外掛程式能執行由引數清單提供的指令。指令的執行時間限制為 timeout (以秒為單位，預設值為 600 秒)。這個方法會傳回包含指令輸出內容的 exec_result 結構。environment 對應可用來覆寫一些要傳遞至程序的環境變數。

參數

參數 說明
arguments 必要
引數清單，第一個元素應為要執行的程式路徑。
timeout default = 600
指令的最長持續時間 (單位為 600 秒)。
environment default = {}
強制將部分環境變數設為傳送至程序。
quiet default = True
如果 stdout 和 stderr 應列印至終端機。
working_directory default = ""
用於執行指令的工作目錄。 可以是存放區根目錄或絕對值。

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)

建構可從模組擴充功能實作函式傳回的不透明物件，將擴充功能產生的存放區中繼資料提供給 Bazel。

參數

參數 說明
root_module_direct_deps sequence of strings; or string; or None; default = None
擴充功能認定為根模組直接依附元件的存放區名稱。如果根模組會匯入其他存放區，或是並未透過 use_repo 匯入所有存放區，Bazel 會在評估擴充功能時輸出警告和修正指令。

如果指定 root_module_direct_deps 和 root_module_direct_dev_deps 其中之一，則必須一併指定另一個。這兩個參數指定的清單不可相鄰。

只能將 root_module_direct_deps 和 root_module_direct_dev_deps 其中之一設為特殊值 "all"。系統會將該值指定為包含擴充功能產生所有存放區名稱的清單時，系統會將該值指定為這個值。

root_module_direct_dev_deps sequence of strings; or string; or None; default = None
擴充功能認定為根模組的直接開發依附元件的存放區名稱。如果根模組在透過 use_extension(..., dev_dependency = True) 建立的擴充功能 Proxy 上匯入其他存放區，或是未透過 use_repo 匯入所有存放區，則 Bazel 會在評估擴充功能時發出警告和修正指令。

如果指定 root_module_direct_deps 和 root_module_direct_dev_deps 其中之一，則必須一併指定另一個。這兩個參數指定的清單不可相鄰。

只能將 root_module_direct_deps 和 root_module_direct_dev_deps 其中之一設為特殊值 "all"。系統會將該值指定為包含擴充功能產生所有存放區名稱的清單時，系統會將該值指定為這個值。

檔案

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

以提供的內容在存放區目錄中產生檔案。

參數

參數 說明
path string; or Label; or path；所需檔案路徑
(相對於存放區目錄)。
content default = ''
要建立的檔案內容，預設為空白。
executable default = True
針對已建立的檔案設定可執行標記，預設為 true。
legacy_utf8 default = True
以預設，將檔案內容編碼為 UTF-8。日後的版本會變更預設值並移除這個參數。

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

path module_ctx.path(path)

傳回字串、標籤或路徑中的路徑。如果是相對路徑，則會解析與存放區目錄的相對路徑。如果路徑是標籤，系統會將其解析為對應檔案的路徑。請注意，遠端存放區是在分析階段執行，因此無法取決於目標結果 (標籤應指向非產生的檔案)。如果路徑是路徑，系統會依原樣傳回該路徑。

參數

參數 說明
path string; or Label; or path；必要
字串、標籤或路徑，建立來源路徑

閱讀

string module_ctx.read(path)

讀取檔案系統中的檔案內容。

參數

參數 說明
path string; or Label; or path；必要
讀取的檔案路徑。

report_progress

None module_ctx.report_progress(status='')

更新這個存放區或模組擴充功能擷取作業的進度狀態

參數

參數 說明
status string; default = ''
字串，說明擷取進度的目前狀態

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

根模組是否將這個擴充功能當做非開發人員依附元件使用。

哪一個？

path module_ctx.which(program)

傳回對應程式的路徑，如果路徑中沒有此類程式，則傳回 None。

參數

參數 說明
program 所需的
程式。
可能會傳回 None。