package_id()

Conan 为每个配置计算唯一的 package_id 引用，包括 settings、options 和 dependencies 版本。 package_id() 方法允许对计算出的 package_id 进行一些自定义和更改，通常目的是放宽一些全局二进制兼容性假设。

一般规则是，每个不同的 settings 和 options 值都会创建一个不同的 package_id。可以采用不同的方法来放宽或扩展此规则

  • 给定的 package recipe 可以在其 package_id() 中确定最终二进制文件与某些 settings 无关，例如，如果它是一个仅包含头文件的库，它使用输入 settings 来构建一些测试，则它可能会完全清除所有配置，因此无论输入如何，生成的 package_id 始终相同。同样，C 库可能希望从其二进制 package_id 中删除 compiler.cppstd 和/或 compiler.libcxx 的影响，因为作为 C 库，其二进制文件将是独立的。

  • 给定的 package recipe 可以实现部分信息擦除，例如，为一系列编译器版本获得相同的 package_id。通常，这种类型的二进制兼容性最好通过全局 compatibility 插件或 compatibility() 方法来解决（如果全局插件不足以解决问题）。

  • package recipe 可以决定在其计算出的 package_id 中注入额外的可变性，添加 conf 项或 “target” settings。

可用的自动实现

警告

此功能是实验性的，可能会发生重大更改。有关更多信息，请参阅Conan 稳定性部分。

当未定义 package_id() 方法时，可以在 implements ConanFile 属性中指定以下自动实现

auto_header_only

当 recipe 声明选项 header_only=True 或 package_type 为 "header-library" 时，Conan 将自动管理 package ID 清除 settings 和 options。可以像这样将其添加到 recipe 中

from conan import ConanFile

class Pkg(ConanFile):
    implements = ["auto_header_only"]
    ...

然后，如果在 recipe 中未指定 package_id() 方法，Conan 将自动管理它并在 package_id() 中自动调用 self.info.clear()，以使 package_id 独立于 settings、options、配置和 requirements。

如果需要在 recipe 中实现自定义行为，但也需要此逻辑，则必须显式声明，例如，如下所示

def package_id(self):
    if self.package_type == "header-library":
        self.info.clear()
    else:
        self.info.settings.rm_safe("compiler.libcxx")
        self.info.settings.rm_safe("compiler.cppstd")

信息擦除

这是一种 package_id 放宽策略。让我们检查第一种情况：仅包含头文件的库，它具有输入 settings，因为它仍然希望在 build() 方法中将它们用于某些单元测试。为了使所有配置都只有一个最终二进制文件，因为最终工件在所有情况下都应该是相同的（仅是头文件），因此有必要执行以下操作

settings = "os", "compiler", "arch", "build_type"

def build(self):
    cmake = CMake(self) # need specific settings to build
    ...
    cmake.test()  # running unit tests for the current configuration

def package_id(self):
    # Completely clear all the settings from the ``package_id`` information ("info" object)
    # All resulting ``package_id`` will be the same, irrespective of configuration
    self.info.settings.clear()

警告

信息的修改始终发生在 self.info 对象上，而不是在 self.settings 或 self.options 上

如果一个 package 只是一个 C 库，但它无法在 configure() 方法中删除 compiler.cppstd 和 compiler.libcxx （大多数情况下推荐的方法，以保证这些标志不会在构建中使用），因为 C 库有 C++ 单元测试，那么由于测试未打包，并且最终二进制文件将独立于 C++，因此可以使用以下方法删除它们

settings = "os", "compiler", "arch", "build_type"

def build(self):
    # building C++ tests for a C library

def package_id(self):
    del self.info.settings.compiler.cppstd
    # Some compilers might not declare libcxx subsetting
    self.info.settings.rm_safe("compiler.libcxx")

如果 package 正在构建要用作工具的可执行文件，并且为了提高效率，每个操作系统和体系结构只需要 1 个可执行文件，则 package_id() 可以删除其他 settings 和 options（如果存在）

# this will be a "tool_require"
package_type = "application"
settings = "os", "compiler", "arch", "build_type"

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

请注意，这并不意味着应该为每个应用程序可执行文件删除 compiler 和 build_type。对于其他不是工具而是要发布的最终产品，最常见的情况是，为不同的编译器、编译器版本、构建类型等维护不同的构建是最佳方法。这也意味着我们正在擦除一些信息。我们将没有用于我们正在使用的二进制文件的编译器和构建类型的信息（它不会在 conan list 输出中，也不会在服务器元数据中）。如果我们使用不同的编译器或构建类型编译新的二进制文件，它将在相同的 package_id 下创建一个新的 package revision。

部分信息擦除

也可以部分擦除给定值子集的信息。例如，如果我们希望对于使用 gcc 在 4.5 和 5.0 版本之间编译的所有二进制文件都具有相同的 package_id，我们可以这样做

def package_id(self):
    v = Version(str(self.info.settings.compiler.version))
    if self.info.settings.compiler == "gcc" and (v >= "4.5" and v < "5.0"):
        # The assigned string can be arbitrary
        self.info.settings.compiler.version = "GCC 4 between 4.5 and 5.0"

这将导致除 gcc 以外的所有其他编译器以及该范围之外的其他版本都具有不同的 package_id，但对于所有 gcc 4.5-5.0 版本，将只有一个 package_id 二进制文件。这也具有上述关于丢失创建此二进制文件的信息的缺点。

不建议在一般情况下使用此方法，最好使用全局 compatibility 插件或 recipe compatibility() 方法来解决。

添加信息

默认情况下，某些信息未添加到 package_id。如果我们正在为工具创建一个 package，将其用作 tool_require，并且恰好每个 “target” 配置的此类 package 二进制文件都不同，就像某些交叉编译器的情况一样，如果编译器本身对于它 targeting 的不同体系结构可能不同，则有必要使用以下方法将 settings_target 添加到 package_id

def package_id(self):
    self.info.settings_target = self.settings_target

默认情况下，conf 项不会影响 package_id。可以使用以下方法在 recipe 级别显式地使其成为其中的一部分

def package_id(self):
    self.info.conf.define("user.myconf:myitem", self.conf.get("user.myconf:myitem"))

虽然可以使用 tools.info.package_id:confs = ["user.myconf:myitem"] 配置来实现所有没有 package_id() 方法的 recipe 的此目的。

使用正则表达式模式： 您可以在 tools.info.package_id:confs 中使用正则表达式模式。这意味着您可以不必指定每个单独的配置项，而是可以使用正则表达式模式来匹配多个配置。当处理大量配置或配置遵循可预测的命名模式时，这尤其有用。例如

  • tools.info.package_id:confs=[".*"] 匹配所有配置。

  • tools.info.package_id:confs=["tools\..*"] 匹配以 “tools.” 开头的配置。

  • tools.info.package_id:confs=["(tools\.deploy|core)"] 匹配以 “tools.deploy” 或 “core” 开头的配置。

另请参阅