包含輔助函式和屬性資訊的存放區規則結構定義。建立存放區規則時，您會取得 repository_ctx 物件做為 implementation 函式的引數。
成員
- attr
- 刪除
- 下載
- download_and_extract
- 執行
- 擷取
- file
- getenv
- 名稱
- os
- patch
- path
- 閱讀
- report_progress
- 符號連結
- template
- 手錶
- watch_tree
- workspace_root
attr
struct repository_ctx.attr用於存取屬性值的結構體。這些值由使用者提供 (如果未提供，則會使用預設值)。
刪除
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;或標籤；或 path;
預設值為 ''輸出檔案的路徑，相對於存放區目錄。 |
sha256
|
預設值為 ''下載檔案的預期 SHA-256 雜湊值。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更，因此省略 SHA-256 會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。 |
executable
|
預設為 False在建立的檔案上設定可執行標記，預設為 false。 |
allow_fail
|
預設值為 False如果已設定，請在傳回值中指出錯誤，而非針對下載失敗的情況擲回錯誤 |
canonical_id
|
預設為 ''如果設為此值，快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況 |
auth
|
預設為 {}(選用) 指定部分網址的驗證資訊的字典。 |
headers
|
預設為 {}(選用) 指定所有網址的 HTTP 標頭。 |
integrity
|
預設值為 ''下載檔案的預期總和檢查碼，採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更，因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位，版本會變為非一致性。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。 |
block
|
預設為 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
|
字串；或字串的可迭代項目；
必要 參照相同檔案的備份網址清單。 |
output
|
string;或標籤；或 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」、「.tbz」、「.ar」或「.deb」。 |
stripPrefix
|
預設值為 ''要從已擷取檔案中移除的目錄前置字串。 許多封存檔都包含頂層目錄，內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串，而不需要在 build_file 中反覆指定這個前置字串。
|
allow_fail
|
預設值為 False如果設定此屬性，請在傳回值中指出錯誤，而非回報下載失敗的錯誤 |
canonical_id
|
預設為 ''如果設為此值，快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況 |
auth
|
預設為 {}(選用) 指定部分網址的驗證資訊的字典。 |
headers
|
預設為 {}(選用) 指定所有網址的 HTTP 標頭。 |
integrity
|
預設值為 ''預期的下載檔案總和檢查碼，格式為子資源完整性。此值必須與下載的檔案檢查和總和相符。由於遠端檔案可能會變更，因此省略總和檢查碼會造成安全風險。如果盡可能省略這個欄位，版本會變為非一致性。您可以選擇是否要設定這個值，以利開發作業，但應在發布前設定。 |
rename_files
|
預設為 {}(選用) 字典，指定在擷取期間要重新命名的檔案。如果封存項目名稱與鍵完全相符，系統會在任何目錄前置字串調整前，將該項目重新命名為該值。這可用於解壓縮包含非 Unicode 檔案名稱的封存檔，或在大小寫不敏感的檔案系統中，將檔案解壓縮至相同路徑。 |
execute
exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")執行由引數清單指定的指令。該指令的執行時間限制為
timeout (以秒為單位，預設為 600 秒)。這個方法會傳回包含指令輸出內容的 exec_result 結構。environment 對應項目可用於覆寫要傳遞至程序的部分環境變數。
參數
| 參數 | 說明 |
|---|---|
arguments
|
必要 引數清單，第一個元素是要執行的程式路徑。 |
timeout
|
預設值為 600指令持續時間上限，以秒為單位 (預設為 600 秒)。 |
environment
|
預設值為 {}強制將某些環境變數設為傳送至程序。 |
quiet
|
預設為 True如果要將 stdout 和 stderr 列印到終端機。 |
working_directory
|
預設值為 ""指令執行的工作目錄。 可以是存放區根目錄或絕對的相對關係。 |
extract
None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')參數
| 參數 | 說明 |
|---|---|
archive
|
string;或標籤；或 path;
必要 將要解壓縮的封存檔路徑 (相對於存放區目錄)。 |
output
|
string;或標籤；或 path;
預設值為 ''將要解壓縮封存封存的目錄路徑 (相對於存放區目錄)。 |
stripPrefix
|
預設值為 ''，許多封存檔都包含頂層目錄，內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串，而不需要在 build_file 中反覆指定這個前置字串。
|
rename_files
|
預設為 {}(選用) 字典，指定在擷取期間要重新命名的檔案。在任何目錄前置字串調整之前，名稱與鍵完全相符的封存項目會改為該值。這可用於擷取包含非萬國碼 (Unicode) 檔案名稱的封存檔案，或是哪些檔案在不區分大小寫的檔案系統中擷取到相同路徑。 |
watch_archive
|
預設值為 'auto'是否要觀看封存檔案。可以是「yes」、「no」或「auto」字串。傳送「是」等同於立即叫用 watch() 方法傳遞「否」未試圖觀看檔案；傳送「auto」只有在合法的情況下，系統才會嘗試觀看影片 (詳情請參閱 watch() 文件)。
|
檔案
None repository_ctx.file(path, content='', executable=True, legacy_utf8=True)參數
| 參數 | 說明 |
|---|---|
path
|
字串；或標籤；或路徑；
必要 相對於存放區目錄的要建立檔案路徑。 |
content
|
預設值為 ''要建立的檔案內容，預設為空白。 |
executable
|
預設值為 True在建立的檔案中設定可執行檔標記 (預設為 true)。 |
legacy_utf8
|
預設為 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')參數
| 參數 | 說明 |
|---|---|
patch_file
|
字串；或標籤；或路徑；
必要 要套用的修補檔案，可以是標籤、相對路徑或絕對路徑。如果是相對路徑，則會解析為存放區目錄。 |
strip
|
預設為 0從檔案名稱中移除指定數量的前置元件。 |
watch_patch
|
預設值為 'auto'是否要觀看修補程式檔案可以是「yes」、「no」或「auto」字串。傳遞「是」等同於立即叫用 watch() 方法；傳遞「否」則不會嘗試監控檔案；傳遞「自動」只會在合法情況下嘗試監控檔案 (詳情請參閱 watch() 文件)。
|
路徑
path repository_ctx.path(path)傳回字串、標籤或路徑的路徑。如果是相對路徑，則會根據存放區目錄進行解析。如果路徑是標籤，則會解析為對應檔案的路徑。請注意，遠端存放區會在分析階段執行，因此無法依賴目標結果 (標籤應指向未產生的檔案)。如果 path 是路徑，則會原封不動地傳回該路徑。
參數
| 參數 | 說明 |
|---|---|
path
|
字串；或標籤；或路徑；
必要 字串、標籤或路徑，用於建立路徑 |
read
string repository_ctx.read(path, *, watch='auto')讀取檔案系統中的檔案內容。
參數
| 參數 | 說明 |
|---|---|
path
|
字串；或標籤；或路徑；
必填 要讀取的檔案路徑。 |
watch
|
預設值為 'auto'是否要觀看檔案？可以是「yes」、「no」或「auto」字串。傳遞「是」等同於立即叫用 watch() 方法；傳遞「否」則不會嘗試監控檔案；傳遞「自動」只會在合法情況下嘗試監控檔案 (詳情請參閱 watch() 文件)。
|
report_progress
None repository_ctx.report_progress(status='')參數
| 參數 | 說明 |
|---|---|
status
|
string;
預設值為 ''說明擷取進度目前狀態的字串 |
符號連結
None repository_ctx.symlink(target, link_name)參數
| 參數 | 說明 |
|---|---|
target
|
字串；或 標籤；或 路徑；
必要 符號連結應指向的路徑。 |
link_name
|
字串；或標籤；或路徑；
必要 要建立的符號連結路徑。 |
範本
None repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')template 產生新檔案。在 substitutions 鍵的 template 中，每次出現時都會由相應的值取代。結果會以 path 寫入。選用的 executable 引數 (預設為 true) 可設為開啟或關閉可執行位元。
參數
| 參數 | 說明 |
|---|---|
path
|
string;或標籤；或 path;
必要 要建立的檔案路徑 (相對於存放區目錄)。 |
template
|
字串；或標籤；或路徑；
必要 範本檔案的路徑。 |
substitutions
|
預設值為 {}替代字元。 |
executable
|
預設值為 True在建立的檔案中設定可執行檔標記 (預設為 true)。 |
watch_template
|
預設值為 'auto'是否要觀看範本檔案。可以是「yes」、「no」或「auto」字串。傳送「是」等同於立即叫用 watch() 方法傳遞「否」未試圖觀看檔案；傳送「auto」只有在合法的情況下，系統才會嘗試觀看影片 (詳情請參閱 watch() 文件)。
|
手錶
None repository_ctx.watch(path)「變更」包括檔案內容的變更 (如果路徑是檔案)；如果路徑原本是檔案但現在是目錄，或反之；以及路徑是否開始或停止存在。值得注意的是，如果路徑是目錄，則「不」包括對目錄下任何檔案所做的變更。如要這麼做，請改用 path.readdir()。
請注意，如果嘗試在目前正在擷取的存放區內，或在目前模組擴充功能的工作目錄中，監控路徑，將會導致錯誤。模組擴充功能嘗試監控目前 Bazel 工作區以外的路徑時，也會發生錯誤。
參數
| 參數 | 說明 |
|---|---|
path
|
字串；或標籤；或路徑；
必要 要監控的檔案路徑。 |
watch_tree
None repository_ctx.watch_tree(path)請注意，如果嘗試在目前正在擷取的存放區中監控路徑，會導致錯誤。
參數
| 參數 | 說明 |
|---|---|
path
|
字串或標籤或路徑；
必要 要監控的目錄樹狀結構路徑。 |
哪一個？
path repository_ctx.which(program)傳回對應程式的路徑，或若路徑中沒有此類程式，則傳回 None。
參數
| 參數 | 說明 |
|---|---|
program
|
必填 在路徑中尋找的程式。 |
None。
workspace_root
path repository_ctx.workspace_root指向 Bazel 叫用動作根目錄工作區的路徑。