操作

报告问题 查看源代码

提供用于创建操作的函数的模块。使用 ctx.actions 访问此模块。

成员

args

Args actions.args()

返回可用于构建节省内存的命令行的 Args 对象。

declare_directory

File actions.declare_directory(filename, *, sibling=None)

声明该规则或切面会在当前软件包中创建具有给定名称的目录。您必须创建一个生成目录的操作。该目录的内容无法直接从 Starlark 访问，但可以使用 Args.add_all() 在操作命令中展开。只有常规文件和目录可以位于 Declare_directory 的展开内容中。

参数

参数 说明
filename 必需
如果未提供“同级”项，则为新目录相对于当前软件包的路径。否则，文件的基本名称（“同级文件”定义目录）。
sibling File；或 None；默认值为 None
与新声明的目录位于同一目录中的文件。该文件必须位于当前软件包中。

declare_file

File actions.declare_file(filename, *, sibling=None)

声明该规则或切面将创建一个具有指定文件名的文件。如果未指定 sibling，则文件名相对于软件包目录；否则，该文件与 sibling 位于同一目录中。无法在当前文件包外创建文件。

请记住，除了声明文件外，您还必须单独创建一个发出文件的操作。要创建该操作，需要将返回的 File 对象传递给该操作的构建函数。

请注意，预声明的输出文件不需要（也不能）使用此函数声明。您可以改为从 ctx.outputs 获取其 File 对象。查看使用示例。

参数

参数 说明
filename 必需
如果没有提供“同级”项，则为新文件相对于当前软件包的路径。否则，文件的基本名称（“同级”决定了目录）。
sibling File；或 None；默认值为 None
与新创建的文件位于同一目录中的文件。该文件必须位于当前软件包中。 

File actions.declare_symlink(filename, *, sibling=None)

声明该规则或切面会在当前软件包中创建具有给定名称的符号链接。您必须创建一个生成此符号链接的操作。Bazel 绝不会解引用此符号链接，并会逐字将其传输到沙盒或远程执行程序。目前不支持树制品内的符号链接。

参数

参数 说明
filename 必需
如果未提供“同级”项，则为新符号链接相对于当前软件包的路径。否则，文件的基本名称（“同级文件”定义目录）。
sibling File；或 None；默认值为 None
与新声明的符号链接位于同一目录中的文件。

do_nothing

None actions.do_nothing(mnemonic, inputs=[])

创建既不执行命令也不生成任何输出，但对插入“额外操作”有用的空操作。

参数

参数 说明
mnemonic required
操作的单字词说明，例如 CppCompile 或 GoLink。
inputs File 的 sequence；或 depset；默认为 []
操作的输入文件的列表。

expand_template

None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)

创建模板展开操作。执行操作后，系统会根据模板生成一个文件。系统将按照指定替换内容的顺序，使用 substitutions 字典替换模板的某些部分。每当字典中的键出现在模板中（或之前的替换结果中）时，它都会被替换为关联值。这些键没有特殊语法。举例来说，您可以使用大括号来避免冲突（例如 {KEY}）。查看使用示例。

参数

参数 说明
template 必需
模板文件，它是一个 UTF-8 编码的文本文件。
output 必需
输出文件，即一个 UTF-8 编码的文本文件。
substitutions 默认值为 {}
展开模板时要执行的替换。
is_executable 默认值为 False
输出文件是否应可执行。
computed_substitutions TemplateDict；默认值为 unbound
展开模板时要执行的替换。

run

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=unbound)

创建运行可执行文件的操作。查看使用示例。

参数

参数 说明
outputs File 的 sequence； required
操作的输出文件的列表。
inputs File 的 sequence；或 depset；默认值为 []
操作的输入文件的列表或设置。
unused_inputs_list File；或 None；默认值为 None
此文件包含操作未使用的输入列表。

