Python 犄角旮旯--重定向 stdout

江川一尾

喜欢新鲜/极客/创业中

What？

在 Python 程序中，使用 print 输出调试信息的做法非常常见，但有的时候我们需要将 print 的内容改写到其他位置，比如一个文件中，便于随时排查。

但是又不希望大面积替换 print 函数，这就需要一些技巧实现。

一种典型的做法是在代码开始的地方增加这样的代码：

def log_to_file(* args):
    # write all args to some a file
print = log_to_file

修改 print 方法，之后的 print 实际上就不是内置方法了。

在 Linux 下也可以通过 shell 的输出重定向，将 print 的内容写入文件：

python3 your_script.py >> log.txt

其实在 Python 代码中，也可以通过输出重定向技术，直接实现上面的目的。

重定向 stdout

stdout 是系统的标准输出，通常是 shell 命令行。如果我们用其他对象覆盖 sys.stdout 就可以实现输出的重定向。

Python 使用任意实现了 write 方法的对象作为标准输出对象。

下面定义了一个 OutputWrapper：

class OutputWrapper:
    def __init__(self, to_file):
        self._to = to_file
    def write(self, data):
        # let's write to log file with some extra string.
        self._to.write("-----")
        self._to.write(data)

它实现了 write 方法，它将输出内容写入 to_file，我们再多做一点工作，在每次调用 print 前插入一段 “-----”。

下面我们用 OutputWrapper 实例替换原生 sys.stdout：

import sys
if __name__ == '__main__':
    # the log file name
    logname = 'log.txt'
    with open(logname,'a') as logfile:
        # save original stdout
        original = sys.stdout
        # redirect stdout
        sys.stdout = OutputWrapper(logfile)
        # output