implementation 函式的引數。成員
- 下載
- download_and_extract
- 執行
- extension_metadata
- file
- is_dev_dependency
- is_isolated
- modules
- os
- path
- read
- report_progress
- root_module_has_non_dev_dependency
下載
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;
required參照相同檔案的備份網址清單。 |
output
|
string; or Label; or path;
default = ''output 檔案相對於存放區目錄的路徑。 |
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;
required參照相同檔案的鏡像網址清單。 |
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」、「.tzst」、「tar.bz2」、「.ar」或「.deb」。 |
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
|
required 引數清單，第一個元素應為要執行的程式路徑。 |
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;
預設值 = Noneextensions 視為根模組直接依附元件的存放區名稱。如果根模組匯入其他存放區，或者並未透過 use_repo 匯入所有這些存放區，Bazel 會在評估擴充功能時輸出警告和修正指令。如果指定
|
root_module_direct_dev_deps
|
sequence of strings; or string; or None;
預設值 = None擴充功能視為根模組直接開發依附元件的存放區名稱。如果根模組匯入其他存放區，或是未透過 use_extension(..., dev_dependency = True) 在使用 use_extension(..., dev_dependency = True) 建立的擴充功能 Proxy 上匯入所有這些存放區，Bazel 會在評估擴充功能時顯示警告和修復指令。use_repo如果指定 確切的 |
檔案
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 取得的標記。 |
is_isolated
bool module_ctx.is_isolated這個擴充功能的特定用途是否已指定
isolate = True，因此與所有其他用途隔離。模組
list module_ctx.modules外部依附元件圖表中，所有使用這個模組擴充功能的 Bazel 模組清單，每個模組都是一個 bazel_module 物件，用來公開為此擴充功能指定的所有標記。這個字典的疊代順序保證與從根模組開始的廣度優先搜尋相同。
OS
repository_os module_ctx.os用來存取系統資訊的結構體。
路徑
path module_ctx.path(path)傳回字串、標籤或路徑的路徑。如果路徑為相對路徑，則會相對於存放區目錄解析。如果路徑是標籤，則會解析為對應檔案的路徑。請注意，遠端存放區會在分析階段執行，因此無法依賴目標結果 (標籤應指向未產生的檔案)。如果 path 是路徑，則會原封不動地傳回該路徑。
參數
| 參數 | 說明 |
|---|---|
path
|
string; or Label; or path;
必要要從中建立路徑的字串、標籤或路徑 |
read
string module_ctx.read(path)讀取檔案系統中的檔案內容。
參數
| 參數 | 說明 |
|---|---|
path
|
string; or Label; or path;
required要讀取的檔案路徑。 |
report_progress
None module_ctx.report_progress(status='')更新擷取此存放區或模組擴充功能的進度狀態
參數
| 參數 | 說明 |
|---|---|
status
|
string;
default = ''string 描述擷取進度目前狀態 |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency根模組是否使用此擴充功能做為非開發人員依附元件。
哪一個？
path module_ctx.which(program)傳回對應程式的路徑，如果路徑中沒有此類程式，則傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
必要 程式，在這個路徑找到產品。 |
None。