儲存區字元

回報問題 查看來源 Nightly

包含輔助函式和屬性資訊的存放區規則結構定義。建立存放區規則時，您會收到存放區_ctx 物件，並將其做為 implementation 函式的引數。

成員

Attr

struct repository_ctx.attr

用來存取屬性值的結構體。這些值是由使用者提供 (如果不是，則會採用預設值)。

delete

bool repository_ctx.delete(path)

刪除檔案或目錄。傳回布林值，表示此呼叫實際上是否已刪除檔案或目錄。

參數

參數 說明
path string；或 path；必要
要刪除的檔案路徑 (相對於存放區目錄，或者絕對路徑)。可以是路徑或字串。

下載

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

將檔案下載至所提供網址的輸出路徑，並傳回包含 success 的結構體，如果下載成功，則會傳回包含 true 的標記；如果成功，檔案雜湊，含 sha256 和 integrity 欄位。

參數

參數 說明
url string；或者可疊代字串；必要
參照相同檔案的鏡像網址清單。
output string；或 Label；或是 path；預設為與存放區目錄相對的輸出檔案 ''
路徑。
sha256 string；預設值為 ''
，即下載檔案的預期 SHA-256 雜湊。這個檔案必須與下載檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。
executable bool；預設值為 False
，在建立的檔案上設定可執行檔的標記，預設為 false。
allow_fail bool；預設值為 False
如果已設定，請在傳回值中表示錯誤，而非在下載失敗時引發錯誤
canonical_id string；預設值為 ''
如果已設定，請將快取命中限制在檔案已加入快取且具有相同標準 ID 的情況中。
auth dict； 預設值為 {}
此為選用引數，用於指定部分網址的驗證資訊。
headers dict； 預設值為 {}
此為選用字典，可指定所有網址的 http 標頭。
integrity string；預設值為 ''
下載檔案的預期總和檢查碼，採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更，因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可選擇是否簡化開發作業，但應在出貨前設定。
block bool；預設值為 True
。如果設為 false，呼叫會立即傳回，而非一般傳回值，呼叫會傳回包含單一方法的 wait() 權杖，該方法會在下載完成並傳回一般的回傳值或照常擲回。

download_and_extract

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

將檔案下載至所提供網址的輸出路徑，然後擷取該檔案，並傳回包含 success 的結構體，如果下載成功，則會標記 true；如果下載成功，則檔案的雜湊值為 sha256 和 integrity。

參數

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

execute

exec_result repository_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；預設為 ""
執行指令的工作目錄。可以是存放區根目錄或絕對的相對關係。預設為存放區根目錄。

extract

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

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

參數

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

檔案

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

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

參數

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

getenv

string repository_ctx.getenv(name, default=None)

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

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

參數

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

名稱

string repository_ctx.name

依據這項規則建立的外部存放區名稱。

os

repository_os repository_ctx.os

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

patch

None repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')

將修補程式檔案套用至外部存放區的根目錄。修補程式檔案應為標準統一差異比較格式檔案。Bazel 原生的修補程式實作不支援模糊比對和二進位檔修補程式 (例如修補程式指令列工具)。

參數

參數 說明
patch_file string; 或 Label; 或 path；必要
要套用的修補檔案，可以是標籤、相對路徑或絕對路徑。如果是相對路徑，則會解析為存放區目錄。
strip int；預設值為 0
，會去除檔案名稱中的指定開頭元件數量。
watch_patch string；預設值為 'auto'
，表示是否要觀看修補檔案。可以是「yes」、「no」或「auto」字串。傳遞「yes」等同於立即叫用 watch() 方法；傳遞「no」並不會嘗試查看檔案；傳遞「auto」只會嘗試在合法的情況下查看檔案 (詳情請參閱 watch() 文件)。

path

path repository_ctx.path(path)

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

參數

參數 說明
path string；或 Label；或 path；必要
字串、標籤或路徑，從中建立路徑

閱讀

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

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

參數

參數 說明
path string；或 Label；或 path；必要
路徑來讀取檔案。
watch string；預設為 'auto'
，是否要觀看檔案。可以是「yes」、「no」或「auto」字串。傳遞「yes」等同於立即叫用 watch() 方法；傳遞「no」並不會嘗試查看檔案；傳遞「auto」只會嘗試在合法的情況下查看檔案 (詳情請參閱 watch() 文件)。

report_progress

None repository_ctx.report_progress(status='')

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

參數

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

None repository_ctx.symlink(target, link_name)

在檔案系統上建立符號連結。

參數

參數 說明
target string；或 Label；或 path；必要
符號連結應指向的路徑。
string；或 Label；或 path；必要
要建立的符號連結路徑。

範本

None repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')

使用 template 產生新檔案。在 substitutions 鍵的 template 中，每次出現時都會由相應的值取代。結果會以 path 寫入。選用的 executable 引數 (預設為 true) 可設為開啟或關閉可執行位元。

參數

參數 說明
path string；或 Label；或 path；必要
路徑，建立相對於存放區目錄的路徑。
template string；或 Label；或 path；必要
路徑至範本檔案。
substitutions dict；預設值為 {}
，在展開範本時替代。
executable bool；預設值為 True
，會在建立的檔案上設定可執行標記，預設為 true。
watch_template string；預設為 'auto'
，是否要觀看範本檔案。可以是「yes」、「no」或「auto」字串。傳遞「yes」等同於立即叫用 watch() 方法；傳遞「no」並不會嘗試查看檔案；傳遞「auto」只會嘗試在合法的情況下查看檔案 (詳情請參閱 watch() 文件)。

手錶

None repository_ctx.watch(path)

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

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

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

參數

參數 說明
path string；或 Label；或 path；必要
要監控的檔案路徑。

watch_tree

None repository_ctx.watch_tree(path)

指示 Bazel 監控指定路徑底下任何檔案或目錄的變更。任何對檔案內容所做的變更、檔案或目錄存在、檔案名稱或目錄名稱都會導致系統重新擷取這個存放區。

請注意，若嘗試查看目前正在擷取的存放區中的路徑，將會導致錯誤。

參數

參數 說明
path string；或是 Label；或 path；必要
路徑，這是要觀察的目錄樹狀結構。

哪一個？

path repository_ctx.which(program)

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

參數

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

workspace_root

path repository_ctx.workspace_root

bazel 叫用的根工作區路徑。