在 recipe 中配置 settings 和 options¶

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

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

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

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

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 中可用的 options 或 settings。例如，在这种情况下，我们删除 fPIC 选项，因为它只应为True如果我们以共享库的形式构建库（实际上，一些构建系统在构建共享库时会自动添加此标志）。
config_options()：此方法用于约束包中可用的 options 在它们取值之前。如果将值赋给在此方法中删除的 setting 或 option，Conan 将引发错误。在这种情况下，我们正在删除 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 只是将一组 settings、options 和有关包需求的信息转换为唯一标识符的一种方式。

让我们为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 是通过获取settings、options 和一些关于需求的集合（我们将在文档中稍后解释）并计算它们的哈希值来计算的。因此，例如，在这种情况下，它们是下图所示信息的结果。

这些包 ID 不同，因为build_type不同。现在，当您想要安装一个包时，Conan 会执行以下操作：

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

这些步骤是简化的，包 ID 的计算远比我们在此解释的复杂。Recipes 本身甚至可以调整其包 ID 计算，除了包 ID，我们还可以有不同的 recipe 和包修订版本，Conan 中还有一个内置机制，可以配置为声明某些具有特定包 ID 的包是相互兼容的。

现在您可能已经明白了为什么我们在 Conan recipe 中删除 settings 或 options。如果您这样做，这些值将不包含在包 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 库¶

在其他典型情况下，您可能希望删除某些 settings。想象一下您正在打包一个 C 库。当您构建此库时，有些 settings，例如编译器 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()方法中删除这些 settings 不仅会修改包 ID 计算，还会影响工具链和构建系统集成的工作方式，因为 C++ settings 不存在。

注意

从 Conan 2.4 开始，如果定义了languages = "C" recipe 属性，则上述configure()不再需要（实验性功能）。

仅头文件库¶

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

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

我们将在稍后解释package_id()方法，并解释如何自定义包 ID 的计算方式。您还可以查阅Conanfile 方法参考，如果您想了解此方法的更多细节。

另请参阅

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