包含輔助函式和屬性資訊的存放區規則結構定義。建立存放區規則時,您會取得 store_ctx 物件做為 implementation
函式的引數。
成員
- attr
- 刪除
- 下載
- download_and_extract
- 執行
- 擷取
- 檔案
- 名稱
- 作業系統
- 修補程式
- 路徑
- 閱讀
- report_progress
- 符號連結
- 範本
- 哪一個
- workspace_root
attr
struct repository_ctx.attr
刪除
bool repository_ctx.delete(path)
參數
參數 | 說明 |
---|---|
path
|
string;或 path;
必要 要刪除的檔案路徑 (相對於存放區目錄,或絕對項目)。可以是路徑或字串。 |
下載
struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
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
|
預設值為 {} 視需要指定部分網址驗證資訊的字典。 |
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
|
string;或「字串」的可疊代項目;
必要 參照相同檔案的鏡像網址清單。 |
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」、「.tar.deb」、「.tar」、「.t.」或「.」。此處。 |
stripPrefix
|
預設值為 '' 要從已擷取檔案中移除的目錄前置字串。 許多封存檔都包含頂層目錄,內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串,而不需要在 build_file 中反覆指定這個前置字串。
|
allow_fail
|
預設值為 False 如果設定此屬性,請在傳回值中指出錯誤,而非回報下載失敗的錯誤 |
canonical_id
|
預設值為 '' 設定後,如果檔案已加入快取且具有相同標準 ID,則快取命中資料的情況。 |
auth
|
預設值為 {} 視需要指定部分網址驗證資訊的字典。 |
integrity
|
預設值為 '' 下載檔案的預期總和檢查碼,採用子資源完整性格式。這個 ID 必須與下載檔案的總和檢查碼相符。遠端檔案可能會變更,因此省略核對和會帶來安全性風險。如果盡可能省略這個欄位,版本會變為非一致性。您可選擇是否簡化開發作業,但應在出貨前設定。 |
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={})
參數
參數 | 說明 |
---|---|
archive
|
string;或標籤;或 path;
必要 將要解壓縮的封存檔路徑 (相對於存放區目錄)。 |
output
|
string;或標籤;或 path;
預設值為 '' 將要解壓縮封存封存的目錄路徑 (相對於存放區目錄)。 |
stripPrefix
|
預設值為 '' 要從已擷取檔案中移除的目錄前置字串。 許多封存檔都包含頂層目錄,內含封存中的所有檔案。這個欄位可用於從已擷取的檔案中移除此前置字串,而不需要在 build_file 中反覆指定這個前置字串。
|
rename_files
|
預設值為 {} 選用的字典,用於指定擷取期間要重新命名的檔案。如果封存項目名稱與鍵完全相符,系統會在任何目錄前置字串調整前,將該項目重新命名為該值。這可用於擷取包含非萬國碼 (Unicode) 檔案名稱的封存檔案,或是哪些檔案在不區分大小寫的檔案系統中擷取到相同路徑。 |
檔案
None
repository_ctx.file(path, content='', executable=True, legacy_utf8=True)
參數
參數 | 說明 |
---|---|
path
|
string;或標籤;或 path;
必要 要建立的檔案路徑,相對於存放區目錄。 |
content
|
預設值為 '' 要建立的檔案內容,預設為空白。 |
executable
|
預設值為 True 在建立的檔案中設定可執行檔標記 (預設為 true)。 |
legacy_utf8
|
預設值為 True 將檔案內容編碼為 UTF-8 或編碼為 UTF-8日後推出的版本將變更預設值,並移除這項參數。 |
名稱
string repository_ctx.name
OS
repository_os repository_ctx.os
patch
None
repository_ctx.patch(patch_file, strip=0)
參數
參數 | 說明 |
---|---|
patch_file
|
string;或標籤;或 path;
必要 要套用的修補檔案,可以是標籤、相對路徑或絕對路徑。如果是相對路徑,則會解析為存放區目錄。 |
strip
|
預設值為 0 移除檔案名稱中的前置元件數量 |
路徑
path repository_ctx.path(path)
參數
參數 | 說明 |
---|---|
path
|
string;或標籤;或 path;
必要 建立路徑的來源字串、標籤或路徑 |
read
string repository_ctx.read(path)
參數
參數 | 說明 |
---|---|
path
|
string;或標籤;或 path;
必要 要讀取的檔案路徑。 |
report_progress
None
repository_ctx.report_progress(status='')
參數
參數 | 說明 |
---|---|
status
|
string;
預設值為 '' 說明擷取進度目前狀態的字串 |
符號連結
None
repository_ctx.symlink(target, link_name)
參數
參數 | 說明 |
---|---|
target
|
string;或標籤;或 path;
必要 符號連結應指向的路徑。 |
link_name
|
string;或標籤;或 path;
必要 要建立的符號連結路徑,相對於存放區目錄。 |
範本
None
repository_ctx.template(path, template, substitutions={}, executable=True)
template
產生新檔案。在 substitutions
鍵的 template
中,每次出現時都會由相應的值取代。結果會以 path
寫入。選用的 executable
引數 (預設為 true) 可設為開啟或關閉可執行位元。
參數
參數 | 說明 |
---|---|
path
|
string;或標籤;或 path;
必要 要建立的檔案路徑,相對於存放區目錄。 |
template
|
string;或標籤;或 path;
必要 範本檔案的路徑 |
substitutions
|
預設值為 {} 替代字元。 |
executable
|
預設值為 True 在建立的檔案中設定可執行檔標記 (預設為 true)。 |
哪一個?
path repository_ctx.which(program)
參數
參數 | 說明 |
---|---|
program
|
必要 要在路徑中找到的程式。 |
None
。
workspace_root
path repository_ctx.workspace_root