运行和输出

从 recipes 输出文本

使用 self.output 属性从 recipes 输出文本。请不要使用 Python 的 print() 函数。self.output 属性具有以下方法来表达打印消息的级别

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

这些输出函数仅在 Conan 启动时所使用的详细级别与消息的级别相同或更高时才会输出，因此以 -vwarning 运行将输出对 warning() 和 error() 的调用，但不会输出 info()。（此外，highlight() 和 success() 方法的详细级别为 -vnotice）

请注意，这些方法会再次返回输出对象，因此如果需要，您可以链接输出调用。

使用 core:warnings_as_errors 配置，您可以让 Conan 在打印错误或匹配任何给定模式的带标签警告时引发异常。这对于确保 recipes 不会打印意外警告或错误非常有用。此外，您可以 通过 *core:skip_warnings* 配置 跳过哪些警告会触发异常。

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

这两个配置都接受一个模式列表，用于匹配警告标签。可以使用特殊的 unknown 值来匹配任何没有标签的警告。

要标记警告，请在您的 recipes 中使用 warning() 方法的 warn_tag 参数

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

这些函数从最不具体到最具体的常见用法是：

  • error(msg):

    表示发生了严重问题，导致系统或应用程序无法继续正常运行。通常，这表示执行流程中的故障，例如服务崩溃或关键异常。

  • warning(msg, warn_tag=None):

    突出显示一个潜在问题，该问题虽然不会停止系统，但将来或在某些条件下可能会导致问题。警告表示异常情况，应进行审查，但不一定会导致操作立即停止。

  • success(msg):

    显示操作已成功完成。此类消息可用于确认关键进程或任务已正确完成，这对于良好的应用程序监控至关重要。

  • highlight(msg):

    标记或强调需要突出显示但并非一定表示成功或错误的重要的事件或过程。这些消息提请注意对用户或管理员可能相关的关键点。

  • info(msg):

    提供有关系统或正在进行的操作的一般信息。信息消息是基本的，用于告知常见事件，例如进程的开始或完成，而不暗示特定的问题或成就。

  • status(msg):

    报告系统或正在进行的操作的当前状态。状态消息提供有关事物如何工作的更新，通常是实时更新，以提供进程的进度或情况的清晰视图。

以下三种方法默认不显示，通常保留给需要更高详细级别的场景。您可以使用参数 -v、-vv 和 -vvv 分别显示它们。

  • verbose(msg):

    显示附加的详细信息，这些信息虽然不关键，但对于更好地理解系统如何工作可能有用。它适用于获取更多上下文而不会用过多细节淹没日志。当需要比简单信息更清晰时很有用。

  • debug(msg):

    具有高详细级别，主要用于调试代码。这些消息为开发人员提供有用的信息，例如变量值或执行流程详细信息，以追踪错误或分析程序的行为。

  • trace(msg):

    这是最极端的详细级别。跟踪消息记录系统采取的每一个小步骤，包括函数进入和退出、变量更改以及其他非常具体的事件。当需要完全可见系统中发生的一切时使用，但由于它可能生成大量信息，因此应谨慎使用。

运行命令

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

self.run() 是一个辅助函数，用于运行系统命令，同时注入激活适当环境的调用，并在发生错误时抛出异常，以便命令错误不会被忽视。它还使用 命令包装器插件 的结果来包装命令。

  • command 应指定为传递给系统 shell 的字符串。

  • 当参数 quiet 设置为 true 时，调用 self.run() 将不会打印要执行的命令。

使用 stdout 和 stderr 参数将命令的输出重定向到类文件对象而不是控制台。

# 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)