函数

目录

package

package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)

此函数声明适用于软件包中每条规则的元数据。它在软件包(BUILD 文件)中最多使用一次。

如需使用对应函数声明适用于整个 代码库中每条规则的元数据,请使用代码库根目录下的 repo() 函数在 REPO.bazel 文件中。repo() 函数采用的参数与 package() 完全相同。

package() 函数应在文件顶部所有 load() 语句之后、任何规则之前调用。

参数

属性 说明
default_applicable_licenses

default_package_metadata. 的别名。

default_visibility

标签列表;默认值为 []

此软件包中规则的默认可见性。

除非在规则的 visibility属性中另有指定,否则此软件包中的每条规则都具有此属性中指定的可见性。如需详细了解此 属性的语法,请参阅可见性文档。软件包的默认可见性不适用于 exports_files,后者默认是 公开的。

default_deprecation

字符串;默认值为 ""

为此软件包中的所有规则设置默认的 deprecation 消息。

default_package_metadata

标签列表;默认值为 []

设置适用于软件包中所有其他目标的默认元数据目标列表。 这些目标通常与 OSS 软件包和许可声明相关。 如需查看示例,请参阅 rules_license

default_testonly

布尔值;默认值为 False,除非另有说明

为此软件包中的所有规则设置默认的 testonly 属性。

javatests 下的软件包中,默认值为 True

features

字符串列表;默认值为 []

设置影响此 BUILD 文件的语义的各种标志。

此功能主要供构建系统开发者使用,用于标记需要某种特殊处理的软件包。除非构建系统开发者 明确要求,否则请勿使用此功能。

示例

以下声明声明,此软件包中的规则仅对软件包组 //foo:target 的成员可见。规则的单独可见性声明(如果存在)会替换此规范。
package(default_visibility = ["//foo:target"])

package_group

package_group(name, packages, includes)

此函数定义一组 软件包 ,并将标签与该组相关联。该标签可在 visibility 属性中引用。

软件包组主要用于可见性控制。公开可见的目标可以从源代码树中的每个软件包引用。私下可见的目标只能在其自己的软件包(而非子软件包)中引用。 在这两种极端情况之间,目标可能会允许访问其自己的软件包,以及一个或多个软件包组描述的任何软件包。如需详细了解可见性系统,请参阅 可见性 属性。

如果给定的软件包与 packages 属性匹配,或者已包含在 includes 属性中提及的其他软件包组之一中,则该软件包被视为属于该组。

软件包组在技术上是目标,但不是由规则创建的,并且本身没有任何可见性保护。

参数

属性 说明
name

名称;必需

此目标的唯一名称。

packages

字符串列表;默认值为 []

零个或多个软件包规范的列表。

每个软件包规范字符串可以具有以下形式之一:

  1. 软件包的完整名称,不包含其代码库,以 双斜杠开头。例如,//foo/bar 指定具有该名称且与软件包组位于同一代码库中的软件包组。
  2. 与上文相同,但带有尾随的 /...。例如, //foo/... 指定 //foo 及其所有 子软件包的集合。//... 指定当前代码库中的所有软件包。
  3. 字符串 publicprivate,分别指定每个软件包或没有软件包。(此形式需要 设置标志 --incompatible_package_group_has_public_syntax。)

此外,前两种软件包规范还可以 带有前缀 -,以表示它们被否定。