此文件的内容（通常是操作的一个输出）与在整个操作执行过程中未使用的输入文件列表相对应。这些文件中的任何更改都不得以任何方式影响操作的输出。
executable File；或 string；或 FilesToRunProvider； required
操作调用的可执行文件。
tools sequence；或 depset；默认值为 unbound
列出或停用操作所需的任何工具。工具是包含其他 runfile 的输入，可自动提供给操作使用。提供的列表可以是 Files、FileToRunProvider 实例或 Files 的依赖项的异构集合。对于直接位于列表中且来自 ctx.executable 的文件，系统会自动添加其 runfile。提供 Depset 时，它必须只包含文件。在这两种情况下，DEpset 中的文件都不会与 runfile 的 ctx.executable 交叉引用。
arguments sequence；默认值为 []
操作的命令行参数。必须是字符串或 actions.args() 对象列表。
mnemonic string；或 None；默认值为 None
操作的单字词说明，例如 CppCompile 或 GoLink。
progress_message string；或 None；默认值为 None
构建期间要向用户显示的进度消息，例如“Compiling foo.cc to create foo.o”。该消息可能包含 %{label}、%{input} 或 %{output} 模式，这些模式分别替换为标签字符串、首次输入或输出的路径。首选使用模式而不是静态字符串，因为使用模式更高效。
use_default_shell_env 默认值为 False
操作是否应使用默认的 shell 环境，该环境包含一些依赖于操作系统的变量以及通过 --action_env 设置的变量。

如果 use_default_shell_env 和 env 均设置为 True，那么在 --incompatible_merge_fixed_and_default_shell_env 已启用（默认）的情况下，在 env 中设置的值将覆盖默认 shell 环境。如果未启用该标志，系统会忽略 env。

env dict；或 None；默认值为 None
设置环境变量的字典。

如果 use_default_shell_env 和 env 均设置为 True，那么在 --incompatible_merge_fixed_and_default_shell_env 已启用（默认）的情况下，在 env 中设置的值将覆盖默认 shell 环境。如果未启用该标志，系统会忽略 env。

execution_requirements dict；或 None；默认值为 None
用于安排操作的信息。如需了解有用的密钥，请参阅标记。
input_manifests sequence；或 None；默认值为 None
（实验性）设置输入 runfile 元数据；它们通常由 resolve_command 生成。
exec_group string；或 None；默认值为 None
在给定执行组的执行平台上运行操作。如果没有，则使用目标的默认执行平台。
shadowed_action 操作；默认值为 None
使用指定被覆盖操作的输入和环境（已添加到操作的输入列表和环境）运行操作。操作环境可以覆盖被覆盖的操作的任何环境变量。如果没有指定，则仅使用操作的输入和给定的环境。
resource_set Callable；或 None；默认值为 None
一个回调函数，用于返回资源集字典，用于估算此操作在本地执行时的资源使用情况。

该函数接受两个位置参数：表示操作系统名称的字符串（例如“osx”）和表示操作的输入数量的整数。返回的字典可能包含以下条目，每个条目都可能是浮点数或整数：

  • "cpu"：CPU 数量；默认值为 1
  • “memory”：以 MB 为单位；默认值为 250
  • “local_test”：本地测试次数；默认值为 1

如果此参数设置为 None 或 --experimental_action_resource_set 为 false，系统会使用默认值。

回调必须是顶级回调（不允许使用 lambda 和嵌套函数）。
toolchain Label；string；或 None；默认值为 unbound

此操作中使用的可执行文件或工具的工具链类型。必须设置该参数，以便在正确的执行平台上执行操作。

目前为空操作，但我们建议您在使用工具链时进行设置，因为在未来 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=unbound)

创建运行 shell 命令的操作。查看使用示例。

参数

参数 说明
outputs File 的 sequence； required
操作的输出文件的列表。
inputs File 的 sequence；或 depset；默认值为 []
操作的输入文件的列表或设置。
tools File 的 sequence；或 depset；默认值为 unbound
操作所需的任何工具的列表或设置。工具是包含其他 runfile 的输入，可自动提供给操作使用。该列表可以包含 Files 或 FilesToRunProvider 实例。
arguments sequence；默认值为 []
操作的命令行参数。必须是字符串或 actions.args() 对象列表。

Bazel 会将此属性中的元素作为参数传递给命令。该命令可以使用 shell 变量替代项（例如 $1、$2 等）访问这些参数。请注意，由于 Args 对象在编入索引之前会被展平，因此如果存在大小未知的 Args 对象，则所有后续字符串的索引都将无法预测。将 $@（检索所有参数）与大小不确定的 Args 对象结合使用可能会很有用。

如果 command 是字符串列表，则不能使用此参数。
mnemonic string；或 None；默认值为 None
操作的单字词说明，例如 CppCompile 或 GoLink。
command string；或 string 的 sequence； required
Shell 命令才能执行。这可以是字符串（首选）或字符串序列（已弃用）。

