From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sat, 3 Dec 2011 21:35:31 +0000 (+0100)
Subject: Refine FAQ entry for catching stdout
X-Git-Tag: v3.2.3rc1~324
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d4ddec59881802aa0c92b0736ff71eb6cff84857;p=thirdparty%2FPython%2Fcpython.git

Refine FAQ entry for catching stdout
---

diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst
index 676890e27c57..7c684a092948 100644
--- a/Doc/faq/extending.rst
+++ b/Doc/faq/extending.rst
@@ -142,21 +142,30 @@ this object to :data:`sys.stdout` and :data:`sys.stderr`.  Call print_error, or
 just allow the standard traceback mechanism to work. Then, the output will go
 wherever your ``write()`` method sends it.
 
-The easiest way to do this is to use the StringIO class in the standard library.
+The easiest way to do this is to use the :class:`io.StringIO` class::
 
-Sample code and use for catching stdout:
+   >>> import io, sys
+   >>> sys.stdout = io.StringIO()
+   >>> print('foo')
+   >>> print('hello world!')
+   >>> sys.stderr.write(sys.stdout.getvalue())
+   foo
+   hello world!
+
+A custom object to do the same would look like this::
 
-   >>> class StdoutCatcher:
+   >>> import io, sys
+   >>> class StdoutCatcher(io.TextIOBase):
    ...     def __init__(self):
-   ...         self.data = ''
+   ...         self.data = []
    ...     def write(self, stuff):
-   ...         self.data = self.data + stuff
+   ...         self.data.append(stuff)
    ...
    >>> import sys
    >>> sys.stdout = StdoutCatcher()
    >>> print('foo')
    >>> print('hello world!')
-   >>> sys.stderr.write(sys.stdout.data)
+   >>> sys.stderr.write(''.join(sys.stdout.data))
    foo
    hello world!