自定义二进制兼容性

默认的二进制兼容性要求设置和选项几乎完全匹配,以及依赖项版本的版本化匹配,如 前面关于依赖项的部分 中所述。

总而言之,安装依赖项时所需的二进制文件 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 版本,而不考虑 patchrecipe_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() 中擦除信息意味着 1 个 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_mode, package_id_non_embed_mode, package_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 中定义可以使用的不同模式