全局变量

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
报告问题

在全局环境中注册的对象、函数和模块。

会员

all

bool all(elements)

如果所有元素求得的值为 True 或者集合为空,则返回 true。元素通过 bool 函数转换为布尔值。
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

参数

参数 说明
elements 必需
一个字符串或一系列元素。

分析测试转换

transition analysis_test_transition(settings)

创建要在分析测试规则的依赖项上应用的配置过渡。这种过渡可能仅适用于具有 analysis_test = True 规则的属性。此类规则在功能上受到限制(例如,其依赖项树的大小有限),因此与使用 Transition 创建的过渡相比,使用此函数创建的过渡会在潜在的范围内受到限制。

此函数主要用于帮助分析测试框架核心库。有关最佳实践,请参阅其文档(或其实现)。

参数

参数 说明
settings 必需
一个字典,其中包含应由此配置转换设置的配置设置的相关信息。键是 build 设置标签,值是其新的转换后值。所有其他设置均保持不变。使用此字段来声明需要通过某项分析测试才能通过的特定配置设置。

任意

bool any(elements)

如果至少有一个元素求得的值为 True,则返回 true。元素通过 bool 函数转换为布尔值。
any([-1, 0, 1]) == True
any([False, 0, ""]) == False

参数

参数 说明
elements 必需
一个字符串或一系列元素。

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

指定此依赖项应来自特定位置的归档文件(zip、gzip 等),而不是来自注册表。此指令仅供根模块使用;也就是说,如果模块指定了任何替换值,则无法将其用作依赖项。

参数

参数 说明
module_name 必需
要应用此替换值的 Bazel 模块依赖项的名称。
urls string; or Iterable of strings;必需
归档的网址;可以是 http(s):// 或 file:// 网址。
integrity default = ''
归档文件的预期校验和,采用子资源完整性格式。
strip_prefix default = ''
要从提取的文件中删除的目录前缀。
patches Iterable of strings;默认值为 []
。一个标签列表,指向要应用于此模块的补丁文件。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings;默认值为 []
在应用补丁程序后,要在 Linux/Macos 上应用的 Bash 命令序列。
patch_strip default = 0
与 Unix 补丁程序的 --strip 参数相同。

切面

Aspect aspect(implementation, attr_aspects=[], attrs=None, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None)

创建新的宽高比。此函数的结果必须存储在全局值中。如需了解详情,请参阅方面介绍

参数

参数 说明
implementation 必需
实现此方面的 Starlark 函数,且正好有两个参数:Target(应用该目标的目标)和 ctx(创建目标时所基于的规则上下文)。目标的属性可通过 ctx.rule 字段获取。系统会在针对应用的每个目标应用的分析阶段评估此函数。
attr_aspects sequence of strings;默认值为 []
。属性名称列表。宽高比会沿着具有这些名称的目标的属性中指定的依赖项传播。此处的常见值包括 depsexports。该列表还可以包含一个字符串 "*",以便沿目标的所有依赖项传播。
attrs dict; or None;默认值为默认值
用于声明相应方面所有属性的字典。它会从属性名称映射到属性对象,例如“attr.label”或“attr.string”(请参阅 attr 模块)。实现属性可用作 ctx 参数的字段。

_ 开头的隐式属性必须具有默认值,并且具有 labellabel_list 类型。

显式属性必须具有 string 类型,并且必须使用 values 限制。显式属性将该属性限制为:只能让具有具有相同名称、类型和有效值的属性的规则根据限制使用。

