模組 _ 字元

模組擴充功能的內容，包含輔助函式及依附元件圖表中相關標記的相關資訊。建立模組擴充功能時，取得 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 預設 = '
下載檔案的預期 SHA-256 雜湊。這個檔案必須與下載檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。
executable 預設值 = 否
在建立的檔案中設定可執行檔的旗標，預設為 false。
allow_fail 預設值 = 否
如果設定此屬性，請在傳回值中指出錯誤，而非回報下載失敗的錯誤
canonical_id 預設 = '
設定後，如果檔案已加入快取且具有相同標準 ID，則快取命中資料的情況。
auth default = {}
視需要指定部分網址驗證資訊的字典。
integrity 預設 = '
下載檔案的預期總和檢查碼，採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更，因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。

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； 預設 = '
將要解壓縮封存封存的目錄路徑 (相對於存放區目錄)。
sha256 預設 = '
下載檔案的預期 SHA-256 雜湊。這個檔案必須與下載檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。如有提供，系統會先檢查含有指定雜湊的檔案。只有在快取中找不到該檔案時，系統才會嘗試下載。下載成功後，檔案會新增至快取。
type 預設 = '
下載檔案的封存類型。根據預設，封存類型取決於網址的副檔名。如果檔案沒有副檔名，您可以明確指定「zip」、「jar」、「war」、「aar」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tzst」、「tar.bz2」或「.dear」。此處。
stripPrefix 預設 = '
要從已擷取檔案中移除的目錄前置字串。 許多封存檔都包含頂層目錄，內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串，而不需要在 build_file 中反覆指定這個前置字串。
allow_fail 預設值 = 否
如果設定此屬性，請在傳回值中指出錯誤，而非回報下載失敗的錯誤
canonical_id 預設 = '
設定後，如果檔案已加入快取且具有相同標準 ID，則快取命中資料的情況。
auth default = {}
視需要指定部分網址驗證資訊的字典。
integrity 預設 = '
下載檔案的預期總和檢查碼，採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更，因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。
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 預設 = 600
指令持續時間上限，以秒為單位 (預設為 600 秒)。
environment default = {}
強制將某些環境變數設為傳送至程序。
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)

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

參數

參數 說明
root_module_direct_deps sequence of strings; or string; or 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； 預設值 = 無
擴充功能認為擴充功能為根模組的直接開發依附元件。如果根模組匯入其他存放區，或者並未在透過 root_module_direct_deps 且指定 root_module_direct_dev_deps 的擴充功能 Proxy 上透過 use_repo 匯入所有這些存放區，您也必須指定另一個存放區。由這兩個參數指定的清單不得相交。

確切的 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 預設 = '
要建立的檔案內容，預設為空白。
executable 預設值 = True
在建立的檔案中設定可執行檔標記 (預設為 true)。
legacy_utf8 預設值 = True
將檔案內容編碼為 UTF-8 或編碼為 UTF-8日後推出的版本將變更預設值，並移除這項參數。

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

傳回使用 devDependency = True 的 use_extension 呼叫結果指定指定的標記。

參數

參數 說明
tag bazel_module_tag； 必要
從 bazel_module.tags 取得的標記。

模組

list module_ctx.modules

外部依附元件圖表中所有 Bazel 模組的清單，每個模組都是 bazel_module 物件，用於公開為此模組擴充功能指定的所有標記。這個字典的疊代順序保證與從根模組開始的廣度搜尋相同。

OS

repository_os module_ctx.os

用來存取系統資訊的結構體。

路徑

path module_ctx.path(path)

傳回字串、標籤或路徑中的路徑。如果是相對路徑，則會根據存放區目錄進行解析。如果路徑是標籤，則會解析為對應檔案的路徑。請注意，遠端存放區是在分析階段執行，因此不能取決於目標結果 (標籤應指向一個未產生的檔案)。如果路徑是路徑，就會依原樣傳回該路徑。

參數

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

read

string module_ctx.read(path)

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

參數

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

report_progress

None module_ctx.report_progress(status='')

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

參數

參數 說明
status string； 預設 = '
說明擷取進度目前狀態的字串

哪一個？

path module_ctx.which(program)

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

參數

參數 說明
program 必要
要在路徑中找到的程式。
可能會傳回 None。