Merged revisions 73518-73519 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk ........ r73518 | nick.coghlan | 2009-06-23 20:19:30 +1000 (Tue, 23 Jun 2009) | 1 line Issue 6288: Update contextlib.nested() docstring to reflect new documentation ........ r73519 | nick.coghlan | 2009-06-23 20:51:02 +1000 (Tue, 23 Jun 2009) | 1 line Remove markup from docstring ........

Merged revisions 73518-73519 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r73518 | nick.coghlan | 2009-06-23 20:19:30 +1000 (Tue, 23 Jun 2009) | 1 line Issue 6288: Update contextlib.nested() docstring to reflect new documentation ........ r73519 | nick.coghlan | 2009-06-23 20:51:02 +1000 (Tue, 23 Jun 2009) | 1 line Remove markup from docstring ........
b7706b58 · Nick Coghlan · 5250401b · b7706b58
Commit b7706b58 authored Jun 23, 2009 by Nick Coghlan
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 10 deletions

Lib/contextlib.py Lib/contextlib.py +8 -10

No files found.
--- a/Lib/contextlib.py
+++ b/Lib/contextlib.py
@@ -87,19 +87,17 @@ def contextmanager(func):

 @contextmanager
 def nested(*managers):
-    """Support multiple context managers in a single with-statement.
+    """Combine multiple context managers into a single nested context manager.

-    Code like this:
-
-        with nested(A, B, C) as (X, Y, Z):
-            <body>
+   This function has been deprecated in favour of the multiple manager form
+   of the with statement.

-    is equivalent to this:
+   The one advantage of this function over the multiple manager form of the
+   with statement is that argument unpacking allows it to be
+   used with a variable number of context managers as follows:

-        with A as X:
-            with B as Y:
-                with C as Z:
-                    <body>
+      with nested(*managers):
+          do_something()

    """
    warn("With-statements now directly support multiple context managers",