Bazel 查询参考

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
报告问题 查看源代码

本页面是您使用 bazel query 分析 build 依赖项时使用的 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 和特殊字符 */@.-_:$~[](星号、正斜线、at、英文句点、连字符、下划线、冒号、美元符号、波浪线、左方括号、右方括号)。不过,不带英文引号的字词不应以连字符 - 或星号 * 开头,即使相对 [target name][(/concepts/labels#target-names) 可能会以这些字符开头。

    不带英文引号的字词不能包含字符加号 + 或等号 =,即使目标名称中允许使用这些字符。在编写用于生成查询表达式的代码时,应该用引号括住目标名称。

    在编写根据用户提供的值构造 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 查询语言是表达式的语言。每个表达式的计算结果都是部分排序的目标,或者目标 (graph) (DAG)。这是唯一的数据类型。

设置和图表引用相同的数据类型,但要强调数据的不同方面,例如:

  • 设置:目标的部分顺序不感兴趣。
  • 图表:目标的部分顺序很重要。

依赖关系图中的周期

构建依赖项图应该是循环的。

查询语言使用的算法适用于无环图,但可以可靠地适应循环。其中并未详细说明处理周期的方式,因此不应加以信赖。

隐式依赖项

除了在 BUILD 文件中明确定义的构建依赖项之外,Bazel 还会向规则添加其他隐式依赖项。例如,每条 Java 规则都隐式依赖于 JavaBuilder。隐式依赖项是使用以 $ 开头的属性建立的,不能在 BUILD 文件中替换。

默认情况下,bazel query 会在计算查询结果时考虑隐式依赖项。您可以使用 --[no]implicit_deps 选项更改此行为。请注意,由于查询不考虑配置,因此绝不会考虑潜在的工具链。

声音

Bazel 查询语言表达式在构建依赖项图上运行,该图是由所有 BUILD 文件中的所有规则声明隐式定义的。请务必注意,此图有点抽象,并不构成如何执行构建的所有步骤的完整说明。若要执行构建,还必须有配置;如需了解详情,请参阅《用户指南》的配置部分。

在所有配置中,使用 Bazel 查询语言对表达式求值的结果为 true,这意味着该值可能是一个保守的近似误差,而不是非常精确。如果您使用查询工具计算构建期间需要的所有源文件集,报告的数据可能会超出实际需要的数量,因为举例来说,查询工具将包含支持消息转换所需的所有文件,即使您不打算在构建中使用该功能,也是如此。

关于图表顺序的保留

操作会保留从其子表达式继承的所有排序约束。您可以将其视为“局部定律的法则”。举个例子,如果您发出查询以确定特定目标的依赖项的传递关闭,则结果集将根据依赖关系图进行排序。如果您将过滤条件设置为仅包含 file 种类的目标,则生成的子集中的每对目标之间都具有相同的传递部分排序关系,即使这些项对实际上并没有与原始图直接连接也是如此。(build 依赖项图中没有文件文件边缘)。

不过,虽然所有运算符都会保留顺序,但有些操作(如设置操作)不会引入自己的任何排序约束。请参考以下表达式:

deps(x) union y

最终结果集的顺序一定会保留其子表达式的所有有序约束,也就是说,x 的所有传递依赖项都会按顺序正确排序。不过,查询无法保证 y 中目标的顺序,也无法保证 deps(x) 中的目标相对于 y 中的目标的顺序(y 中的目标恰好位于 deps(x) 中除外)。

引入排序限制的运算符包括:allpathsdepsrdepssomepath,以及目标模式通配符 package:*dir/... 等。

Sky 查询

星空查询是一种在指定的宇宙范围上运行的查询模式。

只有 SkyQuery 提供的特殊函数

Sky Query 模式具有额外的查询函数 allrdepsrbuildfiles。这些函数适用于整个宇宙范围(因此,它们不适用于普通查询)。

指定宇宙范围

Sky 查询模式通过传递以下两个标志(--universe_scope--infer_universe_scope)和 --order_output=no 启用。--universe_scope=<target_pattern1>,...,<target_patternN> 告知查询预加载由目标模式指定的目标模式的传递闭合,这些模式可以是加法和减法。然后,系统会在此“范围”中评估所有查询。具体而言,allrdepsrbuildfiles 运算符仅会返回此范围中的结果。--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)))"

