在python中将stdout重定向到“无”

Question

我有一个由足够多的模块组成的大型项目，每个模块都会向标准输出打印一些内容。现在随着项目规模的扩大，没有大的。的print 语句在标准输出上打印了很多，这使得程序相当慢。

所以，我现在想在 runtime 决定是否将任何内容打印到标准输出。我无法对模块进行更改，因为它们有很多。 （我知道我可以将标准输出重定向到一个文件，但即使这样也相当慢。）

所以我的问题是如何将标准输出重定向到无，即如何使print 语句什么都不做？

# I want to do something like this.
sys.stdout = None         # this obviously will give an error as Nonetype object does not have any write method.

目前我唯一的想法是创建一个具有 write 方法（什么都不做）的类，并将标准输出重定向到此类的实例。

class DontPrint(object):
    def write(*args): pass

dp = DontPrint()
sys.stdout = dp

python 中是否有为此的内置机制？或者还有什么比这更好的吗？

Answer 1

跨平台：

import os
import sys
f = open(os.devnull, 'w')
sys.stdout = f

在 Windows 上：

f = open('nul', 'w')
sys.stdout = f

在 Linux 上：

f = open('/dev/null', 'w')
sys.stdout = f

Answer 2

一个很好的方法是创建一个小型上下文处理器，您可以在其中包装您的打印。然后您只需在 with-statement 中使用 is 来使所有输出静音。

Python 2：

import os
import sys
from contextlib import contextmanager

@contextmanager
def silence_stdout():
    old_target = sys.stdout
    try:
        with open(os.devnull, "w") as new_target:
            sys.stdout = new_target
            yield new_target
    finally:
        sys.stdout = old_target

with silence_stdout():
    print("will not print")

print("this will print")

Python 3.4+：

Python 3.4 内置了这样的上下文处理器，因此您可以像这样简单地使用 contextlib：

import contextlib

with contextlib.redirect_stdout(None):
    print("will not print")

print("this will print")

---

如果您想要隐藏的代码使用 None 作为重定向目标直接写入 sys.stdout 将不起作用。相反，您可以使用：

import contextlib
import sys
import os

with contextlib.redirect_stdout(open(os.devnull, 'w')):
    sys.stdout.write("will not print")

sys.stdout.write("this will print")

---

如果您的代码写入 stderr 而不是 stdout，您可以使用 contextlib.redirect_stderr 而不是 redirect_stdout。

---

运行此代码只打印第二行输出，而不是第一行：

$ python test.py
this will print

这适用于跨平台（Windows + Linux + Mac OSX），并且比其他答案更干净。

Answer 3

如果您使用的是 python 3.4 或更高版本，使用标准库有一个简单且安全的解决方案：

import contextlib

with contextlib.redirect_stdout(None):
  print("This won't print!")

Answer 4

（至少在我的系统上）似乎写入 os.devnull 比写入 DontPrint 类快约 5 倍，即

#!/usr/bin/python
import os
import sys
import datetime

ITER = 10000000
def printlots(out, it, st="abcdefghijklmnopqrstuvwxyz1234567890"):
   temp = sys.stdout
   sys.stdout = out
   i = 0
   start_t = datetime.datetime.now()
   while i < it:
      print st
      i = i+1
   end_t = datetime.datetime.now()
   sys.stdout = temp
   print out, "\n   took", end_t - start_t, "for", it, "iterations"

class devnull():
   def write(*args):
      pass


printlots(open(os.devnull, 'wb'), ITER)
printlots(devnull(), ITER)

给出以下输出：

<open file '/dev/null', mode 'wb' at 0x7f2b747044b0> 
   took 0:00:02.074853 for 10000000 iterations
<__main__.devnull instance at 0x7f2b746bae18> 
   took 0:00:09.933056 for 10000000 iterations

Answer 5

如果您在 Unix 环境中（包括 Linux），您可以将输出重定向到 /dev/null:

python myprogram.py > /dev/null

对于 Windows：

python myprogram.py > nul

Answer 6

您的类可以正常工作（write() 方法名称除外——它需要被称为write()，小写）。只需确保将sys.stdout 的副本保存在另一个变量中即可。

如果您使用的是 *NIX，则可以使用 sys.stdout = open('/dev/null')，但这比滚动您自己的课程更不便携。

Answer 7

这个怎么样：

from contextlib import ExitStack, redirect_stdout
import os

with ExitStack() as stack:
    if should_hide_output():
        null_stream = open(os.devnull, "w")
        stack.enter_context(null_stream)
        stack.enter_context(redirect_stdout(null_stream))
    noisy_function()

这使用contextlib 模块中的功能来隐藏您尝试运行的任何命令的输出，具体取决于should_hide_output() 的结果，然后在该函数运行完成后恢复输出行为。

如果要隐藏标准错误输出，则从contextlib 导入redirect_stderr 并添加一行stack.enter_context(redirect_stderr(null_stream))。

主要缺点是这只适用于 Python 3.4 及更高版本。

Answer 8

sys.stdout = None

print() 情况下可以。但是如果你调用 sys.stdout 的任何方法，它可能会导致错误，例如sys.stdout.write().

有一个note in docs：

在某些条件下stdin、stdout和stderr以及原来的 stdin、stdout 和 stderr 的值可以为 None。通常是 未连接到控制台的 Windows GUI 应用程序和 Python 应用以 pythonw 开头。

Answer 9

你可以模拟它。

import mock

sys.stdout = mock.MagicMock()

Answer 10

对iFreilicht's answer 的补充 - 它适用于 python 2 和 3。

import sys

class NonWritable:
    def write(self, *args, **kwargs):
        pass

class StdoutIgnore:
    def __enter__(self):
        self.stdout_saved = sys.stdout
        sys.stdout = NonWritable()
        return self

    def __exit__(self, *args):
        sys.stdout = self.stdout_saved

with StdoutIgnore():
    print("This won't print!")

Answer 11

你为什么不试试这个？

sys.stdout.close()
sys.stderr.close()

Answer 12

将在此处为众多答案添加一些示例：

import argparse
import contextlib

class NonWritable:
    def write(self, *args, **kwargs):
        pass

parser = argparse.ArgumentParser(description='my program')
parser.add_argument("-p", "--param", help="my parameter", type=str, required=True)

#with contextlib.redirect_stdout(None): # No effect as `argparse` will output to `stderr`
#with contextlib.redirect_stderr(None): # AttributeError: 'NoneType' object has no attribute 'write'
with contextlib.redirect_stderr(NonWritable): # this works!
    args = parser.parse_args()

正常的输出是：

>python TEST.py
usage: TEST.py [-h] -p PARAM
TEST.py: error: the following arguments are required: -p/--param

Answer 13

如果您不想处理资源分配或滚动您自己的类，您可能希望使用 Python 输入中的TextIO。默认情况下，它为您提供了所有必需的方法。

import sys
from typing import TextIO

sys.stdout = TextIO()