软件包组包含与至少一个肯定规范匹配且与任何否定规范都不匹配的任何软件包。例如,值 [//foo/..., -//foo/tests/...] 包含 //foo 的所有子软件包,这些子软件包不是 //foo/tests 的子软件包。(//foo 本身包含在内,而 //foo/tests 本身不包含在内。)

除了公开可见性之外,没有其他方法可以直接指定 当前代码库之外的软件包。

如果缺少此属性,则等同于将其设置为空列表,也等同于将其设置为仅包含 private 的列表。

注意: 在 Bazel 6.0 之前,规范 //... 的旧行为与 public 相同。启用 --incompatible_fix_package_group_reporoot_syntax 后,此行为已修复,这是 Bazel 6.0 之后的默认行为。

注意:在 Bazel 6.0 之前,当此属性作为 bazel query --output=proto(或 --output=xml)的一部分进行序列化时,系统会省略开头的斜杠。例如, //pkg/foo/... 将输出为 \"pkg/foo/...\"。启用 --incompatible_package_group_includes_double_slash 后,此行为已修复,这是 Bazel 6.0 之后的默认行为。

includes

标签列表;默认值为 []

此软件包组中包含的其他软件包组。

此属性中的标签必须引用其他软件包组。 引用的软件包组中的软件包被视为此 软件包组的一部分。这是可传递的 - 如果软件包组 a 包含软件包组 b,而 b 包含软件包组 c,则 c 中的每个软件包也将成为 a 的成员。

当与否定软件包规范一起使用时,请注意,每个组的软件包集首先是独立计算的,然后将结果合并在一起。这意味着,一个组中的否定 规范对另一个组中的规范没有影响。

示例

以下 package_group 声明指定了一个名为“tropical”的软件包组,其中包含热带水果。

package_group(
    name = "tropical",
    packages = [
        "//fruits/mango",
        "//fruits/orange",
        "//fruits/papaya/...",
    ],
)

以下声明指定了虚构应用的软件包组:

package_group(
    name = "fooapp",
    includes = [
        ":controller",
        ":model",
        ":view",
    ],
)

package_group(
    name = "model",
    packages = ["//fooapp/database"],
)

package_group(
    name = "view",
    packages = [
        "//fooapp/swingui",
        "//fooapp/webui",
    ],
)

package_group(
    name = "controller",
    packages = ["//fooapp/algorithm"],
)

exports_files

exports_files([label, ...], visibility, licenses)

exports_files() 指定属于 此软件包且导出到其他软件包的文件列表。

软件包的 BUILD 文件只能直接引用属于另一个软件包的源文件,前提是这些文件已通过 exports_files() 语句明确导出。详细了解 文件的可见性

作为旧版行为,凡是作为规则的输入提及的文件,都会以默认可见性导出,直到标志 --incompatible_no_implicit_file_export 被翻转为止。不过,不应依赖此行为,而应积极 迁移。

参数

该参数是当前软件包中文件名称的列表。您还可以指定可见性声明;在这种情况下,文件将对指定的目标可见。如果未指定可见性,则文件 将对每个软件包可见,即使在软件包的默认可见性 中指定了 package 函数也是如此。您还可以指定许可

示例

以下示例导出了 golden.txt,一个来自 test_data 软件包的文本文件,以便其他软件包可以使用它,例如在测试的 data 属性中使用。

# from //test_data/BUILD

exports_files(["golden.txt"])

glob

glob(include, exclude=[], exclude_directories=1, allow_empty=True)

Glob 是一种辅助函数,用于查找与特定路径模式匹配的所有文件,并返回一个包含这些文件路径的新列表(可变且已排序)。Glob 仅搜索其自己的软件包中的文件,并且仅查找源文件(而不是生成的文件或其他目标)。

如果源文件的软件包相对路径与任何 include 模式匹配,并且与任何 exclude 模式都不匹配,则该源文件的标签将包含在结果中。

includeexclude 列表包含相对于当前软件包的路径模式。每个模式可以包含一个或多个路径段。与 Unix 路径一样,这些段以 / 分隔。段可以包含 * 通配符:此通配符与路径段中的任何子字符串(甚至是空子字符串)匹配,但不包括目录分隔符 /。此通配符可以在一个路径段中多次使用。此外,** 通配符可以匹配零个或多个完整路径段,但必须声明为独立的路径段。

示例:
  • foo/bar.txt 与此软件包中的 foo/bar.txt 文件完全匹配
  • foo/*.txtfoo/ 目录中的每个文件匹配 如果文件以 .txt 结尾(除非 foo/ 是子软件包)
  • foo/a*.htm*foo/ 目录中以 a 开头、后跟任意字符串(可以 为空)、然后是 .htm、并以另一个任意字符串结尾的每个文件匹配; 例如 foo/axx.htmfoo/a.htmlfoo/axxx.html
  • **/a.txt 与此软件包的每个 子目录中的每个 a.txt 文件匹配
  • **/bar/**/*.txt 与此软件包的每个子目录中的每个 .txt 文件匹配,前提是结果路径上至少有一个目录名为 bar,例如 xxx/bar/yyy/zzz/a.txtbar/a.txt(请注意,** 也匹配零个段)或 bar/zzz/a.txt
  • ** 与此软件包的每个子目录中的每个文件匹配
  • foo**/a.txt 是无效的模式,因为 ** 必须 作为段单独存在

如果启用了 exclude_directories 参数(设置为 1),则结果中将省略目录类型的文件(默认值为 1)。

如果 allow_empty 参数设置为 False,则如果结果为空列表,glob 函数将出错。

有几个重要的限制和注意事项:

  1. 由于 glob() 在 BUILD 文件评估期间运行, glob() 仅匹配源代码树中的文件,而从不 匹配生成的文件。如果您要构建需要 源文件和生成文件的目标,则必须将生成文件的显式列表附加到 glob。请参阅下面的示例,其中包含 :mylib:gen_java_srcs

  2. 如果规则与匹配的源文件同名,则该规则将 "遮盖"该文件。

    为了理解这一点,请记住 glob() 返回的是路径列表,因此在其他规则的属性中使用 glob()(例如 srcs = glob(["*.cc"]))与显式列出匹配的路径具有相同的效果。例如,如果 glob() 生成 ["Foo.java", "bar/Baz.java"],但软件包中也有一个名为“Foo.java”的规则(这是允许的,尽管 Bazel 会发出警告),那么 glob() 的使用者将使用“Foo.java”规则 (其输出),而不是“Foo.java”文件。如需了解详情,请参阅 GitHub 问题 #10395

  3. Glob 可能会匹配子目录中的文件。 子目录名称 可能会使用通配符。不过…
  4. 标签不允许跨越软件包边界,并且 glob 不匹配子软件包中的文件。

    例如,如果 x/y作为软件包存在(无论是作为 x/y/BUILD还是软件包路径上的其他位置),则软件包 x中的 glob 表达式**/*.cc不包含x/y/z.cc。这意味着 glob 表达式的结果实际上取决于 BUILD 文件的存在 - 也就是说,如果没有名为 x/y 的软件包,或者使用 --deleted_packages 标志将其标记为已删除,则相同的 glob 表达式将包含 x/y/z.cc

  5. 上述限制适用于所有 glob 表达式, 无论它们使用哪个通配符。
  6. 文件名以 . 开头的隐藏文件完全匹配 *** 通配符。如果您想使用复合模式匹配隐藏文件 ,则模式需要以 . 开头。例如, *.*.txt 将匹配 .foo.txt,但 *.txt 不会。 隐藏目录也以相同的方式匹配。隐藏目录 可能包含不需要作为输入的文件,并且可能会增加 不必要地 globbed 文件的数量和内存消耗。如需排除 隐藏目录,请将其添加到“exclude”列表参数。
  7. “**”通配符有一个特殊情况:模式 "**" 与软件包的目录路径不匹配。也就是说,glob(["**"], exclude_directories = 0) 严格匹配当前软件包目录下的所有文件和目录(当然,不包括子软件包的目录 - 请参阅有关该内容的上一条注释)。

一般来说,您应该尝试提供适当的扩展名(例如 *.html),而不是对 glob 模式使用裸“*” 。更明确的名称既是自记录的,又可确保您不会意外匹配备份文件或 emacs/vi/... 自动保存文件。

编写构建规则时,您可以枚举 glob 的元素。这样就可以为每个输入生成单独的规则,例如。请参阅下面的 “展开的 glob 示例”部分。

Glob 示例

创建一个 Java 库,该库由该目录中的所有 Java 文件以及 :gen_java_srcs 规则生成的所有文件构建而成。

java_library(
    name = "mylib",
    srcs = glob(["*.java"]) + [":gen_java_srcs"],
    deps = "...",
)

genrule(
    name = "gen_java_srcs",
    outs = [
        "Foo.java",
        "Bar.java",
    ],
    ...
)

包含 testdata 目录中的所有 txt 文件,但 experimental.txt 除外。 请注意,testdata 子目录中的文件将不包含在内。如果您希望包含这些文件,请使用递归 glob (**)。

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(
        ["testdata/*.txt"],
        exclude = ["testdata/experimental.txt"],
    ),
)

递归 Glob 示例

使测试依赖于 testdata 目录及其任何 子目录(以及它们的子目录,依此类推)中的所有 txt 文件。 包含 BUILD 文件的子目录将被忽略。(请参阅上面的限制 和注意事项。)

sh_test(
    name = "mytest",
    srcs = ["mytest.sh"],
    data = glob(["testdata/**/*.txt"]),
)