这是一个有意义的查询调用,它尝试计算传递在一定程度上依赖于定义(使用特定 .bzl 文件的目标)下的目标的 tests 扩展中的测试目标。在这里,--infer_universe_scope 非常方便,特别是在选择 --universe_scope 时,您必须自行解析查询表达式。

因此,对于使用 Universe 运算符(例如 allrdepsrbuildfiles)的查询表达式,请务必仅在其行为符合您的预期时才使用 --infer_universe_scope

与默认查询相比,Sky Query 具有一些优势和缺点。主要缺点是它无法根据图表顺序对其输出进行排序,因此禁止使用某些输出格式。其优势在于,它提供两个在默认查询中不提供的运算符(allrdepsrbuildfiles)。此外,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/...:*

由于 :* 通配符可以匹配文件及规则,因此它通常比 :all 更适用于查询。相反,:all 通配符(隐含在 foo/... 等目标模式中)通常对构建更有用。

bazel query 目标模式与 bazel 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/...

出现在封闭 let name = ... 表达式之外的变量引用 name 出错。换句话说,顶级查询表达式不能包含自由变量。

在上述语法产品中,name 与单词 类似,但额外限制在于,它是 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)

从外部来源读取目标:已设置

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 ... ')'

查询语言定义了多个函数。函数的名称决定了它需要的参数数量和类型。您可以使用以下函数:

依赖项的闭包:依赖项

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、allpaths

expr ::= somepath(expr, expr)
       | allpaths(expr, expr)

somepath(S, E)allpaths(S, E) 运算符用于计算两组目标之间的路径。这两个查询都接受两个参数,即一组起始点 S 和一组端点 Esomepath 返回从 S 的目标到 E 中的某个目标的任意路径上的节点图;allpaths 返回从 S 中的任何目标到 E 中任意目标的所有路径上的节点图。

生成的图表将根据依赖项关系进行排序。如需了解详情,请参阅有关图表顺序的部分。

路径
somepath(S1 + S2, E),一条可能的结果。
路径
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_librarycc_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 规则)的 //foo 依赖项,并将其明确设置为 0 或者根本不设置除 0 之外的默认值(例如针对 cc_binary 规则)。

