理解使用 conanfile.py 与 conanfile.txt 的灵活性¶

在前面的示例中，我们在 conanfile.txt 文件中声明了我们的依赖项（Zlib 和 CMake）。让我们看一下该文件

conanfile.txt¶

[requires]
zlib/1.2.11

[tool_requires]
cmake/3.22.6

[generators]
CMakeDeps
CMakeToolchain

使用 conanfile.txt 通过 Conan 构建项目对于简单的情况已经足够了，但是如果您需要更多灵活性，则应该使用 conanfile.py 文件，您可以在其中使用 Python 代码来执行一些操作，例如动态添加需求、根据其他选项更改选项或为您的需求设置选项。让我们看看如何迁移到 conanfile.py 并使用其中一些功能的示例。

请首先克隆源代码以重新创建此项目。您可以在 GitHub 上的 examples2 存储库中找到它们

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/consuming_packages/conanfile_py

检查文件夹的内容，并注意内容与前面的示例相同，但使用 conanfile.py 而不是 conanfile.txt。

.
├── CMakeLists.txt
├── conanfile.py
└── src
    └── main.c

请记住，在前面的示例中，conanfile.txt 包含以下信息

conanfile.txt¶

[requires]
zlib/1.2.11

[tool_requires]
cmake/3.22.6

[generators]
CMakeDeps
CMakeToolchain

我们将把相同的信息转换为 conanfile.py。此文件通常称为“Conan 食谱”。它可以用于使用包，就像在这种情况下一样，也可以用于创建包。对于我们当前的情况，它将定义我们的需求（库和构建工具）以及修改选项和设置我们希望如何使用这些包的逻辑。在使用此文件创建包的情况下，它可以定义（除其他事项外）如何下载包的源代码、如何从这些源代码构建二进制文件、如何打包二进制文件以及有关未来使用者如何使用包的信息。我们将在后面的创建包部分解释如何使用 Conan 食谱创建包。

conanfile.txt 的等效 Conan 食谱如下所示

conanfile.py¶

from conan import ConanFile


class CompressorRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/1.2.11")

    def build_requirements(self):
        self.tool_requires("cmake/3.22.6")

为了创建 Conan 食谱，我们声明了一个新的类，该类继承自 ConanFile 类。此类具有不同的类属性和方法

settings 此类属性定义了项目范围的变量，例如编译器、其版本或操作系统本身，这些变量在构建项目时可能会发生变化。这与 Conan 如何管理二进制兼容性有关，因为这些值会影响 Conan 包的包 ID的值。我们稍后将解释 Conan 如何使用此值来管理二进制兼容性。
generators 此类属性指定在调用 conan install 命令时将运行哪些 Conan 生成器。在本例中，我们添加了 CMakeToolchain 和 CMakeDeps，就像在 conanfile.txt 中一样。
requirements() 在此方法中，我们使用 self.requires() 方法声明 zlib/1.2.11 依赖项。
build_requirements() 在此方法中，我们使用 self.tool_requires() 方法声明 cmake/3.22.6 依赖项。

注意

不必严格地在 build_requirements() 中将依赖项添加到工具中，因为理论上，此方法中的所有内容都可以在 requirements() 方法中完成。但是，build_requirements() 提供了一个专门的位置来定义 tool_requires 和 test_requires，这有助于保持结构井井有条且清晰。有关更多信息，请查看 requirements() 和 build_requirements() 文档。

您可以检查运行与前面的示例中相同的命令是否会导致与之前相同的结果。

Windows¶

$ conan install . --output-folder=build --build=missing
$ cd build
$ conanbuild.bat
# assuming Visual Studio 15 2017 is your VS version and that it matches your default profile
$ cmake .. -G "Visual Studio 15 2017" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
$ cmake --build . --config Release
...
Building with CMake version: 3.22.6
...
[100%] Built target compressor

$ Release\compressor.exe
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
$ deactivate_conanbuild.bat

Linux、macOS¶

$ conan install . --output-folder build --build=missing
$ cd build
$ source conanbuild.sh
Capturing current environment in deactivate_conanbuildenv-release-x86_64.sh
Configuring environment variables
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
...
Building with CMake version: 3.22.6
...
[100%] Built target compressor

$ ./compressor
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
$ source deactivate_conanbuild.sh

到目前为止，我们已经实现了使用 conanfile.txt 获得的相同功能，让我们看看如何利用 conanfile.py 的功能来定义我们想要遵循的项目结构，以及如何使用 Conan 设置和选项添加一些逻辑。

使用 layout() 方法¶

在前面的示例中，每次执行 conan install 命令时，我们都必须使用 –output-folder 参数来定义我们希望在其中创建 Conan 生成的文件的文件夹。有一种更简洁的方法来决定我们希望 Conan 在哪里为构建系统生成文件，这将允许我们决定，例如，是否希望根据我们使用的 CMake 生成器的类型使用不同的输出文件夹。您可以在 conanfile.py 中的 layout() 方法中直接定义这一点，并使其在每个平台上都能工作，而无需进行更多更改。

conanfile.py¶

import os

from conan import ConanFile


class CompressorRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/1.2.11")
        if self.settings.os == "Windows":
            self.requires("base64/0.4.0")

    def build_requirements(self):
        if self.settings.os != "Windows":
            self.tool_requires("cmake/3.22.6")

    def layout(self):
        # We make the assumption that if the compiler is msvc the
        # CMake generator is multi-config
        multi = True if self.settings.get_safe("compiler") == "msvc" else False
        if multi:
            self.folders.generators = os.path.join("build", "generators")
            self.folders.build = "build"
        else:
            self.folders.generators = os.path.join("build", str(self.settings.build_type), "generators")
            self.folders.build = os.path.join("build", str(self.settings.build_type))

