Mr.Combet Webshell 🔥

Edit File Name : tempfile.html

<!DOCTYPE html>

<title>tempfile — Generate temporary files and directories &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="glob — Unix style pathname pattern expansion" href="glob.html" />
 <link rel="prev" title="filecmp — File and Directory Comparisons" href="filecmp.html" />
 <link rel="canonical" href="https://docs.python.org/3/library/tempfile.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <input type="submit" value="Go"/>
 </form>
 
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">tempfile</code> — Generate temporary files and directories</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#deprecated-functions-and-variables">Deprecated functions and variables</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="filecmp.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">filecmp</code> — File and Directory Comparisons</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="glob.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">glob</code> — Unix style pathname pattern expansion</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/main/Doc/library/tempfile.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="glob.html" title="glob — Unix style pathname pattern expansion"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="filecmp.html" title="filecmp — File and Directory Comparisons"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">tempfile</code> — Generate temporary files and directories</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-tempfile">
<h1><a class="reference internal" href="#module-tempfile" title="tempfile: Generate temporary files and directories."><code class="xref py py-mod docutils literal notranslate">tempfile</code></a> — Generate temporary files and directories<a class="headerlink" href="#module-tempfile" title="Link to this heading">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/tempfile.py">Lib/tempfile.py</a>
<hr class="docutils" id="index-0" />
This module creates temporary files and directories. It works on all
supported platforms. <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-class docutils literal notranslate">TemporaryFile</code></a>, <a class="reference internal" href="#tempfile.NamedTemporaryFile" title="tempfile.NamedTemporaryFile"><code class="xref py py-class docutils literal notranslate">NamedTemporaryFile</code></a>,
<a class="reference internal" href="#tempfile.TemporaryDirectory" title="tempfile.TemporaryDirectory"><code class="xref py py-class docutils literal notranslate">TemporaryDirectory</code></a>, and <a class="reference internal" href="#tempfile.SpooledTemporaryFile" title="tempfile.SpooledTemporaryFile"><code class="xref py py-class docutils literal notranslate">SpooledTemporaryFile</code></a> are high-level
interfaces which provide automatic cleanup and can be used as
<a class="reference internal" href="../glossary.html#term-context-manager">context managers</a>. <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> and
<a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a> are lower-level functions which require manual cleanup.
All the user-callable functions and constructors take additional arguments which
allow direct control over the location and name of temporary files and
directories. Files names used by this module include a string of
random characters which allows those files to be securely created in
shared temporary directories.
To maintain backward compatibility, the argument order is somewhat odd; it
is recommended to use keyword arguments for clarity.
The module defines the following user-callable items:
<dl class="py function">
<dt class="sig sig-object py" id="tempfile.TemporaryFile">
tempfile.TemporaryFile(mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)<a class="headerlink" href="#tempfile.TemporaryFile" title="Link to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="../glossary.html#term-file-like-object">file-like object</a> that can be used as a temporary storage area.
The file is created securely, using the same rules as <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a>. It will be destroyed as soon
as it is closed (including an implicit close when the object is garbage
collected). Under Unix, the directory entry for the file is either not created at all or is removed
immediately after the file is created. Other platforms do not support
this; your code should not rely on a temporary file created using this
function having or not having a visible name in the file system.
The resulting object can be used as a <a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> (see
<a class="reference internal" href="#tempfile-examples">Examples</a>). On completion of the context or
destruction of the file object the temporary file will be removed
from the filesystem.
The mode parameter defaults to <code class="docutils literal notranslate">'w+b'</code> so that the file created can
be read and written without being closed. Binary mode is used so that it
behaves consistently on all platforms without regard for the data that is
stored. buffering, encoding, errors and newline are interpreted as for
<a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate">open()</code></a>.
The dir, prefix and suffix parameters have the same meaning and
defaults as with <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a>.
The returned object is a true file object on POSIX platforms. On other
platforms, it is a file-like object whose <code class="xref py py-attr docutils literal notranslate">file</code> attribute is the
underlying true file object.
The <a class="reference internal" href="os.html#os.O_TMPFILE" title="os.O_TMPFILE"><code class="xref py py-const docutils literal notranslate">os.O_TMPFILE</code></a> flag is used if it is available and works
(Linux-specific, requires Linux kernel 3.11 or later).
On platforms that are neither Posix nor Cygwin, TemporaryFile is an alias
for NamedTemporaryFile.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">tempfile.mkstemp</code> with argument <code class="docutils literal notranslate">fullpath</code>.
<div class="versionchanged">
Changed in version 3.5: The <a class="reference internal" href="os.html#os.O_TMPFILE" title="os.O_TMPFILE"><code class="xref py py-const docutils literal notranslate">os.O_TMPFILE</code></a> flag is now used if available.
</div>
<div class="versionchanged">
Changed in version 3.8: Added errors parameter.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.NamedTemporaryFile">
tempfile.NamedTemporaryFile(mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True, *, errors=None, delete_on_close=True)<a class="headerlink" href="#tempfile.NamedTemporaryFile" title="Link to this definition">¶</a></dt>
<dd>This function operates exactly as <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a> does, except the
following differences:
<ul class="simple">
<li>This function returns a file that is guaranteed to have a visible name in
the file system.</li>
<li>To manage the named file, it extends the parameters of
<a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a> with delete and delete_on_close parameters that
determine whether and how the named file should be automatically deleted.</li>
</ul>
The returned object is always a <a class="reference internal" href="../glossary.html#term-file-like-object">file-like object</a> whose <code class="xref py py-attr docutils literal notranslate">file</code>
attribute is the underlying true file object. This file-like object
can be used in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, just like a normal file. The
name of the temporary file can be retrieved from the <code class="xref py py-attr docutils literal notranslate">name</code> attribute
of the returned file-like object. On Unix, unlike with the
<a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a>, the directory entry does not get unlinked immediately
after the file creation.
If delete is true (the default) and delete_on_close is true (the
default), the file is deleted as soon as it is closed. If delete is true
and delete_on_close is false, the file is deleted on context manager exit
only, or else when the <a class="reference internal" href="../glossary.html#term-file-like-object">file-like object</a> is finalized. Deletion is not
always guaranteed in this case (see <a class="reference internal" href="../reference/datamodel.html#object.__del__" title="object.__del__"><code class="xref py py-meth docutils literal notranslate">object.__del__()</code></a>). If delete is
false, the value of delete_on_close is ignored.
Therefore to use the name of the temporary file to reopen the file after
closing it, either make sure not to delete the file upon closure (set the
delete parameter to be false) or, in case the temporary file is created in
a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, set the delete_on_close parameter to be false.
The latter approach is recommended as it provides assistance in automatic
cleaning of the temporary file upon the context manager exit.
Opening the temporary file again by its name while it is still open works as
follows:
<ul class="simple">
<li>On POSIX the file can always be opened again.</li>
<li>On Windows, make sure that at least one of the following conditions are
fulfilled:
<ul>
<li>delete is false</li>
<li>additional open shares delete access (e.g. by calling <a class="reference internal" href="os.html#os.open" title="os.open"><code class="xref py py-func docutils literal notranslate">os.open()</code></a>
with the flag <code class="docutils literal notranslate">O_TEMPORARY</code>)</li>
<li>delete is true but delete_on_close is false. Note, that in this
case the additional opens that do not share delete access (e.g.
created via builtin <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate">open()</code></a>) must be closed before exiting the
context manager, else the <a class="reference internal" href="os.html#os.unlink" title="os.unlink"><code class="xref py py-func docutils literal notranslate">os.unlink()</code></a> call on context manager
exit will fail with a <a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate">PermissionError</code></a>.</li>
</ul>
</li>
</ul>
On Windows, if delete_on_close is false, and the file is created in a
directory for which the user lacks delete access, then the <a class="reference internal" href="os.html#os.unlink" title="os.unlink"><code class="xref py py-func docutils literal notranslate">os.unlink()</code></a>
call on exit of the context manager will fail with a <a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate">PermissionError</code></a>.
This cannot happen when delete_on_close is true because delete access is
requested by the open, which fails immediately if the requested access is not
granted.
On POSIX (only), a process that is terminated abruptly with SIGKILL
cannot automatically delete any NamedTemporaryFiles it created.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">tempfile.mkstemp</code> with argument <code class="docutils literal notranslate">fullpath</code>.
<div class="versionchanged">
Changed in version 3.8: Added errors parameter.
</div>
<div class="versionchanged">
Changed in version 3.12: Added delete_on_close parameter.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="tempfile.SpooledTemporaryFile">
class tempfile.SpooledTemporaryFile(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)<a class="headerlink" href="#tempfile.SpooledTemporaryFile" title="Link to this definition">¶</a></dt>
<dd>This class operates exactly as <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a> does, except that
data is spooled in memory until the file size exceeds max_size, or
until the file’s <a class="reference internal" href="io.html#io.IOBase.fileno" title="io.IOBase.fileno"><code class="xref py py-func docutils literal notranslate">fileno()</code></a> method is called, at which point the
contents are written to disk and operation proceeds as with
<a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a>.
<dl class="py method">
<dt class="sig sig-object py" id="tempfile.SpooledTemporaryFile.rollover">
rollover()<a class="headerlink" href="#tempfile.SpooledTemporaryFile.rollover" title="Link to this definition">¶</a></dt>
<dd>The resulting file has one additional method, <code class="xref py py-meth docutils literal notranslate">rollover()</code>, which
causes the file to roll over to an on-disk file regardless of its size.
</dd></dl>

The returned object is a file-like object whose <code class="xref py py-attr docutils literal notranslate">_file</code> attribute
is either an <a class="reference internal" href="io.html#io.BytesIO" title="io.BytesIO"><code class="xref py py-class docutils literal notranslate">io.BytesIO</code></a> or <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> object
(depending on whether binary or text mode was specified) or a true file
object, depending on whether <a class="reference internal" href="#tempfile.SpooledTemporaryFile.rollover" title="tempfile.SpooledTemporaryFile.rollover"><code class="xref py py-meth docutils literal notranslate">rollover()</code></a> has been called. This
file-like object can be used in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, just like
a normal file.
<div class="versionchanged">
Changed in version 3.3: the truncate method now accepts a size argument.
</div>
<div class="versionchanged">
Changed in version 3.8: Added errors parameter.
</div>
<div class="versionchanged">
Changed in version 3.11: Fully implements the <a class="reference internal" href="io.html#io.BufferedIOBase" title="io.BufferedIOBase"><code class="xref py py-class docutils literal notranslate">io.BufferedIOBase</code></a> and
<a class="reference internal" href="io.html#io.TextIOBase" title="io.TextIOBase"><code class="xref py py-class docutils literal notranslate">io.TextIOBase</code></a> abstract base classes (depending on whether binary
or text mode was specified).
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="tempfile.TemporaryDirectory">
class tempfile.TemporaryDirectory(suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False, *, delete=True)<a class="headerlink" href="#tempfile.TemporaryDirectory" title="Link to this definition">¶</a></dt>
<dd>This class securely creates a temporary directory using the same rules as <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a>.
The resulting object can be used as a <a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> (see
<a class="reference internal" href="#tempfile-examples">Examples</a>). 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.
<dl class="py attribute">
<dt class="sig sig-object py" id="tempfile.TemporaryDirectory.name">
name<a class="headerlink" href="#tempfile.TemporaryDirectory.name" title="Link to this definition">¶</a></dt>
<dd>The directory name can be retrieved from the <code class="xref py py-attr docutils literal notranslate">name</code> attribute of the
returned object. When the returned object is used as a <a class="reference internal" href="../glossary.html#term-context-manager">context manager</a>, the
<code class="xref py py-attr docutils literal notranslate">name</code> will be assigned to the target of the <code class="xref std std-keyword docutils literal notranslate">as</code> clause in
the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, if there is one.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tempfile.TemporaryDirectory.cleanup">
cleanup()<a class="headerlink" href="#tempfile.TemporaryDirectory.cleanup" title="Link to this definition">¶</a></dt>
<dd>The directory can be explicitly cleaned up by calling the
<code class="xref py py-meth docutils literal notranslate">cleanup()</code> method. If ignore_cleanup_errors is true, any unhandled
exceptions during explicit or implicit cleanup (such as a
<a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate">PermissionError</code></a> removing open files on Windows) will be ignored,
and the remaining removable items deleted on a “best-effort” basis.
Otherwise, errors will be raised in whatever context cleanup occurs
(the <code class="xref py py-meth docutils literal notranslate">cleanup()</code> call, exiting the context manager, when the object
is garbage-collected or during interpreter shutdown).
</dd></dl>

The delete parameter can be used to disable cleanup of the directory tree
upon exiting the context. While it may seem unusual for a context manager
to disable the action taken when exiting the context, it can be useful during
debugging or when you need your cleanup behavior to be conditional based on
other logic.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">tempfile.mkdtemp</code> with argument <code class="docutils literal notranslate">fullpath</code>.
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.10: Added ignore_cleanup_errors parameter.
</div>
<div class="versionchanged">
Changed in version 3.12: Added the delete parameter.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.mkstemp">
tempfile.mkstemp(suffix=None, prefix=None, dir=None, text=False)<a class="headerlink" href="#tempfile.mkstemp" title="Link to this definition">¶</a></dt>
<dd>Creates a temporary file in the most secure manner possible. There are
no race conditions in the file’s creation, assuming that the platform
properly implements the <a class="reference internal" href="os.html#os.O_EXCL" title="os.O_EXCL"><code class="xref py py-const docutils literal notranslate">os.O_EXCL</code></a> flag for <a class="reference internal" href="os.html#os.open" title="os.open"><code class="xref py py-func docutils literal notranslate">os.open()</code></a>. The
file is readable and writable only by the creating user ID. If the
platform uses permission bits to indicate whether a file is executable,
the file is executable by no one. The file descriptor is not inherited
by child processes.
Unlike <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate">TemporaryFile()</code></a>, the user of <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> is responsible
for deleting the temporary file when done with it.
If suffix is not <code class="docutils literal notranslate">None</code>, the file name will end with that suffix,
otherwise there will be no suffix. <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> does not put a dot
between the file name and the suffix; if you need one, put it at the
beginning of suffix.
If prefix is not <code class="docutils literal notranslate">None</code>, the file name will begin with that prefix;
otherwise, a default prefix is used. The default is the return value of
<a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate">gettempprefix()</code></a> or <a class="reference internal" href="#tempfile.gettempprefixb" title="tempfile.gettempprefixb"><code class="xref py py-func docutils literal notranslate">gettempprefixb()</code></a>, as appropriate.
If dir is not <code class="docutils literal notranslate">None</code>, the file will be created in that directory;
otherwise, a default directory is used. The default directory is chosen
from a platform-dependent list, but the user of the application can
control the directory location by setting the TMPDIR, TEMP or TMP
environment variables. There is thus no guarantee that the generated
filename will have any nice properties, such as not requiring quoting
when passed to external commands via <code class="docutils literal notranslate">os.popen()</code>.
If any of suffix, prefix, and dir are not
<code class="docutils literal notranslate">None</code>, they must be the same type.
If they are bytes, the returned name will be bytes instead of str.
If you want to force a bytes return value with otherwise default behavior,
pass <code class="docutils literal notranslate">suffix=b''</code>.
If text is specified and true, the file is opened in text mode.
Otherwise, (the default) the file is opened in binary mode.
<a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> returns a tuple containing an OS-level handle to an open
file (as would be returned by <a class="reference internal" href="os.html#os.open" title="os.open"><code class="xref py py-func docutils literal notranslate">os.open()</code></a>) and the absolute pathname
of that file, in that order.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">tempfile.mkstemp</code> with argument <code class="docutils literal notranslate">fullpath</code>.
<div class="versionchanged">
Changed in version 3.5: suffix, prefix, and dir may now be supplied in bytes in order to
obtain a bytes return value. Prior to this, only str was allowed.
suffix and prefix now accept and default to <code class="docutils literal notranslate">None</code> to cause
an appropriate default value to be used.
</div>
<div class="versionchanged">
Changed in version 3.6: The dir parameter now accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.mkdtemp">
tempfile.mkdtemp(suffix=None, prefix=None, dir=None)<a class="headerlink" href="#tempfile.mkdtemp" title="Link to this definition">¶</a></dt>
<dd>Creates a temporary directory in the most secure manner possible. There
are no race conditions in the directory’s creation. The directory is
readable, writable, and searchable only by the creating user ID.
The user of <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a> is responsible for deleting the temporary
directory and its contents when done with it.
The prefix, suffix, and dir arguments are the same as for
<a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a>.
<a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a> returns the absolute pathname of the new directory.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">tempfile.mkdtemp</code> with argument <code class="docutils literal notranslate">fullpath</code>.
<div class="versionchanged">
Changed in version 3.5: suffix, prefix, and dir may now be supplied in bytes in order to
obtain a bytes return value. Prior to this, only str was allowed.
suffix and prefix now accept and default to <code class="docutils literal notranslate">None</code> to cause
an appropriate default value to be used.
</div>
<div class="versionchanged">
Changed in version 3.6: The dir parameter now accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
<div class="versionchanged">
Changed in version 3.12: <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a> now always returns an absolute path, even if dir is relative.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.gettempdir">
tempfile.gettempdir()<a class="headerlink" href="#tempfile.gettempdir" title="Link to this definition">¶</a></dt>
<dd>Return the name of the directory used for temporary files. This
defines the default value for the dir argument to all functions
in this module.
Python searches a standard list of directories to find one which
the calling user can create files in. The list is:
<ol class="arabic simple">
<li>The directory named by the <code class="xref std std-envvar docutils literal notranslate">TMPDIR</code> environment variable.</li>
<li>The directory named by the <code class="xref std std-envvar docutils literal notranslate">TEMP</code> environment variable.</li>
<li>The directory named by the <code class="xref std std-envvar docutils literal notranslate">TMP</code> environment variable.</li>
<li>A platform-specific location:
<ul class="simple">
<li>On Windows, the directories <code class="file docutils literal notranslate">C:\TEMP</code>, <code class="file docutils literal notranslate">C:\TMP</code>,
<code class="file docutils literal notranslate">\TEMP</code>, and <code class="file docutils literal notranslate">\TMP</code>, in that order.</li>
<li>On all other platforms, the directories <code class="file docutils literal notranslate">/tmp</code>, <code class="file docutils literal notranslate">/var/tmp</code>, and
<code class="file docutils literal notranslate">/usr/tmp</code>, in that order.</li>
</ul>
</li>
<li>As a last resort, the current working directory.</li>
</ol>
The result of this search is cached, see the description of
<a class="reference internal" href="#tempfile.tempdir" title="tempfile.tempdir"><code class="xref py py-data docutils literal notranslate">tempdir</code></a> below.
<div class="versionchanged">
Changed in version 3.10: Always returns a str. Previously it would return any <a class="reference internal" href="#tempfile.tempdir" title="tempfile.tempdir"><code class="xref py py-data docutils literal notranslate">tempdir</code></a>
value regardless of type so long as it was not <code class="docutils literal notranslate">None</code>.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.gettempdirb">
tempfile.gettempdirb()<a class="headerlink" href="#tempfile.gettempdirb" title="Link to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#tempfile.gettempdir" title="tempfile.gettempdir"><code class="xref py py-func docutils literal notranslate">gettempdir()</code></a> but the return value is in bytes.
<div class="versionadded">
New in version 3.5.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.gettempprefix">
tempfile.gettempprefix()<a class="headerlink" href="#tempfile.gettempprefix" title="Link to this definition">¶</a></dt>
<dd>Return the filename prefix used to create temporary files. This does not
contain the directory component.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tempfile.gettempprefixb">
tempfile.gettempprefixb()<a class="headerlink" href="#tempfile.gettempprefixb" title="Link to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate">gettempprefix()</code></a> but the return value is in bytes.
<div class="versionadded">
New in version 3.5.
</div>
</dd></dl>

The module uses a global variable to store the name of the directory
used for temporary files returned by <a class="reference internal" href="#tempfile.gettempdir" title="tempfile.gettempdir"><code class="xref py py-func docutils literal notranslate">gettempdir()</code></a>. It can be
set directly to override the selection process, but this is discouraged.
All functions in this module take a dir argument which can be used
to specify the directory. This is the recommended approach that does
not surprise other unsuspecting code by changing global API behavior.
<dl class="py data">
<dt class="sig sig-object py" id="tempfile.tempdir">
tempfile.tempdir<a class="headerlink" href="#tempfile.tempdir" title="Link to this definition">¶</a></dt>
<dd>When set to a value other than <code class="docutils literal notranslate">None</code>, this variable defines the
default value for the dir argument to the functions defined in this
module, including its type, bytes or str. It cannot be a
<a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
If <code class="docutils literal notranslate">tempdir</code> is <code class="docutils literal notranslate">None</code> (the default) at any call to any of the above
functions except <a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate">gettempprefix()</code></a> it is initialized following the
algorithm described in <a class="reference internal" href="#tempfile.gettempdir" title="tempfile.gettempdir"><code class="xref py py-func docutils literal notranslate">gettempdir()</code></a>.
<div class="admonition note">
Note
Beware that if you set <code class="docutils literal notranslate">tempdir</code> to a bytes value, there is a
nasty side effect: The global default return type of
<a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> and <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">mkdtemp()</code></a> changes to bytes when no
explicit <code class="docutils literal notranslate">prefix</code>, <code class="docutils literal notranslate">suffix</code>, or <code class="docutils literal notranslate">dir</code> arguments of type
str are supplied. Please do not write code expecting or
depending on this. This awkward behavior is maintained for
compatibility with the historical implementation.
</div>
</dd></dl>

<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
Here are some examples of typical usage of the <a class="reference internal" href="#module-tempfile" title="tempfile: Generate temporary files and directories."><code class="xref py py-mod docutils literal notranslate">tempfile</code></a> module:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import tempfile

# create a temporary file and write some data to it
&gt;&gt;&gt; fp = tempfile.TemporaryFile()
&gt;&gt;&gt; fp.write(b&#39;Hello world!&#39;)
# read data from file
&gt;&gt;&gt; fp.seek(0)
&gt;&gt;&gt; fp.read()
b&#39;Hello world!&#39;
# close the file, it will be removed
&gt;&gt;&gt; fp.close()

# create a temporary file using a context manager
&gt;&gt;&gt; with tempfile.TemporaryFile() as fp:
... fp.write(b&#39;Hello world!&#39;)
... fp.seek(0)
... fp.read()
b&#39;Hello world!&#39;
&gt;&gt;&gt;
# file is now closed and removed

# create a temporary file using a context manager
# close the file, use the name to open the file again
&gt;&gt;&gt; with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
... fp.write(b&#39;Hello world!&#39;)
... fp.close()
... # the file is closed, but not removed
... # open the file again by using its name
... with open(fp.name, mode=&#39;rb&#39;) as f:
... f.read()
b&#39;Hello world!&#39;
&gt;&gt;&gt;
# file is now removed

# create a temporary directory using the context manager
&gt;&gt;&gt; with tempfile.TemporaryDirectory() as tmpdirname:
... print(&#39;created temporary directory&#39;, tmpdirname)
&gt;&gt;&gt;
# directory and contents have been removed
</pre></div>
</div>
</section>
<section id="deprecated-functions-and-variables">
<h2>Deprecated functions and variables<a class="headerlink" href="#deprecated-functions-and-variables" title="Link to this heading">¶</a></h2>
A historical way to create temporary files was to first generate a
file name with the <a class="reference internal" href="#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate">mktemp()</code></a> function and then create a file
using this name. Unfortunately this is not secure, because a different
process may create a file with this name in the time between the call
to <a class="reference internal" href="#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate">mktemp()</code></a> and the subsequent attempt to create the file by the
first process. The solution is to combine the two steps and create the
file immediately. This approach is used by <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> and the
other functions described above.
<dl class="py function">
<dt class="sig sig-object py" id="tempfile.mktemp">
tempfile.mktemp(suffix='', prefix='tmp', dir=None)<a class="headerlink" href="#tempfile.mktemp" title="Link to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 2.3: Use <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a> instead.
</div>
Return an absolute pathname of a file that did not exist at the time the
call is made. The prefix, suffix, and dir arguments are similar
to those of <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate">mkstemp()</code></a>, except that bytes file names, <code class="docutils literal notranslate">suffix=None</code>
and <code class="docutils literal notranslate">prefix=None</code> are not supported.
<div class="admonition warning">
Warning
Use of this function may introduce a security hole in your program. By
the time you get around to doing anything with the file name it returns,
someone else may have beaten you to the punch. <a class="reference internal" href="#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate">mktemp()</code></a> usage can
be replaced easily with <a class="reference internal" href="#tempfile.NamedTemporaryFile" title="tempfile.NamedTemporaryFile"><code class="xref py py-func docutils literal notranslate">NamedTemporaryFile()</code></a>, passing it the
<code class="docutils literal notranslate">delete=False</code> parameter:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; f = NamedTemporaryFile(delete=False)
&gt;&gt;&gt; f.name
&#39;/tmp/tmptjujjt&#39;
&gt;&gt;&gt; f.write(b&quot;Hello World!\n&quot;)
13
&gt;&gt;&gt; f.close()
&gt;&gt;&gt; os.unlink(f.name)
&gt;&gt;&gt; os.path.exists(f.name)
False
</pre></div>
</div>
</div>
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">tempfile</code> — Generate temporary files and directories</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#deprecated-functions-and-variables">Deprecated functions and variables</a></li>
</ul>
</li>
</ul>

</div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="glob.html" title="glob — Unix style pathname pattern expansion"
 >next</a> |</li>
 <li class="right" >
 <a href="filecmp.html" title="filecmp — File and Directory Comparisons"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">tempfile</code> — Generate temporary files and directories</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 
 Last updated on Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>

</body>
</html>