python--sys.stdout重定向

1.print

def print(self, *args, sep=' ', end='\n', file=None): # known special case of print
    """
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.
    """
    pass

阅读上面的源代码，print的file对象指向sys.stdout，即标准输出流，打印输出到控制台；

可以直接给file对象赋值，使其指向文件对象，打印输出到文件；

print("123", file=open("text1.log", "w"))

text1.log文件已经写入123

2.sys.stdout重定向

sys.stdout是python中的标准输出流，默认是映射到控制台的，即将信息打印到控制台。

在python中调用print时，默认情况下，实际上是调用了sys.stdout.write(obj+"\n")

print("hello")
sys.stdout.write("hello\n")

控制台输出
hello
hello

3.sys.stdout重定向到文件对象

sys.stdout默认是映射到控制台，可以通过修改映射关系把打印操作重定向到其他地方，例如：可以将文件对象引用赋给sys.stdout，实现sys.stdout的重定向。

# 保存原始sys.stdout进行备份
save_stdout = sys.stdout
# sys.stdout重定向，指向文件对象
sys.stdout = open("test.txt", "w")
# print调用sys.stdout的write方法（此时sys.stdout指向文件对象，实际上调用的就是文件对象的write方法），打印到test.txt文件
print("hello world")
# 恢复，标准输出流
sys.stdout = save_stdout
# print调用sys.stdout的write方法，标准输出流默认打印到控制台
print("hello world again")

test.txt文件已经写入hello world

控制台输出
hello world again

上面代码可以理解为：

4.sys.stdout重定向到自定义对象

sys.stdout可以重定向到一个实现write方法的自定义对象，从上面的例子中知道，print方法调用的实际是sys.stdout.write方法，所以自定义对象一定要实现write方法。

import sys
import tkinter
import tkinter.scrolledtext


class RedictStdout:
    def __init__(self, scroll_text):
        # 保存原始sys.stdout进行备份
        self.save_stdout = sys.stdout
        # sys.stdout重定向，指向该对象
        sys.stdout = self
        self.scroll_text = scroll_text

    def write(self, message):
        # message即sys.stdout接收到的输出信息
        self.scroll_text.insert(tkinter.END, message)  # 在多行文本控件最后一行插入message
        # self.scroll_text.update()  # 更新显示的文本
        self.scroll_text.see(tkinter.END)  # 始终显示最后一行，不加这句，当文本溢出控件最后一行时，可能不会自动显示最后一行

    def restore(self):
    	# 恢复标准输出流
        sys.stdout = self.save_stdout


def click():
    print("hello word")


window = tkinter.Tk()
scroll_text = tkinter.scrolledtext.ScrolledText(window, bg="pink")
scroll_text.pack()
button = tkinter.Button(window, text="点击", command=click)
button.pack()

# 实例化对象
rs = RedictStdout(scroll_text)
# print调用sys.stdout的write方法，sys.stdout指向rs对象，实际上print调用rs的write方法
# rs的write方法，实现了scrolltext组件插入sys.stdout收到的message信息，即print要打印的信息
window.mainloop()
# 恢复标准输出流
rs.restore()

效果：

上面代码可以理解为：

5.logging模块日志输出

logging的基本用法：

# 设置日志等级为DEBUG
logging.basicConfig(level=logging.DEBUG)
logging.error("logging error message")

控制台输出
ERROR:root:logging error message

阅读logging模块源代码，发现basicConfig默认创建一个StreamHandler，并且其指向标准错误输出流，即sys.stderr，默认情况下日志输出到控制台。

def basicConfig(**kwargs):
    """
    Do basic configuration for the logging system.

    This function does nothing if the root logger already has handlers
    configured, unless the keyword argument *force* is set to ``True``.
    It is a convenience method intended for use by simple scripts
    to do one-shot configuration of the logging package.

    The default behaviour is to create a StreamHandler which writes to
    sys.stderr, set a formatter using the BASIC_FORMAT format string, and
    add the handler to the root logger.

    A number of optional keyword arguments may be specified, which can alter
    the default behaviour.
    ...

class StreamHandler(Handler):
    """
    A handler class which writes logging records, appropriately formatted,
    to a stream. Note that this class does not close the stream, as
    sys.stdout or sys.stderr may be used.
    """

    terminator = '\n'

    def __init__(self, stream=None):
        """
        Initialize the handler.

        If stream is not specified, sys.stderr is used.
        """
        Handler.__init__(self)
        if stream is None:
            stream = sys.stderr
        self.stream = stream

所以，在4点中直接使用logging的基本用法，是无法让scrolltext显示logging要打印的日志信息的，因为，4点中的代码只做了对sys.stdout的重定向，我们应该加一步对sys.stderr的重定向。

import logging
import sys
import tkinter
import tkinter.scrolledtext


class RedictStdout:
    def __init__(self, scroll_text):
        # 保存原始sys.stdout/sys.stderr进行备份
        self.save_stdout = sys.stdout
        self.save_stderr = sys.stderr
        # sys.stdout/sys.stderr重定向，指向该对象
        sys.stdout = self
        sys.stderr = self
        self.scroll_text = scroll_text

    def write(self, message):
        # message即sys.stdout/sys.stderr接收到的输出信息
        self.scroll_text.insert(tkinter.END, message)  # 在多行文本控件最后一行插入message
        # self.scroll_text.update()  # 更新显示的文本
        self.scroll_text.see(tkinter.END)  # 始终显示最后一行，不加这句，当文本溢出控件最后一行时，可能不会自动显示最后一行

    def restore(self):
    	# 恢复标准输出流
        sys.stdout = self.save_stdout
        sys.stderr = self.save_stderr


def click():
    print("hello word")
    logging.error("logging error message")


window = tkinter.Tk()
scroll_text = tkinter.scrolledtext.ScrolledText(window, bg="pink")
scroll_text.pack()
button = tkinter.Button(window, text="点击", command=click)
button.pack()

# 实例化对象
rs = RedictStdout(scroll_text)
# print调用sys.stdout的write方法，sys.stdout指向rs对象，实际上print调用rs的write方法
# rs的write方法，实现了scrolltext组件插入sys.stdout收到的message信息，即print要打印的信息

# 设置日志等级为DEBUG
logging.basicConfig(level=logging.DEBUG)
# logging.error调用了sys.stderr的write方法，sys.stderr指向rs对象，实际上logging.error调用rs的write方法
# rs的write方法，实现了scrolltext组件插入sys.stderr收到的message信息，即logging.error要打印的信息

window.mainloop()
# 恢复标准输出流
rs.restore()

效果：

上面代码可以理解为：