成员
- 全部
- analytics_test_transitionanalysis_test_transition
- 任意类型
- archive_override
- 切面
- bazel_dep
- bind
- bool
- configuration_field
- depset
- dict
- dir
- 枚举
- exec_group
- 失败
- float
- getattr
- git_override
- hasattr
- 哈希
- int
- len
- 列表
- local_path_override
- 最大值
- min
- 模块
- module_extension
- multiple_version_override
- provider
- 范围
- register_execution_platforms()
- register_execution_platforms(dev_dependency)
- register_toolchains()
- register_toolchains(dev_dependency)
- repository_rule
- repr
- 反转
- 规则
- 选择
- single_version_override
- 已排序
- str
- tag_class
- tuple
- 类型
- use_extension
- use_repo
- 可见性
- 工作区
- zip
全部
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
|
必需 一个字典,包含应由此配置转换设定的配置设置的相关信息。键是 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)创建新切面。此函数的结果必须存储在一个全局值中。如需了解详情,请参阅切面简介。
参数
参数 | 说明 |
---|---|
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 参数的字段用于实现函数。以 显式属性必须具有 |
required_providers
|
default = [] 借助此属性,切面可以只将其传播到目标,即其规则通告了所需的提供程序。该值必须是包含单个提供商或提供商列表(但不能同时包含两者)的列表。例如, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。未嵌套的提供商列表将自动转换为包含一个提供商列表的列表。也就是说, 如需使某些规则(例如 |
required_aspect_providers
|
default = [] 此属性允许此切面检查其他方面。该值必须是包含单个提供商或提供商列表(但不能同时包含两者)的列表。例如, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。未嵌套的提供商列表将自动转换为包含一个提供商列表的列表。也就是说, 如需使其他切面(例如 |
provides
|
default = [] 实现函数必须返回的提供程序列表。 如果实现函数从其返回值中省略了此处列出的任何类型的提供程序,就会出错。不过,实现函数可能会返回此处未列出的其他提供程序。 列表中的每个元素都是由 |
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` 属性以传递方式传播 `deps`。假设 `alpha` 的 `deps = [':beta_output']` 具有 `deps = [':beta_output']`,其中 `beta_output` 是目标 `beta` 的声明输出。假设 `beta` 的目标 `charlie` 作为其 `deps` 之一。如果 `apply_to then_generating_rules` 将传递目标 `charlie`,则 Aspect 将仅传递 False。 默认值为 false。 |
exec_compatible_with
|
sequence of strings ;
default = []执行平台上应用于此切面的所有实例的限制条件列表。 |
exec_groups
|
dict; or None ;
default = None将执行组名称(字符串)转换为 exec_group s 的字典。如果设置,则允许切面在单个实例内的多个执行平台上运行操作。如需了解详情,请参阅执行组文档。
|
bazel_dep
None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)声明对另一个 Bazel 模块的直接依赖项。
参数
参数 | 说明 |
---|---|
name
|
必需 要作为直接依赖项添加的模块的名称。 |
version
|
default = '' 要作为直接依赖项添加的模块版本。 |
max_compatibility_level
|
default = -1 作为直接依赖项添加的模块支持的最大 compatibility_level 。模块的版本隐含支持的最低合规性_级别,如果未指定此属性,则支持最高兼容级别。
|
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 的列表,其元素成为所创建 depset 的间接元素。将依赖项转换为列表时,返回元素的顺序由 order
参数指定。如需了解详情,请参阅 Depsets 概览。
depset 的所有元素(直接和间接)都必须属于同一类型,与通过表达式 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 = [] 字典或可迭代对象,其元素的长度均为 2(键、值)。 |
kwargs
|
必需 其他条目的字典。 |
dir
list dir(x)返回字符串列表:参数对象的属性和方法的名称。
参数
参数 | 说明 |
---|---|
x
|
必需 要检查的对象。 |
枚举
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
|
必需 错误消息中显示的值列表,采用 debugPrint 格式(默认情况下等同于 str),并以空格连接。 |
float
float float(x=unbound)返回以浮点值表示的 x。
- 如果
x
已经是浮点数,则float
会返回它保持不变。 - 如果
x
是一个布尔值,float
会返回 1.0 表示 True,0.0 表示 False。 - 如果
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
|
必需 访问其属性的结构体。 |
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 ;
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
|
必需 要检查的对象。 |
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)以 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 之间(含 2 和 36),或为 0 以检测底数,就像 x 为整数字面量一样。如果值不是字符串,则不得提供此参数。
|
len
int len(x)返回字符串、序列(例如列表或元组)、字典或其他可迭代对象的长度。
参数
参数 | 说明 |
---|---|
x
|
必需 要报告其长度的值。 |
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
|
必需 此模块所在目录的路径。 |
最大值
unknown max(*args)返回所有给定参数中最大的一个。如果仅提供一个参数,则它必须是非空可迭代对象。如果元素不可比较(例如,带有字符串的 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 中有一个会给您造成干扰的错误,但在以后的版本中会得到修复时使用。 |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc='', environ=[], os_dependent=False, arch_dependent=False)创建一个新的模块扩展。将其存储在一个全局值中,以便可以导出并在 MODULE.bazel 文件中使用。
参数
参数 | 说明 |
---|---|
implementation
|
必需 实现此模块扩展的函数。必须接受一个参数 module_ctx 。系统会在构建开始时调用一次该函数,以确定可用的代码库集。 |
tag_classes
|
default = {} 一个字典,用于声明扩展程序使用的所有标记类。它从标记类的名称映射到 tag_class 对象。 |
doc
|
default = '' 可通过文档生成工具提取的模块扩展的说明。 |
environ
|
sequence of strings ;
default = []提供此模块扩展所依赖的环境变量列表。如果该列表中的环境变量发生变化,系统会重新评估该扩展程序。 |
os_dependent
|
default = False 指示此扩展程序是否依赖于操作系统 |
arch_dependent
|
default = False 指示此扩展程序是否依赖于架构 |
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
|
必需 要输出的对象。 |
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如果指定,将对允许的字段集加以限制。 可能的值包括:
|
init
|
callable; or None ;
default = None可选回调,用于在实例化期间预处理和验证提供程序的字段值。如果指定了 init ,provider() 会返回一个由 2 个元素组成的元组:常规提供程序符号和原始构造函数。以下是精确的说明;如需了解直观的讨论和用例,请参阅规则(自定义提供程序的初始化)。 将
init 回调,则对符号 P 本身的调用将充当对默认构造函数 c 的调用;也就是说,P(*args, **kwargs) 会返回 c(*args, **kwargs) 。例如,MyInfo = provider() m = MyInfo(foo = 1)会直接让 m 成为具有 m.foo == 1 的 MyInfo 实例。但是,如果指定了
注意:上面的步骤意味着,如果 通过这种方式, 指定 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(dev_dependency)
None register_execution_platforms(dev_dependency=False, *platform_labels)指定要在选择此模块时注册的已定义的执行平台。应该是绝对目标模式(即以
@
或 //
开头)。如需了解详情,请参阅工具链解析。
参数
参数 | 说明 |
---|---|
dev_dependency
|
default = False 如果为 true,那么如果当前模块不是根模块或“--ignore_dev_dependency”已启用,则执行平台将不会注册。 |
platform_labels
|
sequence of strings ;必需要注册的平台的标签。 |
register_toolchains()
None register_toolchains(*toolchain_labels)注册已定义的工具链,以便 Bazel 可以在工具链解析期间使用该工具链。请参阅定义和注册工具链的示例。
参数
参数 | 说明 |
---|---|
toolchain_labels
|
sequence of strings ;必需要注册的工具链的标签。 |
register_toolchains(dev_dependency)
None register_toolchains(dev_dependency=False, *toolchain_labels)指定要在选择此模块时注册的已定义工具链。应该是绝对目标模式(即以
@
或 //
开头)。如需了解详情,请参阅工具链解析。
参数
参数 | 说明 |
---|---|
dev_dependency
|
default = False 如果为 true,则如果当前模块不是根模块或“--ignore_dev_dependency”已启用,则不会注册工具链。 |
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 ;
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
|
必需 要转换的对象。 |
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 ;
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 。用于定义预先声明的输出的架构。与 此参数的值可以是字典,也可以是生成字典的回调函数。此回调的工作方式与计算的依赖项属性类似:函数的参数名称将与规则的属性进行匹配,因此,如果您传递使用定义 字典中的每个条目都会创建一个预先声明的输出,其中键是标识符,值是确定输出标签的字符串模板。在规则的实现函数中,标识符将成为用于在
在实践中,最常见的替代占位符是 |
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 = [] 实现函数必须返回的提供程序列表。 如果实现函数从其返回值中省略了此处列出的任何类型的提供程序,就会出错。不过,实现函数可能会返回此处未列出的其他提供程序。 列表中的每个元素都是由 |
exec_compatible_with
|
sequence of strings ;
default = []执行平台中应用于此规则类型的所有目标的限制条件列表。 |
analysis_test
|
default = False 如果为 true,则将此规则视为分析测试。 注意:分析测试规则主要使用 Starlark 核心库中提供的基础架构进行定义。如需获取相关指导,请参阅测试。 如果将某条规则定义为分析测试规则,该规则将允许对其属性使用通过 analysis_test_transition 定义的配置转换,但也可以选择接受一些限制:
|
build_setting
|
BuildSetting; or None ;
default = None如果设置此参数,则表示此规则属于 build setting 类型。请参阅 config 模块。如果设置了此属性,系统会自动向此规则中添加一个名为“build_setting_default”的必需属性,其类型与此处传入的值相对应。
|
cfg
|
default = None 如果设置,则指向配置转换,规则会在分析之前应用于其自身配置。 |
exec_groups
|
dict; or None ;
default = None将执行组名称(字符串)转换为 exec_group s 的字典。如果设置,允许规则在单个目标内的多个执行平台上运行操作。如需了解详情,请参阅执行组文档。
|
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 理解,并在日志记录、 如果省略此参数,则规则的名称会设置为要在其声明 .bzl 模块中绑定到此规则的第一个 Starlark 全局变量的名称。因此,如果名称为 为规则指定明确的名称并不会更改允许实例化规则的位置。 |
选择
unknown select(x, no_match_error='')
select()
是辅助函数,使规则属性变为可配置。如需了解详情,请参阅 build 百科全书。
参数
参数 | 说明 |
---|---|
x
|
必需 用于将配置条件映射到值的字典。每个键都是一个 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
|
必需 要转换的对象。 |
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
|
必需 要检查其类型的对象。 |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)返回一个表示模块扩展程序的代理对象;可以调用其方法来创建模块扩展程序标记。
参数
参数 | 说明 |
---|---|
extension_bzl_file
|
必需 用于定义模块扩展名的 Starlark 文件标签。 |
extension_name
|
必需 要使用的模块扩展的名称。具有此名称的符号必须由 Starlark 文件导出。 |
dev_dependency
|
default = False 如果为 true,那么如果当前模块不是根模块或“--ignore_dev_dependency”被启用,那么对模块扩展的使用会被忽略。 |
isolate
|
default = False 实验性。此参数尚处于实验阶段,随时可能更改。请不要依赖它。可以通过设置 ---experimental_isolated_extension_usages 以实验性方式启用它。如果为 true,此模块扩展的使用将与在此模块和其他模块中的所有其他用法隔离开来。为该用途创建的标记不会影响其他用途,并且该扩展程序为此用途生成的代码库也不同于该扩展程序生成的所有其他代码库。 此参数目前处于实验阶段,只能与 |
use_repo
None use_repo(extension_proxy, *args, **kwargs)将给定模块扩展生成的一个或多个代码库导入到当前模块的作用域中。
参数
参数 | 说明 |
---|---|
extension_proxy
|
必需use_extension 调用返回的模块扩展代理对象。
|
args
|
必需 要导入的代码库的名称。 |
kwargs
|
必需 指定要导入到当前模块范围内(具有不同名称)的特定代码库。键应该是要在当前范围内使用的名称,而值应该是模块扩展程序导出的原始名称。 |
visibility
None visibility(value)
设置当前初始化的 .bzl 模块的加载可见性。
模块的加载可见性决定了其他 build 和 .bzl 文件是否可以加载该模块。(这与底层 .bzl 源文件的目标可见性不同,后者控制着文件是否显示为其他目标的依赖项)。加载可见性在软件包级别工作:如需加载模块,执行加载的文件必须位于已被授予模块可见性的软件包中。模块始终可在其自己的软件包中加载,无论其可见性如何。
每个 .bzl 文件只能调用一次 visibility()
,且只能在顶层调用,不能在函数内调用。首选样式是将此调用放在 load()
语句和确定参数所需的任何简短逻辑正下方。
如果 --check_bzl_visibility
标志设置为 false,加载可见性违规行为会发出警告,但不会使构建失败。
参数
参数 | 说明 |
---|---|
value
|
必需 软件包规范字符串列表,或单个软件包规范字符串。 软件包规范遵循与
不允许使用“@”语法;所有规范都是相对于当前模块的代码库进行解释的。 如果 请注意, |
工作区
None workspace(name)
此函数只能在 WORKSPACE
文件中使用,且必须在 WORKSPACE
文件中的所有其他函数之前进行声明。每个 WORKSPACE
文件都应包含一个 workspace
函数。
设置此工作区的名称。工作区名称应为项目的 Java 软件包样式说明,并以下划线作为分隔符,例如,github.com/bazelbuild/bazel 应使用 com_github_bazelbuild_bazel。
此名称用于存储代码库的 Runfile 的目录。例如,如果本地代码库中有一个运行文件 foo/bar
,并且工作区文件包含 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
编写工作区文件。
参数
参数 | 说明 |
---|---|
name
|
必需 工作区的名称。名称必须以字母开头,且只能包含字母、数字、下划线、短划线和英文句点。 |
zip
list zip(*args)返回由
tuple
组成的 list
,其中第 i 个元组包含每个参数序列或可迭代对象的第 i 个元素。该列表具有最短输入的大小。使用一个可迭代参数时,它会返回一元组列表。在不使用任何参数的情况下,它会返回一个空列表。示例: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
|
必需 要压缩的列表。 |