临时重定向标准输出/标准错误

Posted 2023-02-22

【中文标题】临时重定向标准输出/标准错误

【英文标题】：Temporarily Redirect stdout/stderr

【发布时间】：2011-10-11 09:48:37

【问题描述】：

是否可以在 Python 中临时重定向 stdout/stderr（即在方法的持续时间内）？

编辑：

当前解决方案的问题（我起初记得但后来忘记了）是它们不重定向；相反，它们只是完全替换了流。因此，如果某个方法出于任何原因（例如，因为流作为参数传递给某物）而具有一个变量的本地副本，则它将不起作用。

有什么解决办法吗？

【问题讨论】：

重定向 stdout/stderr 并不少见（或者至少不是闻所未闻）——这里的答案很好地解释了这个过程。

@TokenMacGuy：虽然你永远不应该编写输出到 stderr 或 stdout 的库代码，但你不能总是避免使用那种代码。

@Mehrdad 尝试在代码中替换 sys.__stdout__ 的第一件事，在导入第三方模块

@Rob：我想你错过了我标题中的第二个单词。 :-)

@Mehrdad 不。用您自己的类似流的对象（即实现 .write()）在代码的早期替换 sys.__stdout__。所有对 sys.stdout 的引用都指向它。让它代理可变流，默认为标准输出。然后，您应该能够随意切换代理流。我没试过这个；我在大声思考。

【参考方案1】：

您还可以将重定向逻辑放在上下文管理器中。

import os
import sys

class RedirectStdStreams(object):
    def __init__(self, stdout=None, stderr=None):
        self._stdout = stdout or sys.stdout
        self._stderr = stderr or sys.stderr

    def __enter__(self):
        self.old_stdout, self.old_stderr = sys.stdout, sys.stderr
        self.old_stdout.flush(); self.old_stderr.flush()
        sys.stdout, sys.stderr = self._stdout, self._stderr

    def __exit__(self, exc_type, exc_value, traceback):
        self._stdout.flush(); self._stderr.flush()
        sys.stdout = self.old_stdout
        sys.stderr = self.old_stderr

if __name__ == '__main__':

    devnull = open(os.devnull, 'w')
    print('Fubar')

    with RedirectStdStreams(stdout=devnull, stderr=devnull):
        print("You'll never see me")

    print("I'm back!")

【讨论】：

这个答案替换了sys.stdout，sys.stderr，而不是像问题的编辑版本中要求的那样重定向它们。见my answer that does redirect them。

@RobCowie：风格问题：有没有理由让self._stdout“受保护”（在 Python 意义上）与 self.__stdout“私有”（在 Python 意义上）？跨度>

我似乎从来没有创建私有双下划线属性。我还没有找到合适的情况。

@kevinarpe - x._bar 和 x.__bar 之间没有区别，除了 x.__bar 更难获得，由于名称修改而明智地进行调试。它实际上不会将变量设为私有，因此它不会给您带来任何好处，但会使您的调试工作变得更加困难。一般来说，坚持使用单个下划线，除非您正在处理多重继承并且有特殊原因需要 dunderscore（两个类的变量都需要存在？我觉得有更优雅的解决方案）

也许with 比with open(os.devnull, "w") as devnull, RedirectStdStreams(stdout=devnull, stderr=devnull): 更好，这样devnull 也可以正常关闭

【参考方案2】：

要解决某些函数可能已将 sys.stdout 流缓存为局部变量并因此替换全局 sys.stdout 在该函数内不起作用的问题，您可以在文件描述符级别重定向 (sys.stdout.fileno())例如：

from __future__ import print_function
import os
import sys

def some_function_with_cached_sys_stdout(stdout=sys.stdout):
    print('cached stdout', file=stdout)

with stdout_redirected(to=os.devnull), merged_stderr_stdout():
    print('stdout goes to devnull')
    some_function_with_cached_sys_stdout()
    print('stderr also goes to stdout that goes to devnull', file=sys.stderr)
print('stdout is back')
some_function_with_cached_sys_stdout()
print('stderr is back', file=sys.stderr)

stdout_redirected() 将sys.stdout.fileno() 的所有输出重定向到给定的文件名、文件对象或文件描述符（示例中为os.devnull）。

stdout_redirected() and merged_stderr_stdout() are defined here.

【参考方案3】：

我不确定临时重定向是什么意思。但是，您可以像这样重新分配流并将其重置。

temp = sys.stdout
sys.stdout = sys.stderr
sys.stderr = temp

还可以像这样在打印 stmts 中写入 sys.stderr。

 print >> sys.stderr, "Error in atexit._run_exitfuncs:"

定期打印将输出到标准输出。

【讨论】：

我想我可以用try-finally 包裹它；似乎它会工作，虽然不像我想要的那么漂亮。谢谢+1

这个例子适用于我们这些停留在 python 2.2 上的人。谢谢

你不需要临时。 sys.__stderr__ 保持正确的对象。

+1 是我见过的最干净、最简单的解决方案

在 Python 中，您不需要 temp 变量。您可以拨打sys.stdout, sys.stderr = sys.stderr, sys.stdout。

【参考方案4】：

从 python 3.4 开始有上下文管理器contextlib.redirect_stdout:

