自定义 Conan 生成器

如果您需要使用 Conan 不直接支持的构建系统或工具，可以使用自定义生成器创建自己的自定义集成。这可以通过三种不同的方式完成。

将自定义生成器用作 python_requires

在 Conan 中拥有自己的自定义生成器的一种方法是将其用作 python_requires。您可以在 *mygenerator/1.0* python_requires 包内声明一个 *MyGenerator* 类，其中包含生成某些文件的所有逻辑

mygenerator/conanfile.py

from conan import ConanFile
from conan.tools.files import save


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

    def generate(self):
        deps_info = ""
        for dep, _ in self._conanfile.dependencies.items():
            deps_info += f"{dep.ref.name}, {dep.ref.version}\n"
        save(self._conanfile, "deps.txt", deps_info)


class PyReq(ConanFile):
    name = "mygenerator"
    version = "1.0"
    package_type = "python-require"

然后 conan create mygenerator 并在您自己的包的 generate 方法中使用它，如下所示

pkg/conanfile.py

from conan import ConanFile


class MyPkg(ConanFile):
    name = "pkg"
    version = "1.0"

    python_requires = "mygenerator/1.0"
    requires = "zlib/1.2.11", "bzip2/1.0.8"

    def generate(self):
        mygenerator = self.python_requires["mygenerator"].module.MyGenerator(self)
        mygenerator.generate()

然后，对此 pkg 配方执行 conan install pkg 命令，将创建一个包含以下内容的 deps.txt 文本文件

zlib, 1.2.11
bzip2, 1.0.8

这样做的好处是您可以将自己的自定义生成器版本化为包，并且可以将这些生成器作为 Conan 包共享。

使用全局自定义生成器

您还可以将自定义生成器存储在 [CONAN_HOME]/extensions/generators 文件夹中以全局使用它们。您可以直接将它们放置在该文件夹中，或者使用 conan config install 命令安装。

[CONAN_HOME]/extensions/generators/mygen.py

from conan.tools.files import save


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

    def generate(self):
        deps_info = ""
        for dep, _ in self._conanfile.dependencies.items():
            deps_info = f"{dep.ref.name}, {dep.ref.version}"
        save(self._conanfile, "deps.txt", deps_info)

然后您可以在配方中或在命令行中使用 -g 参数按名称使用它们

conan install --requires=zlib/1.2.13 -g MyGenerator

来自 tool_requires 的生成器

警告

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

直接依赖项 tool_requires 也可以用于提供自定义生成器。以下示例展示了如何创建一个自定义生成器，用于生成一个包含包依赖项的文件，就像上面的示例一样，但是使用 tool_require 代替 python_require 将生成器注入到配方中，方法是将它们添加到 package_info 方法内的 self.generator_info 列表中。

mygenerator/conanfile.py

from conan import ConanFile
from conan.tools.files import save

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

    def generate(self):
        deps_info = ""
        for dep, _ in self._conanfile.dependencies.items():
            deps_info = f"{dep.ref.name}, {dep.ref.version}"
        save(self._conanfile, "deps.txt", deps_info)

class MyToolReq(ConanFile):
    name = "mygenerator-tool"
    version = "1.0"

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

然后在您的配方中添加对 mygenerator-tool 包的 tool_requires 依赖项，将自动把该生成器注入到配方中。

注意

请注意，内置生成器也可以通过 tool_requires 注入，方法是按名称添加它们：self.generator_info.append("CMakeDeps")。 tool_require 该包会将 CMakeDeps 生成器注入到配方中，就像它在其 generators 属性中声明了一样。