模組 _ 字元

回報問題 查看原始碼 。 。 。 夜間7.3 7.2 。 。 7.1 7.0 6.5

模組擴充功能的內容,包含輔助函式及依附元件圖表中相關標記的相關資訊。建立模組擴充功能時,取得 module_ctx 物件做為 implementation 函式的引數。

成員

下載

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

將檔案下載至所提供網址的輸出路徑,並傳回包含 success 的結構體,如果下載成功,則會傳回包含 true 的標記;如果成功,檔案雜湊,含 sha256integrity 欄位。如果指定 sha256integrity,強烈建議您設定明確的 canonical_id。例如:get_default_canonical_id

參數

參數 說明
url string;或「字串」的可疊代項目; 必要
參照相同檔案的鏡像網址清單。
output string;或標籤;或 path; 預設值為 ''
輸出檔案的路徑,相對於存放區目錄。
sha256 string; 預設值為 ''
下載檔案的預期 SHA-256 雜湊。這個檔案必須與下載檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更,因此省略 SHA-256 會帶來安全性風險。如果盡可能省略這個欄位,版本會變為非一致性。您可選擇是否簡化開發作業,但應在出貨前設定。如有提供,系統會先檢查含有指定雜湊的檔案。只有在快取中找不到該檔案時,系統才會嘗試下載。下載成功後,檔案會新增至快取。
executable bool; 預設值為 False
在已建立的檔案上設定可執行檔的旗標,預設為 false。
allow_fail bool; 預設值為 False
如果設定此屬性,請在傳回值中表示錯誤,而非引發下載失敗的錯誤。
canonical_id string; 預設值為 ''
設定後,如果檔案已加入快取且具有相同標準 ID,則快取命中資料的情況。根據預設,快取會使用檢查碼 (sha256integrity)。
auth dict; 預設值為 {}
視需要指定部分網址驗證資訊的字典。
headers dict; 預設值為 {}
選用的字典,用於指定所有網址的 http 標頭。
integrity string; 預設值為 ''
下載檔案的預期總和檢查碼,採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更,因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位,版本會變為非一致性。您可選擇是否簡化開發作業,但應在出貨前設定。如有提供,系統會先檢查存放區快取是否具有指定總和檢查碼的檔案。只有在快取中找不到該檔案時,系統才會嘗試下載。下載成功後,檔案會新增至快取。
block bool; 預設值為 True
如果設為 false,呼叫會立即傳回,而不是一般的傳回值,而是傳回包含單一方法 wait() 的憑證,在下載完成之後就會封鎖,並且會像往常一樣傳回一般的回傳值或擲回。

download_and_extract

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

將檔案下載至所提供網址的輸出路徑,然後擷取該檔案,並傳回包含 success 的結構體,如果下載成功,則會標記 true;如果下載成功,則檔案的雜湊值為 sha256integrity。如果指定 sha256integrity,強烈建議您設定明確的 canonical_id。例如:get_default_canonical_id

參數

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

execute

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

執行由引數清單指定的指令。該指令的執行時間限制為 timeout (以秒為單位,預設為 600 秒)。這個方法會傳回包含指令輸出內容的 exec_result 結構。environment 對應可用於覆寫要傳遞至程序的部分環境變數。

參數

參數 說明
arguments sequence; 必要
引數清單,第一個元素是要執行的程式路徑。
timeout int; 預設值為 600
指令持續時間上限 (以秒為單位),預設值為 600 秒。
environment dict; 預設值為 {}
強制將某些環境變數設為傳送至程序。
quiet bool; 預設值為 True
如果 stdout 和 stderr 應在終端機顯示。
working_directory string; 預設值為 ""
指令執行的工作目錄。 可以是存放區根目錄或絕對的相對關係。 預設為存放區根目錄。

extension_metadata

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

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

參數

參數 說明
root_module_direct_deps 字串序列;或 string;或 None; 預設值為 None
擴充功能認為擴充功能的名稱為根模組的直接依附元件。如果根模組匯入其他存放區,或者並未透過 use_repo 匯入所有存放區,Bazel 會在評估擴充功能時輸出警告,指示使用者執行 bazel mod tidy 來自動修正 use_repo 呼叫。

如果其中一個 root_module_direct_deps,並在評估擴充功能時輸出警告和修正指令。

如果指定 root_module_direct_depsroot_module_direct_dev_deps 中的任一值,也必須一併指定另一個。由這兩個參數指定的清單不得相交。

確切的 root_module_direct_depsroot_module_direct_dev_deps 可設定為特殊值 "all",系統會將其視為包含擴充功能產生的所有存放區名稱的清單,並將其指定為值。

