运行与输出¶

从 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):
提供有关系统或正在进行的通用信息。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)