在 Recipe 中配置设置和选项¶

我们已经解释了 Conan 的设置和选项，以及如何使用它们为不同的配置（如 Debug、Release、静态或共享库等）构建项目。在本节中，我们将解释如何在其中一个设置或选项不适用于 Conan 包的情况下配置这些设置和选项。我们将简要介绍 Conan 如何建模二进制兼容性，以及它与选项和设置的关系。

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

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/creating_packages/configure_options_settings

您会注意到比之前 Recipe 中的 conanfile.py 文件有所变化。让我们检查相关部分。

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    ...
    options = {"shared": [True, False],
               "fPIC": [True, False],
               "with_fmt": [True, False]}

    default_options = {"shared": False,
                       "fPIC": True,
                       "with_fmt": True}
    ...

    def config_options(self):
        if self.settings.os == "Windows":
            del self.options.fPIC

    def configure(self):
        if self.options.shared:
            # If os=Windows, fPIC will have been removed in config_options()
            # use rm_safe to avoid double delete errors
            self.options.rm_safe("fPIC")
    ...

您可以看到我们在 Recipe 中添加了一个 configure() 方法。让我们解释一下这个方法的目的，以及它与我们在 Recipe 中已定义的 config_options() 方法有何不同。

configure()：使用此方法来配置 Recipe 中哪些选项或设置可用。例如，在此案例中，我们 **删除了 fPIC 选项**，因为它仅在我们将库构建为共享库时才应为 **True**（实际上，某些构建系统在构建共享库时会自动添加此标志）。
config_options()：此方法用于在选项 **在取值之前** 约束包中可用的选项。如果一个设置或选项被分配了一个值，而在该方法中被删除，Conan 将会引发一个错误。在此案例中，我们在 Windows 上 **删除了 fPIC 选项**，因为该选项在 Windows 操作系统上不存在。请注意，此方法在 configure() 方法之前执行。

请注意，使用 config_options() 方法删除选项与使用 configure() 方法删除选项的结果不同。在 config_options() 中删除选项 **就像我们从未在 Recipe 中声明过它一样**，这将引发一个说选项不存在的异常。然而，如果我们将其删除在 configure() 方法中，我们可以传递该选项，但它将无效。例如，如果您尝试为 Windows 上的 fPIC 选项传递一个值，Conan 将会引发一个说选项不存在的错误。

Windows¶

$ conan create . --build=missing -o fPIC=True
...
-------- Computing dependency graph --------
ERROR: option 'fPIC' doesn't exist
Possible options are ['shared', 'with_fmt']

正如您所注意到的，configure() 和 config_options() 方法会在满足特定条件时 **删除选项**。让我们解释一下为什么我们这样做以及删除该选项的含义。这与 Conan 如何识别与配置文件中设置的配置二进制兼容的包有关。在下一节中，我们将介绍 **Conan 包 ID** 的概念。

Conan 包的二进制兼容性：包 ID¶

在之前的示例中，我们使用 Conan 为 Debug 和 Release 等不同配置进行构建。每次您为其中一种配置创建包时，Conan 都会构建一个新的二进制文件。每个二进制文件都与一个 **生成的哈希** 相关联，称为 **包 ID**。包 ID 只是一种将一组设置、选项和关于包需求的信息转换为唯一标识符的方法。

让我们构建我们的包以支持 Release 和 Debug 配置，并检查生成的二进制包 ID。

$ conan create . --build=missing -s build_type=Release -tf="" # -tf="" will skip building the test_package
...
[ 50%] Building CXX object CMakeFiles/hello.dir/src/hello.cpp.o
[100%] Linking CXX static library libhello.a
[100%] Built target hello
hello/1.0: Package '738feca714b7251063cc51448da0cf4811424e7c' built
hello/1.0: Build folder /Users/user/.conan2/p/tmp/7fe7f5af0ef27552/b/build/Release
hello/1.0: Generated conaninfo.txt
hello/1.0: Generating the package
hello/1.0: Temporary package folder /Users/user/.conan2/p/tmp/7fe7f5af0ef27552/p
hello/1.0: Calling package()
hello/1.0: CMake command: cmake --install "/Users/user/.conan2/p/tmp/7fe7f5af0ef27552/b/build/Release" --prefix "/Users/user/.conan2/p/tmp/7fe7f5af0ef27552/p"
hello/1.0: RUN: cmake --install "/Users/user/.conan2/p/tmp/7fe7f5af0ef27552/b/build/Release" --prefix "/Users/user/.conan2/p/tmp/7fe7f5af0ef27552/p"
-- Install configuration: "Release"
-- Installing: /Users/user/.conan2/p/tmp/7fe7f5af0ef27552/p/lib/libhello.a
-- Installing: /Users/user/.conan2/p/tmp/7fe7f5af0ef27552/p/include/hello.h
hello/1.0 package(): Packaged 1 '.h' file: hello.h
hello/1.0 package(): Packaged 1 '.a' file: libhello.a
hello/1.0: Package '738feca714b7251063cc51448da0cf4811424e7c' created
hello/1.0: Created package revision 3bd9faedc711cbb4fdf10b295268246e
hello/1.0: Full package reference: hello/1.0#e6b11fb0cb64e3777f8d62f4543cd6b3:738feca714b7251063cc51448da0cf4811424e7c#3bd9faedc711cbb4fdf10b295268246e
hello/1.0: Package folder /Users/user/.conan2/p/5c497cbb5421cbda/p

