summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-05-26 07:34:22 -0700
committerGitHub <noreply@github.com>2021-05-26 15:34:22 +0100
commit1261941e02cd04829592b1b1360b4ec21bfcdb9a (patch)
tree92f1de2e61a0e72dc756d28dfe953d32a9cd7e94
parent7b3b6982a5683f5146ede58a448d3edb777e501b (diff)
downloadcpython-git-1261941e02cd04829592b1b1360b4ec21bfcdb9a.tar.gz
bpo-41147: [doc] contextlib.redirect_stdout() provides the new stream as context var (GH-21199) (GH-26379)
(cherry picked from commit 46db39d7bd67fb9fea133cd4f18cdf7eacb0f6d9) Co-authored-by: Peter Law <PeterJCLaw@gmail.com>
-rw-r--r--Doc/library/contextlib.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index dd903ce8ee..42834fe68b 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -312,10 +312,11 @@ Functions and classes provided:
For example, the output of :func:`help` normally is sent to *sys.stdout*.
You can capture that output in a string by redirecting the output to an
- :class:`io.StringIO` object::
+ :class:`io.StringIO` object. The replacement stream is returned from the
+ ``__enter__`` method and so is available as the target of the
+ :keyword:`with` statement::
- f = io.StringIO()
- with redirect_stdout(f):
+ with redirect_stdout(io.StringIO()) as f:
help(pow)
s = f.getvalue()