定制二进制兼容性

默认的二进制兼容性要求设置和选项几乎精确匹配,以及依赖项版本匹配,如前一个关于依赖项的部分 中所解释的。

总之,当安装依赖项时,所需二进制文件的 package_id 应该默认匹配

  • package_id 中的所有设置,除了 compiler.cppstd 之外,都应该与输入配置文件中提供的设置精确匹配,包括编译器版本。因此,compiler.version=9compiler.version=9.1 不同。

  • 默认行为将假定 C++ 包的不同 compiler.cppstd 值之间具有二进制兼容性,如果输入配置文件所需的 cppstd 不存在,则能够回退到输入配置文件中指定的其他值。这由 compatibility.py 插件控制,用户可以对其进行定制。

  • package_id 中的所有选项都应该与输入配置文件中提供的选项精确匹配。

  • 依赖项的版本应该匹配

    • 对于“嵌入式依赖项”,应匹配精确版本,包括配方修订版和依赖项的 package_idpackage_revision 从不包含在内,因为对于同一个 package_id 存在多个 package_revision 被认为是格式不正确的。

    • 对于“非嵌入式依赖项”,依赖项的版本应匹配到次要版本(minor),而补丁版本(patch)、配方修订版(recipe_revision)以及其他进一步的信息不予考虑。

    • 对于“工具依赖项”,默认情况下,依赖项的版本完全不影响消费者的 package_id

这些规则可以根据需求,使用不同的方法进行定制和更改,如下面各节所述

定制设置和选项的二进制兼容性

package_id() 方法中的信息擦除

配方可以使用其 package_id() 方法从其 package_id擦除信息。例如,一个只包含可执行文件的包可以决定从其 package_id 中移除 settings.compilersettings.build_type 的信息,因为它假定使用任何编译器构建的可执行文件都将有效,并且没有必要存储用不同编译器构建的不同二进制文件。

def package_id(self):
    del self.info.settings.compiler
    del self.info.settings.build_type

也可以为给定设置分配一个值,例如,如果我们希望在 [>=5 <7>] 范围内包含所有 gcc 版本的单个二进制文件,我们可以这样做

def package_id(self):
    if self.info.settings.compiler == "gcc":
        version = Version(self.info.settings.compiler.version)
        if version >= "5.0" and version < "7.0":
            self.info.settings.compiler.version = "gcc5-6"

注意

最佳实践

请注意,在 package_id() 中擦除信息意味着一个单独的 package_id 将代表一系列不同的设置,但用于创建二进制文件的确切设置信息将丢失,并且该范围内只能创建一个二进制文件。在该范围内使用不同设置重新创建包,将创建一个新二进制文件,覆盖旧二进制文件(带有新的包修订版)。

如果我们希望能够为不同的输入设置创建、存储和管理不同的二进制文件,则不能使用信息擦除,建议使用以下 compatibility 方法。

compatibility() 方法

配方可以使用其 compatibility() 方法定义其二进制兼容性规则。例如,如果我们希望用 gcc 4.8、4.7 和 4.6 版本构建的二进制文件被认为与用 4.9 版本编译的二进制文件兼容,我们可以像这样声明一个 compatibility() 方法

def compatibility(self):
    if self.settings.compiler == "gcc" and self.settings.compiler.version == "4.9":
        return [{"settings": [("compiler.version", v)]}
                for v in ("4.8", "4.7", "4.6")]

了解更多关于 compatibility() 方法的信息,请参见 compatibility() 方法参考

compatibility.py 插件

兼容性可以通过 compatibility.py 插件进行全局定义,就像 compatibility() 方法针对单个配方一样,但此插件对所有包全局生效。

检查二进制兼容性 compatibility.py 扩展

定制依赖项版本的二进制兼容性

全局默认 package_id 模式

global.conf 中定义的 core.package_id:default_xxx 配置可用于全局更改依赖项影响其消费者的方式的默认设置。

core.package_id:default_build_mode: By default, 'None'
core.package_id:default_embed_mode: By default, 'full_mode'
core.package_id:default_non_embed_mode: By default, 'minor_mode'
core.package_id:default_python_mode: By default, 'minor_mode'
core.package_id:default_unknown_mode: By default, 'semver_mode'

这些配置会影响 包 ID 的计算方式,因此更改它们将影响您生成的二进制文件。因此,建议它们在整个组织中保持一致。

注意

最佳实践

强烈建议 core.package_id:default_xxx 在组织内保持全局、一致和不可变。为不同的项目或团队更改这些默认设置可能会导致混淆,因为它将导致缺少二进制文件。

如果这些包在组织外部共享,它还应该与生成的包的消费者保持一致和共享,在这种情况下,建议通过 conan config install 共享 global.conf 文件。

考虑使用 Conan 的默认设置,它们应该在效率和安全性之间取得良好平衡,确保嵌入式情况下的精确重建,以及非嵌入式情况下的良好版本控制。

配方消费者的自定义 package_id 模式

配方可以通过一些 package_id_xxxx_mode 属性定义其对消费者的默认影响。

package_id_embed_modepackage_id_non_embed_modepackage_id_unknown_mode 是类属性,可以在配方中定义,以确定当它们作为 requires 被消费时,它们对其消费者 package_id 的影响。build_mode(实验性)是一个类属性,当消费者将其用作 tool_requires 时,会影响包的消费者。可以声明为

from conan import ConanFile

class Pkg(ConanFile):
    ...
    package_id_embed_mode = "full_mode"
    package_id_non_embed_mode = "patch_mode"
    package_id_unknown_mode = "minor_mode"
    build_mode = "patch_mode"  # when this is used with tool_requires

更多信息请参见 package_id_{embed,non_embed,python,unknown}_mode, build_mode

来自配方依赖项的自定义 package_id

配方可以使用 package_id_mode 特性定义其依赖项如何影响其 package_id

from conan import ConanFile

class Pkg(ConanFile):
    def requirements(self):
        self.requires("mydep/1.0", package_id_mode="patch_mode")

使用 package_id_mode 特性不区分“嵌入式”和“非嵌入式”情况,由用户定义正确的值。这种方法可能只应用于那些没有通过 options 控制共享/静态库可变性的非常特殊的情况。

请注意,requirements() 方法在图展开时进行评估,此时依赖项尚不存在(尚未计算),因此无法得知依赖项的选项。在这种情况下,可能更倾向于使用 package_id() 方法。

package_id() 方法可以定义依赖项如何影响当前包,通过

from conan import ConanFile

class Pkg(ConanFile):
    def package_id(self):
        self.info.requires["mydep"].major_mode()

可以使用的不同模式在 package_id_{embed,non_embed,python,unknown}_mode, build_mode 中定义。