PkgConfigDeps¶

PkgConfigDeps 是用于 pkg-config 的依赖关系生成器。它会生成名为 <PKG-NAME>.pc 的 pkg-config 文件，其中包含有效的 pkg-config 文件语法。

这个生成器可以在 conanfile 中按名称使用

conanfile.py¶

class Pkg(ConanFile):
    generators = "PkgConfigDeps"

conanfile.txt¶

[generators]
PkgConfigDeps

它也可以在 conanfile 的 generate() 方法中完全实例化

from conan import ConanFile
from conan.tools.gnu import PkgConfigDeps

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    requires = "zlib/1.2.11"

    def generate(self):
        pc = PkgConfigDeps(self)
        pc.generate()

生成的文件¶

名为 <PKG-NAME>.pc 的 pkg-config 格式文件，包含有效的 pkg-config 文件语法。prefix 变量会自动调整为 package_folder。

prefix=/Users/YOUR_USER/.conan/data/zlib/1.2.11/_/_/package/647afeb69d3b0a2d3d316e80b24d38c714cc6900
libdir=${prefix}/lib
includedir=${prefix}/include
bindir=${prefix}/bin

Name: zlib
Description: Conan package: zlib
Version: 1.2.11
Libs: -L"${libdir}" -lz -F Frameworks
Cflags: -I"${includedir}"

自定义¶

命名¶

默认情况下，*.pc 文件将按照以下规则命名：

对于包，它使用包名，例如，包 zlib/1.2.11 -> zlib.pc。
对于组件，使用包名 + 连字符 + 组件名，例如，带有 self.cpp_info.components["crypto"] 的 openssl/3.0.0 -> openssl-crypto.pc。

你可以使用 pkg_config_name 和 pkg_config_aliases 属性更改此默认行为。请参阅下面的属性部分。

如果 recipe 使用了 components，生成的文件将是 <[PKG-NAME]-[COMP-NAME]>.pc，包含其相应的标志和依赖关系。

此外，还会生成一个 <PKG-NAME>.pc 文件，以便与开始支持组件的 recipe 保持兼容。这个 <PKG-NAME>.pc 文件会将包的所有组件声明为依赖，而其余字段将为空，依赖于组件 <[PKG-NAME]-[COMP-NAME]>.pc 文件传播的标志。

参考¶

class PkgConfigDeps(conanfile)¶

generate()¶: 保存所有 *.pc 文件

set_property(dep, prop, value)¶

使用此方法，你可以从消费者端覆盖 Conan recipes 设置的 property 值。这适用于 pkg_config_name、pkg_config_aliases 和 pkg_config_custom_content 属性。

参数:

dep – 要设置 property 的依赖项名称。对于组件，请使用语法：dep_name::component_name。
prop – property 的名称。
value – 属性的值。使用 None 来使上游 recipe 设置的任何值无效。

属性¶

build_context_activated¶

当你有一个 build-require 时，默认情况下不会生成 *.pc 文件。但你可以使用 build_context_activated 属性激活它。

tool_requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    pc.generate()

build_context_folder¶

Conan 2.2.0 新增

当你同时将同一个包作为 build-require 和 regular require 时，会在生成器中引起冲突，因为 *.pc 文件的文件名会冲突，名称、requires 名称等也会冲突。

例如，这在使用包含用于在构建时生成源代码的工具（因此是 build_require）的某些依赖项（capnproto、protobuf 等）时是典型情况，但同时也提供用于链接到最终应用程序的库，因此你还有一个 regular require。当我们进行交叉构建时，解决此冲突尤为重要，因为该工具（将在构建机器上运行）属于与库不同的二进制包，而库将在宿主机器上“运行”。

你可以使用 build_context_folder 属性指定一个文件夹来保存所有列在 build_context_activated 中的构建依赖项创建的 *.pc 文件。

tool_requires = ["my_tool/0.0.1"]
requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    # save all the *.pc files coming from the "my_tool" build context and its requirements
    pc.build_context_folder = "build"  # [generators_folder]/build/
    pc.generate()

build_context_suffix¶

已弃用：请改用 build_context_folder 属性

概念与上面引用的 build_context_folder 属性相同，但这旨在为依赖项指定一个后缀，以便构建上下文（tool require）中依赖项的文件/requires/名称会被重命名。

tool_requires = ["my_tool/0.0.1"]
requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    # disambiguate the files, requires, names, etc
    pc.build_context_suffix = {"my_tool": "_BUILD"}
    pc.generate()

重要

此属性不应与 build_context_folder 属性同时使用。

属性¶

以下属性影响 PkgConfigDeps 生成器：

pkg_config_name 属性将定义生成的 *.pc 文件的名称 (xxxxx.pc)。
pkg_config_aliases 属性为 pkg_config 生成器设置任何包/组件名称的一些别名。此属性仅接受类列表的 Python 对象。
pkg_config_custom_content 属性将用户定义的内容作为自由格式变量添加到此生成器创建的 .pc 文件中。该内容可以是字符串或类字典的 Python 对象。请注意，此处声明的变量将覆盖 Conan 已定义的变量。点击这里获取有关 *.pc 文件中变量类型的更多信息。
system_package_version：此属性为包设置一个自定义版本，用于创建的 *.pc 文件的 Version 字段。
component_version 属性为该组件设置一个自定义版本，用于创建的 *.pc 文件的 Version 字段（优先级高于 system_package_version 属性）。

这些属性可以在全局 cpp_info 级别或组件级别定义。

示例

def package_info(self):
    custom_content = {"datadir": "${prefix}/share"}  # or "datadir=${prefix}/share"
    self.cpp_info.set_property("pkg_config_custom_content", custom_content)
    self.cpp_info.set_property("pkg_config_name", "myname")
    self.cpp_info.components["mycomponent"].set_property("pkg_config_name", "componentname")
    self.cpp_info.components["mycomponent"].set_property("pkg_config_aliases", ["alias1", "alias2"])
    self.cpp_info.components["mycomponent"].set_property("component_version", "1.14.12")