package_info()

package_info() 方法负责定义传递给包消费者的信息，以便这些消费者可以轻松且自动地使用此包。消费者的 generate() 方法是映射 package_info() 中定义的信息到消费者特定构建系统的地方。因此，如果希望一个包被不同的构建系统使用（例如 ConanCenter 配方用于社区），那么确保此信息完整非常重要。

重要

此方法定义的信息仅供此包的消费者使用，不适用于自身。此方法在二进制文件构建和打包之后执行。构建中使用的信息应在 generate() 方法中处理。

cpp_info: 库和构建信息

每个包都必须为它的消费者指定某些构建信息。这可以在 cpp_info 属性中完成。

# Binaries to link
self.cpp_info.libs = []  # The libs to link against
self.cpp_info.system_libs = []  # System libs to link against
self.cpp_info.frameworks = []  # OSX frameworks that consumers will link against
self.cpp_info.objects = []  # precompiled objects like .obj .o that consumers will link
# Directories
self.cpp_info.includedirs = ['include']  # Ordered list of include paths
self.cpp_info.libdirs = ['lib']  # Directories where libraries can be found
self.cpp_info.bindirs = ['bin']  # Directories where executables and shared libs can be found
self.cpp_info.resdirs = []  # Directories where resources, data, etc. can be found
self.cpp_info.srcdirs = []  # Directories where sources can be found (debugging, reusing sources)
self.cpp_info.builddirs = []  # Directories where build scripts for consumers can be found
self.cpp_info.frameworkdirs = []  # Directories where OSX frameworks can be found
# Flags
self.cpp_info.defines = []  # preprocessor definitions
self.cpp_info.cflags = []  # pure C flags
self.cpp_info.cxxflags = []  # C++ compilation flags
self.cpp_info.sharedlinkflags = []  # linker flags
self.cpp_info.exelinkflags = []  # linker flags
# Properties
self.cpp_info.set_property("property_name", "property_value")
# Structure
self.cpp_info.components # Dictionary-like structure to define the different components a package may have
self.cpp_info.requires # List of components from requirements that need to be propagated downstream

要链接的二进制文件

• libs：消费者应链接的已编译库（包含在包中）的有序列表。默认情况下为空。

• system_libs：消费者应链接的系统库（不包含在包中）的有序列表。默认情况下为空。

• frameworks：消费者应链接的 OSX 框架（包含或不包含在包中）的有序列表。默认情况下为空。

• objects：消费者应链接的包含在包中的预编译对象（.obj, .o）的有序列表。默认情况下为空

目录

• includedirs：标头文件可以找到的目录的相对路径列表（从包根目录开始）。默认情况下初始化为 ['include']，很少更改。

• libdirs：查找库对象二进制文件（*.lib, *.a, *.so, *.dylib）的目录的相对路径列表（从包根目录开始）。默认情况下初始化为 ['lib']，很少更改。

• bindirs：查找库运行时二进制文件（如 Windows .dll 可执行文件）的目录的相对路径列表（从包根目录开始）。默认情况下初始化为 ['bin']，很少更改。

• resdirs：查找资源文件（图像、xml 等）的目录的相对路径列表（从包根目录开始）。默认情况下为空。

• srcdirs：查找源代码（如 .c, .cpp）的目录的相对路径列表（从包根目录开始）。默认情况下为空。它可能用于存储源代码（以便以后调试包，或在其他包中重新使用这些源代码进行构建）。

• builddirs：可以包含消费者可以使用的构建脚本的目录的相对路径列表（从包根目录开始）。默认情况下为空。

• frameworkdirs：包含 OSX 框架的目录的相对路径列表（从包根目录开始）。

标志

• defines：预处理器指令的有序列表。在某些情况下，消费者需要指定一些定义，以便包含库头文件与二进制文件匹配，这是很常见的。

• cflags、cxxflags、sharedlinkflags、exelinkflags：消费者应为正确行为激活的标志列表。很少使用。

属性

• set_property() 允许定义一些内置和用户通用属性，这些属性将与 cpp_info 模型一起传递给消费者。它们可能包含特定于构建系统的信息。一些内置属性是 cmake_file_name、cmake_target_name、pkg_config_name，这些属性可以为 CMakeDeps 或 PkgConfigDeps 生成器定义特定行为。有关更多信息，请阅读特定的构建系统集成文档。

结构

• components：字典，名称作为键，组件对象作为值，用于建模包可能拥有的不同组件：库、可执行文件等。

• requires：实验性 此包（及其消费者）应链接的依赖项组件的列表。它将由支持组件功能的生成器使用。

不同的配置通常会产生不同的 package_info，例如，库名称可能在不同的操作系统中发生变化，或者不同的 system_libs 将取决于编译器和操作系统而使用。