$ conan create . --build=missing -s build_type=Debug -tf="" # -tf="" will skip building the test_package
...
[ 50%] Building CXX object CMakeFiles/hello.dir/src/hello.cpp.o
[100%] Linking CXX static library libhello.a
[100%] Built target hello
hello/1.0: Package '3d27635e4dd04a258d180fe03cfa07ae1186a828' built
hello/1.0: Build folder /Users/user/.conan2/p/tmp/19a2e552db727a2b/b/build/Debug
hello/1.0: Generated conaninfo.txt
hello/1.0: Generating the package
hello/1.0: Temporary package folder /Users/user/.conan2/p/tmp/19a2e552db727a2b/p
hello/1.0: Calling package()
hello/1.0: CMake command: cmake --install "/Users/user/.conan2/p/tmp/19a2e552db727a2b/b/build/Debug" --prefix "/Users/user/.conan2/p/tmp/19a2e552db727a2b/p"
hello/1.0: RUN: cmake --install "/Users/user/.conan2/p/tmp/19a2e552db727a2b/b/build/Debug" --prefix "/Users/user/.conan2/p/tmp/19a2e552db727a2b/p"
-- Install configuration: "Debug"
-- Installing: /Users/user/.conan2/p/tmp/19a2e552db727a2b/p/lib/libhello.a
-- Installing: /Users/user/.conan2/p/tmp/19a2e552db727a2b/p/include/hello.h
hello/1.0 package(): Packaged 1 '.h' file: hello.h
hello/1.0 package(): Packaged 1 '.a' file: libhello.a
hello/1.0: Package '3d27635e4dd04a258d180fe03cfa07ae1186a828' created
hello/1.0: Created package revision 67b887a0805c2a535b58be404529c1fe
hello/1.0: Full package reference: hello/1.0#e6b11fb0cb64e3777f8d62f4543cd6b3:3d27635e4dd04a258d180fe03cfa07ae1186a828#67b887a0805c2a535b58be404529c1fe
hello/1.0: Package folder /Users/user/.conan2/p/c7796386fcad5369/p

正如您所看到的，Conan 生成了两个包 ID。

Release 的包 738feca714b7251063cc51448da0cf4811424e7c
Debug 的包 3d27635e4dd04a258d180fe03cfa07ae1186a828

这两个包 ID 是通过 **设置、选项和有关需求的某些信息**（我们将在文档的后面解释这一点）的集合 **计算哈希值** 而得出的。所以，例如，在这个例子中，它们是下面图表中所示信息的计算结果。

这些包 ID 不同是因为 **build_type** 不同。现在，当您想安装一个包时，Conan 会：

收集应用的设置和选项，以及一些关于需求的信息，并计算相应包 ID 的哈希值。
如果该包 ID 与本地 Conan 缓存中存储的包之一匹配，Conan 将使用该包。如果不是，并且我们配置了任何 Conan 远程仓库，它将在远程仓库中搜索具有该包 ID 的包。
如果计算出的包 ID 在本地缓存和远程仓库中都不存在，Conan 将会以“缺失二进制文件”的错误消息失败，或者尝试从源代码构建该包（这取决于 --build 参数的值）。此构建将在本地缓存中生成一个新的包 ID。

这些步骤是简化的，包 ID 的计算比我们在此解释的要复杂得多。Recipe 本身甚至可以调整其包 ID 计算方式，我们除了包 ID 之外还可以有不同的 Recipe 和包版本，Conan 中还有一个内置机制可以配置为声明某些具有特定包 ID 的包彼此兼容。

