运行和输出

从 recipe 输出文本

使用 self.output 属性从 recipe 输出文本。不要使用 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 conf，您可以使 Conan 在打印错误或与给定模式匹配的标记警告时引发异常。这对于确保 recipe 没有打印意外的警告或错误非常有用。此外，您可以跳过哪些警告触发异常使用 *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']

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

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

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

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

  • error(msg):

    表示发生了严重的 issue，阻止系统或应用程序继续正常运行。通常，这表示正常执行流程中的失败，例如服务崩溃或严重异常。

  • warning(msg, warn_tag=None):

    突出显示潜在的 issue，虽然不会停止系统，但可能会在未来或在特定条件下引起问题。警告表示应审查但不一定导致操作立即停止的异常情况。

  • success(msg):

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

  • highlight(msg):

    标记或强调需要突出显示但不一定表示成功或错误的事件或流程。这些消息引起对可能与用户或管理员相关的关键点的注意。

  • info(msg):

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

  • status(msg):

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

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

  • verbose(msg):

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

  • debug(msg):

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

  • trace(msg):

    这是最极端的详细程度。Trace 消息记录系统执行的每个小步骤，包括函数条目和出口、变量更改以及其他非常具体的事件。当需要完全可见系统中发生的一切时使用它，但由于它可能生成大量信息，应谨慎使用。

运行命令

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)