扩展二进制模型

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

自定义设置

可以在 settings.yml 文件中添加新的设置或子设置，例如

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

其中 null 值允许在配置文件中不定义设置。如果不包含，则配置文件必须为其定义一个值。

自定义设置将在食谱和包中显式或隐式使用

class Pkg(ConanFile):
    # If we explicilty 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 对每个食谱都是自定义的，没有像 settings.yml 那样全局定义的选项。

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

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 应用程序，或混合架构是不可能的。设置不能在包食谱中默认为空。给定库的食谱不能说其默认值是 os=Windows。os 将由处理该食谱的环境提供。它是输入配置文件中必须定义的输入。

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

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

上述内容有一些例外。例如，可以使用 <pattern:>setting=value 为每个包定义设置，无论是在配置文件还是命令行中

$ 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，从而创建不同的包二进制文件。这可以在两个不同的地方完成

  • 在食谱的 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 配置，将现有配置列表作为参数接收，以作为包 ID 的一部分，因此您可以在配置文件中定义

    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 很容易导致缺少二进制文件或不必要地构建过多二进制文件等问题。如果是这种情况，请考虑使用新的自定义设置或选项在二进制文件之上构建更高级别的抽象。

交叉构建目标设置

self.settings_target 是一个 conanfile.py 属性，在交叉编译场景中对于“构建”上下文中的 tool_requires 工具变得相关。当我们有一个 tool_requires 像 CMake，比如 cmake/3.25.3，包二进制文件独立于交叉编译可能面向的平台，对于所有不同的目标平台都是相同的 cmake 可执行文件。对于从 Windows-X64 到 Linux-armv8 场景的 cmake conanfile 食谱，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 食谱中，并且不影响 cmake 二进制包的 package_id。

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

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")