配方设置和选项如何影响其包 ID¶

在 Conan 中，包 ID 是包二进制文件的唯一标识符，它考虑了影响其二进制兼容性的所有因素。这些因素包括配方选项和设置以及需求或工具需求。

让我们看看设置和选项如何影响包 ID，以及一些它们不应该影响的示例。

设置如何影响包 ID¶

设置是项目范围的开发变量，例如编译器、其版本或操作系统本身。这些变量值必须定义，它们应该与我们的开发环境的值匹配，并且它们不能像选项那样具有默认值。

例如，让我们定义一个生成仅依赖于操作系统的包的配方

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "1.0.0"
    settings = "os"  # Only OS setting affects the package ID

如果我们从此配方为 Linux 生成一个包，我们将获得以下包 ID

 $ conan create . --settings os=Linux
 ...
 pkg/1.0.0: Package '9a4eb3c8701508aa9458b1a73d0633783ecc2270' created

 $ conan list pkg/1.0.0:*
 Local Cache
   pkg
     pkg/1.0.0
       revisions
           476929a74c859bb5f646363a4900f7cf (2024-03-07 09:13:43 UTC)
             packages
               9a4eb3c8701508aa9458b1a73d0633783ecc2270
                 info
                   settings
                     os: Linux

如果我们对 Windows 执行相同的操作，现在包 ID 将有所不同

 $ conan create . --settings os=Windows
 ...
 pkg/1.0.0: Package 'ebec3dc6d7f6b907b3ada0c3d3cdc83613a2b715' created

 $ conan list pkg/1.0.0:*
 Local Cache
   pkg
     pkg/1.0.0
       revisions
           476929a74c859bb5f646363a4900f7cf (2024-03-07 09:13:43 UTC)
             packages
               9a4eb3c8701508aa9458b1a73d0633783ecc2270
                 info
                   settings
                     os: Linux
               ebec3dc6d7f6b907b3ada0c3d3cdc83613a2b715
                 info
                   settings
                     os: Windows

每当设置或子设置的值发生变化时，包 ID 都会有所不同以反映这一点。

设置最常见的用法是模拟可能影响包 ID 的不同项目范围方面。执行此操作的配方的格式如下

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "1.0.0"
    settings = "os", "arch", "compiler", "build_type"

现在，使用不同的编译器版本编译包将导致不同的包 ID

 $ conan create . --settings compiler.version=192
 ...
 pkg/1.0.0: Package '4f267380690f99b3ef385199826c268f63147457' created

 $ conan create . --settings compiler.version=193
 ...
 pkg/1.0.0: Package 'c13a22a41ecd72caf9e556f68b406569547e0861' created

 $ conan list pkg/1.0.0:*
 Local Cache
   pkg
     pkg/1.0.0
       revisions
         f1f48830ecb04f3b328429b390fc5de8 (2024-03-07 09:21:07 UTC)
           packages
             4f267380690f99b3ef385199826c268f63147457
               info
                 settings
                   arch: x86_64
                   build_type: Release
                   compiler: msvc
                   compiler.cppstd: 14
                   compiler.runtime: dynamic
                   compiler.runtime_type: Release
                   compiler.version: 192
                   os: Windows
             c13a22a41ecd72caf9e556f68b406569547e0861
               info
                 settings
                   arch: x86_64
                   build_type: Release
                   compiler: msvc
                   compiler.cppstd: 14
                   compiler.runtime: dynamic
                   compiler.runtime_type: Release
                   compiler.version: 193
                   os: Windows

删除用作工具需求的包的设置¶

在某些情况下，设置不应影响生成的包 ID。例如，当一个配方打包一个工具，该工具将通过 tool_requires 用于构建其他包时。

在这种情况下，使用的编译器的值需要用于工具的编译，但对于使用者来说并不那么相关，因为我们只希望执行该工具来构建其他项目。因此，我们最终可以从包 ID 中删除编译器的影响

from conan import ConanFile

class CMake(ConanFile):
    name = "cmake"
    version = "1.0.0"
    settings = "os", "arch", "compiler", "build_type"  # Only OS and architecture influence the resulting package

    def build(self):
        # self.settings.compiler value will be used here to compile cmake

    def package_id(self):
        # Remove compiler setting from package ID
        del self.info.settings.compiler

为什么不从 settings 属性中删除设置？因为编译器值在 build() 方法中仍然需要用于执行可执行文件的编译。

注意

如果我们正在生成自己的可执行文件（我们自己的应用程序，而不是 tool_require），不建议从包 ID 中删除编译器设置，因为我们始终希望知道该包是使用特定编译器生成的。

但是，如果我们打包的工具甚至不需要编译器输入来构建（例如 Python 脚本），我们也可以直接删除 settings 属性

from conan import ConanFile

class MyPythonScripts(ConanFile):
    name = "my-python-scripts"
    version = "1.0.0"
    # No settings this time

或者，如果该工具是特定于平台的，我们可以只保留操作系统和体系结构信息

from conan import ConanFile

class MyScripts(ConanFile):
    name = "my-scripts"
    version = "1.0.0"
    settings = "os", "arch"

选项如何影响包 ID¶

选项用于指定特定于单个配方的特性，这与通常在项目中跨配方保持一致的设置形成对比。它们通常是一组库可执行文件或 Conan 包可能具有的特定特性。

例如，shared 选项是在可以生成共享库的配方中使用的非常常见的选项。但是，它不能是设置，因为并非所有配方都生成共享库。

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "1.0.0"
    options = {"shared": [True, False]}
    default_options = {"shared": True}

与之前设置的情况一样，选项的不同值将影响包 ID，因此根据它生成不同的包。

 $ conan create . --options shared=True
 ...
 pkg/1.0.0: Package '1744785cb24e3bdca70e27041dc5abd20476f947' created

 $ conan create . --options shared=False
 ...
 pkg/1.0.0: Package '55c609fe8808aa5308134cb5989d23d3caffccf2' created

同样，可能存在一些“选项”作为配方中的输入来生成一个包，但这些选项不应该在包 ID 中考虑。例如，一个选项可以控制构建阶段期间的一些内容，但这不会影响包结果，例如编译的详细程度。在这种情况下，配方应该在 package_id() 方法中删除该选项

但是，一般的建议是选项应该始终影响包 ID，如果我们想要对配方进行输入但不希望它影响包 ID，则应该通过配置文件的 conf 部分来完成。然后在配方中，我们应该只添加

from conan import ConanFile

class MyPkg(ConanFile):
    name = "my-pkg"
    version = "1.0.0"

    def build(self):
        verbosity = self.conf.get("user.my-pkg:verbosity")
        self.output.info(f"Using verbosity level: {verbosity})
        ...

myprofile¶

[conf]
user.my-pkg:verbosity=silent

这样，包 ID 不会受到影响，配方将更简洁（没有与包 ID 无关的选项），并且可以通过配置文件的 conf 部分轻松管理输入。

另请参阅