也许您现在已经有了为什么我们在 Conan Recipe 中删除设置或选项的直觉。如果您这样做，这些值将不会包含在包 ID 的计算中，所以即使您定义了它们，生成的包 ID 也会是相同的。例如，您可以检查 fPIC 选项，当我们将选项 shared=True 构建时，该选项会被删除。无论您为 fPIC 选项传递什么值，**hello/1.0** 二进制文件生成的包 ID 都是相同的。

Windows¶

$ conan create . --build=missing -o shared=True -o fPIC=True -tf=""

Linux, macOS¶

$ conan create . --build=missing -o shared=True -o -tf=""

...
hello/1.0 package(): Packaged 1 '.h' file: hello.h
hello/1.0 package(): Packaged 1 '.dylib' file: libhello.dylib
hello/1.0: Package '2a899fd0da3125064bf9328b8db681cd82899d56' created
hello/1.0: Created package revision f0d1385f4f90ae465341c15740552d7e
hello/1.0: Full package reference: hello/1.0#e6b11fb0cb64e3777f8d62f4543cd6b3:2a899fd0da3125064bf9328b8db681cd82899d56#f0d1385f4f90ae465341c15740552d7e
hello/1.0: Package folder /Users/user/.conan2/p/8a55286c6595f662/p

$ conan create . --build=missing -o shared=True -o fPIC=False -tf=""
...
-------- Computing dependency graph --------
Graph root
    virtual
Requirements
    fmt/8.1.1#601209640bd378c906638a8de90070f7 - Cache
    hello/1.0#e6b11fb0cb64e3777f8d62f4543cd6b3 - Cache

-------- Computing necessary packages --------
Requirements
    fmt/8.1.1#601209640bd378c906638a8de90070f7:d1b3f3666400710fec06446a697f9eeddd1235aa#24a2edf207deeed4151bd87bca4af51c - Skip
    hello/1.0#e6b11fb0cb64e3777f8d62f4543cd6b3:2a899fd0da3125064bf9328b8db681cd82899d56#f0d1385f4f90ae465341c15740552d7e - Cache

-------- Installing packages --------

-------- Installing (downloading, building) binaries... --------
hello/1.0: Already installed!

如您所见，第一次运行创建了 2a899fd0da3125064bf9328b8db681cd82899d56 包，第二次运行，尽管 fPIC 选项的值不同，但显示我们已经安装了 2a899fd0da3125064bf9328b8db681cd82899d56 包。

C 库¶

还有其他常见情况，您可能希望删除某些设置。假设您正在打包一个 C 库。当您构建这个库时，像 C++ 编译器标准（self.settings.compiler.cppstd）或使用的标准库（self.settings.compiler.libcxx）这样的设置，根本不会影响生成的二进制文件。那么让它们影响包 ID 的计算就没有意义了，所以一个典型的模式是在 configure() 方法中删除它们。

def configure(self):
    self.settings.rm_safe("compiler.cppstd")
    self.settings.rm_safe("compiler.libcxx")

请注意，在 configure() 方法中删除这些设置不仅会修改包 ID 的计算，还会影响工具链和构建系统集成的工作方式，因为 C++ 设置不存在。

注意

从 Conan 2.4 开始，如果定义了 languages = "C" Recipe 属性（实验性），则上述 configure() 不是必需的。

仅头文件库¶

与打包仅头文件库的包类似的情况也存在。在这种情况下，我们不需要链接任何二进制代码，只需要一些头文件添加到我们的项目中。因此，Conan 包的包 ID 不应受设置或选项的影响。对于这种情况，有一种更简单的方法来声明生成的包 ID 不应考虑设置、选项或任何关于需求的信息：在另一个名为 package_id() 的 Recipe 方法中调用 self.info.clear() 方法。

def package_id(self):
    self.info.clear()

我们将在后面解释 package_id() 方法，并解释如何自定义包 ID 的计算方式。如果您想更详细地了解此方法的工作原理，还可以查看 Conanfile 方法参考。

另请参阅

JFrog Academy Conan 2 Essentials: 配置设置和选项
仅头文件软件包.
检查二进制兼容性 compatibility.py 扩展。
Conan 包类型。
为需求设置 package_id_mode.
请阅读二进制模型参考以全面了解 Conan 二进制模型。

在 Recipe 中配置设置和选项¶

Conan 包的二进制兼容性：**包 ID**¶

C 库¶

仅头文件库¶

Conan 包的二进制兼容性：包 ID¶