module_ctx

回報問題 查看來源

模組擴充功能的結構定義，其中含有輔助函式，以及依附元件圖表中的永久標記相關資訊。建立模組擴充功能時，您會收到 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; 預設 = ''
輸出檔案相對於存放區目錄的路徑。
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」、「.x.zst」和「tar.bz2」或「.z」
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 = ""
執行指令的工作目錄。 相對於存放區根目錄或絕對。

檔案

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 物件，用於公開為其針對這個模組擴充功能指定的所有標記。此字典的疊代順序與從根模組開始的廣泛讀取搜尋相同。

O

repository_os module_ctx.os

存取系統資訊的結構。

路徑

path module_ctx.path(path)

傳回字串、標籤或路徑的路徑。如果路徑是相對路徑，系統會將路徑解析為存放區目錄。如果路徑是標籤，該路徑會解析為對應檔案的路徑。請注意，遠端存放區會在分析階段執行，因此不受目標結果 (標籤應指向未產生的檔案)。如果路徑是路徑，則會傳回該路徑。

參數

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

閱讀

string module_ctx.read(path)

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

參數

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

報表進度

None module_ctx.report_progress(status='')

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

參數

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

哪一個

path module_ctx.which(program)

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

參數

參數 說明
program 必要
路徑。
可能傳回 None。