全局类型

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

成员

全部

bool all(elements)

如果所有元素的计算结果为 True 或集合为空，则返回 true。系统使用 bool 函数将元素转换为布尔值。
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

参数

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

analysis_test_transition

transition analysis_test_transition(settings)

创建要应用于分析测试规则依赖项的配置转换。此过渡效果只能应用于具有 analysis_test = True 的规则的属性。此类规则在功能方面受到限制（例如，其依赖关系树的大小有限），因此与使用 transition 创建的转换相比，使用此函数创建的转换在潜在范围内会受到限制。

此函数主要旨在促进分析测试框架核心库。如需了解最佳实践，请参阅相关文档（或实现）。

参数

参数 说明
settings required
包含相关信息的字典，配置设置应由此配置转换进行设置。键是 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； default = []
一系列指向要应用于此模块的补丁文件的标签。补丁文件必须位于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings； default = []
应用补丁后，在 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)

创建新切面。此函数的结果必须存储在一个全局值中。如需了解详情，请参阅 Aspects 简介。

参数

参数 说明
implementation 必需
实现此切面的 Starlark 函数，只有两个参数：Target（应用切面的目标）和 ctx（创建目标时所依据的规则上下文）。可通过 ctx.rule 字段获取目标的属性。对于每个切面应用于目标，在分析阶段都会评估此函数。
attr_aspects sequence of strings； default = []
属性名称列表。切面会沿具有这些名称的目标的属性中指定的依赖项传播。此处的常见值包括 deps 和 exports。该列表还可以包含单个字符串 "*"，以便在目标的所有依赖项中传播。
attrs dict; or None; default = None
一个用于声明切面所有属性的字典。它从属性名称映射到属性对象，例如 `attr.label` 或 `attr.string`（请参阅 attr 模块）。切面属性可作为 ctx 参数的字段用于实现函数。

以 _ 开头的隐式属性必须具有默认值，并且具有 label 或 label_list 类型。

显式属性必须具有 string 类型，并且必须使用 values 限制。显式属性将切面限制为只能与具有相同名称、类型和有效值的属性（根据限制）的规则一起使用。

required_providers default = []
此属性允许切面将其传播范围限制为仅传播至其规则通告其所需提供程序的目标。该值必须是包含单个提供商或提供商列表（但不能同时包含两者）的列表。例如，[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值，而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。

系统会自动将未嵌套的提供商列表转换为包含一个提供商列表的列表。也就是说，[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]] 无效。

