ctx.actions 存取此模組。成員
- args
- declare_directory
- declare_file
- declare_symlink
- do_nothing
- expand_template
- run
- run_shell
- symlink
- template_dict
- write
args
Args actions.args()會傳回 Args 物件，可用於建構節省記憶體的指令列。
declare_directory
File actions.declare_directory(filename, *, sibling=None)宣告規則或層面會在目前套件中建立具有指定名稱的目錄。您必須建立可產生目錄的動作。您無法直接透過 Starlark 存取目錄內容，但可以使用
Args.add_all() 在動作指令中展開目錄。
參數
| 參數 | 說明 |
|---|---|
filename
|
必要 如未提供「同層」，則新目錄相對於目前套件的路徑。否則，檔案的基本名稱 (「兄弟」定義目錄)。 |
sibling
|
File; or None;
default = None與新宣告目錄位於同一目錄中的檔案。檔案必須位於目前的套件中。 |
declare_file
File actions.declare_file(filename, *, sibling=None)宣告規則或層面會建立使用指定檔案名稱的檔案。如果未指定
sibling，檔案名稱會與套件目錄相關，否則檔案會與 sibling 位於相同目錄。無法在目前套件外建立檔案。請注意，除了宣告檔案之外，您還必須另外建立可發出檔案的動作。建立該動作時，必須將傳回的 File 物件傳遞至動作的建構函式。
請注意，預先宣告的輸出檔案不需要 (也無法) 使用這個函式宣告。您可以改為從 ctx.outputs 取得其 File 物件。查看使用範例。
參數
| 參數 | 說明 |
|---|---|
filename
|
必要 如未提供「同層」，則新檔案相對於目前套件的路徑。否則，檔案的基本名稱 (由「同胞」決定目錄)。 |
sibling
|
File; or None;
default = None與新建檔案位於同一目錄中的檔案。檔案必須位於目前的套件中。 |
declare_symlink
File actions.declare_symlink(filename, *, sibling=None)
實驗功能。這個參數仍在實驗階段，可能隨時變更。請勿仰賴這項功能。您可以設定 --experimental_allow_unresolved_symlinks，以實驗方式啟用這項功能
宣告該規則或切面將在目前套件中建立具有指定名稱的符號連結。您必須建立會產生此符號連結的動作。Bazel 一律不會解參照這個符號連結，而是會將其逐字轉移至沙箱或遠端執行程式。
參數
| 參數 | 說明 |
|---|---|
filename
|
必要 如未提供同層級符號，則新符號連結的路徑 (相對於目前套件)。否則，檔案的基本名稱 (「兄弟」定義目錄)。 |
sibling
|
File; or None;
default = None與新宣告的符號連結位於相同目錄中的檔案。 |
do_nothing
None actions.do_nothing(mnemonic, inputs=[])建立空白動作，既不會執行指令，也不會產生任何輸出內容，但可用於插入「額外動作」。
參數
| 參數 | 說明 |
|---|---|
mnemonic
|
必要 動作的單字說明，例如 CppCompile 或 GoLink。 |
inputs
|
sequence of Files; or depset;
default = []action 的輸入檔案清單。 |
expand_template
None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)建立範本擴展動作。執行動作時，系統會根據範本產生檔案。系統會使用
substitutions 字典依序替換範本的部分內容。每當範本中顯示字典鍵 (或先前的替代結果) 時，就會將其替換為相關聯的值。鍵並沒有特殊語法。舉例來說，您可以使用大括號避免衝突 (例如 {KEY})。請參閱使用範例。
參數
| 參數 | 說明 |
|---|---|
template
|
必要 範本檔案為 UTF-8 編碼文字檔案。 |
output
|
required UTF-8 編碼的文字檔輸出檔案。 |
substitutions
|
default = {} 展開範本時要進行的替換。 |
is_executable
|
default = False 是否應可執行輸出檔案。 |
computed_substitutions
|
TemplateDict；
預設值 = 未綁定實驗。這個參數仍在實驗階段，可能隨時變更。請勿依賴這項功能。您可以設定 --+experimental_lazy_template_expansion Experimental: Substitutions to make when expanding the template，以便在實驗期間啟用這項功能。 |
得分
None actions.run(outputs, inputs=[], unused_inputs_list=None, executable, tools=unbound, arguments=[], mnemonic=None, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)建立可執行執行檔的動作。查看使用範例。
參數
| 參數 | 說明 |
|---|---|
outputs
|
sequence of Files；必要動作的輸出檔案清單。 |
inputs
|
sequence of Files; or depset;
default = []action 的輸入檔案清單或 depset。 |
unused_inputs_list
|
File; or None;
default = None包含動作未使用的輸入項目清單的檔案。 這個檔案的內容 (通常是動作的其中一個輸出項目) 會對應至在整個動作執行期間未使用的輸入檔案清單。這些檔案的任何變更都不得以任何方式影響動作的輸出內容。 |
executable
|
File; or string; or FilesToRunProvider；必要動作要呼叫的可執行檔案。 |
tools
|
sequence; or depset；
default = 不繫結列出動作所需的任何工具或解碼工具。工具是指含有額外執行檔的輸入內容，這些執行檔會自動提供給動作。提供清單時，可以是 Files、FilesToRunProvider 例項或 Files 的 depset 的異質集合。系統會自動新增清單中直接來自 ctx.executable 的檔案。提供的 depset 只能包含檔案。無論是哪種情況，在執行檔的 depset 中，檔案都不會與 ctx.executable 交叉參照。 |
arguments
|
sequence;
default = []動作的指令列引數。必須是字串或 actions.args() 物件的清單。 |
mnemonic
|
string; or None;
default = None動作的單字說明，例如 CppCompile 或 GoLink。 |
progress_message
|
string; or None;
default = None在建構期間向使用者顯示的進度訊息，例如「Compiling foo.cc to create foo.o」。訊息可能包含 %{label}、%{input} 或 %{output} 模式，這些模式會分別替換成標籤字串、首次輸入或輸出的路徑。偏好使用模式而非靜態字串，因為前者的效率較高。 |
use_default_shell_env
|
default = False 動作是否應使用內建的 Shell 環境。 |
env
|
dict; or None;
default = None設定環境變數的字典。 |
execution_requirements
|
dict; or None;
預設值 = None用於排定動作的資訊。如需實用索引鍵的標記，請參閱標記。 |
input_manifests
|
sequence; or None；
預設值 = None(實驗功能) 會設定輸入的執行檔中繼資料，這些資料通常是由 resolve_command 產生。 |
exec_group
|
string; or None;
default = None在指定執行群組的執行平台上執行動作。如果沒有，則使用目標的預設執行平台。 |
shadowed_action
|
Action;
預設值 = None使用已新增至動作輸入清單和環境的指定遮罩動作輸入和環境，執行動作。動作環境可以覆寫任何遮蔽動作的環境變數。如果沒有，則只會使用動作的輸入內容和指定的環境。 |
resource_set
|
callable; or None;
預設值 = None如果在本機執行此動作，回呼函式會傳回資源集字典，用於估算執行時的資源使用量。 這個函式會接受兩個位置引數：代表作業系統名稱的字串 (例如「osx」)，以及代表動作輸入數量的整數。傳回的字典可能包含下列項目，而每個項目可能為浮點值或 int：
如果這個參數設為 回呼必須是頂層 (不允許 lambda 和巢狀函式)。 |
toolchain
|
Label; or string; or None;
default = None在這個動作中使用的可執行檔或工具的工具鍊類型。必須設定參數，才能在正確的執行平台上執行動作。 目前這項屬性不會執行任何操作，但我們建議您在使用工具鍊時設定這項屬性，因為日後的 Bazel 版本將需要這項屬性。 請注意，建立此動作的規則需要在其「rule()」函式中定義此工具鍊。 如果同時設定 `toolchain` 和 `exec_group` 參數，系統會使用 `exec_group`。如果 `exec_group` 未指定相同的值，系統會擲回錯誤。 |
run_shell
None actions.run_shell(outputs, inputs=[], tools=unbound, arguments=[], mnemonic=None, command, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)建立執行 Shell 指令的動作。查看使用範例。
參數
| 參數 | 說明 |
|---|---|
outputs
|
sequence of Files;
requiredAction 的輸出檔案清單。 |
inputs
|
sequence of Files; or depset;
default = []action 的輸入檔案清單或 depset。 |
tools
|
sequence of Files; or depset;
default = unboundaction 所需工具的清單或 depset。工具是指含有額外執行檔的輸入內容，這些執行檔會自動提供給動作。清單可包含 Files 或 FilesToRunProvider 例項。 |
arguments
|
sequence;
預設值 = []動作的指令列引數。必須是字串或 actions.args() 物件的清單。Bazel 會將這個屬性中的元素做為引數傳遞至指令。指令可使用殼層變數替換 (例如 如果 |
mnemonic
|
string; or None;
default = None動作的單字說明，例如 CppCompile 或 GoLink。 |
command
|
string; or sequence of strings;
必要Shell 指令 (要執行)。這可以是字串 (建議) 或字串序列 (已淘汰)。 如果 (已淘汰)如果 Bazel 會使用與 genrules 相同的殼層來執行指令。 |
progress_message
|
string; or None;
default = None建構期間向使用者顯示的進度訊息，例如「Compiling foo.cc to create foo.o」。訊息可能包含 %{label}、%{input} 或 %{output} 模式，這些模式會分別替換為標籤字串、第一個輸入內容或輸出路徑。請盡量使用模式，而非靜態字串，因為前者效率較高。 |
use_default_shell_env
|
default = False 動作是否應使用內建的 Shell 環境。 |
env
|
dict; or None;
default = None設定環境變數字典。 |
execution_requirements
|
dict; or None;
預設值 = None用於排定動作的資訊。如需瞭解實用的鍵，請參閱「標記」。 |
input_manifests
|
sequence; or None；
預設值 = None(實驗功能) 會設定輸入的 runfile 中繼資料，這些資料通常是由 resolve_command 產生。 |
exec_group
|
string; or None;
default = None在指定執行群組的執行平台上執行動作。如果沒有，則會使用目標的預設執行平台。 |
shadowed_action
|
Action;
預設值 = None使用已新增至動作輸入清單的指定影子動作所發現的輸入內容，執行動作。如果沒有，則只使用動作的輸入內容。 |
resource_set
|
callable; or None;
預設值 = None回呼函式，用於在本機執行時估算資源使用量。請參閱 ctx.actions.run()。 |
toolchain
|
Label; or string; or None;
default = None此動作所用執行檔或工具的工具鍊類型。必須設定參數，才能在正確的執行平台上執行動作。 目前這項屬性不會執行任何操作，但我們建議您在使用工具鍊時設定這項屬性，因為日後的 Bazel 版本將需要這項屬性。 請注意，建立此動作的規則需要在其「rule()」函式中定義此工具鍊。 如果同時設定 `toolchain` 和 `exec_group` 參數，系統會使用 `exec_group`。如果 `exec_group` 未指定相同的工具鍊，系統會擲回錯誤。 |
符號連結
None actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)建立動作，在檔案系統中寫入符號連結。
呼叫這個函式時必須明確指定其中一個 target_file 或 target_path。
使用 target_file 時，請使用 declare_file() 或 declare_directory() 宣告 output，並與 target_file 的類型相符。這會讓符號連結指向 target_file。每當符號連結的目標或內容有所變更，Bazel 就會讓這個動作的輸出內容失效。
否則，使用 target_path 時，請使用 declare_symlink() 宣告 output。在這種情況下，符號連結會指向 target_path。Bazel 一律不會解析符號連結，且只有在符號連結的文字內容 (也就是 readlink() 的值) 有所變更時，這個動作的輸出內容才會失效。特別是，這可用於建立懸空符號連結。
參數
| 參數 | 說明 |
|---|---|
output
|
required 此動作的輸出內容。 |
target_file
|
File; or None;
default = None輸出符號連結將指向的檔案。 |
target_path
|
string; or None;
預設值 = None(實驗功能) 輸出符號連結會指向的確切路徑。系統不會套用正規化或其他處理程序。必須設定 --experimental_allow_unresolved_symlinks 才能使用這項功能。
|
is_executable
|
default = False 只能與 target_file 搭配使用，無法用於 target_path。如果為 true，執行動作時，系統會檢查 target_file 的路徑，確認是否可執行，如果無法執行，系統會回報錯誤。如果將 is_executable 設為 False，不表示目標無法執行，只是不會進行驗證。這項功能對 |
progress_message
|
string; or None;
預設值 = None在建構期間向使用者顯示的進度訊息。 |
template_dict
TemplateDict actions.template_dict()實驗功能。這個 API 仍在實驗階段，可能隨時變更。請勿依賴這項功能。您可以設定
--+experimental_lazy_template_expansion Experimental，以實驗方式啟用此功能：返回 TemplateDict 物件，以便進行記憶體效率高的範本展開作業。
write
None actions.write(output, content, is_executable=False)建立檔案寫入動作。執行動作時，系統會將指定內容寫入檔案。這個方法會使用分析階段提供的資訊產生檔案。如果檔案很大且含有大量靜態內容，建議使用
expand_template。
參數
| 參數 | 說明 |
|---|---|
output
|
必要 輸出檔案。 |
content
|
string; or Args；
必填檔案內容。可以是字串或 actions.args() 物件。 |
is_executable
|
default = False 是否應可執行輸出檔案。 |