config

报告问题 查看源代码 夜间版 · 8.0 . 7.47.3 · 7.2 · 7.1 · 7.0 · 6.5

这是一个顶级模块,用于创建配置转换和 build 设置描述符,这些描述符用于描述规则属于哪种 build 设置(如果有)。

例如,通过设置 rule() 函数的 build_setting 参数,以下规则会被标记为 build 设置。具体而言,它是类型为 int 的 build 设置,并且是 flag,这意味着此 build 设置可在命令行中调用。

  my_rule = rule(
    implementation = _impl,
    build_setting = config.int(flag = True),
    ...
  )

成员

bool

BuildSetting config.bool(flag=False)

布尔类型的 build 设置

参数

参数 说明
flag bool; 默认为 False
此 build 设置是否可在命令行上调用。

exec

ExecTransitionFactory config.exec(exec_group=None)

创建执行转换。

参数

参数 说明
exec_group 字符串;或 None; 默认为 None
执行组的名称,此转换将使用该组的执行平台。如果未提供,此执行转换将使用目标的默认执行平台。

int

BuildSetting config.int(flag=False)

整数类型的 build 设置

参数

参数 说明
flag bool; 默认为 False
此 build 设置是否可在命令行上调用。

transition config.none()

创建一个用于移除所有配置、取消设置所有标志的转场效果。适用于以下情况:依赖项仅包含数据,不包含任何需要构建的代码,但应仅分析一次。

字符串

BuildSetting config.string(flag=False, allow_multiple=False)

字符串类型的 build 设置

参数

参数 说明
flag bool; 默认为 False
此 build 设置是否可在命令行上调用。
allow_multiple bool; 默认值为 False
已废弃,请改用 repeatable = Truestring_list 设置。如果已设置,此标志可以在命令行中多次设置。在转场和 build 设置实现函数中访问的标志的值将是字符串列表。系统会保留插入顺序和重复值。如果需要其他行为,可以在 build 设置实现函数中对此列表进行后处理。

string_list

BuildSetting config.string_list(flag=False, repeatable=False)

字符串列表类型的 build 设置。在命令行中,使用英文逗号分隔的值(如 --//my/setting=foo,bar)传递列表。

参数

参数 说明
flag bool; 默认为 False
此 build 设置是否可在命令行上调用。
repeatable bool; 默认为 False
如果设置,则允许在命令行上多次设置此标志,而不是预期以英文逗号分隔的值,每个单独的值都被视为要添加到列表值中的单个字符串。系统会保留插入顺序和重复值。如果需要其他行为,可以在 build 设置实现函数中对此列表进行后处理。

目标

transition config.target()

创建目标转场效果。这是一个无操作转场效果,适用于需要转场对象但不想实际更改任何内容的情况。等同于 attr.label() 中的 cfg = "target"