summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-02-05 19:53:40 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-02-05 19:53:40 (GMT)
commit23686074b0e665395b5b4d238663574f576cc2e3 (patch)
tree145ff4f331364a1b94e1b1dc2c7c7d4e62e18edb
parent3b4f1594ffb360e9a93841a4c8dfe00d6f519bf6 (diff)
downloadcpython-23686074b0e665395b5b4d238663574f576cc2e3.zip
cpython-23686074b0e665395b5b4d238663574f576cc2e3.tar.gz
cpython-23686074b0e665395b5b4d238663574f576cc2e3.tar.bz2
#14515: clarify that TemporaryDirectory's __enter__ returns the name.
-rw-r--r--Doc/library/tempfile.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
index 13b6041..d78159d 100644
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -97,12 +97,14 @@ The module defines the following user-callable items:
This function creates a temporary directory using :func:`mkdtemp`
(the supplied arguments are passed directly to the underlying function).
The resulting object can be used as a context manager (see
- :ref:`context-managers`). On completion of the context (or destruction
- of the temporary directory object), the newly created temporary directory
+ :ref:`context-managers`). On completion of the context or destruction
+ of the temporary directory object the newly created temporary directory
and all its contents are removed from the filesystem.
- The directory name can be retrieved from the :attr:`name` attribute
- of the returned object.
+ The directory name can be retrieved from the :attr:`name` attribute of the
+ returned object. When the returned object is used as a context manager, the
+ :attr:`name` will be assigned to the target of the :keyword:`as` clause in
+ the :keyword:`with` statement, if there is one.
The directory can be explicitly cleaned up by calling the
:func:`cleanup` method.