自定义 Conan 生成器¶
如果您需要使用 Conan 未直接支持的构建系统或工具，则可以使用自定义生成器创建自己的自定义集成。这可以通过三种不同的方式完成。
将自定义生成器用作 python_requires¶
在 Conan 中使用自己的自定义生成器的一种方法是将它们用作 python_requires。您可以声明一个包含所有生成 mygenerator/1.0 python_requires 包内某些文件的逻辑的 MyGenerator 类
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 方法中使用它
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 命令安装。
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_require 而不是 python_require 将生成器注入配方，方法是将它们添加到 package_info 方法内的 self.generators_info 列表中。
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.generators_info.append(MyGenerator)
然后，在您的配方中使用 tool_requires 针对 mygenerator-tool 包将自动将生成器注入配方。
注意
请注意，内置生成器也可以使用 tool_requires 注入，方法是按名称添加它们：self.generators_info.append("CMakeDeps")。 tool_require``ing this package will inject the ``CMakeDeps 生成器将注入配方，就像在它的 generators 属性中声明的一样。