自定义 Conan 生成器¶
如果您需要使用一个Conan不直接支持的构建系统或工具,您可以使用自定义生成器创建自己的集成。这可以通过三种不同的方式实现。
作为 python_requires 的自定义生成器¶
在 Conan 中拥有自己的自定义生成器的一种方法是将其用作 python_requires。您可以声明一个 MyGenerator 类,其中包含在 mygenerator/1.0 python_requires 包内生成文件所需的所有逻辑。
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.3.1", "bzip2/1.0.8"
def generate(self):
mygenerator = self.python_requires["mygenerator"].module.MyGenerator(self)
mygenerator.generate()
然后,在 conan install pkg
命令,针对此 pkg
recipe,将创建一个 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)
然后,您可以在 recipe 中或通过命令行使用 -g 参数按名称使用它们
conan install --requires=zlib/1.2.13 -g MyGenerator
来自 tool_requires 的生成器¶
警告
此功能是实验性的,可能会发生重大更改。有关更多信息,请参阅 Conan 稳定性 部分。
直接依赖的 tool_requires
也可以用于提供自定义生成器。下面的示例展示了如何创建一个自定义生成器,该生成器生成一个包含包依赖关系的文件,就像上面的示例一样,但通过使用 tool_require
而不是 python_require
将生成器注入到 recipe 中,具体方法是将它们添加到 package_info
方法内的 self.generator_info
属性。请注意,此属性默认值为 None
,因此您需要将其明确设置为生成器列表。
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]
然后,在您的 recipe 中拥有一个 tool_requires
,指向 mygenerator-tool
包,将自动把生成器注入到 recipe 中。
注意
请注意,内置生成器也可以使用 tool_requires
注入,通过名称添加它们:self.generator_info = ["CMakeDeps"]
。 tool_require
这个包会将 CMakeDeps
生成器注入到 recipe 中,就像它在其 generators
属性中声明了一样。