食谱的设置和选项如何影响其包ID¶
在 Conan 中，包ID是包二进制文件的唯一标识符，它考虑了所有影响其二进制兼容性的因素。这些因素包括食谱选项和设置，以及要求或工具要求。
让我们看看设置和选项如何影响包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
移除用作 tool_require 的包的设置¶
在某些情况下，设置不应影响最终的包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 脚本），我们也可以直接移除设置属性
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})
...
[conf]
user.my-pkg:verbosity=silent
这样包ID将不受影响，食谱将更简洁（没有与包ID无关的选项），并且可以通过配置文件的 conf 部分轻松管理输入。
另请参阅