扩展二进制模型

有几种机制可以扩展默认的 Conan 二进制模型。

自定义设置

可以在 settings.yml 文件中添加新的设置或子设置，类似于：

os:
    Windows:
        new_subsetting: [null, "subvalue1", "subvalue2"]
new_root_setting: [null, "value1", "value2"]

其中 null 值允许在 profile 中将设置留空。如果不包含，则 profile 必须为它们定义一个值。

自定义设置将在 recipe 和包中显式或隐式地使用。

class Pkg(ConanFile):
    # If we explicitly want this package binaries to vary according to 'new_root_setting'
    settings = "os", "compiler", "build_type", "arch", "new_root_setting"
    # While all packages with 'os=Windows' will implicitly vary according to 'new_subsetting'

另请参阅

有关 settings.yml 文件如何自定义的完整参考，请访问设置部分。实际上，无需修改 settings.yml 文件，而是可以提供 settings_user.yml 文件来扩展现有设置。请参阅settings_user.yml 文档。

自定义选项

Options 是每个 recipe 特有的，不像 settings.yml 那样没有全局定义。

包 conanfile.py recipe 定义自己的选项，具有自己的有效值范围和默认值。

class MyPkg(ConanFile):
    ...
    options = {"build_tests": [True, False],
               "option2": ["ANY"]}
    default_options = {"build_tests": True,
                        "option1": 42,
                        "z*:shared": True}

shared、fPIC 和 header_only 选项对 Conan 具有特殊含义，并且大多数内置构建系统集成都会自动考虑它们。它们也是表示库是共享、静态还是仅头文件的推荐默认值。

另请参阅

设置 vs 选项 vs conf

何时使用设置、选项或配置？

  • 设置 是项目范围的配置，通常会影响正在构建的整个项目并影响生成的包二进制文件。例如，操作系统或体系结构通常对依赖项图中的所有包都是相同的，将 Linux 库链接到构建 Windows 应用程序，或者混合体系结构是不可能的。设置不能在包 recipe 中设置默认值。给定库的 recipe 不能说它的默认值是 os=Windows。 os 将由处理该 recipe 的环境提供。它是必须在输入 profile 中定义的输入。

  • 另一方面，选项 是影响生成的包二进制文件的包特定配置。静态或共享库不是适用于所有包的设置。有些可以是仅头文件库，而其他包可能只是数据，或者包可执行文件。例如，shared 是一个常用选项（用于指定库是静态还是共享的默认选项），但包可以定义和使用它们想要的任何选项。选项是在包 conanfile.py recipe 中定义的，包括它们支持的值和默认值，使用 options 和 default_options。

  • 通过 conf 进行的配置用于在通常情况下不影响生成的包二进制文件的配置。例如，使用 tools.cmake.cmaketoolchain:generator=Ninja 构建一个库，不应该生成与使用 Visual Studio 构建的二进制文件不同的二进制文件（只是由于 Ninja 而通常构建得更快）。

以上存在一些例外。例如，可以使用 `< 

$ conan install . -s mypkg/*:compiler=gcc -s compiler=clang ..

这将为“mypkg”使用 gcc，为其余依赖项使用 clang（在大多数情况下，建议为整个依赖项图使用相同的编译器，但在某些保证强大二进制兼容性的情况下，可以混合使用不同编译器构建的库）。

在某些情况下，许多包使用相同的选项值，从而允许您一次使用模式设置其值，例如：

$ conan install . -o *:shared=True

自定义配置

如上所述，Conan 的 conf 配置系统旨在调整某些工具和行为，但实际上不影响生成的包二进制文件。一些典型的 conf 项目包括激活并行构建、配置上传到服务器时的“重试”次数，或更改 CMake 生成器。有关 Conan 配置系统在此部分中 阅读更多内容。

还可以为用户定义的配置定义 user.xxxx:conf=value，与核心和工具内置配置的精神相同，它们不会影响二进制文件的 package_id。

但可能存在一些特殊情况，在其中确实希望某些 conf 定义不同的 package_ids，从而创建不同的包二进制文件。这可以在两个不同的地方完成：

  • 在本地，在 recipe 的 package_id 方法中，通过 self.info.conf 属性。

    def package_id(self):
    # We can get the value from the actual current conf value, or define a new value
    value = self.conf.get("user.myconf:myitem")
    # This ``self.info.conf`` will become part of the ``package_id``
    self.info.conf.define("user.myconf:myitem", value)

  • 全局，使用 tools.info.package_id:confs 配置，它接收一个现有配置列表作为参数，以便它们成为 package ID 的一部分，因此您可以在 profile 中定义：

    tools.info.package_id:confs=["tools.build:cxxflags", ...]

    生成的 package_id 将包含在 tools.build:cxxflags 和其他配置中提供的值。请注意，此值被管理为字符串，更改字符串将产生不同的结果和不同的 package_id，因此如果使用此方法，请务必对 tools.build:cxxflags 等不同配置提供的值保持一致。

    还可以使用正则表达式匹配多个 confs，而不是列出所有它们，例如 .*cmake 可以匹配其名称中包含“cmake”的任何配置（但不推荐这样做，请参阅下面的最佳实践）。

注意

最佳实践

总的来说，通过 conf 定义二进制文件的 package_id 的可变性应保留给特殊情况，并始终谨慎管理。将许多不同的 confs 传递给 tools.info.package_id:confs 很容易导致诸如二进制文件丢失或不必要地构建过多二进制文件等问题。如果出现这种情况，请考虑使用新的自定义设置或选项来构建更高层次的二进制文件抽象。

交叉构建目标设置

在针对“build”上下文中的 tool_requires 的交叉编译场景中，self.settings_target 是一个 conanfile.py 属性，它变得相关。当我们有一个像 CMake 这样的 tool_requires，例如 cmake/3.25.3，包二进制文件独立于交叉编译可能定位的平台，它是相同的 cmake 可执行文件，适用于所有不同的目标平台。针对 Windows-X64 到 Linux-armv8 场景交叉编译的 cmake conanfile recipe 的 settings 将是：

  • self.settings：当前 cmake/3.25.3 将运行的设置。由于它是工具依赖，它将在 Windows 机器上运行，因此 self.settings.os = Windows 和 self.settings.arch = x86_64。

  • self.settings_build：如果需要，将构建此包的当前构建机的设置。这也是 Windows-x64 机器，因此 self.settings_build.os = Windows 和 self.settings_build.arch = x86_64。

  • self.settings_target：当前应用程序输出将要定位的设置。在这种情况下，它将是 self.settings_target.os = Linux 和 self.settings_target.arch = armv8。

在 cmake 包场景中，正如我们所指出的，目标是无关紧要的。它根本不在 cmake conanfile recipe 中使用，并且不影响 cmake 二进制包的 package_id。

但是，在某些情况下，二进制包可能会因目标平台而异。例如，一个交叉编译器 gcc 根据其要编译的目标有一个不同的 gcc 可执行文件。这在 GNU 生态系统中很常见，例如，我们可以找到特定于给定体系结构的 arm-gcc 工具链。Conan 可以通过将 package_id 扩展到这些 settings_target 的值来反映这种情况。

def package_id(self):
    self.info.settings_target = self.settings_target
    # If we only want the ``os`` and ``arch`` settings, then we remove the other:
    self.info.settings_target.rm_safe("compiler")
    self.info.settings_target.rm_safe("build_type")