build()¶
build()
方法用于定义软件包的源码构建。实际上,这意味着调用某个构建系统,这可以通过显式方式完成,也可以使用 Conan 提供的任何构建辅助工具完成。
from conan.tools.cmake import CMake
class Pkg(ConanFile):
def build(self):
# Either using some of the Conan built-in helpers
cmake = CMake(self)
cmake.configure() # equivalent to self.run("cmake . <other args>")
cmake.build() # equivalent to self.run("cmake --build . <other args>")
cmake.test() # equivalent to self.run("cmake --target=RUN_TESTS")
# Or it could run your own build system or scripts
self.run("mybuildsystem . --configure")
self.run("mybuildsystem . --build")
有关现有内置构建系统集成的更多信息,请访问 Recipe 工具。
build()
方法应尽可能简单,只需封装开发人员以最简单方式进行的命令行调用。generate()
方法负责准备构建,创建工具链文件、CMake 预设或任何其他必要文件,以便开发人员可以轻松手动调用构建系统。这大大改善了与 IDE 的集成,并提升了开发体验。结果是,实际上 build()
方法应相对简单。
build()
方法针对每个唯一配置运行一次,因此,如果存在一些源码操作(例如根据不同配置有条件地应用补丁),它们也可以在实际构建之前应用于 build()
方法中。需要注意的是,在这种情况下,no_copy_source 属性不能设置为 True
。
build()
方法是构建和运行单元测试的正确位置(在打包之前),如果这些测试失败,则抛出错误,中断进程,甚至不打包最终二进制文件。如果定义了 tools.build:skip_test
配置,内置的辅助工具将跳过单元测试。对于自定义集成,期望该方法检查此 conf
值,以便跳过构建和运行测试,这在某些 CI 场景中会很有用。
在交叉构建场景中运行测试:在某些情况下,您可能希望构建测试但无法运行它们,例如在交叉构建场景中。对于这些罕见情况,您可以使用 conan.tools.build.can_run 工具,如下所示:
...
def build(self):
cmake = CMake(self)
cmake.configure()
cmake.build()
if can_run(self):
cmake.test()
注意
最佳实践
build()
方法应尽可能简单,构建准备的繁重工作应在generate()
方法中完成,以实现良好的开发体验,使开发人员只需使用conan install .
即可轻松进行本地构建,然后直接调用构建系统或打开其 IDE。
另请参阅
有关从源码构建的更多信息,请参阅 有关构建软件包的教程。