required_providers default = []
使用此属性时,相应方面可以仅将其规则传播至其规则通告其所需提供程序的目标。该值必须是包含单个提供商或提供商列表的列表,但不能同时包含这两个提供商。例如,[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。

取消嵌套的提供商列表将自动转换为包含 1 个提供商的列表。也就是说,[FooInfo, BarInfo] 会自动转换为 [[FooInfo, BarInfo]]

为了让某个规则(例如 some_rule)的目标对某方面可见,some_rule 必须通告至少一个必需提供商列表中的所有提供商。例如,如果某个方面的 required_providers[[FooInfo], [BarInfo], [BazInfo, QuxInfo]],则仅当且仅当 some_rule 提供 FooInfo *或* BarInfo *或* BazInfo *和* QuxInfo 时,此元素才能看到 some_rule 目标。

required_aspect_providers default = []
此属性允许该方面检查其他方面。该值必须是包含单个提供商或提供商列表的列表,但不能同时包含这两个提供商。例如,[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。

取消嵌套的提供商列表将自动转换为包含 1 个提供商的列表。也就是说,[FooInfo, BarInfo] 会自动转换为 [[FooInfo, BarInfo]]

如需让另一方面(例如 other_aspect)显示此方面,other_aspect 必须至少提供其中一个列表中的所有提供商。在 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 示例中,仅当 other_aspect 提供 FooInfo *或* BarInfo *或* BazInfo *和* QuxInfo 时,此元素才会看到 other_aspect

provides default = []
实现函数必须返回的提供程序列表。

如果实现函数从其返回值中省略了此处列出的任何类型的提供程序,则会发生错误。不过,实现函数可能会返回此处未列出的其他提供程序。

列表中的每个元素都是 provider() 返回的 *Info 对象,不过旧版提供程序由其字符串名称表示。

requires sequence of Aspects;默认值为 []
。要在此方面生效之前需要满足的一系列方面。
fragments sequence of strings;默认值为 []
。在配置方面,相应方面所需的配置 Fragment 的名称列表。
host_fragments sequence of strings;默认值为 []
。 主机配置中所需的相应配置片段的名称列表。
toolchains sequence;默认值为 []
。如果设置,则此规则所需的一组工具链。该列表可以包含字符串、标签或 StarlarkToolchainTypeApi 对象,并且可以任意组合。系统会通过检查当前平台来查找工具链,并通过 ctx.toolchain 将其提供给规则实现。
incompatible_use_toolchain_transition default = False
已弃用,不再使用,应将其移除。
doc default = ''
可通过文档生成工具提取的内容说明。
apply_to_generating_rules default = False
如果为 true,宽高比将应用于输出文件,而不是输出文件的生成规则。

例如,假设某个方面通过属性“deps”以传播方式传播,并且它应用于目标“alpha”。假设“alpha”包含 `deps = [':beta_output']`,其中 `beta_output` 是目标 `beta` 的声明输出。假设 `beta` 的目标 `charlie` 是其 `deps` 之一。如果 `apply_to_gener 钱包式宽高比:` `` `` `` ```` `` ``

默认值为 false。

exec_compatible_with sequence of strings;默认值为 []
执行平台上适用于该方面所有实例的约束列表。
exec_groups dict; or None;默认值 = None
执行组名称(字符串)到 exec_groups 的指令。如果设置此参数,则允许各方面在单个实例内的多个执行平台上执行操作。如需了解详情,请参阅执行组文档

bazel_dep

None bazel_dep(name, version='', repo_name='', dev_dependency=False)

声明对另一个 Bazel 模块的直接依赖项。

参数

参数 说明
name required
要作为直接依赖项添加的模块的名称。
version default = ''
要作为直接依赖项添加的模块版本。
repo_name default = ''
表示此依赖项的外部代码库的名称。默认情况下,这是模块的名称。
dev_dependency default = False
如果为 true,则如果当前模块不是根模块或启用了“--ignore_dev_dependency”,则会忽略此依赖项。

bind

None bind(name, actual=None)

警告:不建议使用 bind()。请参阅考虑解除绑定,详细了解其问题和替代方法。

为目标提供 //external 软件包中的别名。

参数

参数 说明
name 必需
将“//external”下的标签用作别名
actual string; or None; default = None
要进行别名的实际标签

bool

bool bool(x=False)

布尔值类型的构造函数。如果对象为 NoneFalse、空字符串 ("")、数字 0 或空集合(例如 ()[]),则返回 False。否则,返回 True

参数

参数 说明
x default = False
要转换的变量。

配置字段

LateBoundDefault configuration_field(fragment, name)

引用 label 类型的属性的延迟绑定默认值。如果某个值要求先构建配置,然后再确定值,则该值为“后绑定”。任何将此值用作值的属性都必须不公开

用法示例:

定义规则属性:

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

在规则实现过程中访问:

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

参数

参数 说明
fragment 必需
包含延迟值的配置 fragment 的名称。
name required
要从配置 Fragment 获取的值的名称。

偏低

depset depset(direct=None, order="default", *, transitive=None)

创建 depsetdirect 参数是 Depset 的直接元素列表,transitive 参数是一系列元素,这些元素的元素会成为已创建的依赖项的间接元素。将偏移量转换为列表时元素返回的顺序由 order 参数指定。如需了解详情,请参阅依赖项概览

偏移量的所有元素(直接和间接)都必须与表达式 type(x) 获取的类型相同。

由于基于哈希的集合用于在迭代期间消除重复项,因此 depset 的所有元素都应该是哈希处理。不过,目前并非所有构造函数都会一致检查此不变。使用 --incompatible_always_check_depset_elements 标志启用一致性检查;这将是未来版本中的默认行为;请参阅问题 10313

此外,元素目前不可变,但将来会对此限制放宽。

创建的依赖项的顺序应与其 transitive 依赖项的顺序兼容"default" 订单与其他任何订单都兼容,其他所有订单仅与它们兼容。

关于向后兼容性的说明。此函数目前接受位置 items 参数。该 API 已弃用,日后将被移除;移除后,direct 将成为 depset 函数的唯一位置参数。因此,以下调用是等效且面向未来的调用:

depset(['a', 'b'], transitive = [...])
depset(direct = ['a', 'b'], transitive = [...])

参数

参数 说明
direct sequence; or None;默认 = None
direct 元素列表。
order default = "default"
新依赖项的遍历策略。请参阅此处查看可能的值。
transitive sequence of depsets; or None;默认 = None
一系列一系列元素,其中的元素将变为位置的间接元素。

字典

dict dict(pairs=[], **kwargs)

根据可选的位置参数和一组可选的关键字参数创建字典。如果多次提供同一键,将使用最后一个值。系统会将通过关键字参数提供的条目视为在通过位置参数提供的条目之后。

参数

参数 说明
pairs default = []
字典或可迭代对象,其元素均为长度 2(键、值)。
kwargs 必需
其他条目的字典。

dir

list dir(x)

返回字符串列表:即参数对象的属性和方法的名称。

参数

参数 说明
x required
要检查的对象。

枚举

list enumerate(list, start=0)

返回对(双元素元组)对的列表,其中包含索引 (int) 以及输入序列中的项。
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

参数

参数 说明
list 必需
输入序列。
start default = 0
开始索引。

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[], copy_from_rule=False)

创建一个执行组,该组可用于在规则实现期间为特定执行平台创建操作。

参数

参数 说明
toolchains sequence;默认值为 []
。此执行组所需的工具链集。该列表可以包含字符串、标签或 StarlarkToolchainTypeApi 对象,并且可以任意组合。
exec_compatible_with sequence of strings;默认值为 []
。执行平台上的约束列表。
copy_from_rule default = False
如果设为 true,此执行组会继承其附加到的规则的工具链和限制条件。如果设置为任何其他字符串,则会抛出错误。

fail

None fail(msg=None, attr=None, *args)

会导致执行失败并抛出错误。

参数

参数 说明
msg default = None
已弃用:请改用位置参数。此参数类似于隐式前导位置参数。
attr string; or None;默认值 = None
已弃用。使包含此字符串的可选前缀添加到错误消息中。
args 必需
错误消息中显示的值列表,采用 str 格式并用空格连接。

float

float float(x=unbound)

以浮点值的形式返回 x。
  • 如果 x 已经是浮点数,则 float 会将其原封不动地返回。
  • 如果 x 是布尔值,float 表示 True 为 1.0,False 返回 0.0。
  • 如果 x 是一个整数,则 float 会返回最接近的有限浮点值 (x);如果数量太大,则返回错误。
  • 如果 x 是一个字符串,它必须是有效的浮点数字面量,或者等于(不区分大小写)到 NaNInfInfinity(可选前面带 +- 符号)。
任何其他值都会导致错误。如果没有参数,float() 会返回 0.0。

参数

参数 说明
x default = unbound
要转换的值。

Getattr

unknown getattr(x, name, default=unbound)

返回具有指定名称的结构体的字段(如果存在)。否则,它会返回 default(如果已指定)或引发错误。getattr(x, "foobar") 相当于 x.foobar
getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

参数

参数 说明
x required
访问其属性的结构体。
name 必需
结构体特性的名称。
default default = unbound
如果结构体没有具有给定名称的属性,则返回的默认值。

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

指定依赖项应来自 Git 代码库的某个提交内容。此指令仅供根模块使用;也就是说,如果模块指定了任何替换值,则无法将其用作依赖项。

参数

参数 说明
module_name 必需
要应用此替换值的 Bazel 模块依赖项的名称。
remote 必需
远程 Git 代码库的网址。
commit default = ''
应签出的提交。
patches Iterable of strings;默认值为 []
。一个标签列表,指向要应用于此模块的补丁文件。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings;默认值为 []
在应用补丁程序后,要在 Linux/Macos 上应用的 Bash 命令序列。
patch_strip default = 0
与 Unix 补丁程序的 --strip 参数相同。

Hasattr

bool hasattr(x, name)

如果对象 x 具有给定 name 的属性或方法,则返回 True,否则返回 False。示例:
hasattr(ctx.attr, "myattr")

参数

参数 说明
x required
要检查的对象。
name 必需
特性的名称。

hash

int hash(value)

返回字符串的哈希值。此计算是使用与 Java 的 String.hashCode() 相同的算法确定的,也就是说:
s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]
目前不支持对字符串旁边的值进行哈希处理。

