本页是当您使用 bazel query
分析构建依赖项时使用的 Bazel 查询语言的参考手册。以及 bazel query
支持的输出格式。
如需了解实际用例,请参阅 Bazel 查询操作方法。
其他查询参考文档
除了在加载后的目标目标图上运行的 query
之外,Bazel 还包含操作图查询和可配置的查询。
操作图查询
操作图查询 (aquery
) 针对分析后配置的目标图运行,并公开有关操作、工件及其关系的信息。如果您对通过配置的目标图表生成的操作/工件的属性感兴趣,aquery
非常有用。例如,实际的命令及其输入、输出和记忆符。
如需了解详情,请参阅查询参考。
可配置的查询
传统 Bazel 查询在加载后阶段的目标图上运行,因此不存在配置及其相关概念的概念。值得注意的是,它无法正确解析 select 语句,而是会返回所有可能的选择分辨率。但是,可配置的查询环境 cquery
可正确处理配置,但无法提供此原始查询的所有功能。
如需了解详情,请参阅 cquery 参考文档。
示例
用户如何使用bazel query
?以下是典型的示例:
为什么 //foo
树依赖于 //bar/baz
?
显示路径:
somepath(foo/..., //bar/baz:all)
所有 foo
测试都依赖于 foo_bin
目标不依赖哪些 C++ 库?
kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo:foo_bin))
令牌:词法语法
查询语言中的表达式由以下令牌组成:
关键字,例如
let
。关键字是语言的保留字词,下文对每个关键字进行了介绍。完整的关键字集合如下:字词,例如“
foo/...
”“.*test rule
”或“//bar/baz:all
”。如果字符序列“加引号”(以单引号开头和结尾,或以双引号开头和结尾),则是一个单词。即使不加引号的字符序列,也仍然可以解析为字词。不带引号的字词是指从字母 A-Za-z 中提取的数字序列、数字 0-9 以及特殊字符*/@.-_:$~[]
(星号、正斜杠、句号、连字符、下划线、冒号、美元符号、波浪线、左方括号、右方括号)。不过,不带引号的字词不得以连字符-
或星号*
开头,即使相对 [目标名称][(/concepts/labels#target-name)可以以这些字符开头。此外,不带引号的字词不能包含字符加号
+
或等号=
,尽管这些字符可以在目标名称中使用。在编写可生成查询表达式的代码时,应该用引号将目标名称引起来。在编写根据用户提供的值构建 Bazel 查询表达式的脚本时,必须引用。
//foo:bar+wiz # WRONG: scanned as //foo:bar + wiz. //foo:bar=wiz # WRONG: scanned as //foo:bar = wiz. "//foo:bar+wiz" # OK. "//foo:bar=wiz" # OK.
请注意,此引号是对 shell 可能需要的任何引号进行的补充,例如:
bazel query ' "//foo:bar=wiz" ' # single-quotes for shell, double-quotes for Bazel.
关键字和运算符在引用时将被视为普通字词。例如,
some
是一个关键字,但“some”是一个单词。foo
和“foo”都是字词。不过,在目标名称中使用单引号或双引号时,请务必小心。引用一个或多个目标名称时,只能使用一种引号(无论是单引号还是全双引号)。
以下是 Java 查询字符串的示例:
'a"'a' # WRONG: Error message: unclosed quotation. "a'"a" # WRONG: Error message: unclosed quotation. '"a" + 'a'' # WRONG: Error message: unexpected token 'a' after query expression '"a" + ' "'a' + "a"" # WRONG: Error message: unexpected token 'a' after query expression ''a' + ' "a'a" # OK. 'a"a' # OK. '"a" + "a"' # OK "'a' + 'a'" # OK
之所以选择这种语法,是为了在大多数情况下不需要引号。(异常)
".*test rule"
示例需要引用:它以英文句点开头,并包含一个空格。不引用"cc_library"
是没有必要但无害的。标点,例如英文圆括号
()
、英文句点.
和英文逗号,
。必须引用包含标点符号的字词(上面列出的例外情况除外)。
引用的字词之外的空格字符将被忽略。
Bazel 查询语言概念
Bazel 查询语言是一种表达式语言。每个表达式的评估结果都是部分排序的目标,或等效的目标图 (DAG)。这是唯一的数据类型。
集和图指的是相同的数据类型,但应重点展现不同的数据类型,例如:
- 设置:目标的部分顺序不感兴趣。
- 图表:目标的部分顺序是非常重要的。
依赖关系图中的周期
构建依赖关系图应该是循环的。
查询语言使用的算法适用于无环图,但对于循环而言非常可靠。有关如何处理周期的详细信息未指定且不应依赖。
隐式依赖项
除了在 BUILD
文件中明确定义的构建依赖项之外,Bazel 还会向规则添加额外的隐式依赖项。例如,每条 Java 规则都隐式依赖于 JavaBuilder。隐式依赖项是使用以 $
开头的属性建立的,不能在 BUILD
文件中替换。
默认情况下,bazel query
会在计算查询结果时考虑隐式依赖项。此行为可通过 --[no]implicit_deps
选项进行更改。请注意,由于查询不考虑配置,因此绝不会考虑潜在的工具链。
音效
Bazel 查询语言表达式针对构建依赖关系图运行,该构建图由所有 BUILD
文件中的所有规则声明隐式定义。请务必注意,此图表有点抽象,并不完整说明如何执行构建的所有步骤。若要执行构建,还必须进行配置;如需了解详情,请参阅《用户指南》的配置部分。
对于所有配置,用 Bazel 查询语言评估表达式的结果是真实的,这意味着这可能是一个保守的过近似值,而不是非常精确。如果您使用查询工具计算构建期间所需的所有源代码集,它报告的数据可能会比实际需要的数据多,因为举例来说,查询工具将包含支持消息转换所需的所有文件,即使您不打算在 build 中使用该功能,也是如此。
关于保存图表顺序
操作会保留从其子表达式继承的任何排序约束。您可以将其视为“部分顺序保护法”。例如,如果您发出查询以确定特定目标的依赖项的传递关闭,则生成的集将根据依赖关系图进行排序。如果您进行过滤以仅包含 file
类型的目标,则系统会在生成的子集中的每对目标之间保留相同的传递部分排序关系,即使这些键值对实际上都未直接连接在原始图中。(build 依赖关系图中没有文件文件边缘)。
不过,虽然所有运算符保留顺序,但有些操作(如设置操作)不会引入它们自己的任何排序约束。考虑以下表达式:
deps(x) union y
最终结果集一定能保证其子表达式的所有排序约束条件,即 x
的所有传递依赖项均正确排序。但是,查询无法保证关于 y
中目标的顺序,也无法保证 deps(x)
中目标相对于 y
中的排序(y
中的目标也正好位于 deps(x)
中)。
引入排序约束的运算符包括 allpaths
、deps
、rdeps
、somepath
和目标模式通配符 package:*
、dir/...
等。
天空查询
Sky Query 是一种在特定范围中运行的查询模式。
仅适用于 SkyQuery 的特殊函数
Sky 查询模式具有额外的查询函数 allrdeps
和 rbuildfiles
。这些函数适用于整个宇宙范围(这就是为什么它们不适用于正常查询的原因)。
指定宇宙范围
Sky 查询模式通过传递以下两个标志(--universe_scope
或 --infer_universe_scope
)和 --order_output=no
被启用。--universe_scope=<target_pattern1>,...,<target_patternN>
会指示查询预加载由目标模式指定的目标模式的传递闭包,目标模式可以是累加和减法。然后,此查询会评估所有查询。具体而言,allrdeps
和 rbuildfiles
运算符仅返回此范围内的结果。--infer_universe_scope
告诉 Bazel,根据查询表达式推断 --universe_scope
的值。此推断值是查询表达式中的唯一目标模式的列表,但这可能并不是您想要的。例如:
bazel query --infer_universe_scope --order_output=no "allrdeps(//my:target)"
此查询表达式中的唯一目标模式列表是 ["//my:target"]
,因此 Bazel 会将其视为调用相同:
bazel query --universe_scope=//my:target --order_output=no "allrdeps(//my:target)"
但使用 --universe_scope
执行该查询的结果仅为 //my:target
;根据构造,//my:target
的反向依赖项都不是在同一个宇宙中!另一方面,请考虑:
bazel query --infer_universe_scope --order_output=no "tests(//a/... + b/...) intersect allrdeps(siblings(rbuildfiles(my/starlark/file.bzl)))"
这是一个有意义的查询调用,会尝试计算一些目录下测试目标的 tests
扩展,这些目录以传递方式依赖于定义使用特定 .bzl
文件的目标。在这里,--infer_universe_scope
非常方便,尤其是在选择 --universe_scope
时,您必须自行解析查询表达式。
因此,对于使用通用范围运算符(如 allrdeps
和 rbuildfiles
)的查询表达式,请务必仅在其行为符合预期时才使用 --infer_universe_scope
。
与默认查询相比,Sky Query 具有一些优缺点。主要缺点是无法根据图表顺序对其输出进行排序,因此不允许使用某些输出格式。其优势在于,它提供两个默认查询中不提供的运算符(allrdeps
和 rbuildfiles
)。
同样,Sky Query 通过自省 Skyframe 图表来工作,而不是创建新图表(这是默认实现的作用)。因此,在某些情况下,它速度更快,使用的内存更少。
表达式:语法和语法
以下是 Bazel 查询语言的语法,使用 EBNF 表示法:
expr ::= word
| let name = expr in expr
| (expr)
| expr intersect expr
| expr ^ expr
| expr union expr
| expr + expr
| expr except expr
| expr - expr
| set(word *)
| word '(' int | word | expr ... ')'
以下部分依次介绍了此语法的每种形式。
目标模式
expr ::= word
对语法而言,“目标模式”只是一个词。系统会将其视为(无序)目标集。最简单的目标模式是标签,用于标识单个目标(文件或规则)。例如,目标模式 //foo:bar
的求值结果集包含一个元素,即目标,即 bar
规则。
目标模式对标签进行泛化处理,以包括通配符而不是软件包和目标。例如,foo/...:all
(或者仅 foo/...
)是一个目标模式,其求值结果集包含 foo
目录下每个软件包中的所有规则;bar/baz:all
是一个目标模式,求得的值为 bar/baz
软件包中的所有规则,但不是其子软件包。
同样,foo/...:*
是一个目标模式,求值为 foo
目录下以递归方式包含每个软件包中的所有目标(规则和文件)集;bar/baz:*
求值为 bar/baz
软件包中所有目标集,但不包含其子软件包。
由于 :*
通配符匹配文件以及规则,因此它在查询中通常比 :all
更有用。相反,:all
通配符(在 foo/...
等目标模式中隐式)通常对 build 更有用。
bazel query
目标模式与 bazel build
build 目标的工作方式相同。如需了解详情,请参阅目标模式或输入 bazel help target-syntax
。
如果目标模式与目标不匹配,则目标模式可以评估为单例集(如果是标签),则集中到包含许多元素的集合(例如,foo/...
具有数千个元素)或空集。
目标模式表达式的结果中的所有节点都会根据依赖关系相互正确排序。因此,foo:*
的结果不仅是软件包 foo
中的目标集,还是这些目标的图。(无法保证结果节点相对于其他节点的相对顺序。)如需了解详情,请参阅图表顺序部分。
变量
expr ::= let name = expr1 in expr2
| $name
Bazel 查询语言允许定义和引用变量。let
表达式的评估结果与 expr2 的评估结果相同,只是变量的所有可用 name 值替换为 expr1 的值。
例如,let v = foo/... in allpaths($v, //common) intersect $v
相当于 allpaths(foo/...,//common) intersect foo/...
。
如果某个变量引用 name
并未包含在封装的 let name = ...
表达式中,则出现错误。换句话说,顶级查询表达式不能包含自由变量。
在上述语法中,name
与 word 类似,但有一个额外限制,即它是 C 编程语言中的法律标识符。必须在变量前面加上“$”字符。
每个 let
表达式仅定义一个变量,但您可以嵌套它们。
目标模式和变量引用都只包含一个令牌(一个单词),会产生语法歧义。不过,没有语义上的歧义,因为属于法定变量名称的字词子集与合法目标格式的字词子集并无交集。
从技术上讲,let
表达式不会提高查询语言的表达能力:采用该语言表达的任何查询也可以在没有这些表达式的情况下表达。不过,它们可以提高许多查询的简洁性,还可以提高查询评估的效率。
带括号的表达式
expr ::= (expr)
圆括号通过关联子表达式来强制计算顺序。 圆括号的表达式的计算结果为该参数的值。
代数集运算:交集、并集、集差异
expr ::= expr intersect expr
| expr ^ expr
| expr union expr
| expr + expr
| expr except expr
| expr - expr
这三个运算符会计算其参数的常规设置运算。每个运算符都有两种形式,一种是名词形式(如 intersect
),一种符号形式(如 ^
)。这两种形式是等效的;符号形式的输入速度更快。(为清楚起见,本页面的其余部分使用了标称形式)。
例如
foo/... except foo/bar/...
求出的匹配目标集与 foo/...
匹配,但与 foo/bar/...
不匹配。
您可以编写如下查询:
foo/... - foo/bar/...
intersect
(^
) 和 union
(+
) 操作是交换的(对称);except
(-
) 是非对称的。解析器会将这三个运算符视为左关联和同等优先级,因此您可能需要用括号。例如,前两个表达式是等效的,但第三个表达式不是:
x intersect y union z
(x intersect y) union z
x intersect (y union z)
从外部来源读取目标:set
expr ::= set(word *)
set(a b c ...)
运算符会计算一组零或多个目标模式的并集,这些模式以空格分隔(无英文逗号)。
结合 Bourne shell 的 $(...)
功能,set()
提供了一种方法来将某个查询的结果保存在常规文本文件中,使用其他程序(如标准 UNIX shell 工具)处理该文本文件,然后将结果作为值引入查询工具进行进一步处理。例如:
bazel query deps(//my:target) --output=label | grep ... | sed ... | awk ... > foo
bazel query "kind(cc_binary, set($(<foo)))"
在下一个示例中,kind(cc_library, deps(//some_dir/foo:main, 5))
是使用 awk
程序按 maxrank
值进行过滤计算得出的。
bazel query 'deps(//some_dir/foo:main)' --output maxrank | awk '($1 < 5) { print $2;} ' > foo
bazel query "kind(cc_library, set($(<foo)))"
在这些示例中,$(<foo)
是 $(cat foo)
的简写形式,但您也可以使用 cat
以外的 shell 命令(例如之前的 awk
命令)。
函数
expr ::= word '(' int | word | expr ... ')'
查询语言定义了多个函数。函数的名称决定了它需要的参数数量和类型。可用函数如下:
allpaths
attr
buildfiles
rbuildfiles
deps
filter
kind
labels
loadfiles
rdeps
allrdeps
same_pkg_direct_rdeps
siblings
some
somepath
tests
visible
依赖项的传递闭包:依赖项
expr ::= deps(expr)
| deps(expr, depth)
deps(x)
运算符会对其参数集 x 的依赖项的传递闭包形成的图求值。例如,deps(//foo)
的值是基于单个节点 foo
的依赖关系图,包括其所有依赖项。deps(foo/...)
的值是依赖关系图,其根是 foo
目录下每个软件包中的所有规则。在这种情况下,“依赖项”仅指规则和文件目标,因此创建这些目标所需的 BUILD
和 Starlark 文件未包含在内。为此,您应该使用 buildfiles
运算符。
生成的图将根据依赖关系关系进行排序。如需了解详情,请参阅有关图表顺序的部分。
deps
运算符接受可选的第二个参数,这是一个用于指定搜索深度上限的整数字面量。因此,deps(foo:*, 0)
会返回 foo
软件包中的所有目标,deps(foo:*, 1)
还包含 foo
软件包中任何目标的直接前提条件,而 deps(foo:*, 2)
还包含直接从 deps(foo:*, 1)
中的节点可以访问的节点,依此类推。(这些数字对应于 minrank
输出格式中显示的排名。)
如果省略 depth 参数,搜索将是无界限的:它会计算前提条件的反射传递关闭。
反向依赖项的传递闭包:rdeps
expr ::= rdeps(expr, expr)
| rdeps(expr, expr, depth)
rdeps(u, x)
运算符会计算宇宙集 u 的传递闭包中的参数集 x 的反向依赖项。
生成的图将根据依赖关系关系进行排序。如需了解详情,请参阅有关图表顺序的部分。
rdeps
运算符接受可选的第三个参数,该参数是一个用于指定搜索深度上限的整数字面量。生成的图仅包含指定深度与参数集中的任意节点相距指定范围内的节点。因此,rdeps(//foo, //common, 1)
会针对 //foo
的传递闭包中直接依赖于 //common
的所有节点求值。(这些数字对应于 minrank
输出格式中显示的排名。)如果省略 depth 参数,搜索将是无界限的。
以传递方式关闭所有反向依赖项:allrdeps
expr ::= allrdeps(expr)
| allrdeps(expr, depth)
allrdeps
运算符的行为方式与 rdeps
运算符类似,不同之处在于“宇宙集”是 --universe_scope
标志的评估结果,而不是单独指定。因此,如果传递了 --universe_scope=//foo/...
,则 allrdeps(//bar)
相当于 rdeps(//foo/..., //bar)
。
同一软件包中的直接反向依赖项:same_pkg_direct_rdeps
expr ::= same_pkg_direct_rdeps(expr)
same_pkg_direct_rdeps(x)
运算符会针对与参数集内的某个目标位于同一软件包的整套目标求值,这些目标直接依赖于它。
处理目标软件包:同级
expr ::= siblings(expr)
siblings(x)
运算符的求值结果与参数集内的某个目标位于同一软件包中的所有目标集。
任意选择:部分
expr ::= some(expr)
| some(expr, count )
some(x, k)
运算符最多会从其参数集 x 中任意选择 k 个目标,并求得仅包含这些目标的集合。参数 k 是可选的;如果缺失,结果将是仅包含一个任意选择的目标的单例集。如果参数集 x 的大小小于 k,系统将返回整个参数集 x。
例如,表达式 some(//foo:main union //bar:baz)
求值为包含 //foo:main
或 //bar:baz
的单例集,但二者未定义。表达式 some(//foo:main union //bar:baz, 2)
或 some(//foo:main union //bar:baz, 3)
会返回 //foo:main
和 //bar:baz
。
如果参数是单例,则 some
会计算身份函数:some(//foo:main)
相当于 //foo:main
。
如果指定的参数集为空(如表达式 some(//foo:main intersect //bar:baz)
),则会出错。
路径运算符:somepath、allpath
expr ::= somepath(expr, expr)
| allpaths(expr, expr)
somepath(S, E)
和 allpaths(S, E)
运算符计算两组目标之间的路径。这两个查询都接受两个参数,一组起点 S,一组 E 终点。somepath
返回从 S 的目标到 E 中某个目标的任意路径上的节点图;allpaths
返回从 S 中的任何目标到 E 中的任何目标的节点的路径图。
生成的图表按照依赖关系关系进行排序。 如需了解详情,请参阅有关图表顺序的部分。
somepath(S1 + S2, E) ,可能有 1 个结果。 |
somepath(S1 + S2, E) ,这是可能出现的另一个结果。 |
allpaths(S1 + S2, E) |
目标种类过滤:种类
expr ::= kind(word, expr)
kind(pattern, input)
运算符会对一组目标应用过滤条件,并舍弃这些非预期目标。pattern 参数指定要匹配的目标类型。
例如,下表所示的 BUILD
文件(针对软件包 p
)定义的四个目标的种类:
编码 | 目标 | 种类 |
---|---|---|
genrule( name = "a", srcs = ["a.in"], outs = ["a.out"], cmd = "...", ) |
//p:a |
genrule 规则 |
//p:a.in |
源文件 | |
//p:a.out |
生成的文件 | |
//p:BUILD |
源文件 |
因此,kind("cc_.* rule", foo/...)
会针对 foo
下的所有 cc_library
、cc_binary
等规则目标求值,而 kind("source file", deps(//foo))
的求值结果为 //foo
目标的传递性闭包中的所有源文件。
通常情况下,必须使用 pattern 参数,因为如果没有该参数,解析器就不会将许多正则表达式(如 source
file
和 .*_test
)视为字词。
匹配 package group
时,以 :all
结尾的目标可能不会产生任何结果。请改用 :all-targets
。
目标名称过滤:过滤条件
expr ::= filter(word, expr)
filter(pattern, input)
运算符会对一组目标应用过滤条件,并舍弃标签(绝对形式)与模式不匹配的目标;它会评估为其输入的子集。
第一个参数 pattern 是一个包含正则表达式(高于目标名称)的单词。filter
表达式会针对包含所有目标 x 的集求值,使 x 是集 input 的成员,并且 x 的标签(以绝对形式,如 //foo:bar
)包含正则表达式 pattern 的(未锚定)匹配项。由于所有目标名称都以 //
开头,因此可以用作 ^
正则表达式锚点的替代方案。
此运算符通常比 intersect
运算符提供更快、更强大的替代方案。例如,如需查看 //foo:foo
目标的所有 bar
依赖项,您可以评估
deps(//foo) intersect //bar/...
但是,此语句需要解析 bar
树中的所有 BUILD
文件,这样会很慢,并且容易出现不相关的 BUILD
文件中的错误。另一种方法是:
filter(//bar, deps(//foo))
该类会先计算一组 //foo
依赖项,然后仅过滤与所提供的模式匹配的目标(换句话说,名称包含 //bar
作为子字符串的目标)。
filter(pattern,
expr)
运算符的另一个常见用途是按名称或扩展名过滤特定文件。例如
filter("\.cc$", deps(//foo))
会提供用于构建 //foo
的所有 .cc
文件的列表。
规则属性过滤:属性
expr ::= attr(word, word, expr)
attr(name, pattern, input)
运算符会对一组目标应用过滤条件,舍弃非规则的目标、未定义 name 规则的规则目标、或特性目标与提供的正则表达式 pattern 不匹配的规则目标;它会计算其输入的子集。
第一个参数 name 是应与所提供的正则表达式模式匹配的规则特性的名称。第二个参数 pattern 是属性值的正则表达式。attr
表达式的计算结果为包含所有目标 x 的集,因此 x 是集 input 的成员、具有已定义的属性 name 的规则,并且属性值包含正则表达式 pattern 的(未锚定)匹配项。如果 name 是一个可选属性,并且规则未明确指定该属性,则使用默认属性值进行比较。例如
attr(linkshared, 0, deps(//foo))
会选择所有具有链接共享属性(例如 cc_binary
规则)且明确将此项设置为 0 或者根本不设置此值(例如对于 cc_binary
规则)的依赖项。//foo
列表类型属性(例如 srcs
、data
等)会转换为 [value<sub>1</sub>, ..., value<sub>n</sub>]
形式的字符串,以 [
括号开头,结尾为 ]
括号,并使用“,
”(英文逗号、空格)分隔多个值。使用标签的绝对形式将标签转换为字符串。例如,属性 deps=[":foo",
"//otherpkg:bar", "wiz"]
将转换为字符串 [//thispkg:foo, //otherpkg:bar, //thispkg:wiz]
。括号始终存在,因此空列表将使用字符串值 []
进行匹配。例如
attr("srcs", "\[\]", deps(//foo))
将选择 //foo
依赖项具有 srcs
属性为空的所有规则,而
attr("data", ".{3,}", deps(//foo))
将在 //foo
依赖项中选择所有规则,这些依赖项在 data
属性中至少指定一个值(由于 //
和 :
,每个标签的长度至少为 3 个字符)。
如需在列表类型特性中选择具有特定 value
的 //foo
依赖项之间的所有规则,请使用
attr("tags", "[\[ ]value[,\]]", deps(//foo))
之所以能正常运行,是因为 value
之前的字符是 [
或空格,value
后面的字符是英文逗号或 ]
。
规则公开范围过滤:可见
expr ::= visible(expr, expr)
visible(predicate, input)
运算符会对一组目标应用过滤条件,并舍弃没有必要可见性的目标。
第一个参数 predicate 是输出中的所有目标都必须可见的一组目标。visible 表达式会针对包含所有目标 x 的集求值,使 x 是集 input 的成员,并且对 predicate 中的所有目标 y 可见 y。x例如:
visible(//foo, //bar:*)
将选择 //foo
软件包 //bar
中可依赖的所有目标,且不会违反可见性限制。
评估标签类型的规则特性:标签
expr ::= labels(word, expr)
在一组 inputs 规则中,labels(attr_name, inputs)
运算符会返回 attr_name 属性中指定的类型为“label”或“标签列表”的一组目标。
例如,labels(srcs, //foo)
会返回 //foo
规则的 srcs
属性中显示的一组目标。如果 inputs 集中有多个规则具有 srcs
属性,则返回其 srcs
的并集。
展开和过滤 test_suites: 测试
expr ::= tests(expr)
tests(x)
运算符会返回 x 集中的所有测试规则的集合,将任何 test_suite
规则扩展到它们引用的单个测试集,并通过 tag
和 size
应用过滤。
默认情况下,查询评估会忽略所有 test_suite
规则中的任何非测试目标。使用 --strict_test_suite
选项可以将其更改为错误。
例如,查询 kind(test, foo:*)
会列出 foo
软件包中的所有 *_test
和 test_suite
规则。所有结果都是(根据定义)foo
软件包的成员。相比之下,查询 tests(foo:*)
将返回将由 bazel test
foo:*
执行的所有单个测试:这可能包括属于其他软件包的测试,这些测试通过 test_suite
规则直接或间接引用。
软件包定义文件:buildfiles
expr ::= buildfiles(expr)
buildfiles(x)
运算符会返回 x 集中定义每个目标的软件包的一组文件;换句话说,对于每个软件包及其 BUILD
文件,及其通过 load
引用的任何 .bzl 文件。请注意,这也会返回包含这些 load
ed 文件的软件包的 BUILD
文件。
此运算符通常用于确定构建指定目标所需的文件或软件包(通常与下面的 --output package
选项结合使用)。例如
bazel query 'buildfiles(deps(//foo))' --output package
返回 //foo
以传递方式依赖的所有软件包的集合。
软件包定义文件:rbuildfiles
expr ::= rbuildfiles(word, ...)
rbuildfiles
运算符接受以英文逗号分隔的路径 fragment 列表,并返回一组以传递方式依赖于这些路径 fragment 的 BUILD
文件。例如,如果 //foo
是一个软件包,则 rbuildfiles(foo/BUILD)
将返回 //foo:BUILD
目标。如果 foo/BUILD
文件中包含 load('//bar:file.bzl'...
,那么 rbuildfiles(bar/file.bzl)
将返回 //foo:BUILD
目标,以及任何其他会加载 //bar:file.bzl
的 BUILD
文件的目标
--universe_scope
标志指定。不与 BUILD
文件和 .bzl
文件不直接对应的文件不会影响结果。例如,源代码文件(如 foo.cc
)会被忽略,即使 BUILD
文件中明确提到它们也是如此。不过,会遵循符号链接,因此,如果 foo/BUILD
是指向 bar/BUILD
的符号链接,那么 rbuildfiles(bar/BUILD)
会在结果中包含 //foo:BUILD
。
rbuildfiles
运算符基本上与 buildfiles
运算符相反。不过,这个道德倒置更坚定的一个方向:rbuildfiles
的输出就像 buildfiles
的输入一样;前者的输出仅包含软件包中的 BUILD
文件目标,后者可能包含这样的目标。反之,对应的信号较弱。buildfiles
运算符的输出是与所有软件包和 .给定输入所需的 bzl
文件。不过,rbuildfiles
运算符的输入不是这些目标,而是对应于这些目标的路径 fragment。
软件包定义文件:loadfiles
expr ::= loadfiles(expr)
loadfiles(x)
运算符可返回加载 x 集中每个目标软件包所需的 Starlark 文件集。换句话说,对于每个软件包,它都会返回从其 BUILD
文件引用的 .bzl 文件。
输出格式
bazel query
会生成图表。您可以指定 bazel query
通过 --output
命令行选项呈现此图表的内容、格式和顺序。
使用 Sky Query 运行时,只能使用与无序输出兼容的输出格式。具体来说,禁止使用 graph
、minrank
和 maxrank
输出格式。
某些输出格式接受其他选项。每个输出选项的名称都加上了它所适用的输出格式前缀,因此 --graph:factored
仅在使用 --output=graph
时适用;如果使用 graph
以外的输出格式,则不会产生任何影响。同样,--xml:line_numbers
仅在使用 --output=xml
时适用。
结果排序方式
虽然查询表达式始终遵循“图表顺序保护法”,呈现结果可以按依赖项有序或无序的方式完成。这不会影响结果集中的目标或查询的计算方式。只会影响向 stdout 输出结果的方式。此外,依赖项顺序中等效的节点不一定会按字母顺序排序。--order_output
标志可用于控制此行为。
(--[no]order_results
标志包含 --order_output
标志的部分功能,已弃用。)
此标志的默认值为 auto
,它会按字典顺序输出结果。不过,当使用 somepath(a,b)
时,结果会按 deps
顺序输出。
如果此标志为 no
且 --output
为 build
、label
、label_kind
、location
、package
、proto
或 xml
之一,输出将按任意顺序输出。这通常是最快的选项。当 --output
是 graph
、minrank
或 maxrank
之一时,则不受支持:使用这些格式时,Bazel 始终会输出按依赖关系顺序或排名排序的结果。
当此标志为 deps
时,Bazel 会按某种拓扑顺序输出结果,即优先显示依赖项。但是,依赖项顺序无序的节点(因为彼此之间不存在路径)可能会以任何顺序输出。
当此标志为 full
时,Bazel 会按完全确定(总计)的顺序输出节点。首先,所有节点均按字母顺序排序。然后,列表中的每个节点都会用作后顺序优先搜索的起始操作。在执行后顺序搜索时,系统将按后续节点的字母顺序遍历未访问节点的传出边缘。最后,节点会按访问顺序倒序输出。
按此顺序输出节点的速度可能较慢,因此应仅在确定性重要时使用。
按照 BUILD 中显示的目标格式输出目标形式
--output build
采用此选项时,每个目标的表示法就像是用 build 语言手动编写的一样。所有变量和函数调用(例如 glob、宏)都会展开,这有助于查看 Starlark 宏的效果。此外,每个有效规则会报告一个 generator_name
和/或 generator_function
值,并附上评估后会生成有效规则的宏的名称。
虽然输出使用与 BUILD
文件相同的语法,但不保证能生成有效的 BUILD
文件。
输出每个目标的标签
--output label
使用此选项后,所生成结果中每个目标的名称(或标签)集会按拓扑顺序输出(每行一个标签),除非指定了 --noorder_results
,请参阅结果排序说明。(拓扑排序是指图节点比其所有后续作业出现的时间更早。)当然,可能会有许多图表的拓扑排序(逆向后序只是其中之一);已选择哪一个未指定。
输出 somepath
查询的输出时,节点的打印顺序是路径的顺序。
注意:在某些极端情况下,可能会有两个标签相同的不同目标;例如,sh_binary
规则及其唯一(隐式)srcs
文件都可以称为 foo.sh
。如果查询结果包含这两个目标,则输出(label
格式)将显示为包含重复项。使用 label_kind
格式(见下文)时,区别很明显:这两个目标具有相同的名称,但一个种类为 sh_binary rule
,另一个种类为 source file
。
输出每个目标的标签和类型
--output label_kind
与 label
一样,此输出格式会按拓扑顺序输出所生成图中每个目标的标签,但在标签之前,它会以目标的 种类开头。
按排名顺序输出每个目标的标签
--output minrank --output maxrank
与 label
类似,minrank
和 maxrank
输出格式会输出结果图中每个目标的标签,但它们不是按照拓扑顺序显示,而是按排名顺序显示。这些标志不受结果排序 --[no]order_results
标志的影响(请参阅结果排序说明)。
此格式有两个变体:minrank
按照从根节点到节点的最短路径长度对每个节点进行排名。“无”根节点(没有传入边缘)的等级为 0,其继承者的等级为 1,依此类推。(一如既往,边缘从目标指向其前提条件:所依赖的目标)。
maxrank
按根节点到节点的最长路径的长度对每个节点进行排名。同样,“roots”的排名为 0,所有其他节点的排名都高于其所有前身的最高排名。
一个周期中的所有节点都视为具有相同排名。(大多数图表都是无循环的,但只是因为 BUILD
文件包含错误的周期而形成。)
这些输出格式有助于发现图表的深度。如果它用于 deps(x)
、rdeps(x)
或 allpaths
查询的结果,则排名值等于从 x
到该排名中的某个节点的最短路径(使用 minrank
)或最长路径(使用 maxrank
)的长度。maxrank
可用于确定构建目标所需的最长构建序列。
例如,左侧图表分别会在指定 --output minrank
和 --output maxrank
时产生右侧的输出。
minrank 0 //c:c 1 //b:b 1 //a:a 2 //b:b.cc 2 //a:a.cc |
maxrank 0 //c:c 1 //b:b 2 //a:a 2 //b:b.cc 3 //a:a.cc |
输出每个目标的位置
--output location
与 label_kind
一样,对于结果中的每个目标,此选项都会输出其种类和标签,但其前缀是一个字符串,用于描述该目标的位置,格式为文件名和行号。其格式类似于 grep
的输出。因此,可以解析后者(例如 Emacs 或 vi)的工具也可以使用查询输出来遍历一系列匹配,从而将 Bazel 查询工具用作依赖项图感知型“grep for BUILD 文件”。
位置信息因目标种类而异(请参阅种类运算符)。对于规则,系统会输出规则声明在 BUILD
文件中的位置。对于源文件,系统会输出实际文件的第 1 行位置。对于生成的文件,系统会输出生成该文件的规则的位置。(查询工具没有足够的信息来查找所生成文件的实际位置,并且在任何情况下,如果尚未执行构建,则可能不存在。)
输出一组软件包
--output package
此选项会输出结果集中某个目标所属的所有软件包的名称。名称按字典顺序输出;重复项除外。正式地讲,这是从一组标签(软件包、目标)到软件包的投影。
外部代码库中的软件包采用 @repo//foo/bar
格式,主代码库中的软件包采用 foo/bar
格式。
与 deps(...)
查询结合使用,此输出选项可用于查找一组用于签出给定目标集而必须签出的软件包。
显示结果图表
--output graph
此选项会使查询结果以常用的 AT&T GraphViz 格式输出为有向图。通常,结果会保存到 .png
或 .svg
等文件中。(如果您的工作站上未安装 dot
程序,您可以使用 sudo apt-get install graphviz
命令安装该程序。)如需查看调用示例,请查看以下示例部分。
此输出格式对于 allpaths
、deps
或 rdeps
查询特别有用,其中结果包含以线性形式呈现时无法轻松呈现的一系列路径,例如使用 --output label
。
默认情况下,图表会以因式形式呈现。也就是说,在逻辑上等效的节点会合并到一个具有多个标签的节点中。这会让图表更加紧凑且易读,因为典型的结果图表包含高度重复的模式。例如,java_library
规则可能依赖于数百个由同一 genrule
生成的 Java 源文件;在分解图中,所有这些文件由单个节点表示。此行为可通过 --nograph:factored
选项停用。
--graph:node_limit n
此选项用于指定输出中图表节点的标签字符串的最大长度。较长的标签将被截断;-1 表示截断。由于通常输出图的因式分解,节点标签可能会很长。GraphViz 无法处理超出 1024 个字符的标签,这是此选项的默认值。除非使用了 --output=graph
,否则此选项不起作用。
--[no]graph:factored
默认情况下,图表以分解形式显示,如上文所述。指定 --nograph:factored
时,会输出图表而不进行因式分解。因此,使用 GraphViz 执行的可视化操作不切实际,但更简单的格式可能会让其他工具(如 grep)更容易处理。除非使用的是 --output=graph
,否则此选项不会产生任何影响。
XML
--output xml
此选项会使生成的目标以 XML 格式输出。输出以 XML 标头开头,如下所示
<?xml version="1.0" encoding="UTF-8"?>
<query version="2">
然后,按照拓扑顺序(结果中请求无序结果)为结果图中的每个目标附加一个 XML 元素,最后终止
</query>
系统会针对 file
种类的目标发出简单条目:
<source-file name='//foo:foo_main.cc' .../>
<generated-file name='//foo:libfoo.so' .../>
但对于规则而言,XML 是结构化的,包含规则所有属性的定义,其中包括未在规则的 BUILD
文件中明确指定的值。
此外,结果还会包含 rule-input
和 rule-output
元素,这样就可以重新构建依赖项图的拓扑,而无需知道,例如 srcs
属性的元素是前向依赖项(前提条件)而 outs
属性的内容是向后依赖项(使用方)。
如果指定 --noimplicit_deps
,系统将禁止隐式依赖项的 rule-input
元素。
<rule class='cc_binary rule' name='//foo:foo' ...>
<list name='srcs'>
<label value='//foo:foo_main.cc'/>
<label value='//foo:bar.cc'/>
...
</list>
<list name='deps'>
<label value='//common:common'/>
<label value='//collections:collections'/>
...
</list>
<list name='data'>
...
</list>
<int name='linkstatic' value='0'/>
<int name='linkshared' value='0'/>
<list name='licenses'/>
<list name='distribs'>
<distribution value="INTERNAL" />
</list>
<rule-input name="//common:common" />
<rule-input name="//collections:collections" />
<rule-input name="//foo:foo_main.cc" />
<rule-input name="//foo:bar.cc" />
...
</rule>
目标的每个 XML 元素都包含一个 name
属性(其值是目标的标签)和一个 location
属性(其值是 --output location
输出的目标位置)。
--[no]xml:line_numbers
默认情况下,XML 输出中显示的位置包含行号。
如果指定了 --noxml:line_numbers
,系统就不会输出行号。
--[no]xml:default_values
默认情况下,XML 输出不包含其值是此类属性的默认值的规则属性(例如,如果未在 BUILD
文件中指定该值,或明确提供了默认值)。此选项会使此类属性值包含在 XML 输出中。
正则表达式
查询语言中的正则表达式使用 Java 正则表达式库,因此您可以使用 java.util.regex.Pattern
的完整语法。
使用外部代码库查询
如果构建依赖于来自外部代码库(在 WORKSPACE 文件中定义的)的规则,则查询结果将包含这些依赖项。例如,如果 //foo:bar
依赖于 //external:some-lib
并将 //external:some-lib
绑定到 @other-repo//baz:lib
,则 bazel query 'deps(//foo:bar)'
会将 @other-repo//baz:lib
和 //external:some-lib
都列为依赖项。
外部代码库本身不是 build 的依赖项。也就是说,在上面的示例中,//external:other-repo
不是依赖项。但可以作为 //external
软件包的成员查询它,例如:
# Querying over all members of //external returns the repository.
bazel query 'kind(http_archive, //external:*)'
//external:other-repo
# ...but the repository is not a dependency.
bazel query 'kind(http_archive, deps(//foo:bar))'
INFO: Empty results