系统会自动将未嵌套的提供商列表转换为包含一个提供商列表的列表。也就是说，[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； default = []
在此切面之前需要传播的切面列表。
fragments sequence of strings； default = []
方面在目标配置中所需的配置 fragment 的名称列表。
host_fragments sequence of strings； default = []
方面在主机配置中所需的配置 fragment 的名称列表。
toolchains sequence； default = []
如果设置，则是此规则所需的工具链集。该列表可以包含任意组合的 String、Label 或 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`。如果 `deps` 的 `apply_to_generating`将仅传播至一个 False。如果 `apply_to_generating_rules` 将会传递至该值为 True，

默认值为 false。
exec_compatible_with sequence of strings； default = []
执行平台上的、适用于此方面的所有实例的限制条件列表。
exec_groups dict; or None； default = 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)

Bool 类型的构造函数。如果对象为 None、False、空字符串 ("")、数字 0 或空集合（例如 ()、[]），该方法会返回 False。否则，它会返回 True。

参数

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

configuration_field

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 必需
要从配置 fragment 获取的值的名称。

废弃

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

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

偏移的所有元素（直接和间接）都必须属于同一类型，如表达式 type(x) 所获取的类型。

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

此外，元素当前必须是不可变的，但此限制将在将来放宽。

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

关于向后/向前兼容性的说明。此函数目前接受位置 items 参数。它已被弃用，日后将被移除。移除后，direct 将成为 depset 函数的唯一位置参数。因此，以下两个调用是等效的，并且可满足未来需求：

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

参数

参数 说明
direct sequence; or None； default = None
偏移量的直接元素列表。
order default = "default"
新依赖项的遍历策略。如需了解可能的值，请参阅此处。
transitive sequence of depsets; or None； default = None
一系列偏移值，其中各元素将成为该偏移值的间接元素。

dict

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

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

参数

参数 说明
pairs default = []
字典或 iterable，其元素的长度均为 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； default = []
此执行组所需的工具链集。该列表可以包含任意组合的 String、Label 或 StarlarkToolchainTypeApi 对象。
exec_compatible_with sequence of strings； default = []
执行平台上的限制条件列表。
copy_from_rule default = False
如果设为 true，此执行组会继承该执行组所附加到的规则的工具链和限制条件。如果设置为任何其他字符串，则会抛出错误。

fail

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

会导致执行失败并报错。

参数

参数 说明
msg default = None
已弃用：请改用位置参数。此参数充当隐式前导位置参数。
attr string; or None； default = None
已废弃。用于在错误消息中添加包含此字符串的可选前缀。
args required
错误消息中显示的一系列值，采用字符串格式并以空格连接。

float

float float(x=unbound)

以浮点值返回 x。
  • 如果 x 已经是浮点数，则 float 原样返回它。
  • 如果 x 是布尔值，float 会针对 True 返回 1.0，对 False 返回 0.0。
  • 如果 x 是一个整数，float 会返回与 x 最接近的有限浮点值；如果幅度过大，则返回错误。
  • 如果 x 是一个字符串，它必须是有效的浮点字面量，或者等于 NaN、Inf 或 Infinity（不区分大小写），前面加上 + 或 - 符号。
任何其他值都会导致错误。如果没有参数，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 required
结构体属性的名称。
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； default = []
一系列指向要应用于此模块的补丁文件的标签。补丁文件必须位于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings； default = []
应用补丁后，在 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 required
属性的名称。

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)

以 int 值返回 x。
  • 如果 x 已经是 int，int 会原样返回它。
  • 如果 x 为布尔值，int 会返回 1 表示 True，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 必需
要检查的元素。

分钟

unknown min(*args)

返回所有给定参数中的最小参数。如果仅提供一个参数，则该参数必须是非空可迭代对象。如果元素不可比较（例如 int 和字符串），或者没有指定任何参数，就会出错。 
min(2, 5, 4) == 2
min([5, 6, 3]) == 3

参数

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

模块

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; default = []
一个 Bazel 版本列表，允许用户声明哪些 Bazel 版本与此模块兼容。它不会影响依赖项解析，但 bzlmod 将使用这些信息来检查您当前的 Bazel 版本是否兼容。此值的格式是一些限制条件值的字符串（以英文逗号分隔）。支持三个限制条件：<=X.X.X：Bazel 版本必须等于或低于 X.X.X。当新版本中存在已知的不兼容更改时使用。>=X.X.X：Bazel 版本必须等于或高于 X.X.X。当您依赖于仅在 X.X.X 之后提供的功能时使用。-X.X.X：Bazel 版本 X.X.X 不兼容。适用于 X.X.X 中存在会造成破坏的错误，但在以后的版本中会得到修复的 bug。

module_extension

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

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

参数

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

multiple_version_override

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 值和一个原始构造函数 Callable 值。如需了解详情，请参阅规则（自定义提供程序的自定义初始化）和下文对 init 参数的讨论。

参数

参数 说明
doc default = ''
该提供程序的说明，可通过文档生成工具提取。
fields sequence of strings; or dict; or None； default = None
如果指定，则对允许的字段集进行限制。
可能的值包括：
  • 字段列表：
    provider(fields = ['a', 'b'])

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

下面提供了详细描述；请参阅规则（提供程序的自定义初始化），了解直观的讨论和用例。

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

  • 如果 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 == 1 的 MyInfo 实例。

但在指定 init 的情况下，调用 P(*args, **kwargs) 将改为执行以下步骤：

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

注意：以上步骤意味着，如果 *args 或 **kwargs 与 init 的签名不匹配，或者对 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)

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

参数

参数 说明
start_or_stop 必需
如果提供了停止值，则为起始元素的值，否则，停止值和实际起始值为 0
stop_or_none int; or None； default = None
不在结果列表中包含的第一项的可选索引；在达到 stop 之前停止生成列表。
step 默认值 = 1
增量（默认值为 1）。此值可能为负数。

register_execution_platforms()

None register_execution_platforms(*platform_labels)

注册一个已定义的平台，以便 Bazel 可以在工具链解析期间将其用作执行平台。

参数

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

register_execution_platforms()

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；必需
要注册的工具链的标签。

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

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

创建新的代码库规则。将其存储在一个全局值中，以便可以从 WORKSPACE 文件加载和调用。

参数

参数 说明
implementation 必需
实现此规则的函数。必须有一个参数 repository_ctx。在加载阶段，系统会针对规则的每个实例调用该函数。
attrs dict; or None; default = None
字典，用于声明规则的所有属性。它从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有属性，可用于向文件添加对标签的隐式依赖项（代码库规则不能依赖于生成的工件）。属性 name 是隐式添加的，不得指定。
local default = False
表示此规则从本地系统抓取所有内容，并且应在每次提取时重新评估。
environ sequence of strings； default = []
提供此代码库规则所依赖的环境变量列表。如果该列表中的环境变量发生变化，系统将重新获取代码库。
configure default = False
表示代码库出于配置目的检查系统
remotable default = False
实验性。此参数尚处于实验阶段，随时可能发生变化。请不要依赖它。可以通过设置 ---experimental_repo_remote_exec
与远程执行兼容
doc default = ''
可通过文档生成工具提取的代码库规则的说明。

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

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

创建新的代码库规则。将其存储在一个全局值中，以便可以从 WORKSPACE 文件加载和调用。

参数

参数 说明
implementation 必需
实现此规则的函数。必须有一个参数 repository_ctx。在加载阶段，系统会针对规则的每个实例调用该函数。
attrs dict; or None; default = None
字典，用于声明规则的所有属性。它从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有属性，可用于向文件添加对标签的隐式依赖项（代码库规则不能依赖于生成的工件）。属性 name 是隐式添加的，不得指定。
local default = False
表示此规则从本地系统抓取所有内容，并且应在每次提取时重新评估。
environ sequence of strings； default = []
提供此代码库规则所依赖的环境变量列表。如果该列表中的环境变量发生变化，系统将重新获取代码库。
configure default = 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 required
要反转的可迭代序列（例如 list）。

规则

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; default = None
字典，用于声明规则的所有属性。它从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有属性，可用于添加对标签的隐式依赖项。属性 name 是隐式添加的，不得指定。visibility、deprecation、tags、testonly 和 features 属性是隐式添加的，无法替换。大多数规则只需要少量属性。为了限制内存用量，规则函数对属性的大小施加了上限。
outputs dict; or None; or function； default = None
已废弃。此参数已弃用，很快就会被移除。请不要依赖它。已使用 ---incompatible_no_rule_outputs_param 停用。使用此标记验证您的代码是否符合即将移除的代码。
此参数已废弃。迁移规则以改用 OutputGroupInfo 或 attr.output。

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

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

字典中的每个条目都会创建一个预声明的输出，其中键是标识符，值是确定输出标签的字符串模板。在规则的实现函数中，标识符将成为用于访问 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" 中，目录名称为 a，基名为 b.c。

在实践中，最常见的替代占位符是 "%{name}"。例如，对于名为“foo”的目标，输出字典 {"bin": "%{name}.exe"} 以 ctx.outputs.bin 的形式预先声明了一个名为 foo.exe 的输出，该输出可在实现函数中访问。
executable default = False
此规则是否可执行，即它是否可能是 blaze run 命令的主题。如需了解详情，请参阅 “规则”页面。
output_to_genfiles default = False
如果为 true，则将在 genfiles 目录而不是 bin 目录中生成文件。除非您需要它以便与现有规则兼容（例如，在为 C++ 生成头文件时），否则请勿设置此标志。
fragments sequence of strings； default = []
规则在目标配置中所需的配置 fragment 的名称列表。
host_fragments sequence of strings； default = []
规则在主机配置中所需的配置 fragment 的名称列表。
_skylark_testable default = False
（实验性）

如果为 true，此规则将通过 Actions 提供程序将其操作公开，供依赖于它的规则进行检查。该提供程序也可以通过调用 ctx.created_actions() 提供给规则本身。

此方法应仅用于测试 Starlark 规则的分析时行为。此标志日后可能会移除。
toolchains sequence； default = []
如果设置，则是此规则所需的工具链集。该列表可以包含任意组合的 String、Label 或 StarlarkToolchainTypeApi 对象。将通过检查当前平台找到工具链，并通过 ctx.toolchain 将其提供给规则实现。
incompatible_use_toolchain_transition default = False
已废弃，不再使用，应将其移除。
doc default = ''
可通过文档生成工具提取的规则说明。
provides default = []
实现函数必须返回的提供程序列表。

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

列表的每个元素都是由 provider() 返回的 *Info 对象，只不过旧版提供程序由其字符串名称表示。
exec_compatible_with sequence of strings； default = []
针对执行平台上的、适用于此规则类型的所有目标的限制条件列表。
analysis_test default = False
如果为 true，则将此规则视为分析测试。

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

如果某条规则被定义为分析测试规则，则可以对该规则的属性使用通过 analysis_test_transition 定义的配置转换，但会选择接受一些限制：

  • 此规则的目标受限于其可具有的传递依赖项的数量。
  • 该规则被视为测试规则（就好像已设置 test=True）。这会取代 test 的值
  • 规则实现函数可能无法注册操作。而必须通过提供 AnalysisTestResultInfo 来注册通过/失败结果。
build_setting BuildSetting; or None； default = None
如果设置，则表示此规则属于 build setting 的种类。请参阅 config 模块。设置后，系统会自动向此规则添加一个名为“build_setting_default”的必需属性，其类型对应于此处传入的值。
cfg default = None
如果设置，则指向配置转换，在分析之前，规则将应用于其自身的配置。
exec_groups dict; or None； default = None
执行组名称（字符串）的语音输入到 exec_groups。如果设置，则允许规则在单个目标内的多个执行平台上运行操作。如需了解详情，请参阅执行组文档。
compile_one_filetype sequence of strings; or None; default = None
由 --compile_one_dependency 使用：如果多条规则使用指定的文件，我们应该优先选择此规则。
name string; or None； default = 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 required
用于将配置条件映射到值的字典。每个键都是一个 Label 或一个标签字符串，用于标识 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； default = []
一系列指向要应用于此模块的补丁文件的标签。补丁文件必须位于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds Iterable of strings； default = []
应用补丁后，在 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 required
要排序的可迭代序列。
key default = None
比较前应用于每个元素的可选函数。
reverse default = False
按降序返回结果。

str

string str(x)

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

参数

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

tag_class

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
要检查其类型的对象。

use_extension

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

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

参数

参数 说明
extension_bzl_file 必需
用于定义模块扩展名的 Starlark 文件标签。
extension_name required
要使用的模块扩展的名称。具有此名称的符号必须由 Starlark 文件导出。
dev_dependency default = False
如果为 true，当当前模块不是根模块或“--ignore_dev_dependency”处于启用状态时，系统会忽略对模块扩展的这种使用。

use_repo

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

将给定模块扩展生成的一个或多个代码库导入到当前模块的作用域中。

参数

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

visibility

None visibility(value)

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

模块的加载可见性决定其他 BUILD 和 .bzl 文件是否可以加载该模块。（这与底层 .bzl 源文件的目标可见性不同，后者用于控制文件是否显示为其他目标的依赖项）。加载可见性在软件包级别工作：如需加载模块，执行加载的文件必须位于已被授予该模块可见性的软件包中。无论模块可见性如何，模块始终可在其自己的软件包中加载。

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

如果 --check_bzl_visibility 标志设为 false，加载可见性违规行为将会发出警告，但构建不会失败。

参数

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

软件包规范遵循与 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。

此名称用于存储代码库的 Runfile 的目录。例如，如果本地代码库中有一个运行文件 foo/bar，并且 WORKSPACE 文件包含 workspace(name = 'baz')，则 mytarget.runfiles/baz/foo/bar 下将有运行文件。如果未指定工作区名称，则运行文件将符号链接到 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)

返回 tuple 的 list，其中第 i 个元组包含每个参数序列或可迭代对象的第 i 个元素。该列表具有最短输入的大小。使用一个 iterable 参数时，它会返回一元组的列表。在不使用任何参数的情况下，它会返回一个空列表。示例：
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 压缩的
列表。