参数

参数 说明
value 必需
要进行哈希处理的字符串值。

int

int int(x, base=unbound)

以整数值的形式返回 x。
  • 如果 x 已经是 int,int 会将其原封不动地返回。
  • 如果 x 是布尔值,int 表示 True 为 1,0 表示 False。
  • 如果 x 是一个字符串,则其格式必须为 <sign><prefix><digits><sign>"+""-" 或空(解释为正数)。<digits> 是从 0 到 base - 1 的数字序列,其中字母 a-z(或等效的 A-Z)用作 10-35 的数字。如果 base 为 2/8/16,<prefix> 是可选的,可能分别为 0b/0o/0x(或等效的 0B/0O/0X);如果 base 是除这些基数或特殊值 0 的任何其他值,则前缀必须为空。在 base 为 0 的情况下,该字符串将被解释为整数字面量,也就是说,系统会根据使用哪个前缀来选择 2/8/10/16 这个底数中的一个。如果 base 为 0,则不使用前缀,并且有多个位,则前导数不能为 0;这是为了避免八进制数与十进制数混淆。字符串表示的数字数量范围必须在 int 类型的允许范围内。
  • 如果 x 是浮点数,int 会返回浮点数的整数值,并舍入到零。如果 x 为非有限(NaN 或无穷大),则会出现错误。
如果 x 是任何其他类型,或者值是不符合上述格式的字符串,则此函数将失败。与 Python 的 int 函数不同,此函数不允许使用零参数,也不允许字符串参数包含无关空格。

示例:

int("123") == 123
int("-123") == -123
int("+123") == 123
int("FF", 16) == 255
int("0xFF", 16) == 255
int("10", 0) == 10
int("-0x10", 0) == -16
int("-0x10", 0) == -16
int("123.456") == 123

参数

参数 说明
x required
要转换的字符串。
base default = unbound
用于解读字符串值的基数;默认值为 10。必须介于 2 到 36(含)之间,如果为 0,则检测基数,如同 x 是整数字面量。如果值不是字符串,则不得提供此参数。

len

int len(x)

返回字符串、序列(例如列表或元组)、字典或其他可迭代项的长度。

参数

参数 说明
x required
要报告的时长的值。

list

list list(x=[])

返回元素与指定可迭代值相同的新列表。
list([1, 2]) == [1, 2]
list((2, 3, 2)) == [2, 3, 2]
list({5: "a", 2: "b", 4: "c"}) == [5, 2, 4]

参数

参数 说明
x default = []
要转换的对象。

local_path_override

None local_path_override(module_name, path)

指定依赖项应来自本地磁盘上的某个目录。此指令仅供根模块使用;也就是说,如果模块指定了任何替换值,则无法将其用作依赖项。

参数

参数 说明
module_name 必需
要应用此替换值的 Bazel 模块依赖项的名称。
path required
此模块所在目录的路径。

最大值

unknown max(*args)

