运行和输出¶

配方中的输出文本¶

使用 self.output 属性从配方中输出文本。不要使用 Python 的 print() 函数。

error(self, msg: str, error_type: str = None)¶

指示发生了严重问题，导致系统或应用程序无法继续正常运行。

通常，这代表了正常执行流程中的失败，例如服务崩溃或关键异常。请注意，如果用户设置了 core:warnings_as_errors 配置，则在打印输出时会引发异常，以确保错误不会被忽略。

warning(self, msg: str, warn_tag: str = None)¶

突出显示潜在问题，虽然不会停止系统，但将来或在某些条件下可能会导致问题。

警告表明异常情况，应进行审查，但不一定导致操作立即停止。请注意，如果标签与 core:warnings_as_errors 配置中的模式匹配，并且未被跳过，则会被升级为错误，并在打印输出时引发异常，以确保错误不会被忽略。

success(self, msg: str)¶

显示操作已成功完成。

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

highlight(self, msg: str)¶

标记或强调重要的事件或流程，这些事件或流程需要突出显示，但不一定表示成功或错误。

这些消息引起用户或管理员注意的关键点。

info(self, msg: str, fg: str = None, bg: str = None, newline: bool = True)¶

提供有关系统或正在进行的操作的一般信息。

信息消息是基本的，用于告知常见的事件，例如流程或任务的开始或完成，而不会暗示特定的问题或成就。

status(self, msg: str, fg: str = None, bg: str = None, newline: bool = True)¶

提供有关系统或正在进行的操作的一般信息。

信息消息是基本的，用于告知常见的事件，例如流程或任务的开始或完成，而不会暗示特定的问题或成就。

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

verbose(self, msg: str, fg: str = None, bg: str = None)¶

显示附加的详细信息，虽然不重要，但可以帮助更好地了解系统的运行方式。

除非用户将日志级别设置为详细 (例如，使用命令行中的 -v 选项)，否则不会打印此消息。

它适用于获得更多上下文，而不会用过多的细节使日志不堪重负。当比简单的信息需要更多清晰度时很有用。

debug(self, msg: str, fg: str = '\x1b[35m', bg: str = None)¶

具有高水平的细节，主要用于调试代码。

除非用户将日志级别设置为调试 (例如，使用命令行中的 -vv 选项)，否则不会打印此消息。

这些消息为开发人员提供有用的信息，例如变量值或执行流程细节，以跟踪错误或分析程序的行为。

trace(self, msg: str)¶

这是最极端的细节级别。

跟踪消息记录系统采取的每一个小步骤，包括函数入口和退出、变量更改和其他非常具体的事件。

除非用户将日志级别设置为跟踪 (例如，使用命令行中的 -vvv 选项)，否则不会打印此消息。

当需要完全了解系统中的所有内容时使用它，但由于它可以生成大量信息，因此应谨慎使用。

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

请注意，这些方法会返回输出对象，以便在需要时可以链接输出调用。

使用 core:warnings_as_errors 配置，您可以使 Conan 在打印错误或与给定模式匹配的带标签警告时引发异常。这对于确保配方不会打印意外的警告或错误非常有用。此外，您可以使用 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 来匹配任何没有标签的警告。

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

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

注意

自定义命令和工具可以自由实例化自己的 ConanOutput 对象。

一些方法具有可选的 fg 和 bg 参数，这些是文本的前景色和背景色的颜色代码，可在 conan.api.output.Color 类中找到。

self.output.info("This is a message", fg=Color.BLUE, bg=Color.YELLOW)

运行命令¶

配方和助手可以使用 self.run() 方法运行系统命令，同时注入调用以激活适当的环境，并在发生错误时引发异常，以便命令错误不会被忽略。它还包装了使用命令包装器插件的命令的结果。

run(self, command: str, stdout=None, cwd=None, ignore_errors=False, env='', quiet=False, shell=True, scope='build', stderr=None)¶

在当前包上下文中运行命令。

参数:

command – 要运行的命令。
stdout – 将命令输出写入的输出流。如果为 None，则默认为标准输出流。
stderr – 将命令错误输出写入的错误输出流。如果为 None，则默认为标准错误流。
cwd – 运行命令的当前工作目录。
ignore_errors – 如果为 True，则不会在命令返回非零退出代码时引发错误。
env – 要使用的环境变量文件。如果为空，则默认为 "conanbuild"，当 scope 为 build 时，或 "conanrun"，当 run 时。如果显式设置为 None，则不会应用任何环境变量文件，这对于不需要任何环境变量的命令很有用。
quiet – 如果为 True，则抑制命令的输出。
shell – 如果为 True，则在 shell 中运行命令。这传递给底层的 Popen 函数。
scope – 命令的范围，可以是 "build" 或 "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)