Command API

Warning

This feature is experimental and subject to breaking changes. See the Conan stability section for more information.

Warning

Subapis must not be initialized by themselves. They are intended to be accessed only through the main ConanAPI attributes.

class CommandAPI(conan_api)

This CommandAPI is useful to be able to launch full commands from the ConanAPI

Sometimes some commands are built using several calls to the ConanAPI. If we want to reuse the same functionality, then we would have to copy all that code into our own commands. Instead of doing that, it is possible to call Conan commands using this API, via the run() method.

run(cmd, raise_on_errors=True)

Runs another Conan command via API

Parameters:

  • cmd – Conan command to run. It can be either a string, or a list of strings.

  • raise_on_errors – If True, it will raise an exception on errors. By default, some command will return errors as conan_error entries in the result, and it will be the caller’s responsibility to check for them and raise/report them if desired.

Returns:

It will return what that command returns. Note that different commands can return different things, so the caller needs to process it accordingly.

Note

When consuming this sub-API from a standalone script where the ConanAPI class is instantiated manually (which is not the recommended way to use the Python API, and custom commands should be preferred), an extra step is required, because the ConanAPI class does not automatically set the CLI interface needed for this sub-API to work properly. In that case, the following code snippet should be used:

from conan.api.conan_api import ConanAPI
from conan.cli.cli import Cli

api = ConanAPI()
cli = Cli(api)
cli.add_commands()
result = api.command.run(["remote", "list"])

The Cli class should be treated as a private opaque object, and its usage limited to the above snippet.