本页介绍了如何开始使用 Bazel 的查询语言跟踪代码中的依赖项。
如需了解语言详情和 --output
标志详情,请参阅参考手册、Bazel 查询参考文档和 Bazel Cquery 参考文档。您可以通过在命令行中输入 bazel help query
或 bazel help cquery
获取帮助。
如需在执行查询的同时忽略错误(例如缺少目标),请使用 --keep_going
标志。
查找规则的依存关系
如需查看 //foo
的依赖项,请在 Bazel 查询中使用 deps
函数:
$ bazel query "deps(//foo)" //foo:foo //foo:foo-dep ...
这是构建 //foo
所需的所有目标的集合。
跟踪两个软件包之间的依赖项链
库 //third_party/zlib:zlibonly
不在 //foo
的 BUILD 文件中,但它是间接依赖项。如何跟踪此依赖项路径?这里有两个实用的函数:allpaths
和 somepath
。如果您仅关心所构建的工件中包含的内容,而不是所有可能的作业,则还可以使用 --notool_deps
排除工具依赖项。
如需直观呈现所有依赖项的图,请通过 dot
命令行工具传输 bazel 查询输出:
$ bazel query "allpaths(//foo, third_party/...)" --notool_deps --output graph | dot -Tsvg > /tmp/deps.svg
当依赖关系图很大并且复杂时,从单一路径开始会很有帮助:
$ bazel query "somepath(//foo:foo, third_party/zlib:zlibonly)" //foo:foo //translations/tools:translator //translations/base:base //third_party/py/MySQL:MySQL //third_party/py/MySQL:_MySQL.so //third_party/mysql:mysql //third_party/zlib:zlibonly
如果您未使用 allpaths
指定 --output graph
,将获得依赖关系图的扁平化列表。
$ bazel query "allpaths(//foo, third_party/...)" ...many errors detected in BUILD files... //foo:foo //translations/tools:translator //translations/tools:aggregator //translations/base:base //tools/pkg:pex //tools/pkg:pex_phase_one //tools/pkg:pex_lib //third_party/python:python_lib //translations/tools:messages //third_party/py/xml:xml //third_party/py/xml:utils/boolean.so //third_party/py/xml:parsers/sgmlop.so //third_party/py/xml:parsers/pyexpat.so //third_party/py/MySQL:MySQL //third_party/py/MySQL:_MySQL.so //third_party/mysql:mysql //third_party/openssl:openssl //third_party/zlib:zlibonly //third_party/zlib:zlibonly_v1_2_3 //third_party/python:headers //third_party/openssl:crypto
延伸阅读:隐式依赖项
//foo
的 build 文件从不引用 //translations/tools:aggregator
。那么,直接依赖项在哪里?
某些规则包含对其他库或工具的隐式依赖性。例如,如需构建 genproto
规则,您需要先构建协议编译器,以便每条 genproto
规则都隐含对协议编译器的依赖。这些依赖项不会在 build 文件中提及,而是由构建工具添加。整套隐式依赖项目前未记录。您可以使用 --noimplicit_deps
从查询结果中滤除这些依赖项。对于 cquery,这将包括已解析的工具链。
反向依赖项
您可能想知道一组依赖于某个目标的目标。例如,如果您要更改某些代码,您可能想知道即将破坏哪些其他代码。您可以使用 rdeps(u, x)
在 u
的传递闭包中找到 x
中目标的反向依赖项。
Bazel 的 Sky Query 支持 allrdeps
函数,您可以使用该函数查询您指定的宇宙中的反向依赖项。
其他用途
您可以使用 bazel query
来分析许多依赖关系。
现有内容 ...
foo
下存在哪些软件包?
bazel query 'foo/...' --output package
foo
软件包中定义了哪些规则?
bazel query 'kind(rule, foo:*)' --output label_kind
foo
软件包中的规则会生成哪些文件?
bazel query 'kind("generated file", //foo:*)'
Starlark 宏 foo
会生成哪些目标?
bazel query 'attr(generator_function, foo, //path/to/search/...)'
构建 //foo
所需的一组 BUILD 文件?
bazel query 'buildfiles(deps(//foo))' | cut -f1 -d:
test_suite
会扩展为哪些具体测试?
bazel query 'tests(//foo:smoke_tests)'
其中哪些是 C++ 测试?
bazel query 'kind(cc_.*, tests(//foo:smoke_tests))'
哪些空间较小?中等?大型?
bazel query 'attr(size, small, tests(//foo:smoke_tests))' bazel query 'attr(size, medium, tests(//foo:smoke_tests))' bazel query 'attr(size, large, tests(//foo:smoke_tests))'
foo
下有哪些与模式匹配的测试?
bazel query 'filter("pa?t", kind(".*_test rule", //foo/...))'
该模式是一个正则表达式,并应用于规则的全名。这类似于
bazel query 'kind(".*_test rule", //foo/...)' | grep -E 'pa?t'
哪个软件包中包含文件 path/to/file/bar.java
?
bazel query path/to/file/bar.java --output=package
path/to/file/bar.java?
的 build 标签是什么?
bazel query path/to/file/bar.java
哪些规则目标包含文件 path/to/file/bar.java
作为来源?
fullname=$(bazel query path/to/file/bar.java) bazel query "attr('srcs', $fullname, ${fullname//:*/}:*)"
存在哪些软件包依赖项 ...
foo
依赖于哪些软件包?(构建 foo
时,我需要检查什么)
bazel query 'buildfiles(deps(//foo:foo))' --output package
foo
树依赖于哪些软件包(foo/contrib
除外)?
bazel query 'deps(foo/... except foo/contrib/...)' --output package
存在哪些关联规则 ...
bar 依赖于什么 genproto 规则?
bazel query 'kind(genproto, deps(bar/...))'
查找某个 JNI (C++) 库的定义,该库由 WebView 树中的 Java 二进制规则以传递方式依赖。
bazel query 'some(kind(cc_.*library, deps(kind(java_binary, //java/com/example/frontend/...))))' --output location
...现在找到依赖于它们的所有 Java 二进制文件的定义
bazel query 'let jbs = kind(java_binary, //java/com/example/frontend/...) in let cls = kind(cc_.*library, deps($jbs)) in $jbs intersect allpaths($jbs, $cls)'
存在哪些文件依赖项 ...
构建 foo 所需的一整套 Java 源文件是什么?
源文件:
bazel query 'kind("source file", deps(//path/to/target/foo/...))' | grep java$
生成的文件:
bazel query 'kind("generated file", deps(//path/to/target/foo/...))' | grep java$
构建 QUX 测试所需的整套 Java 源文件是什么?
源文件:
bazel query 'kind("source file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$
生成的文件:
bazel query 'kind("generated file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$
X 和 Y 之间的依赖关系存在哪些差异 ...
//foo
依赖哪些目标,而 //foo:foolib
不依赖?
bazel query 'deps(//foo) except deps(//foo:foolib)'
foo
测试依赖于 //foo
正式版二进制文件不依赖于哪些 C++ 库?
bazel query 'kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo))'
为什么存在此依赖项 ...
为什么 bar
依赖于 groups2
?
bazel query 'somepath(bar/...,groups2/...:*)'
获得此查询的结果后,您通常会发现单个目标特别突出,表现为意外或严重的 bar
依赖项。然后,该查询可以进一步优化为:
显示从 docker/updater:updater_systest
(一个 py_test
)到它所依赖的某个 cc_library
的路径:
bazel query 'let cc = kind(cc_library, deps(docker/updater:updater_systest)) in somepath(docker/updater:updater_systest, $cc)'
为什么库 //photos/frontend:lib
依赖于同一库 //third_party/jpeglib
和 //third_party/jpeg
的两个变体?
此查询可归结为:“显示依赖于这两个库的 //photos/frontend:lib
的子图”。当按拓扑顺序显示时,结果的最后一个元素很可能是问题根源。
bazel query 'allpaths(//photos/frontend:lib, //third_party/jpeglib) intersect allpaths(//photos/frontend:lib, //third_party/jpeg)' //photos/frontend:lib //photos/frontend:lib_impl //photos/frontend:lib_dispatcher //photos/frontend:icons //photos/frontend/modules/gadgets:gadget_icon //photos/thumbnailer:thumbnail_lib //third_party/jpeg/img:renderer
取决于哪些因素 ...
bar 下的哪些规则依赖于 Y?
bazel query 'bar/... intersect allpaths(bar/..., Y)'
哪些目标直接依赖于 T 软件包中的 T?
bazel query 'same_pkg_direct_rdeps(T)'
如何破坏依赖项 ...
如需使 bar
不再依赖于 X,我必须中断哪些依赖项路径?
如需将图表输出到 svg
文件,请执行以下操作:
bazel query 'allpaths(bar/...,X)' --output graph | dot -Tsvg > /tmp/dep.svg
其他
//foo-tests
构建中有多少个依序步骤?
遗憾的是,查询语言目前无法为您提供从 x 到 y 的最长路径,但它可以从起点找到(更确切地说是 a)最远的节点,或者向您显示从 x 到其所依赖的每个 y 的最长路径长度。使用 maxrank
:
bazel query 'deps(//foo-tests)' --output maxrank | tail -1 85 //third_party/zlib:zutil.c
结果表明,在此 build 中,必须按顺序存在长度为 85 的路径。