settings = "os", "compiler", "arch", "build_type"
options = {"shared": [True, False]}

def package_info(self):
    if not self.settings.os == "Windows":
        self.cpp_info.libs = ["zmq-static"] if not self.options.shared else ["zmq"]
    else:
        ...

    if not self.options.shared:
        self.cpp_info.defines = ["ZMQ_STATIC"]
    if self.settings.os == "Windows" and self.settings.compiler == "msvc":
        self.cpp_info.system_libs.append("ws2_32")

属性

任何 CppInfo 对象都可以声明“属性”，这些属性可以由生成器读取。属性的值可以是任何类型。请查看每个生成器的参考，以查看其使用的属性。

def set_property(self, property_name, value)
def get_property(self, property_name, check_type=None):

示例

def package_info(self):
    self.cpp_info.set_property("cmake_find_mode", "both")
    self.cpp_info.get_property("cmake_find_mode", check_type=str)

组件

如果您的包由多个库组成，则可以声明组件，从而可以为这些库中的每一个定义 CppInfo 对象，以及它们之间的依赖关系以及与其他包的组件之间的依赖关系（以下案例不是真实示例）

def package_info(self):
    self.cpp_info.set_property("cmake_file_name", "OpenSSL")

    self.cpp_info.components["crypto"].set_property("cmake_target_name", "OpenSSL::Crypto")
    self.cpp_info.components["crypto"].libs = ["libcrypto"]
    self.cpp_info.components["crypto"].defines = ["DEFINE_CRYPTO=1"]
    self.cpp_info.components["crypto"].requires = ["zlib::zlib"]  # Depends on all components in zlib package

    self.cpp_info.components["ssl"].set_property("cmake_target_name", "OpenSSL::SSL")
    self.cpp_info.components["ssl"].includedirs = ["include/headers_ssl"]
    self.cpp_info.components["ssl"].libs = ["libssl"]
    self.cpp_info.components["ssl"].requires = ["crypto",
                                                "boost::headers"]  # Depends on headers component in boost package

    obj_ext = "obj" if platform.system() == "Windows" else "o"
    self.cpp_info.components["ssl-objs"].objects = [os.path.join("lib", "ssl-object.{}".format(obj_ext))]

可以使用 requires 属性和组件的名称来定义组件之间的依赖关系以及与其他要求的组件之间的依赖关系。将计算组件的依赖关系图，并且值将以正确的顺序聚合到每个字段中。

buildenv_info, runenv_info

buildenv_info 和 runenv_info 属性是 Environment 对象，允许以环境变量的形式向消费者定义信息。它们可以使用任何 Environment 方法来定义这些信息

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

