配置配方中的设置和选项¶

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

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

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

您会注意到与之前的配方相比，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")
    ...

您可以看到，我们向配方中添加了一个 configure() 方法。让我们解释一下该方法的目的以及它与我们已经在配方中定义过的 config_options() 方法的不同之处

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

请注意，使用 config_options() 方法删除选项与使用 configure() 方法删除选项的结果不同。在 config_options() 中删除选项**就像我们从未在配方中声明过它一样**，这将引发一个说选项不存在的异常。但是，如果我们将其在 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

包 *738feca714b7251063cc51448da0cf4811424e7c* 用于 Release
包 *3d27635e4dd04a258d180fe03cfa07ae1186a828* 用于 Debug

这些包 ID 通过获取**设置、选项和一些关于包要求的信息**并**计算它们的哈希值**来计算。因此，例如，在本例中，它们是下图所示信息的结果。

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

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

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

也许您现在已经了解了为什么我们在 Conan 配方中删除设置或选项。如果您这样做，这些值将不包含在包 ID 的计算中，因此即使您定义了它们，结果包 ID 也会相同。您可以检查此行为，例如使用在 shared=True 选项下构建时删除的 fPIC 选项。无论您传递给 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"（实验性），则上述 configure() 不是必需的。

仅头文件库¶

对于打包仅头文件库，情况类似。在这种情况下，我们不需要链接的二进制代码，而只需要添加到我们项目中的一些头文件。因此，Conan 包的包 ID 不应受设置或选项的影响。对于这种情况，有一种更简单的方法来声明生成的包 ID 应该忽略设置、选项或来自要求的任何信息：在另一个名为 package_id() 的配方方法中调用 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 二进制模型。

配置配方中的设置和选项¶

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

C 库¶

仅头文件库¶

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