.bzl 文件

报告问题 夜间版 · 8.0 . 7.4 。 7.3 · 7.2 · 7.1 · 7.0 · 6.5

所有 .bzl 文件中都提供的全局方法。

成员

analysis_test_transition

transition analysis_test_transition(settings)

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

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

参数

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

切面

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

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

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

声明的属性会将 None 转换为默认值。
required_providers sequence；默认为 []
此属性可让此方面将其传播限制为仅限规则中宣传其所需提供程序的目标。该值必须是包含单个提供商或提供商列表的列表，但不能同时包含这两者。例如，[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是一个有效值，而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 无效。

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

若要让某些规则（例如 some_rule）的目标对某个方面可见，some_rule 必须宣传至少一个必需提供商列表中的所有提供商。例如，如果某个方面（aspect）的 required_providers 为 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]]，则只有当 some_rule 提供 FooInfo、BarInfo 或同时提供 BazInfo 和 QuxInfo 时，此方面才能看到 some_rule 目标。
required_aspect_providers sequence； 默认值为 []
此属性允许此 aspect 检查其他 aspect。该值必须是包含单个提供商或提供商列表的列表，但不能同时包含这两者。例如，[[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 sequence； 默认为 []
实现函数必须返回的提供程序列表。

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

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

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

例如，假设某个方面通过属性 `deps` 传递，并应用于目标 `alpha`。假设 `alpha` 的 `deps = [':beta_output']`，其中 `beta_output` 是目标 `beta` 的声明输出。假设 `beta` 的 `deps` 之一是目标 `charlie`。如果该方面的 `apply_to_generating_rules=True`，则该方面将通过 `alpha`、`beta` 和 `charlie` 传播。如果为 False，则该方面将仅传播到 `alpha`。

默认值为 false。
exec_compatible_with 字符串的序列； 默认为 []
适用于此方面所有实例的执行平台限制条件的列表。
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 string; required
包含延迟绑定值的配置 fragment 的名称。
name string； 必需
要从配置 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 string； 默认为 "default"
新 depset 的遍历策略。如需了解可能的值，请点击此处。
transitive 依赖项集的序列；或 None； 默认值为 None
依赖项集的列表，其元素将成为依赖项集的间接元素。

exec_group

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

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

参数

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

exec_transition

transition exec_transition(implementation, inputs, outputs)

transition() 的专用版本，用于定义执行转换。如需了解最佳实践，请参阅其文档（或实现）。只能从 Bazel 内置函数使用。

参数

参数 说明
implementation 可调用； 必需
inputs 字符串的序列； 必需
outputs 字符串的序列； 必需

微距

macro macro(implementation, attrs={}, inherit_attrs=None, finalizer=False, doc=None)

定义符号宏，可在 BUILD 文件或宏（旧版或符号宏）中调用以定义目标（可能多个）。

macro(...) 返回的值必须分配给 .bzl 文件中的全局变量；全局变量的名称将是宏符号的名称。

如需有关如何使用符号宏的全面指南，请参阅宏。

参数

参数 说明
implementation function; 必需
用于实现此宏的 Starlark 函数。宏属性的值会作为关键字参数传递给实现函数。实现函数必须至少具有两个命名参数 name 和 visibility，如果宏继承了属性（请参阅下文中的 inherit_attrs），则必须具有 **kwargs 残留关键字参数。

根据惯例，实现函数应针对宏需要检查、修改或传递给非“主要”目标的任何属性提供命名参数，而将以不变形式传递给“主要”目标的“批量”继承属性则以 **kwargs 的形式传递。

实现函数不得返回值。相反，实现函数通过调用规则或宏符号来声明目标。

由符号宏（包括宏的实现函数间接调用的任何 Starlark 函数）声明的任何目标或内部符号宏的名称必须等于 name（这称为“主”目标），或者以 name 开头，后跟分隔符字符（"_"、"-" 或 "."）和字符串后缀。（允许声明违反此命名方案的目标，但无法构建、配置或依赖于这些目标。）

默认情况下，由符号宏声明的目标（包括宏的实现函数间接调用的任何 Starlark 函数）仅在包含定义宏的 .bzl 文件的软件包中可见。如需声明对外公开的目标（包括对符号宏的调用方），实现函数必须适当地设置 visibility，通常是通过将 visibility = visibility 传递给要调用的规则或宏符号来实现。

以下 API 在宏实现函数及其传递调用的任何 Starlark 函数中不可用：

attrs 字典； 默认值为 {}
此宏支持的属性的字典，类似于 rule.attrs。键是属性名称，值是 attr.label_list(...) 等属性对象（请参阅 attr 模块）或 None。None 条目表示宏没有该名称的属性，即使它本来可以通过 inherit_attrs 继承该属性也是如此（见下文）。

特殊的 name 属性是预声明的，不得包含在字典中。visibility 属性名称已预留，不得包含在字典中。

名称以 _ 开头的属性是私有的，无法在规则的调用位置传递。您可以为此类属性指定默认值（如 attr.label(default="//pkg:foo") 中所示），以便创建对标签的隐式依赖项。

为了限制内存用量，可声明的属性数量存在上限。

inherit_attrs rule；或 macro；或 string；或 None； 默认为 None
规则符号、宏符号，或宏应从中继承属性的内置公共属性列表的名称（见下文）。

如果将 inherit_attrs 设置为字符串 "common"，则该宏将继承所有 Starlark 规则使用的常规规则属性定义。

请注意，如果 rule() 或 macro() 的返回值未分配给 .bzl 文件中的全局变量，则此类值尚未注册为规则或宏符号，因此无法用于 inherit_attrs。

继承机制的运作方式如下：

  1. 特殊的 name 和 visibility 属性永远不会被继承；
  2. 隐藏属性（名称以 "_" 开头的属性）永远不会被继承；
  3. 名称已在 attrs 字典中定义的属性永远不会被继承（attrs 中的条目优先；请注意，可以将条目设置为 None，以确保宏中没有以该名称定义的属性）；
  4. 所有其他属性均从规则或宏继承，并有效合并到 attrs 字典中。

继承非必需属性时，无论原始规则或宏中指定了什么值，该属性的默认值都会被替换为 None。这可确保当宏将属性的值转发给封装的规则或宏的实例时（例如通过传入未修改的 **kwargs），外部宏调用中缺少的值在内部规则或宏调用中也会缺失（因为将 None 传递给属性的处理方式与省略属性相同）。这一点很重要，因为省略属性与传递其表面默认值的语义略有不同。具体而言，某些 bazel query 输出格式不会显示省略的属性，并且仅在省略值时才会执行计算的默认值。如果宏需要检查或修改继承的属性（例如，向继承的 tags 属性添加值），您必须确保在宏的实现函数中处理 None 情况。

例如，以下宏会继承 native.cc_library 的所有属性，但 cxxopts（已从属性列表中移除）和 copts（已获得新定义）除外。它还会在附加其他标记之前，仔细检查继承的 tags 属性的默认 None 值。 

def _my_cc_library_impl(name, visibility, tags, **kwargs):
    # Append a tag; tags attr was inherited from native.cc_library, and
    # therefore is None unless explicitly set by the caller of my_cc_library()
    my_tags = (tags or []) + ["my_custom_tag"]
    native.cc_library(
        name = name,
        visibility = visibility,
        tags = my_tags,
        **kwargs
    )

my_cc_library = macro(
    implementation = _my_cc_library_impl,
    inherit_attrs = native.cc_library,
    attrs = {
        "cxxopts": None,
        "copts": attr.string_list(default = ["-D_FOO"]),
    },
)

如果设置了 inherit_attrs，则宏的实现函数必须包含 **kwargs 残留关键字参数。

根据惯例，宏应将未被替换的继承属性原封不动地传递给宏要封装的“主要”规则或宏符号。通常，大多数继承的属性在实现函数的参数列表中都没有参数，而只会通过 **kwargs 传递。如果宏需要将某些继承的属性（最常见的是 tags 和 testonly）同时传递给“main”和非“main”目标，则实现函数可以为这些属性提供显式参数，这样会很方便；但如果宏还需要检查或操控这些属性，则必须小心处理非必需继承属性的 None 默认值。

finalizer bool； 默认值为 False
此宏是否为规则终结器。无论此宏在 BUILD 文件中的什么位置，系统都会在打包加载结束且所有非终结器目标都已定义后对其进行评估。

与普通符号宏不同，规则终结器可以调用 native.existing_rule() 和 native.existing_rules() 来查询当前软件包中定义的一组非终结器规则目标。请注意，native.existing_rule() 和 native.existing_rules() 无法访问任何规则最终处理脚本（包括此脚本）定义的目标。

doc string；或 None； 默认为 None
可由文档生成工具提取的宏的说明。

module_extension

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

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

参数

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

repository_rule

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

创建新的代码库规则。将其存储在全局值中，以便从 module_extension() 实现函数加载和调用它，或由 use_repo_rule() 使用。

参数

参数 说明
implementation 可调用； 必需
用于实现此规则的函数。必须有一个参数 repository_ctx。系统会在规则的每个实例的加载阶段调用该函数。
attrs 字典；或 None； 默认为 None
用于声明代码库规则的所有属性的字典。它用于从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有的，可用于向文件添加对标签的隐式依赖项（代码库规则不能依赖于生成的工件）。系统会隐式添加属性 name，因此不得指定该属性。

声明的属性会将 None 转换为默认值。
local bool； 默认值为 False
表示此规则会从本地系统提取所有内容，并且应在每次提取时重新评估。
environ 字符串的序列；默认为 []
已废弃。此参数已被弃用。请改为迁移到 repository_ctx.getenv。
提供此代码库规则依赖的环境变量列表。如果该列表中的环境变量发生更改，系统会重新提取代码库。
configure bool； 默认值为 False
指示代码库出于配置目的检查系统
remotable bool； 默认值为 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=[], dependency_resolution_rule=False, 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 function； 必需
实现此规则的 Starlark 函数必须只有一个参数：ctx。系统会在分析阶段针对规则的每个实例调用该函数。它可以访问用户提供的属性。它必须创建操作来生成所有声明的输出。
test bool； 默认值为 unbound
此规则是否为测试规则，即是否可以是 blaze test 命令的正文。所有测试规则都会自动视为executable；无需（也不建议）为测试规则显式设置 executable = True。此值默认为 False。如需了解详情，请参阅 “规则”页面。
attrs 字典； 默认值为 {}
用于声明规则的所有属性的字典。它用于从属性名称映射到属性对象（请参阅 attr 模块）。以 _ 开头的属性是私有的，可用于向标签添加隐式依赖项。系统会隐式添加属性 name，因此无需指定该属性。系统会隐式添加属性 visibility、deprecation、tags、testonly 和 features，且这些属性无法被替换。大多数规则只需要几个属性。为了限制内存用量，可声明的属性数量存在上限。

声明的属性会将 None 转换为默认值。
outputs 字典；或 None；或函数； 默认是 None
已废弃。此参数已废弃，很快就会被移除。请勿依赖此功能。在 --incompatible_no_rule_outputs_param 中，此功能处于停用状态。使用此标志可验证您的代码是否与即将移除的 API 兼容。
此参数已被弃用。请改用 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 bool； 默认为 False
如果为 true，文件将在 genfiles 目录中生成，而不是在 bin 目录中生成。除非您需要此标志来与现有规则保持兼容（例如，为 C++ 生成头文件时），否则请勿设置此标志。
fragments 字符串的序列；默认为 []
目标配置中规则所需的配置 fragment 的名称列表。
host_fragments 字符串的序列；默认为 []
该规则在主机配置中所需的配置 fragment 的名称列表。
_skylark_testable bool； 默认为 False
（实验性）

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

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

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

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

dependency_resolution_rule bool； 默认值为 False
如果设置，则规则可以通过在材质化程序中也标记为可用的属性成为依赖项。设置了此标志的规则的每个属性都必须标记为可在 Material 化器中使用。这样，这样标记的规则就不能依赖于未标记的规则。
exec_compatible_with 字符串的序列； 默认为 []
适用于此规则类型的所有目标的执行平台限制条件列表。
analysis_test bool； 默认为 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() 是一个辅助函数，用于使规则属性可配置。如需了解详情，请参阅build 百科全书。

参数

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

子规则

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

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

参数

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

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

  • FilesToRunProvider（适用于带有 executable=True 的标签属性）
  • File（适用于带有 allow_single_file=True 的标签属性）
  • Target：适用于所有其他标签属性
  • [Target]（适用于所有标签列表属性）
toolchains sequence； 默认为 []
如果设置，则表示此子规则所需的工具链集。该列表可以包含 String、Label 或 StarlarkToolchainTypeApi 对象，可以任意组合。系统会通过检查当前平台来查找工具链，并通过 ctx.toolchains 将其提供给子规则实现。请注意，如果设置此参数，则需要在使用规则上启用 AEG。如果您尚未迁移到 AEG，请参阅 https://bazel.build/extending/auto-exec-groups#migration-aegs。
fragments 字符串的序列； 默认为 []
子规则在目标配置中需要的配置 fragment 的名称列表。
subrules 子规则的顺序；默认为 []
此子规则所需的其他子规则的列表。

tag_class

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

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

参数

参数 说明
attrs 字典； 默认值为 {}
用于声明此代码类的所有属性的字典。它用于从属性名称映射到属性对象（请参阅 attr 模块）。

请注意，与 rule()、aspect() 和 repository_rule() 不同，声明的属性不会将 None 转换为默认值。如需使用默认值，调用方必须完全省略该属性。
doc 字符串；或 None； 默认为 None
标记类的说明，可由文档生成工具提取。

visibility

None visibility(value)

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

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

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

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

参数

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