如果 command 是一个字符串，则它会按照 sh -c <command> "" <arguments> 的执行方式执行，也就是说，arguments 中的元素可作为 $1、$2（如果使用 Windows 批处理，则为 %1、%2）等形式提供给命令。如果 arguments 包含任何 actions.args() 对象，其内容会逐一附加到命令行，因此 $i 可以引用 Args 对象中的各个字符串。请注意，如果将未知大小的 Args 对象作为 arguments 的一部分进行传递，则字符串将处于未知索引；在这种情况下，使用 $@ shell 替换（检索所有参数）可能很有用。

（已弃用）如果 command 是字符串序列，则第一项是要运行的可执行文件，其余项是其参数。如果使用此表单，则不得提供 arguments 参数。请注意，此表单已被弃用，很快就会被移除。已使用“--incompatible_run_shell_command_string”停用该功能。请使用此标记验证您的代码是否兼容。

Bazel 使用与 genrules 相同的 shell 执行命令。
progress_message string；或 None；默认值为 None
构建期间要向用户显示的进度消息，例如“Compiling foo.cc to create foo.o”。该消息可能包含 %{label}、%{input} 或 %{output} 模式，这些模式分别替换为标签字符串、首次输入或输出的路径。首选使用模式而不是静态字符串，因为使用模式更高效。
use_default_shell_env 默认值为 False
操作是否应使用默认的 shell 环境，该环境包含一些依赖于操作系统的变量以及通过 --action_env 设置的变量。

如果 use_default_shell_env 和 env 均设置为 True，那么在 --incompatible_merge_fixed_and_default_shell_env 已启用（默认）的情况下，在 env 中设置的值将覆盖默认 shell 环境。如果未启用该标志，系统会忽略 env。

env dict；或 None；默认值为 None
设置环境变量的字典。

如果 use_default_shell_env 和 env 均设置为 True，那么在 --incompatible_merge_fixed_and_default_shell_env 已启用（默认）的情况下，在 env 中设置的值将覆盖默认 shell 环境。如果未启用该标志，系统会忽略 env。

execution_requirements dict；或 None；默认值为 None
用于安排操作的信息。如需了解有用的密钥，请参阅标记。
input_manifests sequence；或 None；默认值为 None
（实验性）设置输入 runfile 元数据；它们通常由 resolve_command 生成。
exec_group string；或 None；默认值为 None
在给定执行组的执行平台上运行操作。如果没有，则使用目标的默认执行平台。
shadowed_action 操作；默认值为 None
使用添加到操作的输入列表的指定被覆盖操作的已发现输入来运行操作。如果没有指定，则仅使用操作的输入。
resource_set Callable；或 None；默认值为 None
一个回调函数，用于估算在本地运行的资源使用情况。请参阅 ctx.actions.run()。
toolchain Label；string；或 None；默认值为 unbound

此操作中使用的可执行文件或工具的工具链类型。必须设置该参数，以便在正确的执行平台上执行操作。

目前为空操作，但我们建议您在使用工具链时进行设置，因为在未来 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；或 None；默认值为 None
输出符号链接将指向的文件。
target_path string；或 None；默认值为 None
输出符号链接指向的确切路径。不会应用任何标准化或其他处理。
is_executable 默认值为 False
只能与 target_file 一起使用，不能与 target_path 一起使用。如果为 true，则在执行操作时，系统会检查 target_file 的路径以确认其是否可执行，如果不可执行，则会报告错误。将 is_executable 设为 False 并不意味着目标不可执行，只是表示不会完成验证。

此功能对 target_path 没有意义，因为在构建时可能不存在悬空符号链接。
progress_message string；或 None；默认值为 None
在构建期间向用户显示的进度消息。

template_dict

TemplateDict actions.template_dict()

返回用于节省内存效率的模板扩展的 TemplateDict 对象。

write

None actions.write(output, content, is_executable=False)

创建文件写入操作。执行操作时，它会将指定内容写入文件。此文件用于使用分析阶段中可用的信息生成文件。如果文件很大并且包含大量静态内容，请考虑使用 expand_template。

参数

参数 说明
output required
输出文件。
content string；或 Args； required
文件内容。可以是字符串或 actions.args() 对象。
is_executable 默认值为 False
输出文件是否应可执行。