root_module_direct_dev_deps 字串序列;或 string;或 None; 預設值為 None
擴充功能認為擴充功能為根模組的直接開發依附元件。如果根模組匯入其他存放區,或者並未在使用 use_extension(..., dev_dependency = True) 建立的擴充功能 Proxy 上透過 use_repo 匯入所有這些存放區,Bazel 會在評估擴充功能時輸出警告,指示使用者執行 bazel mod tidy 來自動修正 use_repo 呼叫。

如果指定 root_module_direct_depsroot_module_direct_dev_deps 中的任一值,也必須一併指定另一個。由這兩個參數指定的清單不得相交。

確切的 root_module_direct_depsroot_module_direct_dev_deps 可設定為特殊值 "all",系統會將其視為包含擴充功能產生的所有存放區名稱的清單,並將其指定為值。

reproducible bool; 預設值為 False
指出此模組擴充功能可確保完整可重現性,因此不應儲存在 Lockfile 中。

extract

None module_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')

將封存檔解壓縮至存放區目錄。

參數

參數 說明
archive string;或標籤;或 path; 必要
將要解壓縮的封存檔路徑 (相對於存放區目錄)。
output string;或標籤;或 path; 預設值為 ''
將要解壓縮封存封存的目錄路徑 (相對於存放區目錄)。
stripPrefix string; 預設值為 ''
要從已擷取檔案中移除的目錄前置字串。 許多封存檔都包含頂層目錄,內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串,而不需要在 build_file 中反覆指定這個前置字串。
rename_files dict; 預設值為 {}
選用的字典,用於指定擷取期間要重新命名的檔案。如果封存項目名稱與鍵完全相符,系統會在任何目錄前置字串調整前,將該項目重新命名為該值。這可用於擷取包含非萬國碼 (Unicode) 檔案名稱的封存檔案,或是哪些檔案在不區分大小寫的檔案系統中擷取到相同路徑。
watch_archive string; 預設值為 'auto'
是否要觀看封存檔案。可以是「yes」、「no」或「auto」字串。傳送「是」等同於立即叫用 watch() 方法傳遞「否」未試圖觀看檔案;傳送「auto」只有在合法的情況下,系統才會嘗試觀看影片 (詳情請參閱 watch() 文件)。

檔案

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

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

參數

參數 說明
path string;或標籤;或 path; 必要
要建立的檔案路徑,相對於存放區目錄。
content string; 預設值為 ''
要建立的檔案內容,預設為空白。
executable bool; 預設值為 True
在已建立的檔案上設定執行檔標記 (預設為 true)。
legacy_utf8 bool; 預設值為 True
將檔案內容的編碼成 UTF-8 編碼,預設為 true。日後推出的版本將變更預設值,並移除這項參數。

getenv

string module_ctx.getenv(name, default=None)

傳回環境變數 name 的值 (如有),否則傳回 default

執行漸進式建構作業時,如果變更 name 命名的變數值,系統就會重新擷取這個存放區。

參數

參數 說明
name string; 必要
所需環境變數的名稱。
default string;或 None; 預設值為 None
如果找不到 name,系統會傳回的預設值。
可能會傳回 None

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

傳回使用 devDependency = Trueuse_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;或標籤;或 path; 必要
建立路徑的來源 stringLabelpath

read

string module_ctx.read(path, *, watch='auto')

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

參數

參數 說明
path string;或標籤;或 path; 必要
要讀取的檔案路徑。
watch string; 預設值為 'auto'
是否要觀看檔案。可以是「yes」、「no」或「auto」字串。傳送「是」等同於立即叫用 watch() 方法傳遞「否」未試圖觀看檔案;傳送「auto」只有在合法的情況下,系統才會嘗試觀看影片 (詳情請參閱 watch() 文件)。

report_progress

None module_ctx.report_progress(status='')

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

參數

參數 說明
status string; 預設值為 ''
string,說明擷取進度的目前狀態。

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

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

手錶

None module_ctx.watch(path)

告知 Bazel 監控指定路徑的變更,無論該路徑是否存在,或是是檔案或目錄。任何對檔案或目錄所做的變更,都會使這個存放區或模組擴充功能失效,並導致系統下次重新擷取或重新評估內容。

「變更」包括檔案內容變更 (如果路徑是檔案);如果路徑是檔案,但現在是目錄,反之亦然;以及路徑的開始或停止值得注意的是,如果路徑是目錄,則「不」包括對目錄下任何檔案所做的變更。如要這麼做,請改用 path.readdir()

請注意,如果嘗試查看目前擷取的存放區中的路徑,或是目前模組擴充功能的工作目錄,就會導致錯誤。如果模組擴充功能嘗試監控目前 Bazel 工作區以外的路徑,也會導致錯誤。

參數

參數 說明
path string;或標籤;或 path; 必要
要監控的檔案路徑。

哪一個?

path module_ctx.which(program)

傳回對應程式的 path;如果路徑中沒有這類程式,則傳回 None

參數

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