目录
包裹
package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)
此函数用于声明适用于 软件包。在软件包 (BUILD 文件) 中最多使用一次。
对于声明将元数据应用于整个
代码库中的示例，请使用repo()
REPO.bazel 文件。
repo() 函数所采用的参数与 package() 完全相同。
应在所有 load() 语句后调用 package() 函数， 文件。
参数
| 属性 | 说明 |
|---|---|
default_applicable_licenses |
|
default_visibility |
标签列表；默认值为 此软件包中规则的默认可见性。 此包中的每个规则都具有此
属性（除非 |
default_deprecation |
String;默认值为 设置默认
此软件包中所有规则的 |
default_package_metadata |
标签列表；默认值为 设置适用于软件包中所有其他目标的默认元数据目标列表。 这些通常是与 OSS 软件包和许可声明相关的目标。 有关示例，请参阅 rules_license。 |
default_testonly |
布尔值；默认值为 为此软件包中的所有规则设置默认的 在 |
features |
列表字符串；默认值为 设置影响此 BUILD 文件语义的各种标记。 此功能主要供构建系统开发者用来 为需要特殊处理的软件包添加代码。除非 由构建系统工作者明确请求。 |
示例
以下声明声明此软件包中的规则仅对软件包组//foo:target 的成员可见。规则上的各个公开声明（如果有）会覆盖此规范。
package(default_visibility = ["//foo:target"])
package_group
package_group(name, packages, includes)
此函数定义了一组软件包
并将标签与集合相关联。您可以在 visibility 属性中引用该标签。
软件包组主要用于控制可见性。源代码树中的每个软件包都可以引用公开可见的目标。私有 可见目标只能在其自己的软件包（而不是子软件包）中引用。 在这两种极端情况之间，目标可能会允许访问其自己的软件包以及一个或多个软件包组描述的任何软件包。如需详细了解公开范围系统，请参阅公开范围属性。
如果指定软件包与
packages 属性，或已包含在其中一个属性中
includes 属性中提到的软件包组。
从技术层面来看，软件包组是目标，但不是由规则创建的，并且本身没有任何公开范围保护。
参数
| 属性 | 说明 |
|---|---|
name |
名称；必需 此目标的唯一名称。 |
packages |
字符串列表；默认值为 零个或多个软件包规范的列表。 每个软件包规范字符串都可以包含以下某一项 表单：
此外，前两种软件包规范还可以加上 软件包组包含与至少一个项匹配的任何软件包
所有肯定性规范均未包含，且均未包含
例如，值 除了公开可见性之外，没有任何方法可以直接指定当前代码库之外的软件包。 如果缺少此属性，则等同于将其设置为空列表，这也等同于将其设置为仅包含 注意：在 Bazel 6.0 之前，规范 注意：在 Bazel 6.0 之前，如果此属性作为 |
includes |
标签列表；默认值为 此方案中包含的其他软件包组。 此属性中的标签必须引用其他软件包组。
所引用软件包组中的软件包会纳入此
软件包组。这种关系是传递性的：如果软件包组 请注意，与否定软件包规范搭配使用时，系统会先独立计算每个组的软件包集，然后将结果联接在一起。这意味着，一个组中的否定规范不会影响另一个组中的规范。 |
示例
以下 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 格式。
include 和 exclude 列表包含路径模式
相对于当前软件包的出价每个模式都可能由一个或多个路径片段组成。与 Unix 路径一样，这些片段由 / 分隔。系统会将模式中的路径段与路径的路径段进行匹配。片段可能包含 * 通配符：此匹配
路径段中的任何子字符串（即使是空子字符串），不包括
目录分隔符 /。此通配符可以在一个路径段中多次使用。此外，** 通配符可以与零个或多个完整路径段匹配，但必须声明为独立路径段。
foo/bar.txt与foo/bar.txt文件完全匹配 （除非foo/是子软件包）foo/*.txt会匹配foo/目录中的每个文件 如果文件以.txt结尾（除非foo/是 子包）foo/a*.htm*匹配foo/目录中以a开头、包含任意字符串（可以为空）、包含.htm且以另一个任意字符串结尾的每个文件（除非foo/是子软件包）；例如foo/axx.htm和foo/a.html或foo/axxx.htmlfoo/*会匹配foo/目录中的每个文件， （除非foo/是子软件包）；它与foo不匹配 目录本身，即使exclude_directories设置为 0 次foo/**会匹配每个非子软件包子目录中的每个文件 位于软件包的第一级子目录foo/下；如果exclude_directories设置为 0、foo目录本身也与模式匹配；在此示例中，**被视为与零路径段匹配**/a.txt与此软件包的a.txt文件匹配 目录以及非子软件包子目录。**/bar/**/*.txt会匹配以下中的每个.txt文件： 此软件包的非子软件包子目录（如果 生成的路径称为bar，例如xxx/bar/yyy/zzz/a.txt或bar/a.txt（请注意，**也与零个细分匹配）或bar/zzz/a.txt**会匹配以下项中的每个非子软件包子目录中的每个文件： 此软件包foo**/a.txt是一个无效的模式，因为**必须作为一个片段独立存在foo/是一个无效的模式，因为在/后面定义的第二个路段为空字符串
如果启用了 exclude_directories 参数（设置为 1），则结果中将省略目录类型的文件（默认值为 1）。
如果 allow_empty 参数设置为 False，
glob如果结果为
空列表。
下面是一些重要的限制和注意事项：
-
由于
glob()在 BUILD 文件评估期间运行，因此glob()仅与源代码树中的文件匹配，而不会与生成的文件匹配。如果您构建的目标同时需要 则您必须明确地附上 复制到 glob。请参阅下面使用:mylib和:gen_java_srcs的示例。 -
如果规则的名称与匹配的源文件相同，则该规则将“掩盖”该文件。
为了理解这一点，请注意，
glob()会返回 因此，在其他规则中使用glob()属性（例如srcs = glob(["*.cc"])）与列出 匹配路径。例如，如果glob()生成["Foo.java", "bar/Baz.java"]，但软件包中还有一个名为“Foo.java”的规则（允许这样，但 Bazel 会发出警告），则glob()的使用方将使用“Foo.java”规则（其输出）而非“Foo.java”文件。请参阅 GitHub 问题 #10395 了解详情。 - 通配符可以与子目录中的文件匹配。子目录名称可以使用通配符。但是...
-
标签不允许跨越软件包边界，而 glob 则跨越软件包边界 不匹配子包中的文件。
例如，软件包中的 glob 表达式
**/*.cc如果符合以下情况，则x不包含x/y/z.cc：x/y以软件包的形式存在（作为x/y/BUILD或软件包路径上的其他位置）。这个 而 glob 表达式的结果实际上取决于 是否存在 BUILD 文件，也就是说，相同的 glob 表达式将 如果未调用任何软件包，则包含x/y/z.ccx/y，或使用 --deleted_packages 标记。 - 上述限制适用于所有全局通配符表达式，无论它们使用哪种通配符。
-
文件名以
.开头的隐藏文件与**和*通配符完全匹配。如果您想使用复合模式匹配隐藏文件，则模式需要以.开头。例如，*和.*.txt将与.foo.txt匹配，但*.txt则不会。 系统也会以相同的方式匹配隐藏目录。隐藏目录 可能包含并不需要作为输入的文件， 不必要的全局性文件数量和内存消耗。排除 隐藏目录，请将它们添加到“排除”list 参数。 -
“**”通配符有一个极端情况：模式
"**"与软件包的目录路径不匹配。也就是说， 例如，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 中添加除了 experiment.txt 之外的所有 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(
{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"]
})
)
这样，通过将 sh_binary 的正常标签列表赋值替换为将配置条件映射到匹配值的 select 调用，即可使 sh_binary 的 srcs 属性可配置。每个条件都是一个标签
引用
config_setting 或
constraint_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(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/bar/but/bad/BUILD # foo/sub/BUILD # foo/sub/deeper/BUILD # # In foo/BUILD a call to subs1 = subpackages(include = ["**"]) # results in subs1 == ["sub", "bar/baz", "bar/but/bad"] # # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of # 'foo' subs2 = subpackages(include = ["bar/*"]) # results in subs2 = ["bar/baz"] # # Since 'bar' is not a subpackage itself, this looks for any subpackages under # all first level subdirectories of 'bar'. subs3 = subpackages(include = ["bar/**"]) # results in subs3 = ["bar/baz", "bar/but/bad"] # # Since bar is not a subpackage itself, this looks for any subpackages which are # (1) under all subdirectories of 'bar' which can be at any level, (2) not a # subpackage of another subpackages. subs4 = subpackages(include = ["sub"]) subs5 = subpackages(include = ["sub/*"]) subs6 = subpackages(include = ["sub/**"]) # results in subs4 and subs6 being ["sub"] # results in subs5 = []. # # In subs4, expression "sub" checks whether 'foo/sub' is a package (i.e. is a # subpackage of 'foo'). # In subs5, "sub/*" looks for subpackages under directory 'foo/sub'. Since # 'foo/sub' is already a subpackage itself, the subdirectories will not be # traversed anymore. # In subs6, 'foo/sub' is a subpackage itself and matches pattern "sub/**", so it # is returned. But the subdirectories of 'foo/sub' will not be traversed # anymore.
一般来说，用户最好使用 skylib 的“subpackages”模块，而不是直接调用此函数。