Python 中 stdout 输出重定向指南：让输出乖乖就范

2024-03-04 13:54:21

在 Python 的世界里，你是否曾为程序的输出信息感到困惑？或许你想将这些信息保存到文件以便日后分析，又或许你希望将程序的错误信息单独记录下来。这时，你就需要学会如何重定向 Python 程序的标准输出 stdout。别担心，这并不像听起来那么复杂。Python 提供了多种方法帮助你轻松掌控程序的输出流，就像一位经验丰富的舵手，引导着你的程序信息驶向正确的目的地。

操控输出流的利器：sys.stdout

sys 模块是 Python 的标准库之一，它提供了许多与系统相关的功能，其中就包括了对标准输入、标准输出和标准错误的访问。sys.stdout 就代表了程序的标准输出，默认情况下，它指向你的终端屏幕。这意味着当你使用 print() 函数时，信息会直接显示在屏幕上。

但如果我们想将输出信息保存到文件，该怎么办呢？很简单，我们可以将 sys.stdout 重新指向一个文件对象。就像这样：

import sys

# 打开一个文件，以写入模式
with open('output.txt', 'w') as f:
    # 将 sys.stdout 指向文件对象 f
    sys.stdout = f
    # 现在，所有 print() 函数的输出都会写入到 output.txt 文件中
    print("Hello, world!")
    print("This is a test.")

# 文件关闭后，sys.stdout 会自动恢复到默认的屏幕输出
print("This will be printed on the screen.")

在这段代码中，我们首先打开了一个名为 output.txt 的文件，并使用 with 语句确保文件在使用完毕后能够自动关闭。然后，我们将 sys.stdout 赋值为文件对象 f，这样一来，所有原本应该输出到屏幕的信息都会被写入到 output.txt 文件中。最后，当 with 语句结束时，sys.stdout 会自动恢复到默认的屏幕输出，所以最后一条 print() 语句的输出会显示在屏幕上。

更优雅的重定向：contextlib.redirect_stdout

除了直接操作 sys.stdout 之外，Python 还提供了一种更简洁、更优雅的重定向方法，那就是使用 contextlib 模块中的 redirect_stdout 上下文管理器。

redirect_stdout 的使用方法非常简单，你只需要将它与 with 语句一起使用，并将一个文件对象作为参数传递给它即可。就像这样：

from contextlib import redirect_stdout

with open('output.txt', 'w') as f:
    with redirect_stdout(f):
        print("Hello, world!")
        print("This is a test.")

print("This will be printed on the screen.")

这段代码与之前的例子功能相同，但代码更加简洁易读。redirect_stdout(f) 会将标准输出临时重定向到文件对象 f，当 with 语句结束时，标准输出会自动恢复到原来的状态。

应对模块输出的挑战

有时候，我们可能需要重定向的不仅仅是程序本身的输出，还包括一些外部模块的输出。例如，某些模块可能会将日志信息或调试信息打印到屏幕上，而我们希望将这些信息也保存到文件中。

这时，我们可以将 sys.stdout 的重定向操作放在程序的开头，这样就能确保所有后续的输出，包括模块的输出，都会被重定向到指定的文件中。

import sys
import logging

# 在程序开头重定向 stdout
with open('output.txt', 'w') as f:
    sys.stdout = f

    # 配置 logging 模块，将日志信息输出到标准输出
    logging.basicConfig(level=logging.DEBUG)
    logging.debug("This is a debug message.")

    # 其他代码...