返回所有指定参数中最大的一个。如果只提供一个参数,该参数必须是非空的 Iterable。如果元素无法比较(例如包含字符串的 int),或者没有提供任何参数,则会发生错误。
max(2, 5, 4) == 5
max([5, 6, 3]) == 6

参数

参数 说明
args required
要检查的元素。

分钟

unknown min(*args)

返回所有给定参数中的最小一个。如果只提供一个参数,该参数必须是非空的可迭代对象。如果元素无法比较(例如 int 与字符串),或者没有提供任何参数,就会发生错误。
min(2, 5, 4) == 2
min([5, 6, 3]) == 3

参数

参数 说明
args required
要检查的元素。

模块

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

声明由当前 Bazel 代码库表示的 Bazel 模块的某些属性。这些属性要么是模块的基本元数据(例如名称和版本),要么会影响当前模块及其从属项的行为。

最多只能调用一次。只有当此模块是根模块时(例如,如果它不依赖于其他模块时),才能省略此模块。

参数

参数 说明
name default = ''
模块的名称。仅当此模块为根模块时(例如,如果此模块不受其他模块依赖时),才能省略。有效的模块名称必须:1) 仅包含小写字母 (a-z)、数字 (0-9)、点 (.)、连字符 (-) 和下划线 (_);2) 以小写字母开头;3) 以小写字母或数字结尾。
version default = ''
模块的版本。仅当此模块为根模块(例如,如果它不依赖于其他模块时)时,才可以省略。
compatibility_level default = 0
模块的兼容性级别;每次引入主要的不兼容变更时,都应更改此级别。就 SemVer 而言,它本质上是该模块的“主要版本”,只不过它不是嵌入在版本字符串中,而是作为一个单独的字段存在。不同兼容性级别的模块会参与版本解析,就像它们是具有不同名称的模块一样,但最终的依赖关系图不能包含同名但不同兼容性级别的多个模块(除非 multiple_version_override 有效;如需了解详情,请参阅此处)。
repo_name default = ''
表示此模块的代码库的名称,如模块本身所示。默认情况下,代码库的名称就是模块的名称。指定此参数有助于为已自行使用代码库名称(与模块名称不同)的项目简化迁移。
bazel_compatibility Iterable of strings;默认值为 []
允许用户声明哪些 Bazel 版本与此模块兼容的 Bazel 版本列表。这不会影响依赖项解析,但 bzlmod 将使用此信息检查您当前的 Bazel 版本是否兼容。此值的格式为一些限制条件值的字符串,以英文逗号分隔。支持以下三个限制条件:<=X.X.X:Bazel 版本必须等于或低于 X.X.X。当新版本存在已知不兼容的变更时使用。>=X.X.X:Bazel 版本必须等于或高于 X.X.X。如果您需要使用仅从 X.X.X 开始提供的部分功能,就需要使用 Bazel 版本。-X.X.X:Bazel 版本 X.X.X 不兼容。在 X.X.X 中存在会破坏您的 bug,但在后续版本中修复的 bug 时使用。

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc='')

创建新的模块扩展。将其存储在全局值中,以便导出可在 MODULE.bazel 文件中使用。

参数

参数 说明
implementation 必需
实现此模块扩展的函数。只能接受一个参数,即 module_ctx。系统会在构建开始时调用该函数一次,以确定一组可用的代码库。
tag_classes default = {}
用于声明扩展程序使用的所有标记类的字典。它会从标记类的名称映射到 tag_class 对象。
doc default = ''
可由文档生成工具提取的模块扩展的说明。

多个版本覆盖

None multiple_version_override(module_name, versions, registry='')

指定依赖项仍应来自注册表,但应允许其多个版本共存。此指令仅供根模块使用;也就是说,如果模块指定了任何替换值,则无法将其用作依赖项。

参数

参数 说明
module_name 必需
要应用此替换值的 Bazel 模块依赖项的名称。
versions Iterable of strings;必需
明确指定允许共存的版本。这些版本必须已经存在于依赖项图预先选择部分中。此模块的依赖项将“升级”到同一兼容性级别所允许的最接近的更高版本,而具有高于同一兼容性级别的任何允许版本的依赖项将会导致错误。
registry default = ''
替换此模块的注册表;应使用指定的注册表,而不是从默认的注册表中查找此模块。

输出

None print(sep=" ", *args)

输出 args 作为调试输出。它将带有字符串 "DEBUG" 和此调用的位置(文件和行号)作为前缀。无法将参数转换为字符串的确切方式,并且可能会随时更改。具体而言,它可能与 str()repr() 采用的格式不同(也更详细)。

不建议在正式版代码中使用 print,因为它会给用户带来垃圾内容。如需废弃,最好尽可能使用 fail() 硬性错误。

参数

参数 说明
sep default = " "
对象之间的分隔符字符串,默认值为空格 (" ")。
args required
要输出的对象。

provider

unknown provider(doc='', *, fields=None, init=None)

定义提供程序符号。该提供程序可通过调用对其进行实例化,或直接用作键以从目标中检索该提供程序的实例。示例:
MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

有关如何使用提供程序的综合指南,请参阅规则(提供程序)

如果未指定 init,则返回 Provider Callable 值。

如果指定了 init,则返回包含 2 个元素的元组:Provider Callable 值和 Raw 构造函数 Callable 值。如需了解详情,请参阅规则(自定义提供程序的自定义初始化)以及对 init 参数的讨论。

参数

