Custom Conan generators

In the case that you need to use a build system or tool that is not supported by Conan off-the-shelf, you could create your own custom integrations using a custom generator. This can be done in two different ways.

Custom generators as python_requires

One way of having your own custom generators in Conan is by using them as python_requires. You could declare a MyGenerator class with all the logic to generate some files inside the mygenerator/1.0 python_requires package:

mygenerator/conanfile.py

  1. from conan import ConanFile
  2. from conan.tools.files import save
  5. class MyGenerator:
  6.     def __init__(self, conanfile):
  7.         self._conanfile = conanfile
  9.     def generate(self):
  10.         deps_info = ""
  11.         for dep, _ in self._conanfile.dependencies.items():
  12.             deps_info += f"{dep.ref.name}, {dep.ref.version}\n"
  13.         save(self._conanfile, "deps.txt", deps_info)
  16. class PyReq(ConanFile):
  17.     name = "mygenerator"
  18.     version = "1.0"
  19.     package_type = "python-require"

And then conan create mygenerator and use it in the generate method of your own packages like this:

pkg/conanfile.py

  1. from conan import ConanFile
  4. class MyPkg(ConanFile):
  5.     name = "pkg"
  6.     version = "1.0"
  8.     python_requires = "mygenerator/1.0"
  9.     requires = "zlib/1.2.11", "bzip2/1.0.8"
  11.     def generate(self):
  12.         mygenerator = self.python_requires["mygenerator"].module.MyGenerator(self)
  13.         mygenerator.generate()

Then, doing a conan install pkg on this pkg recipe, will create a deps.txt text file containing:

  1. zlib, 1.2.11
  2. bzip2, 1.0.8

This has the advantage that you can version your own custom generators as packages and also that you can share those generators as Conan packages.

Using global custom generators

You can also use your custom generators globally if you store them in the [CONAN_HOME]/extensions/generators folder. You can place them directly in that folder or install with the conan config install command.

[CONAN_HOME]/extensions/generators/mygen.py

  1. from conan.tools.files import save
  4. class MyGenerator:
  5.     def __init__(self, conanfile):
  6.         self._conanfile = conanfile
  8.     def generate(self):
  9.         deps_info = ""
  10.         for dep, _ in self._conanfile.dependencies.items():
  11.             deps_info = f"{dep.ref.name}, {dep.ref.version}"
  12.         save(self._conanfile, "deps.txt", deps_info)

Then you can use them by name in the recipes or in the command line using the -g argument:

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