python重定向_Python 犄角旮旯--重定向 stdout

What？

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

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

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

def log_to_file(* args):
    # write all args to some a file
    pass
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
        print('line 1')
        print('line 2')

        # restore stdout
        sys.stdout = original

运行时命令行的输出消失了，如果查看 log.txt ：

-----line 1-----
-----line 2-----

原来 print 的内容已经写到文件中了，此时 log.txt 就相当于命令行输出了。

为什么 “line1” 和 “line2” 后面也多了额外输出呢？这是因为 print 方法会自动在尾部追加输出一个 ‘n’，又调用了一次 print(’n’)。

How ？

这种重定向技术是如何实现的？其实一切就在最熟悉不过的 print 方法中。

print 方法是 Python 的内建函数，其原型为：

print(*objects, sep=' ', end='n', file=sys.stdout, flush=False)

• 第一个参数是不定参数，表示 print 的对象；
• sep 是多个输出对象之间的分隔符，所以 print(‘a’, ‘b’) 会输出 “a b”，这是因为 sep 默认是空格，你也可以设置为其他字符串；
• end 是行位字符，默认是换行，这也是 print 总是一行的原因，如果不希望换行，可以用参数 end = “”;
• file 非常重要，表示 print 方法的输出对象，最终的输出工作是通过 file.write 实现的，默认情况下 file = sys.stdout。
• flush 与输出缓冲有关，暂时不必关心。

前面的输出重定向可以总结为这样的流程：

修改了 sys.stdout --> print 默认 file = sys.stdout --> 间接修改了 print 的输出对象。

原来如此！

Built-in Functions​docs.python.org

首发公众号 “江川Go”，关注了解程序员的烧脑日常。