How to capture stdout output from a Python function call?

by

Try this context manager:

from io import StringIO 
import sys

class Capturing(list):
    def __enter__(self):
        self._stdout = sys.stdout
        sys.stdout = self._stringio = StringIO()
        return self
    def __exit__(self, *args):
        self.extend(self._stringio.getvalue().splitlines())
        del self._stringio    # free up some memory
        sys.stdout = self._stdout

Usage:

with Capturing() as output:
    do_something(my_object)

output is now a list containing the lines printed by the function call.

Advanced usage:

What may not be obvious is that this can be done more than once and the results concatenated:

with Capturing() as output:
    print('hello world')

print('displays on screen')

with Capturing(output) as output:  # note the constructor argument
    print('hello world2')

print('done')
print('output:', output)

Output:

displays on screen                     
done                                   
output: ['hello world', 'hello world2']

Update: They added redirect_stdout() to contextlib in Python 3.4 (along with redirect_stderr()). So you could use io.StringIO with that to achieve a similar result (though Capturing being a list as well as a context manager is arguably more convenient).

More Related Contents:

  1. Disable output buffering
  2. How to set sys.stdout encoding in Python 3?
  3. How to open every file in a folder
  4. catching stdout in realtime from subprocess
  5. Silence the stdout of a function in Python without trashing sys.stdout and restoring each function call
  6. Displaying subprocess output to stdout and redirecting it
  7. The difference between sys.stdout.write and print?
  8. Redirecting stdout and stderr to a PyQt4 QTextEdit from a secondary thread
  9. Python: How to get stdout after running os.system? [duplicate]
  10. Interactive input/output using Python
  11. Why is printing to stdout so slow? Can it be sped up?
  12. Intercepting stdout of a subprocess while it is running
  13. Python read from subprocess stdout and stderr separately while preserving order
  14. How to redirect stdout and stderr to logger in Python
  15. Running an interactive command from within Python
  16. Command executed with Paramiko does not produce any output
  17. Print to the same line and not a new line?
  18. How do I check if stdin has some data?
  19. Suppress stdout / stderr print from Python functions
  20. How to replicate tee behavior in Python when using subprocess?
  21. Redirecting stdio from a command in os.system() in Python
  22. How to redirect stdout to a Tkinter Text widget
  23. How can I redirect print output of a function in python [duplicate]
  24. Force another program’s standard output to be unbuffered using Python
  25. Integer File Descriptor “0” in open()
  26. Piping output of subprocess.Popen to files
  27. How can I capture the stdout output of a child process?
  28. How to make print() output UTF-8 in Python 3.0?
  29. Python subprocess output to stdout
  30. multiprocessing: How can I ʀᴇʟɪᴀʙʟʏ redirect stdout from a child process?

Leave a Comment