package_id()

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

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

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

  • 给定的包配方可以实现部分信息擦除，例如为了在一定范围的编译器版本中获得相同的 package_id。这种类型的二进制兼容性通常通过全局 compatibility 插件，或者在全局插件不足时通过 compatibility() 方法来更好地解决。

  • 包配方可以决定在计算出的 package_id 中注入额外的可变性，添加 conf 项或“目标”设置。

可用的自动实现

警告

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

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

auto_header_only

当配方声明选项 header_only=True 或当 package_type 是 "header-library" 时，Conan 将自动管理包 ID 清除设置和选项。可以像这样添加到配方中：

from conan import ConanFile

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

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

如果您需要在配方中实现自定义行为，但同时又需要此逻辑，则必须明确声明，例如，像这样：

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 上。

如果一个包只是一个 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_id() 可以移除其他现有设置和选项：

# 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 下创建一个新的包修订版。

部分信息擦除

还可以对给定值子集进行部分信息擦除。例如，如果我们要为使用 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 版本将只有 1 个 package_id 二进制文件。这也具有上面提到的关于丢失创建此二进制文件信息的缺点。

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

注意

不仅可以擦除 settings，还可以擦除所有其他类型的信息，如 options 和 conf 项。

添加信息

默认情况下，有些信息不会添加到 package_id 中。如果我们正在为工具创建一个包，用作 tool_require，并且该包的二进制文件对于每个“目标”配置都不同，就像某些交叉编译器的情况一样，如果编译器本身可能因其目标的不同架构而异，则需要通过以下方式将 settings_target 添加到 package_id 中：

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

默认情况下，conf 项不影响 package_id。可以通过以下方式在配方级别明确地将它们作为 package_id 的一部分：

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

尽管这可以在没有 package_id() 方法的情况下为所有配方实现，但可以使用 tools.info.package_id:confs = ["user.myconf:myitem"] 配置。

使用正则表达式模式： 您可以在 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”开头的配置。

另请参阅