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

如果一个包正在构建一个要作为工具使用的可执行文件，并且只希望为每个操作系统和架构构建 1 个可执行文件以提高效率，则 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 下创建一个新的包修订版。

部分信息擦除

也可以为给定值的子集部分擦除信息。例如，如果我们希望为使用版本 4.5 到 5.0 之间的 gcc 编译的所有二进制文件具有相同的 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 插件或配方 compatibility() 方法来解决。

添加信息

默认情况下，某些信息不会添加到 package_id 中。如果我们正在为一个工具创建一个包，要作为 tool_require 使用，并且碰巧此包二进制文件对于每个“目标”配置都不同，例如某些交叉编译器的情况，如果编译器本身对于它所针对的不同架构可能不同，则需要将 settings_target 添加到 package_id 中，方法如下

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

conf 项目默认情况下不会影响 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”开头的配置。

另请参阅