from contextlib import redirect_stdout

with open('yourfile.txt', 'w') as f:
    with redirect_stdout(f):
        # do stuff...

让stdout 完全静音这行得通：

from contextlib import redirect_stdout

with redirect_stdout(None):
    # do stuff...

【讨论】：

我刚刚用redirect_stdout(None) 尝试过，但没有成功。产生输出的模块是用 C++ 编写的，可能与它有关。

如何'它不起作用'？因为它真的应该！参见例如这个问题：***.com/questions/49757674/…

也许这只是一个极端情况，我尝试在with redirect_stderr(None) 中封装对caffe.Net() 的调用，但仍然有大量调试消息转储到stderr。事实证明，您可以通过另一种方式针对 Caffe 的特定情况禁用这些功能，但我想禁用标准输出对于在后台使用 std::iostream 的模块来说并不容易。

如果想将stdout和stderr都重定向到同一个地方怎么办？

@baxx with redirect_stdout(sys.stderr): 然后你可以重定向stderr（或相反）。

【参考方案5】：

可以使用如下装饰器：

import sys

def redirect_stderr_stdout(stderr=sys.stderr, stdout=sys.stdout):
    def wrap(f):
        def newf(*args, **kwargs):
            old_stderr, old_stdout = sys.stderr, sys.stdout
            sys.stderr = stderr
            sys.stdout = stdout
            try:
                return f(*args, **kwargs)
            finally:
                sys.stderr, sys.stdout = old_stderr, old_stdout

        return newf
    return wrap

用作：

@redirect_stderr_stdout(some_logging_stream, the_console):
def fun(...):
    # whatever

或者，如果你不想修改fun的来源，直接调用为

redirect_stderr_stdout(some_logging_stream, the_console)(fun)

但请注意，这不是线程安全的。

【讨论】：

+1 似乎是我需要的。只是好奇，你为什么要做except: raise？

@Mehrdad：忘记except: raise 的事情，这是我的想法。顺便说一句，我重写了整件事。我总是第一次弄错装饰器中的嵌套级别，但现在它确实有效。

你知道，我注意到一个问题：如果程序缓存流对象（例如，将它们作为参数传递给接受流的函数）怎么办？那么这行不通。 :\ 有没有办法自己重定向流，而不是用新的流替换它们？

@Mehrdad：那么你会做一些低级的文件描述符魔术，甚至在执行所需的代码之前分叉进程并重定向子进程中的流，通过管道返回结果。恐怕这里没有灵丹妙药。

changereturn wrap(f) 以返回 wrap

【参考方案6】：

这是一个我觉得很有用的上下文管理器。这样做的好处是您可以将它与with 语句一起使用，它还可以处理子进程的重定向。

import contextlib


@contextlib.contextmanager
def stdchannel_redirected(stdchannel, dest_filename):
    """
    A context manager to temporarily redirect stdout or stderr

    e.g.:

    with stdchannel_redirected(sys.stderr, os.devnull):
        ...
    """

    try:
        oldstdchannel = os.dup(stdchannel.fileno())
        dest_file = open(dest_filename, 'w')
        os.dup2(dest_file.fileno(), stdchannel.fileno())

        yield
    finally:
        if oldstdchannel is not None:
            os.dup2(oldstdchannel, stdchannel.fileno())
        if dest_file is not None:
            dest_file.close()

我创建它的原因是this blog post。

【讨论】：

是否可以不将标准输出重定向到文件而忽略它？

【参考方案7】：

Raymond Hettinger 向我们展示了一种更好的方法[1]：

import sys
with open(filepath + filename, "w") as f: #replace filepath & filename
    with f as sys.stdout:
        print("print this to file")   #will be written to filename & -path

在 with 块之后，sys.stdout 将被重置

[1]：http://www.youtube.com/watch?v=OSGv2VnC0go&list=PLQZM27HgcgT-6D0w6arhnGdSHDcSmQ8r3

【讨论】：

-1 -- with 将不会恢复初始的 sys.stdout。如果您尝试在这些 with 块之后打印某些内容，您会收到 ValueError: I/O operation on closed file.。您应该删除第二个 with 并在第一个 with 块的末尾添加一个 sys.stdout = sys.__stdout__。

【参考方案8】：

查看contextlib.redirect_stdout(new_target) 和contextlib.redirect_stderr(new_target)。 contextlib.redirect_stderr(new_target) 是 Python 3.5 中的新功能。

【参考方案9】：

我们将在python3中使用ob_start和ob_get_contents函数的php语法，并将输入重定向到一个文件中。

输出被存储在一个文件中，任何类型的流都可以使用。

from functools import partial
output_buffer = None
print_orig = print
def ob_start(fname="print.txt"):
    global print
    global output_buffer
    print = partial(print_orig, file=output_buffer)
    output_buffer = open(fname, 'w')
def ob_end():
    global output_buffer
    close(output_buffer)
    print = print_orig
def ob_get_contents(fname="print.txt"):
    return open(fname, 'r').read()

用法：

print ("Hi John")
ob_start()
print ("Hi John")
ob_end()
print (ob_get_contents().replace("Hi", "Bye"))

会打印

嗨，约翰 再见约翰