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；預設 = ''路徑，指向要解壓縮封存的目錄 (相對於存放區目錄)。 |
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.bzar」或。 |
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
|
預設 = 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 (預設為 true)。日後的版本將變更預設值，並移除這項參數。 |
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；預設 =「'」字串，說明擷取進度的目前狀態 |
哪一個？
path module_ctx.which(program)如果路徑中沒有這樣的程式，會傳回對應程式的路徑，或是傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
必要計畫， 從學習路徑中發現。 |
None。