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 tools。

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。

另请参阅

有关从源码构建的更多信息，请遵循 关于构建包的教程。