创建一个库,该库由该目录中的所有 Java 文件以及所有子目录构建而成,但路径中包含名为 testing 的目录的子目录除外。 如果可能,应避免使用此模式,因为它可能会降低构建增量,从而增加构建时间。

java_library(
    name = "mylib",
    srcs = glob(
        ["**/*.java"],
        exclude = ["**/testing/**"],
    ),
)

展开的 Glob 示例

在当前目录中为 *_test.cc 创建单独的 genrule,用于统计文件中的行数。

# Conveniently, the build language supports list comprehensions.
[genrule(
    name = "count_lines_" + f[:-3],  # strip ".cc"
    srcs = [f],
    outs = ["%s-linecount.txt" % f[:-3]],
    cmd = "wc -l $< >$@",
 ) for f in glob(["*_test.cc"])]

如果上面的 BUILD 文件位于软件包 //foo 中,并且该软件包包含三个匹配的文件 a_test.cc、b_test.cc 和 c_test.cc,那么运行 bazel query '//foo:all' 将列出生成的所有规则:

$ bazel query '//foo:all' | sort
//foo:count_lines_a_test
//foo:count_lines_b_test
//foo:count_lines_c_test

select

select(
    {conditionA: valuesA, conditionB: valuesB, ...},
    no_match_error = "custom message"
)

