Отключите стандартный вывод функции в Python, не удаляя sys.stdout и не восстанавливая каждый вызов функции

Question

Есть ли в Python способ отключить стандартный вывод без переноса вызова функции, как показано ниже?

Оригинальный сломанный код:

from sys import stdout
from copy import copy
save_stdout = copy(stdout)
stdout = open('trash','w')
foo()
stdout = save_stdout

Изменить: Исправленный код от Алекса Мартелли

import sys
save_stdout = sys.stdout
sys.stdout = open('trash', 'w')
foo()
sys.stdout = save_stdout

Этот способ работает, но кажется ужасно неэффективным. Должен быть лучший способ. Есть идеи?

Answer 1

Назначение stdout переменная, как вы делаете, не имеет никакого эффекта, если предположить, foo содержит print операторы - еще один пример того, почему вы никогда не должны импортировать что-либо изнутри модуля (как вы делаете здесь), но всегда модуль в целом (тогда используйте квалифицированные имена). copy не имеет значения, кстати. Правильный эквивалент вашего фрагмента:

import sys
save_stdout = sys.stdout
sys.stdout = open('trash', 'w')
foo()
sys.stdout = save_stdout

Теперь, когда код верен, самое время сделать его более элегантным или быстрым. Например, вы можете использовать файловый объект в памяти вместо файла 'trash':

import sys
import io
save_stdout = sys.stdout
sys.stdout = io.BytesIO()
foo()
sys.stdout = save_stdout

для элегантности лучше всего использовать контекст, например:

import contextlib
import io
import sys

@contextlib.contextmanager
def nostdout():
    save_stdout = sys.stdout
    sys.stdout = io.BytesIO()
    yield
    sys.stdout = save_stdout

как только вы определили этот контекст, для любого блока, в котором вы не хотите стандартный вывод,

with nostdout():
    foo()

Дополнительная оптимизация: вам просто нужно заменить sys.stdout на объект, у которого нет операции write метод. Например:

import contextlib
import sys

class DummyFile(object):
    def write(self, x): pass

@contextlib.contextmanager
def nostdout():
    save_stdout = sys.stdout
    sys.stdout = DummyFile()
    yield
    sys.stdout = save_stdout

использоваться так же, как и предыдущая реализация nostdout, Я не думаю, что это становится чище или быстрее, чем это;-).

Answer 2

Просто чтобы добавить к тому, что уже говорили другие, Python 3.4 представил contextlib.redirect_stdout контекстный менеджер. Он принимает файловый (-подобный) объект, на который должен быть перенаправлен вывод.

Перенаправление на /dev/null подавит вывод:

In [11]: def f(): print('noise')

In [12]: import os, contextlib

In [13]: with open(os.devnull, 'w') as devnull:
   ....:     with contextlib.redirect_stdout(devnull):
   ....:         f()
   ....:         

In [14]: 

Это решение может быть адаптировано для использования в качестве декоратора:

import os, contextlib

def supress_stdout(func):
    def wrapper(*a, **ka):
        with open(os.devnull, 'w') as devnull:
            with contextlib.redirect_stdout(devnull):
                func(*a, **ka)
    return wrapper

@supress_stdout
def f():
    print('noise')

f() # nothing is printed

Другое возможное и иногда полезное решение, которое будет работать как в Python 2, так и в 3, - передать /dev/null в качестве аргумента f и перенаправить вывод, используя file аргумент print функция:

In [14]: def f(target): print('noise', file=target)

In [15]: with open(os.devnull, 'w') as devnull:
   ....:     f(target=devnull)
   ....:     

In [16]: 

Вы даже можете сделать target совершенно необязательно:

def f(target=sys.stdout):
    # Here goes the function definition

Обратите внимание, вам нужно

from __future__ import print_function

в Python 2.

Answer 3

Позвонил мне очень поздно, и я решил, что это более чистое решение этой проблемы.

import sys, traceback

class Suppressor(object):

    def __enter__(self):
        self.stdout = sys.stdout
        sys.stdout = self

    def __exit__(self, type, value, traceback):
        sys.stdout = self.stdout
        if type is not None:
            # Do normal exception handling

    def write(self, x): pass

Использование:

with Suppressor():
    DoMyFunction(*args,**kwargs)

Answer 4

Почему вы считаете это неэффективным? Вы проверяли это? Кстати, это не работает вообще, потому что вы используете from ... import заявление. Замена sys.stdout это хорошо, но не делайте копию и не используйте временный файл. Вместо этого откройте нулевое устройство:

import sys
import os

def foo():
    print "abc"

old_stdout = sys.stdout
sys.stdout = open(os.devnull, "w")
try:
    foo()
finally:
    sys.stdout.close()
    sys.stdout = old_stdout

Answer 5

redirect_stdout() был добавлен в contextlib начиная с python 3.4

Для python >= 3.4 это должно быть сделано:

import contextlib
import io

with contextlib.redirect_stdout(io.StringIO()):
    foo()

Answer 6

Небольшая модификация ответа Алекса Мартелли...

Это касается случая, когда вы всегда хотите подавить stdout для функции, а не отдельные вызовы функции.

Если foo() был бы вызван много раз, было бы лучше / проще обернуть функцию (украсить ее). Таким образом, вы измените определение foo один раз вместо того, чтобы включать каждое использование функции в оператор with.

import sys
from somemodule import foo

class DummyFile(object):
    def write(self, x): pass

def nostdout(func):
    def wrapper(*args, **kwargs):        
        save_stdout = sys.stdout
        sys.stdout = DummyFile()
        func(*args, **kwargs)
        sys.stdout = save_stdout
    return wrapper

foo = nostdout(foo)

Answer 7

Обобщая еще больше, вы можете получить хороший декоратор, который может захватывать выходные данные и даже возвращать их:

import sys
import cStringIO
from functools import wraps

def mute(returns_output=False):
    """
        Decorate a function that prints to stdout, intercepting the output.
        If "returns_output" is True, the function will return a generator
        yielding the printed lines instead of the return values.

        The decorator litterally hijack sys.stdout during each function
        execution for ALL THE THREADS, so be careful with what you apply it to
        and in which context.

        >>> def numbers():
            print "42"
            print "1984"
        ...
        >>> numbers()
        42
        1984
        >>> mute()(numbers)()
        >>> list(mute(True)(numbers)())
        ['42', '1984']

    """

    def decorator(func):

        @wraps(func)
        def wrapper(*args, **kwargs):

            saved_stdout = sys.stdout
            sys.stdout = cStringIO.StringIO()

            try:
                out = func(*args, **kwargs)
                if returns_output:
                    out = sys.stdout.getvalue().strip().split()
            finally:
                sys.stdout = saved_stdout

            return out

        return wrapper

    return decorator

Answer 8

Я не думаю, что это становится чище или быстрее, чем это;-)

Ба! Я думаю, что я могу сделать немного лучше:-D

import contextlib, cStringIO, sys

@contextlib.contextmanager
def nostdout():

    '''Prevent print to stdout, but if there was an error then catch it and
    print the output before raising the error.'''

    saved_stdout = sys.stdout
    sys.stdout = cStringIO.StringIO()
    try:
        yield
    except Exception:
        saved_output = sys.stdout
        sys.stdout = saved_stdout
        print saved_output.getvalue()
        raise
    sys.stdout = saved_stdout

Который добирается до того, что я хотел изначально, для обычного подавления вывода, но для показа подавленного вывода, если была выдана ошибка.