Running and output

Output text from recipes

Use the self.output attribute to output text from the recipes. Do not use Python’s print() function. The self.output attribute has the following methods to express the level of the printed message:

trace(msg)
debug(msg)
verbose(msg)
status(msg)
info(msg)
highlight(msg)
success(msg)
warning(msg, warn_tag=None)
error(msg)

These output functions will only output if the verbosity level with which Conan was launched is the same or higher than the message, so running with -vwarning will output calls to warning() and error(), but not info() (Additionally, the highlight() and success() methods have a -vnotice verbosity level)

Note that these methods return the output object again, so that you can chain output calls if needed.

Using the core:warnings_as_errors conf, you can make Conan raise an exception when either errors or a tagged warning matching any of the given patterns is printed. This is useful to make sure that recipes are not printing unexpected warnings or errors. Additionally, you can skip which warnings trigger an exception with the *core:skip_warnings* conf.

# Raise an exception if any warning or error is printed
core:warnings_as_errors=['*']
# But skip the deprecation warnings
core:skip_warnings=['deprecated']

Both confs accept a list of patterns to match against the warning tags. A special unknown value can be used to match any warning without a tag.

To tag a warning, use the warn_tag argument of the warning() method in your recipes:

self.output.warning("Extra warning", warn_tag="custom_tag")

The common use of these functions from least specific to most specific, is:

• error(msg):

  Indicates that a serious issue has occurred that prevents the system or application from continuing to function correctly. Typically, this represents a failure in the normal flow of execution, such as a service crash or a critical exception.

• warning(msg, warn_tag=None):

  Highlights a potential issue that, while not stopping the system, could cause problems in the future or under certain conditions. Warnings signal abnormal situations that should be reviewed but don’t necessarily cause an immediate halt in operations.

• success(msg):

  Shows that an operation has been completed successfully. This type of message is useful to confirm that key processes or tasks have finished correctly, which is essential for good application monitoring.

• highlight(msg):

  Marks or emphasizes important events or processes that need to stand out but don’t necessarily indicate success or error. These messages draw attention to key points that may be relevant for the user or administrator.

• info(msg):

  Provides general information about the system or ongoing operations. Info messages are basic and used to inform about common events, like the start or completion of processes, without implying specific problems or achievements.

• status(msg):

  Reports the current state of the system or an ongoing operation. Status messages provide updates on how something is working, often in real time, to offer a clear view of the progress or situation of a process.

The following three methods are not shown by default and are usually reserved for scenarios that require a higher level of verbosity. You can display them using the arguments -v, -vv, and -vvv respectively.

• verbose(msg):

  Displays additional and detailed information that, while not critical, can be useful for better understanding how the system is working. It’s appropriate for gaining more context without overloading the logs with excessive detail. Useful when more clarity is needed than a simple info.

• debug(msg):

  With a high level of detail, it is mainly used for debugging code. These messages provide useful information for developers, such as variable values or execution flow details, to trace errors or analyze the program’s behavior.

• trace(msg):

  This is the most extreme level of detail. Trace messages log every little step the system takes, including function entries and exits, variable changes, and other very specific events. It’s used when full visibility of everything happening in the system is required, but should be used carefully due to the large amount of information it can generate.

Running commands

run(self, command, stdout=None, cwd=None, ignore_errors=False, env="", quiet=False, shell=True, scope="build", stderr=None)

self.run() is a helper to run system commands while injecting the calls to activate the appropriate environment, and throw exceptions when errors occur so that command errors do not pass unnoticed. It also wraps the commands with the results of the command wrapper plugin.

• command should be specified as a string which is passed to the system shell.

• When the argument quiet is set to true, the invocation of self.run() will not print the command to be executed.

Use the stdout and stderr arguments to redirect the output of the command to a file-like object instead of the console.

# Redirect stdout to a file
with open("ninja_stdout.log", "w") as stdout:
    # Redirect stderr to a StringIO object to be able to read it later
    stderr = StringIO()
    self.run("ninja ...", stdout=stdout, stderr=stderr)