参数 说明
doc default = ''
可通过文档生成工具提取的提供商的说明。
fields sequence of strings; or dict; or None;默认值为 None
如果指定,则限制一组允许的字段。
可能的值包括:
  • 字段列表:
    provider(fields = ['a', 'b'])

  • 字典字段名称 -> 文档:
    provider(
           fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
所有字段均为选填。
init callable; or None;默认值为 None
用于在实例化期间预处理和验证提供程序字段值的可选回调函数。如果指定了 initprovider() 会返回一个包含 2 个元素的元组:普通提供程序符号和原始构造函数

后面有详细的说明;如需直观的讨论和用例,请参阅规则(提供程序的自定义初始化)

P 是通过调用 provider() 创建的提供程序符号。从概念上讲,通过调用默认构造函数 c(*args, **kwargs) 生成 P 的实例,该函数会执行以下操作:

  • 如果 args 不为空,则会出现错误。
  • 如果在调用 provider() 时指定了 fields 参数,并且 kwargs 包含 fields 中未列出的任何键,则会出现错误。
  • 否则,c 会返回一个新实例,对于 kwargs 中的每个 k: v 条目,一个名为 k 且值为 v 的字段。
如果未提供 init 回调,则对 P 符号本身的调用将充当对默认构造函数 c 的调用;换言之,P(*args, **kwargs) 会返回 c(*args, **kwargs)例如,
MyInfo = provider()
m = MyInfo(foo = 1)
将直接使 m 变为具有 m.foo == 1MyInfo 实例。

但如果指定了 init,调用 P(*args, **kwargs) 将改为执行以下步骤:

  1. 回调函数将以 init(*args, **kwargs) 的形式调用,也就是说,其位置和关键字参数与传递给 P 的完全相同。
  2. init 的返回值应为字典 d,其键为字段名称字符串。否则,会发生错误。
  3. 生成 P 的新实例,就像调用 d 的条目作为关键字参数的默认构造函数一样,如 c(**d) 中所示。

注意:如果 *args**kwargsinit 的签名不匹配、init 正文的评估失败(可能是有意通过调用 fail()),或者 init 的返回值不是具有预期架构的字典,以上步骤意味着发生错误。

这样一来,init 回调就可以允许位置参数和任意逻辑进行预处理和验证,从而对常规提供程序构造进行泛化。它不会启用规避允许的 fields 列表。

指定 init 后,provider() 的返回值会变为元组 (P, r),其中 r原始构造函数。实际上,r 的行为与上述默认构造函数 c 的行为完全一致。通常,r 会绑定到名称以下划线前缀的变量,以便只有当前的 .bzl 文件可以直接对其进行访问:

MyInfo, _new_myinfo = provider(init = ...)

范围

sequence range(start_or_stop, stop_or_none=None, step=1)

创建一个列表,其中项从 startstop,并以 step 为增量。如果提供一个参数,则项的范围为 0 到该元素。
range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

参数

参数 说明
start_or_stop 必需
如果提供了停止值,起始元素的值将为 true,否则为停止值且实际起始值为 0
stop_or_none int; or None;默认 = None
系统不会包含在生成的列表中的第一个项的可选索引;列表生成会在达到 stop 之前停止。
step default = 1
增量(默认值为 1)。此值可以是负数。

寄存器执行平台()

None register_execution_platforms(*platform_labels)

注册已定义的平台,以便 Bazel 可以在工具链解决方案期间将其用作执行平台。

参数

参数 说明
platform_labels sequence of strings;必需
要注册的平台的标签。

寄存器执行平台()

None register_execution_platforms(*platform_labels)

指定选择此模块时要注册的执行平台。应为绝对目标模式(即以 @// 开头)。如需了解详情,请参阅工具链解析

参数

参数 说明
platform_labels sequence of strings;必需
要注册的平台的标签。

register_toolchains()

None register_toolchains(*toolchain_labels)

注册已定义的工具链,以便 Bazel 可以在工具链解析期间使用它。请参阅定义注册工具链示例。

参数

参数 说明
toolchain_labels sequence of strings;必需
要注册的工具链的标签。

register_toolchains()

None register_toolchains(*toolchain_labels)

指定已选择此模块时要注册的预定义工具链。应为绝对目标模式(即以 @// 开头)。如需了解详情,请参阅工具链解析

参数

参数 说明
toolchain_labels sequence of strings;必需
要注册的工具链的标签。

repository_rule(实现, 属性, 本地, 环境, 配置, 远程, 文档)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

创建新的代码库规则。将其存储在全局值中,以便能够从 WORKSPACE 文件加载和调用它。

参数

参数 说明
implementation 必需
实现此规则的函数。必须具有单个参数 repository_ctx。系统会在加载规则期间针对规则的每个实例调用该函数。
attrs dict; or None;默认 = 无
字典,用于声明规则的所有属性。它会从属性名称映射到属性对象(请参阅 attr 模块)。以 _ 开头的属性是私有属性,可用于为文件添加对标签的隐式依赖关系(代码库规则不能依赖于生成的工件)。属性 name 是隐式添加的,不得指定。
local default = False
表示此规则从本地系统提取所有内容,应在每次提取时重新评估。
environ sequence of strings;默认值为 []
。提供此代码库规则所依赖的环境变量列表。如果该列表中的某个环境变量发生更改,系统将会重新提取代码库。
configure 默认 = False
表示代码库对系统进行检查以实现配置目的
remotable default = False
实验性。此参数是实验性参数,随时都可能更改。请勿依赖它。可以通过将 ---experimental_repo_remote_exec
设置为与远程执行兼容 来以实验性方式启用该功能
doc default = ''
可通过文档生成工具提取的代码库规则的说明。

repository_rule(实现, 属性, 本地, 环境, 配置, 远程, 文档)

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

创建新的代码库规则。将其存储在全局值中,以便能够从 WORKSPACE 文件加载和调用它。

参数

参数 说明
implementation 必需
实现此规则的函数。必须具有单个参数 repository_ctx。系统会在加载规则期间针对规则的每个实例调用该函数。
attrs dict; or None;默认 = 无
字典,用于声明规则的所有属性。它会从属性名称映射到属性对象(请参阅 attr 模块)。以 _ 开头的属性是私有属性,可用于为文件添加对标签的隐式依赖关系(代码库规则不能依赖于生成的工件)。属性 name 是隐式添加的,不得指定。
local default = False
表示此规则从本地系统提取所有内容,应在每次提取时重新评估。
environ sequence of strings;默认值为 []
。提供此代码库规则所依赖的环境变量列表。如果该列表中的某个环境变量发生更改,系统将会重新提取代码库。
configure 默认 = False
表示代码库对系统进行检查以实现配置目的
remotable default = False
实验性。此参数是实验性参数,随时都可能更改。请勿依赖它。可以通过将 ---experimental_repo_remote_exec
设置为与远程执行兼容 来以实验性方式启用该功能
doc default = ''
可通过文档生成工具提取的代码库规则的说明。

转化

string repr(x)

将任何对象转换为字符串表示形式。这对于调试非常有用。
repr("ab") == '"ab"'

参数

参数 说明
x required
要转换的对象。

reversed

list reversed(sequence)

返回未冻结的新列表,其中包含原始可迭代序列的元素(按倒序排列)。
reversed([3, 5, 4]) == [4, 5, 3]

参数

参数 说明
sequence 必需
要反转的可迭代序列(例如列表)。

规则

callable rule(implementation, test=False, attrs=None, outputs=None, executable=False, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, compile_one_filetype=None, name=None)

创建新规则,该规则可通过 BUILD 文件或宏调用,用于创建目标。

规则必须分配给 .bzl 文件中的全局变量;全局变量的名称是规则的名称。

测试规则的名称必须以 _test 结尾,而所有其他规则均不得有此后缀。(此限制仅适用于规则,不适用于其目标。)

参数

参数 说明
implementation 必需
实现此规则的 Starlark 函数必须且只能有一个参数:ctx。系统会在规则的每个实例的分析阶段调用该函数。它可以访问用户提供的属性。它必须创建操作来生成所有声明的输出。
test default = False
此规则是否为测试规则,即此规则是否是 blaze test 命令的主题。所有测试规则均被视为可执行;不需要(且不建议)为测试规则明确设置 executable = True。如需了解详情,请参阅“规则”页面
attrs dict; or None;默认 = 无
字典,用于声明规则的所有属性。它会从属性名称映射到属性对象(请参阅 attr 模块)。以 _ 开头的属性是私有属性,可用于添加对标签的隐式依赖项。属性 name 是隐式添加的,不得指定。属性 visibilitydeprecationtagstestonlyfeatures 是隐式添加的,无法替换。大多数规则只需要少量特性。为了限制内存用量,规则函数会限制属性的大小。
outputs dict; or None; or function;默认值为“无”
已弃用。此参数已被弃用,很快就会被移除。请勿依赖它。它是通过 ---incompatible_no_rule_outputs_param 停用的。使用此标记验证您的代码是否与即将移除的代码兼容。
此参数已被弃用。请迁移规则以改用 OutputGroupInfoattr.output

用于定义预声明输出的架构。与 outputoutput_list 属性不同,用户无需指定这些文件的标签。如需详细了解预声明的输出,请参阅“规则”页面

该参数的值是字典或生成字典的回调函数。回调的工作原理与计算的依赖项属性类似:函数的参数名称会与规则的属性进行匹配,因此,如果您通过定义 def _my_func(srcs, deps): ... 传递 outputs = _my_func,函数就可以访问 srcsdeps 属性。无论字典是直接指定的还是通过函数指定的,都会按以下方式进行解释。

字典中的每个条目都会创建一个预声明的输出,其中键是一个标识符,而值是一个字符串模板,用于确定输出的标签。在规则的实现函数中,标识符将成为用于访问 ctx.outputs 中的输出 File 的字段名称。输出标签的标签与规则相同,并且系统通过将 "%{ATTR}" 格式的每个占位符替换为由 ATTR 属性值形成的字符串来生成软件包之后的部分:

  • 字符串类型属性是逐字替换的。
  • 标签类型属性成为软件包后标签的一部分,减去文件扩展名。例如,标签 "//pkg:a/b.c" 将变为 "a/b"
  • 输出类型属性会成为软件包后标签的一部分,包括文件扩展名(对于上面的示例,"a/b.c")。
  • 占位符中使用的所有列表类型属性(例如 attr.label_list)都必须有一个元素。其转化与其非名单版本 (attr.label) 相同。
  • 其他属性类型可能不会出现在占位符中。
  • 特殊非属性占位符 %{dirname}%{basename} 会展开为规则标签的相应部分,其软件包除外。例如,在 "//pkg:a/b.c" 中,dirname 为 a,基名为 b.c

实际上,最常见的替换占位符是 "%{name}"。例如,对于名为“foo”的目标,输出字典 {"bin": "%{name}.exe"} 预先声明了一个名为 foo.exe 的输出,该输出在实现函数中可访问 ctx.outputs.bin

executable default = False
此规则是否可执行,即是否是 blaze run 命令的主题。如需了解详情,请参阅“规则”页面
output_to_genfiles default = False
如果为 true,则文件会在 genfiles 目录中生成,而不是在 bin 目录中。除非您需要它与现有规则兼容(例如,为 C++ 生成头文件时),否则请勿设置此标志。
fragments sequence of strings;默认值 = []
目标配置中规则所需的配置片段的名称列表。
host_fragments sequence of strings;默认值为 []
。主机在配置中所需的配置片段的名称列表。
_skylark_testable 默认 = False
(实验性)

如果为 true,则此规则将通过依赖于操作提供程序的规则公开其操作,以执行检查。规则本身也可以通过调用 ctx.created_actions() 来获取提供程序。

此测试程序应仅用于测试 Starlark 规则的分析时行为。此标记日后可能会被移除。
toolchains sequence;默认值为 []
。如果设置,则此规则所需的一组工具链。该列表可以包含字符串、标签或 StarlarkToolchainTypeApi 对象,并且可以任意组合。系统会通过检查当前平台来查找工具链,并通过 ctx.toolchain 将其提供给规则实现。
incompatible_use_toolchain_transition default = False
已弃用,不再使用,应将其移除。
doc default = ''
可通过文档生成工具提取的规则说明。
provides default = []
实现函数必须返回的提供程序列表。

如果实现函数从其返回值中省略了此处列出的任何类型的提供程序,则会发生错误。不过,实现函数可能会返回此处未列出的其他提供程序。

列表中的每个元素都是 provider() 返回的 *Info 对象,不过旧版提供程序由其字符串名称表示。

exec_compatible_with sequence of strings;默认值 = []
执行平台上适用于此规则类型的所有目标的限制条件列表。
analysis_test default = False
如果为 true,则将此规则视为分析测试。

注意:分析测试规则主要使用 Starlark 核心库中提供的基础架构进行定义。如需相关指导,请参阅测试

如果某个规则被定义为分析测试规则,则系统允许对其属性使用通过 analysis_test_Transition 定义的配置转换,但会存在一些限制:

  • 此规则的目标在传递时具有的传递依赖项数量有限。
  • 该规则被视为测试规则(如同设置了 test=True)。此字段会取代 test 的值
  • 规则实现函数可能无法注册操作。而是必须通过提供 AnalysisTestResultInfo 来注册通过/失败结果。
build_setting BuildSetting; or None;默认值 = None
如果已设置,则描述此规则属于哪种 build setting。请参阅 config 模块。如果设置了此属性,则系统会自动将名为“build_setting_default”的必需属性(类型为此处传入的值对应)添加到该规则中。
cfg default = None
如果设置此参数,则指向配置转换时,规则将在分析之前应用于自己的配置。
exec_groups dict; or None;默认值 = None
执行组名称(字符串)到 exec_groups 的指令。如果设置此标记,则允许规则在单个目标内的多个执行平台上执行操作。如需了解详情,请参阅执行组文档
compile_one_filetype sequence of strings; or None;默认 = None
- --compile_one_dependency 使用:如果多条规则使用指定的文件,我们是否应选择此规则而不是其他规则。
name string; or None;默认值为“无”
已弃用。此参数已被弃用,很快就会被移除。请勿依赖它。它是通过 --+incompatible_remove_rule_name_parameter 停用的。使用此标记验证您的代码是否与即将移除的代码兼容。
已弃用:请勿使用。

此规则的名称,由 Bazel 理解并在上下文(例如日志记录、native.existing_rule(...)[kind]bazel query)中报告。这通常与绑定到此规则的 Starlark 标识符相同;例如,名为 foo_library 的规则通常声明为 foo_library = rule(...),并在 BUILD 文件中实例化为 foo_library(...)

如果省略此参数,规则的名称将设置为在其声明的 .bzl 模块中绑定到此规则的第一个 Starlark 全局变量的名称。因此,如果名称为 foo_library,则 foo_library = rule(...) 无需指定此参数。

为规则指定明确的名称不会更改允许实例化规则的位置。

select

unknown select(x, no_match_error='')

select() 是一个辅助函数,用于使规则属性可配置。如需了解详情,请参阅版本百科全书

参数

参数 说明
x 必需
将配置条件映射到值的字典。每个键都是一个标签或标识 config_setting 或 constraint_value 实例的标签字符串。如需了解何时使用标签(而非字符串),请参阅有关宏的文档
no_match_error default = ''
在没有条件匹配时要报告的自定义错误(可选)。

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

指定依赖项仍应来自注册表,但应固定其版本、覆盖其注册表或应用补丁程序列表。此指令仅供根模块使用;也就是说,如果模块指定了任何替换值,则无法将其用作依赖项。

参数

参数 说明
module_name 必需
要应用此替换值的 Bazel 模块依赖项的名称。
version default = ''
替换依赖项图中此模块的声明版本。换言之,此模块将“固定”到此替换版本。如果只想覆盖注册表或补丁,则可以省略此属性。
registry default = ''
替换此模块的注册表;应使用指定的注册表,而不是从默认的注册表中查找此模块。
patches Iterable of strings;默认值为 []
。一个标签列表,指向要应用于此模块的补丁文件。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings;默认值为 []
在应用补丁程序后,要在 Linux/Macos 上应用的 Bash 命令序列。
patch_strip default = 0
与 Unix 补丁程序的 --strip 参数相同。

已排序

list sorted(iterable, *, key=None, reverse=False)

返回包含已提供的可迭代序列的所有元素的新排序列表。如果任何元素 x、y 均无法使用 x < y 进行比较,则可能会出现错误。元素按升序排序,除非反向参数为 True(在这种情况下则为降序)。 排序比较稳定:比较相等的元素将保留其原始相对顺序。
sorted([3, 5, 4]) == [3, 4, 5]

参数

参数 说明
iterable 必需
要排序的可迭代序列。
key default = None
比较之前为每个元素应用的可选函数。
reverse default = False
按降序返回结果。

Str

string str(x)

将任何对象转换为字符串。这对于调试非常有用。
str("ab") == "ab"
str(8) == "8"

参数

参数 说明
x required
要转换的对象。

标记类

tag_class tag_class(attrs={}, *, doc='')

创建一个新的 tag_class 对象,该对象为一个代码类(一种可供模块扩展使用的数据对象)定义一个属性架构。

参数

参数 说明
attrs default = {}
用于声明此标记类的所有属性的字典。它会从属性名称映射到属性对象(请参阅 attr 模块)。
doc default = ''
可通过文档生成工具提取的标记类的说明。

tuple

tuple tuple(x=())

返回一个元素与给定可迭代值相同的元组。
tuple([1, 2]) == (1, 2)
tuple((2, 3, 2)) == (2, 3, 2)
tuple({5: "a", 2: "b", 4: "c"}) == (5, 2, 4)

参数

参数 说明
x default = ()
要转换的对象。

类型

string type(x)

返回其参数的类型名称。这对于调试和类型检查很有用。示例:
type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"
此函数将来可能会发生变化。如需编写与 Python 兼容的代码并且确保代码可满足未来需求,请仅使用此代码比较返回值:
if type(x) == type([]):  # if x is a list

参数

参数 说明
x required
要检查其类型的对象。

使用扩展程序

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False)

返回表示模块扩展的代理对象;可以调用其方法来创建模块扩展标记。

参数

参数 说明
extension_bzl_file 必需
定义模块扩展的 Starlark 文件的标签。
extension_name 必需
要使用的模块扩展的名称。必须由 Starlark 文件导出具有此名称的符号。
dev_dependency default = False
如果为 true,则如果当前模块不是根模块或启用了“--ignore_dev_dependency”,则会忽略模块扩展。

使用代码库

None use_repo(extension_proxy, *args, **kwargs)

将给定模块扩展生成的一个或多个代码库导入当前模块的范围内。

参数

参数 说明
extension_proxy 必需
use_extension 调用返回的模块扩展代理对象。
args 必需
要导入的代码库的名称。
kwargs required
使用不同的名称指定要导入当前模块的范围内的某些代码库。键应该是要在当前范围内使用的名称,而值应该是模块扩展导出的原始名称。

visibility

None visibility(value)

设置当前初始化的 .bzl 模块的加载可见性。

模块的负载可见性决定了其他 build 和 .bzl 文件是否可以加载模块。(这与底层 .bzl 源文件的目标可见性不同,后者用于控制文件是否可能显示为其他目标的依赖项。)加载可见性在软件包级别发挥作用:要加载某个模块,执行加载的文件必须位于已获得该模块可见性的软件包中。模块可以随时在其自身软件包内加载,无论其可见性如何。

每个 .bzl 文件只能调用一次 visibility(),且只能在顶层调用,而不能在函数内调用。首选样式是将此调用放置在 load() 语句以及确定参数所需的任何简要逻辑的正下方。

如果 --check_bzl_visibility 标志设置为 false,则违反加载可见性违规行为时,系统会发出警告但不会使 build 失败。

参数

参数 说明
value 必需
软件包规范字符串列表或单个软件包规范字符串。

软件包规范遵循与 package_group 相同的格式,不过不允许使用排除的软件包规范。也就是说,一个规范可以采用以下格式:

  • "//foo":软件包 //foo
  • "//foo/...":软件包 //foo 及其所有子软件包。
  • "public""private":分别表示所有软件包或无软件包

不允许使用“@”语法;所有规范均以当前模块的代码库为准。

如果 value 是字符串列表,向此模块授予可见性的一组软件包就是每个规范所表示的软件包的并集。(空列表与 private 具有相同的效果。)如果 value 是单个字符串,则系统会将其视为单例列表 [value]

请注意,--incompatible_package_group_has_public_syntax--incompatible_fix_package_group_reporoot_syntax 标志对此参数没有影响。"public""private" 值始终可用,且 "//..." 始终被解释为“当前代码库中的所有软件包”。

工作区

None workspace(name)

此函数只能在 WORKSPACE 文件中使用,并且必须在 WORKSPACE 文件中的所有其他函数之前声明。每个 WORKSPACE 文件都应具有一个 workspace 函数。

设置此工作区的名称。工作区名称应为项目的 Java 软件包样式说明,使用下划线作为分隔符,例如,github.com/bazelbuild/bazel 应使用 com_github_bazelbuild_bazel。

此名称用于存储代码库的运行文件所在的目录。例如,如果本地代码库中有一个运行文件 foo/bar,并且 WORKSPACE 文件包含 workspace(name = 'baz'),则该运行文件将在 mytarget.runfiles/baz/foo/bar 下可用。如果未指定工作区名称,则 runfile 将通过符号关联至 bar.runfiles/foo/bar

远程代码库规则名称必须是有效的工作区名称。例如,您可以使用 maven_jar(name = 'foo'),但不能有 maven_jar(name = 'foo%bar'),因为 Bazel 会尝试为包含 workspace(name = 'foo%bar')maven_jar 编写 WORKSPACE 文件。

参数

参数 说明
name 必需
工作区的名称。名称必须以字母开头,且只能包含字母、数字、下划线、短划线和英文句点。

zip

list zip(*args)

返回 tuplelist,其中第 i 个元组包含来自每个参数序列或可迭代对象的第 i 个元素。列表具有最短输入内容的大小。使用单个可迭代参数,它会返回一个 1 元组列表。不带参数,则返回空列表。示例:
zip()  # == []
zip([1, 2])  # == [(1,), (2,)]
zip([1, 2], [3, 4])  # == [(1, 3), (2, 4)]
zip([1, 2], [3, 4, 5])  # == [(1, 3), (2, 4)]

参数

参数 说明
args