BUILD 文件中提供的方法。另请参阅 Build 百科全书，了解其他函数和 build 规则，这些函数和规则也可用于 BUILD 文件。
成员
- depset
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- select
- 子软件包
depset
depset depset(direct=None, order="default", *, transitive=None)
direct 参数是依赖项集的直接元素的列表，transitive 参数是依赖项集的列表，其元素会成为所创建依赖项集的间接元素。将 depset 转换为列表时返回元素的顺序由 order 参数指定。如需了解详情，请参阅依赖项集概览。
依赖项集的所有元素（直接和间接）都必须为同一类型，如通过表达式 type(x) 获取的类型。
由于基于哈希的集合用于在迭代期间消除重复项，因此 depset 的所有元素都应可哈希化。不过，目前并未在所有构造函数中一致地检查此不变量。使用 --incompatible_always_check_depset_elements 标志启用一致的检查；这将是未来版本中的默认行为；请参阅问题 10313。
此外，元素目前必须是不可变的，但我们日后会放宽此限制。
创建的 depset 的顺序应与其 transitive depset 的顺序兼容。"default" 订单与其他任何订单兼容，其他所有订单仅与其兼容。
参数
| 参数 | 说明 |
|---|---|
direct
|
sequence；或 None；
默认为 Nonedepset 的直接元素的列表。 |
order
|
默认值为 "default"新 depset 的遍历策略。如需了解可能的值，请点击此处。 |
transitive
|
依赖项集的序列；或 None；
默认值为 None依赖项集的列表，其元素将成为依赖项集的间接元素。 |
existing_rule
unknown existing_rule(name)
None。在这里，不可变的字典型对象是指支持字典型迭代的深层不可变对象 x、len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys() 和 x.values()。
如果设置了 --noincompatible_existing_rules_immutable_view 标志，则改为返回具有相同内容的新可变字典。
结果包含每个属性的条目，但私有属性（名称不以字母开头）和一些无法表示的旧版属性类型除外。此外，该字典还包含规则实例的 name 和 kind 的条目（例如 'cc_binary'）。
结果的值表示属性值，如下所示：
- 类型为 str、int 和 bool 的属性按原样表示。
- 标签会转换为字符串，对于同一软件包中的目标，格式为
':foo'；对于其他软件包中的目标，格式为'//pkg:name'。 - 列表表示为元组，字典会转换为新的可变字典。它们的元素以相同的方式进行递归转换。
- 返回的
select值会按上述方式转换其内容。 - 未在规则实例化期间指定任何值，并且已计算默认值的属性会从结果中排除。（在分析阶段之前无法计算计算得出的默认值）。
请尽可能避免使用此函数。这会使 BUILD 文件变得脆弱且依赖于顺序。此外，请注意，它与将规则属性值从内部形式转换为 Starlark 的另外两种转换略有不同：一种由计算的默认值使用，另一种由 ctx.attr.foo 使用。
参数
| 参数 | 说明 |
|---|---|
name
|
必填 目标的名称。 |
existing_rules
unknown existing_rules()
existing_rule(name) 将返回的结果。在这里，“类字典的不可变对象”是指支持类似字典的迭代 x、len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys() 和 x.values() 的深度不可变对象。
如果设置了 --noincompatible_existing_rules_immutable_view 标志，则改为返回内容相同的新可变字典。
注意：请尽可能避免使用此函数。这会使 BUILD 文件变得脆弱且依赖于顺序。此外，如果设置了 --noincompatible_existing_rules_immutable_view 标志，此函数的开销可能会非常高，尤其是在循环中调用时。
exports_files
None exports_files(srcs, visibility=None, licenses=None)参数
| 参数 | 说明 |
|---|---|
srcs
|
string 的 sequence；必需 要导出的文件的列表。 |
visibility
|
sequence；或 None；
默认为 None可以指定可见性声明。指定的目标将可以看到这些文件。如果未指定可见性，则文件将对每个软件包可见。 |
licenses
|
字符串的序列；或 None；
默认为 None要指定的许可。 |
glob
sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- 与
include中的至少一个模式匹配。 - 与
exclude中的任何模式都不匹配（默认值为[]）。
exclude_directories 参数已启用（设为 1），则结果中会忽略目录类型的文件（默认为 1）。
参数
| 参数 | 说明 |
|---|---|
include
|
字符串的序列；默认为 []要包含的 glob 模式列表。 |
exclude
|
string 的 sequence；默认值为 []要排除的 glob 模式的列表。 |
exclude_directories
|
默认值为 1表示是否排除目录的标志。 |
allow_empty
|
默认值为 unbound是否允许全局通配模式匹配任何内容。如果 `allow_empty` 为 False，则每个包含模式都必须与某个内容匹配，并且最终结果也必须不为空（在排除 `exclude` 模式的匹配后）。 |
module_name
string module_name()
module_ctx.modules 中显示的 module.name 字段相同。
可以返回 None。
module_version
string module_version()
module_ctx.modules 中显示的 module.version 字段相同。
可以返回 None。
package_group
None package_group(name, packages=[], includes=[])visibility 属性中引用该标签。
参数
| 参数 | 说明 |
|---|---|
name
|
required 此规则的唯一名称。 |
packages
|
“string”的序列；默认值为 []此组中软件包的完整枚举。 |
includes
|
字符串的序列；
默认为 []此软件包组包含的其他软件包组。 |
package_name
string package_name()
some/package/BUILD 中，其值将为 some/package。如果 BUILD 文件调用 .bzl 文件中定义的函数，package_name() 将与调用方 BUILD 文件软件包匹配。
package_relative_label
Label package_relative_label(input)
BUILD 文件）的上下文中，将输入字符串转换为 Label 对象。如果输入已是 Label，则会原样返回。此函数只能在评估 BUILD 文件及其直接或间接调用的宏时调用；不得在规则实现函数中调用此函数。
此函数的结果与将给定字符串传递给 BUILD 文件中声明的目标的标签值属性所产生的 Label 值相同。
使用注意事项：此函数与 Label() 之间的区别在于，Label() 使用调用它的 .bzl 文件的软件包上下文，而不是 BUILD 文件的软件包。如果您需要引用硬编码到宏中的固定目标（例如编译器），请使用 Label()。如果您需要将 BUILD 文件提供的标签字符串标准化为 Label 对象，请使用 package_relative_label()。（除了 BUILD 文件或调用 .bzl 文件之外，无法在软件包上下文中将字符串转换为 Label。因此，外部宏应始终优先将 Label 对象传递给内部宏，而不是标签字符串。）
参数
| 参数 | 说明 |
|---|---|
input
|
字符串；或标签；
必需 输入标签字符串或 Label 对象。如果传递了 Label 对象，系统会按原样返回该对象。 |
repo_name
string repo_name()
repository_name
string repository_name()
--+incompatible_enable_deprecated_label_apis 以实验性方式启用此功能已废弃。建议改用
repo_name，它不包含多余的前置 @ 符号，但在其他方面行为完全相同。包含当前正在评估的软件包的代码库的规范名称，前面带有一个 @ 符号 (@)。例如，在由 WORKSPACE 诗节 local_repository(name='local', path=...) 调用的软件包中，它将设置为 @local。在主代码库中的软件包中，它将设置为 @。
选择
unknown select(x, no_match_error='')
select() 是一个辅助函数，用于使规则属性可配置。如需了解详情，请参阅 build 百科全书。
参数
| 参数 | 说明 |
|---|---|
x
|
required 一个字典，用于将配置条件映射到值。每个键都是一个标签或标签字符串，用于标识 config_setting 或 constraint_value 实例。如需了解何时使用标签而非字符串，请参阅有关宏的文档。 |
no_match_error
|
默认值为 ''如果没有条件匹配，可报告的可选自定义错误。 |
子软件包
sequence subpackages(include, exclude=[], allow_empty=False)
参数
| 参数 | 说明 |
|---|---|
include
|
字符串的序列；
必需 要包含在子软件包扫描中的 glob 模式的列表。 |
exclude
|
字符串的序列；
默认值为 []要从子软件包扫描中排除的 glob 模式列表。 |
allow_empty
|
默认值为 False如果调用返回空列表，是否失败。默认情况下，空列表表示 BUILD 文件中调用 subpackages() 是多余的，可能会导致错误。在这种情况下，设置为 true 可让此函数成功。 |