How can I redirect print output of a function in python [duplicate]

by

For python3.4+, there’s a context manager for this in the standard library.

with contextlib.redirect_stdout(file_like_object):
    ...

This part of the answer was updated, but is mostly for people who are still stuck in a python2.x world

If you’re stuck on an older version of python, this context manager isn’t too hard to write yourself. The key is that you can update sys.stdout to whatever file-like object you want (that’s what print writes to):

>>> import sys
>>> import StringIO
>>> stdout = sys.stdout  # keep a handle on the real standard output
>>> sys.stdout = StringIO.StringIO() # Choose a file-like object to write to
>>> foo() 
>>> sys.stdout = stdout
>>> foo()
bar

To create a context manager to set stdout to whatever you want when you enter the context and then have the context manager reset stdout when you __exit__ the context.

Here’s a simple example using contextlib to create the context manager:

import contextlib
import sys

@contextlib.contextmanager
def stdout_redirect(where):
    sys.stdout = where
    try:
        yield where
    finally:
        sys.stdout = sys.__stdout__

def foo():
    print 'bar'

# Examples with StringIO
import StringIO

with stdout_redirect(StringIO.StringIO()) as new_stdout:
    foo()

new_stdout.seek(0)
print "data from new_stdout:",new_stdout.read()

new_stdout1 = StringIO.StringIO()
with stdout_redirect(new_stdout1):
    foo()

new_stdout1.seek(0)
print "data from new_stdout1:",new_stdout1.read()

# Now with a file object:
with open('new_stdout') as f:
    with stdout_redirect(f):
        foo()

# Just to prove that we actually did put stdout back as we were supposed to
print "Now calling foo without context"
foo()

Note:

On python3.x, StringIO.StringIO has moved to io.StringIO. Also, on python2.x, cStringIO.StringIO might be slightly more performant.

More Related Contents:

  1. multiple prints on the same line in Python
  2. The difference between sys.stdout.write and print?
  3. Why is printing to stdout so slow? Can it be sped up?
  4. Difference between returns and printing in python? [duplicate]
  5. How can I print multiple things on the same line, one at a time?
  6. Python – Class.function().function()
  7. Function to return results in a dictionary in Python
  8. Why does this recursion return 0?
  9. Why is the output of my function printing out “None”?
  10. How to print instances of a class using print()?
  11. How to get the original variable name of variable passed to a function
  12. UnboundLocalError with nested function scopes
  13. Print multiple arguments in Python
  14. Passing functions with arguments to another function in Python?
  15. What does it mean to “call” a function in Python? [closed]
  16. How to print to stderr in Python?
  17. How to block calls to print?
  18. Python: Passing variables between functions
  19. Return value from button click
  20. Using a dictionary to select function to execute
  21. Running an interactive command from within Python
  22. Calling a function upon button press
  23. How to access a function inside a function?
  24. Declare function at end of file in Python [duplicate]
  25. Python Class Based Decorator with parameters that can decorate a method or a function
  26. Python functions with multiple parameter brackets
  27. Force another program’s standard output to be unbuffered using Python
  28. Check if all values in list are greater than a certain number
  29. Is it ok to skip “return None”?
  30. How can I capture the stdout output of a child process?

Leave a Comment