存放區規則的內容,包含輔助函式和屬性相關資訊。建立存放區規則時,您會取得 repository_ctx 物件做為 implementation
函式的引數。
成員
- attr
- 刪除
- 下載
- download_and_extract
- 執行
- extract
- file
- name
- os
- patch
- path
- read
- report_progress
- symlink
- template
- workspace_root
attr
struct repository_ctx.attr
刪除
bool repository_ctx.delete(path)
參數
參數 | 說明 |
---|---|
path
|
字串或路徑;
必要 要刪除的檔案路徑,相對於儲存庫目錄或絕對路徑。可以是路徑或字串。 |
下載
struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
success
的結構體,如果下載成功,則會傳回包含 true
的標記;如果成功,該檔案雜湊值為 sha256
和 integrity
。
參數
參數 | 說明 |
---|---|
url
|
字串;或 字串的可迭代項目;
必要 參照相同檔案的鏡像網址清單。 |
output
|
字串;或標籤;或路徑;預設為 '' 輸出檔案的路徑,相對於存放區目錄。 |
sha256
|
預設值為 '' 下載檔案的預期 SHA-256 雜湊值。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更,因此省略 SHA-256 會帶來安全性風險。即使您省略這個欄位,建構作業仍會變得不完整。您可以選擇是否要設定這個值,以利開發作業,但應在發布前設定。 |
executable
|
預設為 False 在建立的檔案上設定可執行標記,預設為 false。 |
allow_fail
|
預設值為 False 如果已設定,請在傳回值中指出錯誤,而非針對下載失敗的情況擲回錯誤 |
canonical_id
|
預設為 '' 如果設為此值,快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況 |
auth
|
預設值為 {} 這個選用規則可指定部分網址的驗證資訊。 |
integrity
|
預設值為 '' 預期的下載檔案總和檢查碼,格式為子資源完整性。這個 ID 必須與下載檔案的總和檢查碼相符。由於遠端檔案可能會變更,因此省略總和檢查碼會造成安全風險。即使您省略這個欄位,建構作業仍會變得不完整。您可以選擇是否要設定這個值,以利開發作業,但應在發布前設定。 |
download_and_extract
struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})
success
的結構體,如果下載成功,則會傳回 true
標記,如果成功,則會傳回檔案的雜湊,其中包含 sha256
和 integrity
欄位。
參數
參數 | 說明 |
---|---|
url
|
字串;或 字串的可迭代項目;
必要 參照相同檔案的鏡像網址清單。 |
output
|
字串;或標籤;或路徑;預設為 '' 相對於存放區目錄的路徑,指向封存檔案解壓縮的目錄。 |
sha256
|
預設值為 '' 預期的檔案 SHA-256 雜湊。這必須與下載的檔案的 SHA-256 雜湊相符。由於遠端檔案可能會變更,因此省略 SHA-256 會帶來安全性風險。即使您省略這個欄位,建構作業仍會變得不完整。您可以選擇是否要設定這個值,以利開發作業,但應在發布前設定。如果提供,系統會先檢查儲存庫快取是否有指定雜湊的檔案;如果在快取中找不到檔案,系統才會嘗試下載。下載成功後,檔案就會加入快取。 |
type
|
預設為 '' 下載檔案的封存類型。根據預設,封存類型取決於網址的副檔名。如果檔案沒有副檔名,您可明確指定「zip」、「jar」、「war」、「aar」、「tar」、「tar.gz」、「tgz」、「tar.xz」、「txz」、「.tar.zst」、「.tar.zst」、「.tar.zst」、「 |
stripPrefix
|
預設值為 '' ,許多封存檔案都包含頂層目錄,其中包含封存檔案中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串,而不需要在 build_file 中反覆指定這個前置字串。 |
allow_fail
|
預設值為 False 如果已設定,請在傳回值中指出錯誤,而非針對下載失敗的情況擲回錯誤 |
canonical_id
|
預設為 '' 如果設為此值,快取命中就會限制在檔案以相同的標準 ID 新增至快取的情況 |
auth
|
預設值為 {} 這個選用規則可指定部分網址的驗證資訊。 |
integrity
|
預設值為 '' 應以子資源完整性格式下載檔案的總和檢查碼。此值必須與下載的檔案檢查和總和相符。由於遠端檔案可能會變更,因此省略總和檢查碼會造成安全風險。即使您省略這個欄位,建構作業仍會變得不完整。您可以選擇是否要設定這個值,以利開發作業,但應在發布前設定。 |
rename_files
|
預設值為 {} (選用) 字典,指定在擷取期間要重新命名的檔案。如果封存項目名稱與鍵完全相符,系統會在任何目錄前置字串調整前,將該項目重新命名為該值。這可用於擷取包含非萬國碼 (Unicode) 檔案名稱的封存檔案,或是哪些檔案在不區分大小寫的檔案系統中擷取到相同路徑。 |
execute
exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout
限制 (以秒為單位,預設為 600 秒)。這個方法會傳回包含指令輸出的 exec_result
結構。environment
對應項目可用於覆寫要傳遞至程序的部分環境變數。
參數
參數 | 說明 |
---|---|
arguments
|
required 引數清單,第一個元素應為要執行的程式路徑。 |
timeout
|
預設值為 600 ,且該時間長度上限 (以秒為單位) (預設為 600 秒)。 |
environment
|
預設為 {} 強制設定某些環境變數,以便傳遞至程序。 |
quiet
|
預設為 True 如果要將 stdout 和 stderr 列印到終端機。 |
working_directory
|
預設為 "" 指令執行的工作目錄。可以是相對於存放區根目錄的相對路徑,也可以是絕對路徑。 |
extract
None
repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})
參數
參數 | 說明 |
---|---|
archive
|
字串;或標籤;或路徑;
必要 相對於存放區目錄的封存檔案路徑。 |
output
|
字串;或標籤;或路徑;預設為 '' 相對於存放區目錄的路徑,指向封存檔案解壓縮的目錄。 |
stripPrefix
|
預設值為 '' ,許多封存檔案都包含頂層目錄,其中包含封存檔案中的所有檔案。您不必在 build_file 中一再指定這個前置字串,而是可以使用這個欄位從擷取的檔案中移除前置字串。 |
rename_files
|
預設值為 {} (選用) 字典,指定在擷取期間要重新命名的檔案。在任何目錄前置字串調整之前,名稱與鍵完全相符的封存項目會改為該值。這可用於解壓縮包含非 Unicode 檔案名稱的封存檔,或是在大小寫不敏感的檔案系統中,會解壓縮至相同路徑的檔案。 |
檔案
None
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
參數
參數 | 說明 |
---|---|
path
|
字串;或標籤;或路徑;
必要 相對於存放區目錄的要建立檔案路徑。 |
content
|
預設為 '' 要建立的檔案內容,預設為空白。 |
executable
|
預設為 True 在建立的檔案上設定可執行標記,預設為 true。 |
legacy_utf8
|
預設為 True 將檔案內容編碼為 UTF-8,預設為 true。日後的版本將變更預設值並移除這個參數。 |
名稱
string repository_ctx.name
os
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0)
參數
參數 | 說明 |
---|---|
patch_file
|
字串;或標籤;或路徑;
必要 要套用的修補檔案,可以是標籤、相對路徑或絕對路徑。如果是相對路徑,則會解析為存放區目錄。 |
strip
|
預設值為 0 ,會去除檔案名稱中的前置元件數量。 |
路徑
path repository_ctx.path(path)
參數
參數 | 說明 |
---|---|
path
|
字串;或標籤;或路徑;
必要 字串、標籤或路徑,用於建立路徑 |
read
string repository_ctx.read(path)
參數
參數 | 說明 |
---|---|
path
|
字串;或標籤;或路徑;
必要 要讀取的檔案路徑。 |
report_progress
None
repository_ctx.report_progress(status='')
參數
參數 | 說明 |
---|---|
status
|
字串;預設為 '' 。字串會描述擷取進度目前的狀態。 |
符號連結
None
repository_ctx.symlink(target, link_name)
參數
參數 | 說明 |
---|---|
target
|
字串;或 標籤;或 路徑;
必要 符號連結應指向的路徑。 |
link_name
|
字串;或標籤;或路徑;
必要 相對於存放區目錄,要建立的符號連結路徑。 |
範本
None
repository_ctx.template(path, template, substitutions={}, executable=True)
template
產生新檔案。template
中每個 substitutions
鍵的出現位置都會替換為對應的值。結果會以 path
寫入。您可以設定選用的 executable
引數 (預設為 true),來開啟或關閉可執行位元。
參數
參數 | 說明 |
---|---|
path
|
string;或 Label;或 path;必要 路徑,建立相對於存放區目錄的路徑。 |
template
|
字串;或標籤;或路徑;
必要 範本檔案的路徑。 |
substitutions
|
預設為 {} 替換項目,用於在展開範本時進行替換。 |
executable
|
預設為 True 在建立的檔案上設定可執行標記,預設為 true。 |
哪一個?
path repository_ctx.which(program)
參數
參數 | 說明 |
---|---|
program
|
必填 在路徑中尋找的程式。 |
None
。
workspace_root
path repository_ctx.workspace_root