如您所见，我们在 layout() 方法中定义了 self.folders.generators 属性。这是 Conan 生成所有辅助文件（CMake 工具链和 cmake 依赖项文件）的文件夹。

请注意，如果它是多配置生成器（如 Visual Studio）或单配置生成器（如 Unix Makefiles），则文件夹的定义会有所不同。在第一种情况下，无论构建类型如何，文件夹都相同，构建系统将在该文件夹内管理不同的构建类型。但是像 Unix Makefiles 这样的单配置生成器必须为每个不同的配置（作为不同的 build_type Release/Debug）使用不同的文件夹。在本例中，我们添加了一个简单的逻辑来考虑如果编译器名称为 msvc 则为多配置。

检查运行与前面的示例中相同的命令，但不使用 –output-folder 参数是否会导致与之前相同的结果

Windows¶

$ conan install . --build=missing
$ cd build
$ generators\conanbuild.bat
# assuming Visual Studio 15 2017 is your VS version and that it matches your default profile
$ cmake .. -G "Visual Studio 15 2017" -DCMAKE_TOOLCHAIN_FILE=generators\conan_toolchain.cmake
$ cmake --build . --config Release
...
Building with CMake version: 3.22.6
...
[100%] Built target compressor

$ Release\compressor.exe
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
$ generators\deactivate_conanbuild.bat

Linux、macOS¶

$ conan install . --build=missing
$ cd build/Release
$ source ./generators/conanbuild.sh
Capturing current environment in deactivate_conanbuildenv-release-x86_64.sh
Configuring environment variables
$ cmake ../.. -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
...
Building with CMake version: 3.22.6
...
[100%] Built target compressor

$ ./compressor
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
$ source ./generators/deactivate_conanbuild.sh

无需始终在 conanfile.py 中编写此逻辑。您可以导入一些预定义的布局并直接在您的食谱中使用它们。例如，对于 CMake 案例，Conan 中已经定义了 cmake_layout()

conanfile.py¶

from conan import ConanFile
from conan.tools.cmake import cmake_layout


class CompressorRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/1.2.11")

    def build_requirements(self):
        self.tool_requires("cmake/3.22.6")

    def layout(self):
        cmake_layout(self)

使用 validate() 方法为不受支持的配置引发错误¶

当 Conan 加载 conanfile.py 时，会评估 validate() 方法，您可以使用它来执行输入设置的检查。例如，如果您的项目不支持 macOS 上的 armv8 架构，您可以引发 ConanInvalidConfiguration 异常以使 Conan 返回一个特殊的错误代码。这将表明用于设置或选项的配置不受支持。

conanfile.py¶

...
from conan.errors import ConanInvalidConfiguration

class CompressorRecipe(ConanFile):
    ...

    def validate(self):
        if self.settings.os == "Macos" and self.settings.arch == "armv8":
            raise ConanInvalidConfiguration("ARM v8 not supported in Macos")

使用 conanfile.py 进行条件需求¶

您可以向 requirements() 方法添加一些逻辑，以有条件地添加或删除需求。例如，假设您希望在 Windows 中添加额外的依赖项，或者您希望使用系统的 CMake 安装而不是使用 Conan 的 tool_requires

conanfile.py¶

from conan import ConanFile


class CompressorRecipe(ConanFile):
    # Binary configuration
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def requirements(self):
        self.requires("zlib/1.2.11")

        # Add base64 dependency for Windows
        if self.settings.os == "Windows":
            self.requires("base64/0.4.0")

    def build_requirements(self):
        # Use the system's CMake for Windows
        if self.settings.os != "Windows":
            self.tool_requires("cmake/3.22.6")

使用 generate() 方法从包中复制资源¶

在某些情况下，Conan 包包含对使用它们打包的库有用甚至必要的文件。这些文件可以包括配置文件、资产，以及项目正确构建或运行所需的特定文件。使用 generate() 方法，您可以将这些文件从 Conan 缓存复制到项目的文件夹中，确保所有必需的资源都可直接使用。

以下是一个示例，说明如何将依赖项的 resdirs 目录中的所有资源复制到项目中的 assets 目录

import os
from conan import ConanFile
from conan.tools.files import copy

class MyProject(ConanFile):

    ...

    def generate(self):
        # Copy all resources from the dependency's resource directory
        # to the "assets" folder in the source directory of your project
        dep = self.dependencies["dep_name"]
        copy(self, "*", dep.cpp_info.resdirs[0], os.path.join(self.source_folder, "assets"))

然后，在 conan install 步骤之后，所有这些资源文件都将被复制到本地，允许您在项目的构建过程中使用它们。有关如何在 generate() 方法中从包中导入文件的完整示例，您可以参考关于使用 Dear ImGui 库的博文 <https://blog.conan.org.cn/2019/06/26/An-introduction-to-the-Dear-ImGui-library.html>，该博文演示了如何根据图形 API 导入库的绑定。

注意

需要说明的是，复制库（无论是静态库还是共享库）都是没有必要的。Conan 旨在使用其在 Conan 本地缓存中的位置的库，使用生成器和环境工具，而无需将它们复制到本地文件夹。

另请参阅

使用“cmake_layout” + “CMakeToolchain” + “CMakePresets 功能”构建您的项目.
了解 Conan 包布局.
所有可用的 conanfile.py 方法的文档.
在 configure() 中使用条件生成器