Commit 23686074 authored by R David Murray's avatar R David Murray

#14515: clarify that TemporaryDirectory's __enter__ returns the name.

parent 3b4f1594
...@@ -97,12 +97,14 @@ The module defines the following user-callable items: ...@@ -97,12 +97,14 @@ The module defines the following user-callable items:
This function creates a temporary directory using :func:`mkdtemp` This function creates a temporary directory using :func:`mkdtemp`
(the supplied arguments are passed directly to the underlying function). (the supplied arguments are passed directly to the underlying function).
The resulting object can be used as a context manager (see The resulting object can be used as a context manager (see
:ref:`context-managers`). On completion of the context (or destruction :ref:`context-managers`). On completion of the context or destruction
of the temporary directory object), the newly created temporary directory of the temporary directory object the newly created temporary directory
and all its contents are removed from the filesystem. and all its contents are removed from the filesystem.
The directory name can be retrieved from the :attr:`name` attribute The directory name can be retrieved from the :attr:`name` attribute of the
of the returned object. 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 The directory can be explicitly cleaned up by calling the
:func:`cleanup` method. :func:`cleanup` method.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment