.bzl 文件

报告问题 每夜 build · 7.4 .

所有 .bzl 文件中都可用的全局方法。

成员

analysis_test_transition

transition analysis_test_transition(settings)

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

此函数主要用于简化 Analysis Test Framework 核心库的使用。如需了解最佳实践，请参阅其文档（或其实现）。

参数

参数 说明
settings required
此字典包含有关此配置转换应设置的配置设置的信息。键是 build 设置标签，值是转换后的新值。所有其他设置保持不变。使用此属性声明分析测试需要设置的特定配置设置，以便测试能够通过。

切面

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

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

参数

参数 说明
implementation 必需
用于实现此方面功能的 Starlark 函数，该函数只有两个参数：Target（要应用此方面功能的目标）和 ctx（用于创建目标的规则上下文）。您可以通过 ctx.rule 字段获取目标的属性。在分析阶段，系统会针对将某个方面应用于目标的每次操作来评估此函数。
attr_aspects string 的序列；默认值为 []
属性名称列表。切面会沿着具有这些名称的目标的属性中指定的依赖项传播。此处的常见值包括 deps 和 exports。该列表还可以包含单个字符串 "*"，以沿着目标的所有依赖项传播。
attrs 字典； 默认值为 {}
用于声明相应方面所有属性的字典。它用于从属性名称映射到属性对象，例如 `attr.label` 或 `attr.string`（请参阅 attr 模块）。切面属性可作为 ctx 参数的字段提供给实现函数。

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

显式属性的类型必须为 string，且必须使用 values 限制。显式属性会限制相应方面只能与具有相同名称、类型和有效值的规则搭配使用（具体取决于限制）。

required_providers 默认值为 []
此属性允许切面将其传播范围限制为规则通告其所需提供程序的目标。该值必须是包含单个提供商或提供商列表的列表，但不能同时包含这两者。例如，[[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 默认值为 []
此属性允许此切面检查其他切面。该值必须是包含单个提供商或提供商列表（但不能同时包含两者）的列表。例如，[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值，而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。

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

若要使另一个 aspect（例如 other_aspect）对此 aspect 可见，other_aspect 必须提供至少一个列表中的所有提供程序。在 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 示例中，只有当 other_aspect 提供 FooInfo、或 BarInfo、或 BazInfo 和 QuxInfo 时，此 aspect 才能看到 other_aspect。

provides 默认值为 []
实现函数必须返回的提供程序列表。

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

该列表的每个元素都是 provider() 返回的 *Info 对象，但旧版提供程序由其字符串名称表示。如果规则的目标被用作声明所需提供程序的目标的依赖项，则无需在此处指定该提供程序。实现函数返回它就足够了。不过，最佳实践是指定它，即使这不是必需的。不过，方面的 required_providers 字段要求在此处指定提供商。

requires Aspect 的 sequence；默认值为 []
在此切面之前需要传播的切面的列表。
fragments 字符串的序列； 默认为 []
该方面在目标配置中需要的配置 fragment 的名称列表。
host_fragments 字符串的序列； 默认为 []
该方面在主机配置中需要的配置 fragment 的名称列表。
toolchains sequence； 默认为 []
如果设置，则表示此规则所需的工具链集。该列表可以包含 String、Label 或 StarlarkToolchainTypeApi 对象，可以任意组合。系统将通过检查当前平台找到工具链，并通过 ctx.toolchain 将其提供给规则实现。
incompatible_use_toolchain_transition 默认值为 False
已废弃，此属性已不再使用，应予移除。
doc string；或 None； 默认为 None
对可由文档生成工具提取的方面进行说明。
apply_to_generating_rules 默认值为 False
如果为 true，则切面在应用于输出文件时，会应用于输出文件的生成规则。

例如，假设一个切面通过属性 `deps` 以传递方式传播，并且应用于目标 `alpha`。假设 `alpha` 的 `deps = [':beta_output']` 为 `beta_output` 是目标 `beta` 的声明输出。假设 `beta` 将目标 `charlie` 设为其 `deps` 的 `deps`。如果 `apply_to_beta` 将仅传播到 `alphali` 的切面，那么 char_to_generating_alpha 的切面为

默认值为 false。
exec_compatible_with string 的 sequence；默认值为 []
执行平台上的一系列约束条件，适用于此切面的所有实例。
exec_groups 字典；或 None； 默认为 None
执行组名称（字符串）与 exec_groups 的字典。如果设置，则允许在单个实例中对多个执行平台运行操作。如需了解详情，请参阅执行组文档。
subrules 子规则的序列；默认为 []
实验性：此方面使用的子规则列表。

configuration_field

LateBoundDefault configuration_field(fragment, name)

引用类型为标签的属性的延迟绑定默认值。如果某个值需要在确定该值之前构建配置，则该值为“后期绑定”。任何使用此用作值的属性都必须不公开。

用法示例：

定义规则属性：

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

在规则实现中进行访问：

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

参数

参数 说明
fragment required
包含延迟绑定值的配置 fragment 的名称。
name required
要从配置 fragment 中获取的值的名称。

depset

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

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

废弃集的所有元素（直接和间接）都必须属于同一种类型，可以通过表达式 type(x) 获得。

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

此外，元素目前必须是不可变的，但我们日后会放宽此限制。

已创建的 Depset 的顺序应与其 transitive 的 Depset 的顺序兼容。"default" 订单与其他任何订单兼容，其他所有订单仅与其兼容。

参数

参数 说明
direct sequence；或 None； 默认为 None
depset 的直接元素的列表。
order 默认值为 "default"
新 depset 的遍历策略。如需了解可能的值，请参阅此处。
transitive 依赖项集的序列；或 None； 默认值为 None
依赖项集的列表，其元素将成为依赖项集的间接元素。

exec_group

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

创建执行组，以便在规则实施期间为特定执行平台创建操作。

参数

参数 说明
toolchains sequence； 默认为 []
此执行组所需的一组工具链。列表可以包含 String、Label 或 StarlarkToolchainTypeApi 对象，可以任意组合。
exec_compatible_with string 的 sequence；默认值为 []
执行平台上的约束条件列表。

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)

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

参数

参数 说明
implementation required
实现此模块扩展的函数。必须接受单个参数 module_ctx。系统会在构建开始时调用此函数一次，以确定一组可用代码库。
tag_classes 默认值为 {}
一个字典，用于声明扩展程序使用的所有代码类。它会将标记类的名称映射到 tag_class 对象。
doc string；或 None；默认值为 None
模块扩展的说明，可由文档生成工具提取。
environ 字符串的序列；默认为 []
提供此模块扩展程序依赖的环境变量列表。如果该列表中的环境变量发生变化，系统会重新评估扩展程序。
os_dependent 默认值为 False
指明此扩展程序是否依赖于操作系统
arch_dependent 默认值为 False
指示此扩展程序是否依赖于架构

provider

unknown provider(doc=None, *, 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 可调用值。

如果指定了 init，则返回一个包含 2 个元素的元组：一个 Provider 可调用值和一个原始构造函数可调用值。如需了解详情，请参阅 规则（自定义提供程序的自定义初始化）以及下面对 init 参数的讨论。

参数

参数 说明
doc string；或 None； 默认为 None
提供方说明，可由文档生成工具提取。
fields 字符串的序列；或字典；或 None； 默认为 None
如果指定，则会限制允许的字段集。
可能的值包括：
  • 字段列表：
    provider(fields = ['a', 'b'])

  • 字典字段名称 -> 文档：
    provider(
       fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
所有字段均为选填字段。
init 可调用对象；或 None； 默认为 None
可选回调，用于在实例化期间预处理和验证提供程序的字段值。如果指定了 init，provider() 会返回一个包含 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 == 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 = ...)

repository_rule

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

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

参数

参数 说明
implementation required
实现此规则的函数。必须有一个参数 repository_ctx。系统会在规则的每个实例的加载阶段调用该函数。
attrs 字典；或 None； 默认值为 None
用于声明规则的所有属性的字典。它用于从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有属性，可用于为文件添加对标签的隐式依赖项（仓库规则不能依赖于生成的工件）。系统会隐式添加属性 name，因此不得指定该属性。
local 默认值为 False
表示此规则会从本地系统提取所有内容，并且应在每次提取时重新评估。
environ string 的 sequence；默认值为 []
已废弃。此参数已被弃用。请改为迁移到 repository_ctx.getenv。
提供此代码库规则依赖的环境变量列表。如果该列表中的环境变量发生更改，系统会重新提取代码库。
configure 默认值为 False
表示代码库会出于配置目的检查系统
remotable 默认值为 False
实验性。此参数目前处于实验阶段，随时可能发生变化。请勿依赖此功能。您可以通过设置 ---experimental_repo_remote_exec
Compatible with remote execution 以实验性方式启用该功能
doc 字符串；或 None； 默认为 None
可由文档生成工具提取的代码库规则说明。

规则

callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])

创建一个新规则，可从 BUILD 文件或宏调用该规则来创建目标。

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

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

参数

参数 说明
implementation 必需
实现此规则的 Starlark 函数只能有一个参数：ctx。系统会在分析阶段针对规则的每个实例调用该函数。它可以访问用户提供的属性。它必须创建操作才能生成所有声明的输出。
test bool； 默认值为 unbound
此规则是否为测试规则，即是否可以是 blaze test 命令的主体。所有测试规则都会自动视为可执行；无需（也不建议）为测试规则显式设置 executable = True。该值默认为 False。如需了解详情，请参阅“规则”页面。
attrs 字典；默认值为 {}
，用于声明规则的所有属性。它从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有的，可用于向标签添加隐式依赖项。系统会隐式添加属性 name，因此无需指定该属性。系统会隐式添加属性 visibility、deprecation、tags、testonly 和 features，且这些属性无法被替换。大多数规则只需要几个属性。为限制内存用量，规则函数对属性的大小施加了限制。
outputs 字典；或 None；或函数； 默认是 None
已废弃。此参数已弃用，很快就会被移除。请勿依赖此功能。在 ---incompatible_no_rule_outputs_param 中，此功能处于停用状态。使用此标记验证您的代码与其即将移除的兼容性兼容。
此参数已被弃用。迁移规则以改用 OutputGroupInfo 或 attr.output。

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

此参数的值是字典，或者是生成字典的回调函数。回调的运作方式与计算依赖项属性类似：函数的参数名称会与规则的属性进行匹配，例如，如果您传递 outputs = _my_func 并使用定义 def _my_func(srcs, deps): ...，则该函数可以访问属性 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" 中，dirname 为 a，basename 为 b.c。

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

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

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

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

列表中的每个元素都是 provider() 返回的 *Info 对象，但旧版提供程序则由其字符串名称表示。当规则的目标用作声明了必需提供程序的目标的依赖项时，无需在此处指定该提供程序。实现函数会返回它就足够了。不过，最佳实践是指定它，即使这不是必需的。但是，方面的 required_providers 字段要求在此处指定提供商。
exec_compatible_with string 的 sequence，默认值为 []
执行平台上的一系列限制条件，这些限制条件会应用于此规则类型的所有目标。
analysis_test 默认值为 False
如果为 true，则此规则会被视为分析测试。

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

如果将规则定义为分析测试规则，则允许对其属性使用使用 analysis_test_transition 定义的配置转换，但会选择接受一些限制：

  • 此规则的目标数量有限。
  • 该规则会被视为测试规则（就像设置了 test=True 一样）。此值会替换 test 的值
  • 规则实现函数可能无法注册操作。而是必须通过提供 AnalysisTestResultInfo 来注册通过/失败结果。
build_setting BuildSetting；或 None；默认值为 None
如果设置，则说明此规则所属的类型 build setting。请参阅 config 模块。如果设置此属性，系统会自动向此规则添加名为“build_setting_default”的必需属性，其类型与此处传入的值相对应。
cfg 默认值为 None
如果设置，则指向规则在分析之前将应用于其自身配置的配置转换。
exec_groups 字典；或 None； 默认为 None
执行组名称（字符串）与 exec_groups 的字典。如果设置，则允许规则在单个目标中的多个执行平台上运行操作。如需了解详情，请参阅执行组文档。
initializer 默认值为 None
实验性：用于初始化规则属性的 Stalark 函数。

系统会在加载规则的每个实例时调用该函数。该方法使用 name 和规则定义的公共属性的值进行调用（而不是使用通用属性，例如 tags）。

它必须返回一个字典，其中包含属性名称与所需值的对应关系。未返回的属性不受影响。将 None 作为值返回会导致使用属性定义中指定的默认值。

系统会先评估初始化程序，然后再评估属性定义中指定的默认值。因此，如果初始化程序签名中的参数包含默认值，则会覆盖属性定义中的默认值（返回 None 除外）。

同样，如果初始化程序签名中的参数没有默认值，该参数将变为必需参数。在这种情况下，最好省略属性定义的默认/强制性设置。

最好对未处理的属性使用 **kwargs。

对于扩展的规则，系统会从子级到祖先依次调用所有初始化程序。每个初始化程序只会传递它知道的公共属性。

parent 默认值为 None
实验性：扩展的 Stalark 规则。设置后，系统会合并公共属性以及通告的提供程序。该规则与父级中的 executable 和 test 匹配。fragments、toolchains、exec_compatible_with 和 exec_groups 的值会合并。不得设置旧版或已废弃的参数。父级的传入配置转换 cfg 会在此规则的传入配置之后应用。
extendable bool；或标签；或字符串；或 None； 默认值为 None
实验性：许可名单的标签，用于定义哪些规则可以扩展此规则。您还可以将其设置为 True/False，以始终允许/禁止延长。Bazel 默认始终允许扩展程序。
subrules 子规则的序列；默认为 []
实验性：此规则使用的子规则列表。

选择

unknown select(x, no_match_error='')

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

参数

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

子规则

Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])

构造子规则的新实例。此函数的结果必须先存储在全局变量中，然后才能使用。

参数

参数 说明
implementation function； 必需
实现此子规则的 Starlark 函数
attrs 字典； 默认为 {}
用于声明子规则的所有（私有）属性的字典。

子规则只能包含标签类型（即标签或标签列表）的私有属性。Bazel 会自动将与这些标签对应的已解析值作为命名参数传递给子规则的实现函数（因此，实现函数必须接受与属性名称匹配的命名参数）。这些值的类型将为：

  • FilesToRunProvider（适用于带有 executable=True 的标签属性）
  • File（适用于带有 allow_single_file=True 的标签属性）
  • Target：适用于所有其他标签属性
  • [Target]（适用于所有标签列表属性）
toolchains sequence；默认值为 []
如果设置了此字段，则表示此子规则所需的工具链集。该列表可以包含 String、Label 或 StarlarkToolchainTypeApi 对象，可以任意组合。系统会通过检查当前平台来查找工具链，并通过 ctx.toolchains 将其提供给子规则实现。
fragments 字符串的序列； 默认为 []
子规则在目标配置中需要的配置 fragment 的名称列表。
subrules 子规则的顺序；默认为 []
此子规则所需的其他子规则的列表。

tag_class

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

创建一个新的 tag_class 对象，用于为一类代码定义属性架构。这些代码是模块扩展程序可使用的数据对象。

参数

参数 说明
attrs 默认值为 {}
用于声明此代码类的所有属性的字典。它会从属性名称映射到属性对象（请参阅 attr 模块）。
doc string；或 None；默认值为 None
可通过文档生成工具提取的标记类的说明。

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" 值始终可用，"//..." 始终被解释为“当前代码库中的所有软件包”。