列表类型属性(例如 srcsdata 等)会转换为 [value<sub>1</sub>, ..., value<sub>n</sub>] 形式的字符串,以 [ 括号开头,以 ] 括号结尾,并使用“,”(英文逗号、空格)分隔多个值。使用标签的绝对形式将标签转换为字符串。例如,属性 deps=[":foo", "//otherpkg:bar", "wiz"] 将转换为字符串 [//thispkg:foo, //otherpkg:bar, //thispkg:wiz]。 括号始终存在,因此空列表将使用字符串值 [] 进行匹配。例如,

attr("srcs", "\[\]", deps(//foo))

将在 srcs 属性为空的 //foo 依赖项之间选择所有规则,而

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 的成员,并且 ypredicate 中的所有目标 y 均可见。例如:

visible(//foo, //bar:*)

将选择 //bar 软件包中 //foo 可以依赖的所有目标,且不会违反可见性限制。

评估标签类型为“规则”的规则属性

expr ::= labels(word, expr)

labels(attr_name, inputs) 运算符会在 inputs 集合中的某个规则中,返回“attr_name”属性中指定的一组“标签”或“标签列表”目标。

例如,labels(srcs, //foo) 会返回 //foo 规则的 srcs 属性中显示的一组目标。如果多条规则在 inputs 集中具有 srcs 属性,则返回其 srcs 的并集。

展开并过滤 test_suites:测试

expr ::= tests(expr)

tests(x) 运算符返回 x 集合中的所有测试规则集,将所有 test_suite 规则扩展到它们引用的单个测试集,并按 tagsize 应用过滤。

默认情况下,查询评估会忽略所有 test_suite 规则中的任何非测试目标。这可以通过 --strict_test_suite 选项更改为错误。

例如,查询 kind(test, foo:*) 会列出 foo 软件包中的所有 *_testtest_suite 规则。根据定义,所有结果均为 foo 软件包的成员。相比之下,查询 tests(foo:*) 将返回由 bazel test foo:* 执行的所有单个测试:这可能包括属于其他软件包的测试,这些测试通过 test_suite 规则直接或间接引用。

软件包定义文件:buildfiles

expr ::= buildfiles(expr)

buildfiles(x) 运算符返回一组文件,用于定义 x 集内每个目标的软件包;换言之,就是每个软件包及其 BUILD 文件,以及它通过 load 引用的任何 .bzl 文件。请注意,此操作也会返回包含这些 load 文件的软件包的 BUILD 文件。

此运算符通常用于确定构建指定目标所需的文件或软件包,通常与下面的 --output package 选项结合使用。例如,

bazel query 'buildfiles(deps(//foo))' --output package

返回 //foo 间接依赖的所有软件包的集合。

软件包定义文件:rbuildfiles

expr ::= rbuildfiles(word, ...)

rbuildfiles 运算符接受以英文逗号分隔的路径片段列表,并返回一组间接依赖于这些路径片段的 BUILD 文件。例如,如果 //foo 是一个软件包,则 rbuildfiles(foo/BUILD) 将返回 //foo:BUILD 目标。如果 foo/BUILD 文件中包含 load('//bar:file.bzl'...rbuildfiles(bar/file.bzl) 将返回 //foo:BUILD 目标,以及任何其他会加载 //bar:file.bzlBUILD 文件的目标

rbuildfiles 运算符的范围是 --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 会生成图表。您可以通过 --output 命令行选项指定 bazel query 在呈现此图表时所依据的内容、格式和顺序。

使用 Sky Query 运行时,只允许使用与无序输出兼容的输出格式。具体来说,禁止使用 graphminrankmaxrank 输出格式。

某些输出格式接受其他选项。每个输出选项的名称均以其所适用的输出格式为前缀,因此 --graph:factored 仅在使用 --output=graph 时适用;如果使用 graph 以外的输出格式,则无效。同样,--xml:line_numbers 仅在使用 --output=xml 时适用。

结果排序

虽然查询表达式始终遵循“图表顺序守护定律”,但呈现结果可以采用有序或无序的方式完成。这不会影响结果集中的目标或查询的计算方式。它只会影响结果输出到 stdout 的方式。此外,依赖项顺序中的等效节点不一定会按字母顺序排序。--order_output 标志可用于控制此行为。(--[no]order_results 标志具有 --order_output 标志的部分功能,已弃用。)

此标志的默认值为 auto,它会输出结果的字典顺序。不过,使用 somepath(a,b) 时,结果会按 deps 顺序输出。

当此标志为 no--outputbuildlabellabel_kindlocationpackageprotoxml 之一时,输出将按任意顺序输出。这通常是速度最快的选项。但当 --outputgraphminrankmaxrank 之一时不受支持:采用这些格式时,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 一样,minrankmaxrank 输出格式会输出结果图中每个目标的标签,但它们不会按拓扑顺序显示,而是按排名顺序显示,后跟排名数字。这些标志不受结果排序 --[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”。

位置信息因目标种类而异(请参阅种类运算符)。对于规则,系统会输出规则声明在 BUILD 文件中的位置。对于源文件,系统会输出实际文件的第 1 行的位置。对于生成的文件,系统会输出生成该文件的规则的位置。(查询工具没有足够的信息来查找生成的文件的实际位置,并且在任何情况下,如果构建尚未执行,它可能不存在。)

--output package

此选项会输出结果集中某个目标所属的所有软件包的名称。名称会按字典顺序输出;重复项会被排除。正式地说,这是一组标签(软件包、目标)到软件包的投影。

外部代码库中的软件包采用 @repo//foo/bar 格式,而主代码库中的软件包采用 foo/bar 格式。

结合 deps(...) 查询,此输出选项可用于查找要构建给定的一组目标而必须检出的一组软件包。

显示结果图表

--output graph

此选项会导致查询结果以常用的 AT&T GraphViz 格式输出为有向图。通常,系统会将结果保存到一个文件中,例如 .png.svg。(如果工作站上未安装 dot 程序,您可以使用 sudo apt-get install graphviz 命令安装它。)如需查看调用示例,请参阅下面的示例部分。

此输出格式对 allpathsdepsrdeps 查询尤其有用,因为查询结果包含一组路径,这些路径在以线性形式(例如使用 --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-inputrule-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