def package_info(self):
    self.buildenv_info.define("MYVAR", "1")
    self.buildenv_info.prepend_path("MYPATH", "my/path")
    if self.settings.os == "Android":
        arch = "myarmarch" if self.settings.arch=="armv8" else "otherarch"
        self.buildenv_info.append("MY_ANDROID_ARCH", f"android-{arch})

    self.runenv_info.append_path("MYRUNPATH", "my/run/path")
    if self.settings.os == "Windows":
        self.runenv_info.define_path("MYPKGHOME", "my/home")

请注意，这些对象不绑定到常规 requires 或 tool_requires，任何包配方都可以使用两者。 buildenv_info 和 runenv_info 之间的区别在于，前者应用于 Conan 从源代码构建某些内容时（例如在 build() 方法中），而后者将在执行“主机”上下文中的内容时使用，并且需要激活运行时。

Conan VirtualBuildEnv 生成器将在消费者中默认使用，从 buildenv_info（以及来自“构建”上下文的某些 runenv_info）收集信息，以创建 conanbuild 环境脚本，该脚本默认在所有 self.run(cmd, env="conanbuild") 调用中运行。 VirtualRunEnv 生成器也将默认在消费者中收集 runenv_info 来自“主机”上下文，创建 conanrun 环境脚本，可以使用 self.run(<cmd>, env="conanrun") 显式使用。

注意

最佳实践

不必将 bindirs 添加到 PATH 环境变量，消费者 VirtualBuildEnv 和 VirtualRunEnv 生成器将自动执行此操作。同样，不必添加 includedirs、libdirs 或任何其他目录到环境变量，因为这些信息通常由其他生成器管理。

conf_info

在“构建”上下文中的 tool_requires 包可以将一些 conf 配置传递给其直接消费者，方法是使用 conf_info 属性。例如，打包 AndroidNDK 的 Conan 包可以执行

def package_info(self):
    self.conf_info.define_path("tools.android:ndk_path", "path/to/ndk/in/package")

conf_info 来自包仍然可以被配置文件值覆盖，因为用户配置文件将具有更高的优先级。

Conf.define(name, value)

为给定的配置名称定义一个值。

参数:

• name – 配置的名称。

• value – 配置的值。

def package_info(self):
    # Setting values
    self.conf_info.define("tools.build:verbosity", "verbose")
    self.conf_info.define("tools.system.package_manager:sudo", True)
    self.conf_info.define("tools.microsoft.msbuild:max_cpu_count", 2)
    self.conf_info.define("user.myconf.build:ldflags", ["--flag1", "--flag2"])
    self.conf_info.define("tools.microsoft.msbuildtoolchain:compile_options", {"ExceptionHandling": "Async"})

Conf.append(name, value)

将一个值附加到给定的配置名称。

参数:

• name – 配置的名称。

• value – 要附加的值。

def package_info(self):
    # Modifying configuration list-like values
    self.conf_info.append("user.myconf.build:ldflags", "--flag3")  # == ["--flag1", "--flag2", "--flag3"]

Conf.prepend(name, value)

将一个值添加到给定的配置名称。

参数:

• name – 配置的名称。

• value – 要添加的值。

def package_info(self):
    self.conf_info.prepend("user.myconf.build:ldflags", "--flag0")  # == ["--flag0", "--flag1", "--flag2", "--flag3"]

Conf.update(name, value)

更新给定配置名称的值。

参数:

• name – 配置的名称。

• value – 配置的值。

def package_info(self):
    # Modifying configuration dict-like values
    self.conf_info.update("tools.microsoft.msbuildtoolchain:compile_options", {"ExpandAttributedSource": "false"})

Conf.remove(name, value)

从给定的配置名称中删除一个值。

参数:

• name – 配置的名称。

• value – 要删除的值。

def package_info(self):
    # Remove
    self.conf_info.remove("user.myconf.build:ldflags", "--flag1")  # == ["--flag0", "--flag2", "--flag3"]

Conf.unset(name)

清除变量，相当于 unset 或 set XXX=

参数:

name – 配置的名称。

def package_info(self):
    # Unset any value
    self.conf_info.unset("tools.microsoft.msbuildtoolchain:compile_options")

可以定义是 tool_requires 的包中的配置，例如，假设有一个打包 AndroidNDK 的包，它可以将 NDK 的位置定义为 tools.android:ndk_path 配置，如下所示

import os
from conan import ConanFile

class Pkg(ConanFile):
    name = "android_ndk"

    def package_info(self):
        self.conf_info.define("tools.android:ndk_path", os.path.join(self.package_folder, "ndk"))

请注意，这仅从配方的直接 tool_requires 传播。

generator_info

警告

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

构建上下文中的 tool_requires 可以通过将它们添加到 package_info 方法中的 generator_info 属性中，将生成器注入到配方中。这对于将自定义生成器注入到配方中很有用，这些生成器将由包的消费者使用，就像它们在消费者的 generators 属性中声明一样。

class MyGenerator:
    def __init__(self, conanfile):
        self._conanfile = conanfile

    def generate(self):
        self.output.info(f"Calling custom generator for {conanfile}")

def package_info(self):
    self.generator_info = [MyGenerator]

请注意，这仅从配方的直接 tool_requires 传播，并且默认情况下 self.generator_info 为 None。

注意

最佳实践

• 如果你的包可以通过其他方式向消费者传播信息，那么 package_info() 方法并非绝对必要。例如，如果你的包在构建时创建 xxx-config.cmake 文件，并将它们放在最终的包中，那么可能不需要定义 package_info()，并且在消费者端也不需要 CMakeDeps，因为 CMakeToolchain 能够注入路径来定位包内的 xxx-config.cmake 文件。这种方法对于 Conan 的私有使用来说是不错的，但 CMake 存在一些限制，例如无法管理多配置项目（例如 Visual Studio 在 IDE 中切换 Debug/Release，而 CMakeDeps 可以提供），以及在某些交叉构建场景中使用既是库又是构建工具的包（例如 protobuf，而 CMakeDeps 也可以处理）时存在限制。

• 如果消费者可以使用不同的构建系统，例如在 ConanCenter 中，那么提供 package_info() 非常必要。在这种情况下，需要进行一些重复，并且编写 package_info() 可能会感觉像复制了包的 xxx-config.cmake，但目前无法自动从 CMake 中提取信息。

• 如果你计划使用可编辑模式或本地开发流程，则需要检查 layout() 并定义 self.cpp.build 和 self.cpp.source 的信息。

• 不需要将 bindirs 添加到 PATH 环境变量中，这将会由消费者的 VirtualBuildEnv 和 VirtualRunEnv 生成器自动完成。

• 在 package_info() 中定义的 **路径** 不应转换为任何特定格式（例如 Windows 子系统要求的格式）。相反，将这些路径转换为适当格式是消费者的责任。

另请参阅

有关更多信息，请参阅 定义包信息教程。