select() 是使规则属性 可配置的辅助函数。 它可以替换 几乎 任何属性赋值的右侧,因此其值取决于命令行 Bazel 标志。 例如,您可以使用此函数定义特定于平台的依赖项,或者根据规则是在“开发者”模式还是“发布”模式下构建来 嵌入不同的资源。

基本用法如下:

sh_binary(
    name = "mytarget",
    srcs = select({
        ":conditionA": ["mytarget_a.sh"],
        ":conditionB": ["mytarget_b.sh"],
        "//conditions:default": ["mytarget_default.sh"]
    })
)

这会通过将 srcs 属性的 常规标签 列表赋值替换为将配置条件映射到匹配值的 select 调用,使 sh_binary 可配置。每个条件都是对 config_settingconstraint_value 的标签引用,如果目标的配置与预期的一组值匹配,则该条件将“匹配”。然后,mytarget#srcs 的值将成为与当前调用匹配的任何 标签列表。

注意:

  • 在任何调用中,都只会选择一个条件。
  • 如果多个条件匹配,并且其中一个条件是其他条件的特例, 则特例优先。如果条件 B 具有与条件 A 相同的所有标志和限制值,外加一些额外的标志或限制值,则条件 B 被视为条件 A 的特例。这也意味着,特例解析并非旨在创建排序,如下面的示例 2 所示。
  • 如果多个条件匹配,并且其中一个条件不是所有其他条件的特例,则 Bazel 会失败并显示错误,除非所有条件都解析为相同的值。
  • 如果没有其他条件匹配,则特殊伪标签 //conditions:default 被视为匹配。如果省略此条件 ,则必须匹配其他规则以避免错误。
  • select 可以嵌入到更大的属性赋值中。因此,srcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...}) srcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]}) 是有效的表达式。
  • select 适用于大多数属性,但并非所有属性。不兼容的 属性在其文档中标记为 nonconfigurable

    subpackages

    subpackages(include, exclude=[], allow_empty=True)

    subpackages() 是一个辅助函数,类似于 glob() ,但它列出的是子软件包,而不是文件和目录。它使用与 glob() 相同的 路径模式,并且可以匹配当前加载的 BUILD 文件的任何 直接后代子软件包。如需详细了解包含和 排除模式并查看相关示例,请参阅 glob

    返回的子软件包列表按排列顺序排列,并且包含 与当前加载软件包相关的路径,这些路径与 include 中的给定模式匹配,但不与 exclude 中的模式匹配。

    示例

    以下示例列出了软件包 foo/BUILD 的所有直接子软件包

    # The following BUILD files exist:
    # foo/BUILD
    # foo/bar/baz/BUILD
    # foo/sub/BUILD
    # foo/sub/deeper/BUILD
    #
    # In foo/BUILD a call to
    subs = subpackages(include = ["**"])
    
    # results in subs == ["sub", "bar/baz"]
    #
    # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of
    # 'foo'
    

    一般来说,建议用户使用 skylib 的“subpackages”模块,而不是直接调用此函数。