Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
關註 1
收藏 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
分支: master
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/tempfile.html

776 line
70KB
原始文件 永久連結 Blame 文件歷史 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="tempfile — Generate temporary files and directories" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/tempfile.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/tempfile.py This module creates temporary files and directories. It works on all supported platforms. TemporaryFile, NamedTemporaryFile, TemporaryDirectory, and SpooledTemporaryFil..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/tempfile.py This module creates temporary files and directories. It works on all supported platforms. TemporaryFile, NamedTemporaryFile, TemporaryDirectory, and SpooledTemporaryFil..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <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">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="glob — Unix style pathname pattern expansion" href="glob.html" />

  39.     <link rel="prev" title="filecmp — File and Directory Comparisons" href="filecmp.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/tempfile.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <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>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code> — Generate temporary files and directories</a><ul>

  99. <li><a class="reference internal" href="#examples">Examples</a></li>

  100. <li><a class="reference internal" href="#deprecated-functions-and-variables">Deprecated functions and variables</a></li>

  101. </ul>

  102. </li>

  103. </ul>

  104. 

  105.   </div>

  106.   <div>

  107.     <h4>Previous topic</h4>

  108.     <p class="topless"><a href="filecmp.html"

  109.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">filecmp</span></code> — File and Directory Comparisons</a></p>

  110.   </div>

  111.   <div>

  112.     <h4>Next topic</h4>

  113.     <p class="topless"><a href="glob.html"

  114.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code> — Unix style pathname pattern expansion</a></p>

  115.   </div>

  116.   <div role="note" aria-label="source link">

  117.     <h3>This Page</h3>

  118.     <ul class="this-page-menu">

  119.       <li><a href="../bugs.html">Report a Bug</a></li>

  120.       <li>

  121.         <a href="https://github.com/python/cpython/blob/main/Doc/library/tempfile.rst"

  122.             rel="nofollow">Show Source

  123.         </a>

  124.       </li>

  125.     </ul>

  126.   </div>

  127.         </nav>

  128.     </div>

  129. </div>

  130. 

  131.   

  132.     <div class="related" role="navigation" aria-label="related navigation">

  133.       <h3>Navigation</h3>

  134.       <ul>

  135.         <li class="right" style="margin-right: 10px">

  136.           <a href="../genindex.html" title="General Index"

  137.              accesskey="I">index</a></li>

  138.         <li class="right" >

  139.           <a href="../py-modindex.html" title="Python Module Index"

  140.              >modules</a> |</li>

  141.         <li class="right" >

  142.           <a href="glob.html" title="glob — Unix style pathname pattern expansion"

  143.              accesskey="N">next</a> |</li>

  144.         <li class="right" >

  145.           <a href="filecmp.html" title="filecmp — File and Directory Comparisons"

  146.              accesskey="P">previous</a> |</li>

  147. 

  148.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  149.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  150.           <li class="switchers">

  151.             <div class="language_switcher_placeholder"></div>

  152.             <div class="version_switcher_placeholder"></div>

  153.           </li>

  154.           <li>

  155.               

  156.           </li>

  157.     <li id="cpython-language-and-version">

  158.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  159.     </li>

  160. 

  161.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  162.           <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> &#187;</li>

  163.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code> — Generate temporary files and directories</a></li>

  164.                 <li class="right">

  165.                     

  166. 

  167.     <div class="inline-search" role="search">

  168.         <form class="inline-search" action="../search.html" method="get">

  169.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  170.           <input type="submit" value="Go" />

  171.         </form>

  172.     </div>

  173.                      |

  174.                 </li>

  175.             <li class="right">

  176. <label class="theme-selector-label">

  177.     Theme

  178.     <select class="theme-selector" oninput="activateTheme(this.value)">

  179.         <option value="auto" selected>Auto</option>

  180.         <option value="light">Light</option>

  181.         <option value="dark">Dark</option>

  182.     </select>

  183. </label> |</li>

  184.             

  185.       </ul>

  186.     </div>    

  187. 

  188.     <div class="document">

  189.       <div class="documentwrapper">

  190.         <div class="bodywrapper">

  191.           <div class="body" role="main">

  192.             

  193.   <section id="module-tempfile">

  194. <span id="tempfile-generate-temporary-files-and-directories"></span><h1><a class="reference internal" href="#module-tempfile" title="tempfile: Generate temporary files and directories."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code></a> — Generate temporary files and directories<a class="headerlink" href="#module-tempfile" title="Link to this heading">¶</a></h1>

  195. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/tempfile.py">Lib/tempfile.py</a></p>

  196. <hr class="docutils" id="index-0" />

  197. <p>This module creates temporary files and directories.  It works on all

  198. supported platforms. <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-class docutils literal notranslate"><span class="pre">TemporaryFile</span></code></a>, <a class="reference internal" href="#tempfile.NamedTemporaryFile" title="tempfile.NamedTemporaryFile"><code class="xref py py-class docutils literal notranslate"><span class="pre">NamedTemporaryFile</span></code></a>,

  199. <a class="reference internal" href="#tempfile.TemporaryDirectory" title="tempfile.TemporaryDirectory"><code class="xref py py-class docutils literal notranslate"><span class="pre">TemporaryDirectory</span></code></a>, and <a class="reference internal" href="#tempfile.SpooledTemporaryFile" title="tempfile.SpooledTemporaryFile"><code class="xref py py-class docutils literal notranslate"><span class="pre">SpooledTemporaryFile</span></code></a> are high-level

  200. interfaces which provide automatic cleanup and can be used as

  201. <a class="reference internal" href="../glossary.html#term-context-manager"><span class="xref std std-term">context managers</span></a>. <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a> and

  202. <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkdtemp()</span></code></a> are lower-level functions which require manual cleanup.</p>

  203. <p>All the user-callable functions and constructors take additional arguments which

  204. allow direct control over the location and name of temporary files and

  205. directories. Files names used by this module include a string of

  206. random characters which allows those files to be securely created in

  207. shared temporary directories.

  208. To maintain backward compatibility, the argument order is somewhat odd; it

  209. is recommended to use keyword arguments for clarity.</p>

  210. <p>The module defines the following user-callable items:</p>

  211. <dl class="py function">

  212. <dt class="sig sig-object py" id="tempfile.TemporaryFile">

  213. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">TemporaryFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'w+b'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.TemporaryFile" title="Link to this definition">¶</a></dt>

  214. <dd><p>Return a <a class="reference internal" href="../glossary.html#term-file-like-object"><span class="xref std std-term">file-like object</span></a> that can be used as a temporary storage area.

  215. 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"><span class="pre">mkstemp()</span></code></a>. It will be destroyed as soon

  216. as it is closed (including an implicit close when the object is garbage

  217. collected).  Under Unix, the directory entry for the file is either not created at all or is removed

  218. immediately after the file is created.  Other platforms do not support

  219. this; your code should not rely on a temporary file created using this

  220. function having or not having a visible name in the file system.</p>

  221. <p>The resulting object can be used as a <a class="reference internal" href="../glossary.html#term-context-manager"><span class="xref std std-term">context manager</span></a> (see

  222. <a class="reference internal" href="#tempfile-examples"><span class="std std-ref">Examples</span></a>).  On completion of the context or

  223. destruction of the file object the temporary file will be removed

  224. from the filesystem.</p>

  225. <p>The <em>mode</em> parameter defaults to <code class="docutils literal notranslate"><span class="pre">'w+b'</span></code> so that the file created can

  226. be read and written without being closed.  Binary mode is used so that it

  227. behaves consistently on all platforms without regard for the data that is

  228. stored.  <em>buffering</em>, <em>encoding</em>, <em>errors</em> and <em>newline</em> are interpreted as for

  229. <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  230. <p>The <em>dir</em>, <em>prefix</em> and <em>suffix</em> parameters have the same meaning and

  231. defaults as with <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a>.</p>

  232. <p>The returned object is a true file object on POSIX platforms.  On other

  233. platforms, it is a file-like object whose <code class="xref py py-attr docutils literal notranslate"><span class="pre">file</span></code> attribute is the

  234. underlying true file object.</p>

  235. <p>The <a class="reference internal" href="os.html#os.O_TMPFILE" title="os.O_TMPFILE"><code class="xref py py-const docutils literal notranslate"><span class="pre">os.O_TMPFILE</span></code></a> flag is used if it is available and works

  236. (Linux-specific, requires Linux kernel 3.11 or later).</p>

  237. <p>On platforms that are neither Posix nor Cygwin, TemporaryFile is an alias

  238. for NamedTemporaryFile.</p>

  239. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">tempfile.mkstemp</span></code> with argument <code class="docutils literal notranslate"><span class="pre">fullpath</span></code>.</p>

  240. <div class="versionchanged">

  241. <p><span class="versionmodified changed">Changed in version 3.5: </span>The <a class="reference internal" href="os.html#os.O_TMPFILE" title="os.O_TMPFILE"><code class="xref py py-const docutils literal notranslate"><span class="pre">os.O_TMPFILE</span></code></a> flag is now used if available.</p>

  242. </div>

  243. <div class="versionchanged">

  244. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added <em>errors</em> parameter.</p>

  245. </div>

  246. </dd></dl>

  247. 

  248. <dl class="py function">

  249. <dt class="sig sig-object py" id="tempfile.NamedTemporaryFile">

  250. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">NamedTemporaryFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'w+b'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delete_on_close</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.NamedTemporaryFile" title="Link to this definition">¶</a></dt>

  251. <dd><p>This function operates exactly as <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a> does, except the

  252. following differences:</p>

  253. <ul class="simple">

  254. <li><p>This function returns a file that is guaranteed to have a visible name in

  255. the file system.</p></li>

  256. <li><p>To manage the named file, it extends the parameters of

  257. <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a> with <em>delete</em> and <em>delete_on_close</em> parameters that

  258. determine whether and how the named file should be automatically deleted.</p></li>

  259. </ul>

  260. <p>The returned object is always a <a class="reference internal" href="../glossary.html#term-file-like-object"><span class="xref std std-term">file-like object</span></a> whose <code class="xref py py-attr docutils literal notranslate"><span class="pre">file</span></code>

  261. attribute is the underlying true file object. This file-like object

  262. can be used in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement, just like a normal file.  The

  263. name of the temporary file can be retrieved from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code> attribute

  264. of the returned file-like object. On Unix, unlike with the

  265. <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a>, the directory entry does not get unlinked immediately

  266. after the file creation.</p>

  267. <p>If <em>delete</em> is true (the default) and <em>delete_on_close</em> is true (the

  268. default), the file is deleted as soon as it is closed. If <em>delete</em> is true

  269. and <em>delete_on_close</em> is false, the file is deleted on context manager exit

  270. only, or else when the <a class="reference internal" href="../glossary.html#term-file-like-object"><span class="xref std std-term">file-like object</span></a> is finalized. Deletion is not

  271. 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"><span class="pre">object.__del__()</span></code></a>). If <em>delete</em> is

  272. false, the value of <em>delete_on_close</em> is ignored.</p>

  273. <p>Therefore to use the name of the temporary file to reopen the file after

  274. closing it, either make sure not to delete the file upon closure (set the

  275. <em>delete</em> parameter to be false) or, in case the temporary file is created in

  276. a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement, set the <em>delete_on_close</em> parameter to be false.

  277. The latter approach is recommended as it provides assistance in automatic

  278. cleaning of the temporary file upon the context manager exit.</p>

  279. <p>Opening the temporary file again by its name while it is still open works as

  280. follows:</p>

  281. <ul class="simple">

  282. <li><p>On POSIX the file can always be opened again.</p></li>

  283. <li><p>On Windows, make sure that at least one of the following conditions are

  284. fulfilled:</p>

  285. <ul>

  286. <li><p><em>delete</em> is false</p></li>

  287. <li><p>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"><span class="pre">os.open()</span></code></a>

  288. with the flag <code class="docutils literal notranslate"><span class="pre">O_TEMPORARY</span></code>)</p></li>

  289. <li><p><em>delete</em> is true but <em>delete_on_close</em> is false. Note, that in this

  290. case the additional opens that do not share delete access (e.g.

  291. created via builtin <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>) must be closed before exiting the

  292. 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"><span class="pre">os.unlink()</span></code></a> call on context manager

  293. exit will fail with a <a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">PermissionError</span></code></a>.</p></li>

  294. </ul>

  295. </li>

  296. </ul>

  297. <p>On Windows, if <em>delete_on_close</em> is false, and the file is created in a

  298. 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"><span class="pre">os.unlink()</span></code></a>

  299. 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"><span class="pre">PermissionError</span></code></a>.

  300. This cannot happen when <em>delete_on_close</em> is true because delete access is

  301. requested by the open, which fails immediately if the requested access is not

  302. granted.</p>

  303. <p>On POSIX (only), a process that is terminated abruptly with SIGKILL

  304. cannot automatically delete any NamedTemporaryFiles it created.</p>

  305. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">tempfile.mkstemp</span></code> with argument <code class="docutils literal notranslate"><span class="pre">fullpath</span></code>.</p>

  306. <div class="versionchanged">

  307. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added <em>errors</em> parameter.</p>

  308. </div>

  309. <div class="versionchanged">

  310. <p><span class="versionmodified changed">Changed in version 3.12: </span>Added <em>delete_on_close</em> parameter.</p>

  311. </div>

  312. </dd></dl>

  313. 

  314. <dl class="py class">

  315. <dt class="sig sig-object py" id="tempfile.SpooledTemporaryFile">

  316. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">SpooledTemporaryFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'w+b'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.SpooledTemporaryFile" title="Link to this definition">¶</a></dt>

  317. <dd><p>This class operates exactly as <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a> does, except that

  318. data is spooled in memory until the file size exceeds <em>max_size</em>, or

  319. 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"><span class="pre">fileno()</span></code></a> method is called, at which point the

  320. contents are written to disk and operation proceeds as with

  321. <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a>.</p>

  322. <dl class="py method">

  323. <dt class="sig sig-object py" id="tempfile.SpooledTemporaryFile.rollover">

  324. <span class="sig-name descname"><span class="pre">rollover</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.SpooledTemporaryFile.rollover" title="Link to this definition">¶</a></dt>

  325. <dd><p>The resulting file has one additional method, <code class="xref py py-meth docutils literal notranslate"><span class="pre">rollover()</span></code>, which

  326. causes the file to roll over to an on-disk file regardless of its size.</p>

  327. </dd></dl>

  328. 

  329. <p>The returned object is a file-like object whose <code class="xref py py-attr docutils literal notranslate"><span class="pre">_file</span></code> attribute

  330. is either an <a class="reference internal" href="io.html#io.BytesIO" title="io.BytesIO"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.BytesIO</span></code></a> or <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOWrapper</span></code></a> object

  331. (depending on whether binary or text <em>mode</em> was specified) or a true file

  332. 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"><span class="pre">rollover()</span></code></a> has been called.  This

  333. 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"><span class="pre">with</span></code></a> statement, just like

  334. a normal file.</p>

  335. <div class="versionchanged">

  336. <p><span class="versionmodified changed">Changed in version 3.3: </span>the truncate method now accepts a <em>size</em> argument.</p>

  337. </div>

  338. <div class="versionchanged">

  339. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added <em>errors</em> parameter.</p>

  340. </div>

  341. <div class="versionchanged">

  342. <p><span class="versionmodified changed">Changed in version 3.11: </span>Fully implements the <a class="reference internal" href="io.html#io.BufferedIOBase" title="io.BufferedIOBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.BufferedIOBase</span></code></a> and

  343. <a class="reference internal" href="io.html#io.TextIOBase" title="io.TextIOBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOBase</span></code></a> abstract base classes (depending on whether binary

  344. or text <em>mode</em> was specified).</p>

  345. </div>

  346. </dd></dl>

  347. 

  348. <dl class="py class">

  349. <dt class="sig sig-object py" id="tempfile.TemporaryDirectory">

  350. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">TemporaryDirectory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_cleanup_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.TemporaryDirectory" title="Link to this definition">¶</a></dt>

  351. <dd><p>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"><span class="pre">mkdtemp()</span></code></a>.

  352. The resulting object can be used as a <a class="reference internal" href="../glossary.html#term-context-manager"><span class="xref std std-term">context manager</span></a> (see

  353. <a class="reference internal" href="#tempfile-examples"><span class="std std-ref">Examples</span></a>).  On completion of the context or destruction

  354. of the temporary directory object, the newly created temporary directory

  355. and all its contents are removed from the filesystem.</p>

  356. <dl class="py attribute">

  357. <dt class="sig sig-object py" id="tempfile.TemporaryDirectory.name">

  358. <span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#tempfile.TemporaryDirectory.name" title="Link to this definition">¶</a></dt>

  359. <dd><p>The directory name can be retrieved from the <code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code> attribute of the

  360. returned object.  When the returned object is used as a <a class="reference internal" href="../glossary.html#term-context-manager"><span class="xref std std-term">context manager</span></a>, the

  361. <code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code> will be assigned to the target of the <code class="xref std std-keyword docutils literal notranslate"><span class="pre">as</span></code> clause in

  362. the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement, if there is one.</p>

  363. </dd></dl>

  364. 

  365. <dl class="py method">

  366. <dt class="sig sig-object py" id="tempfile.TemporaryDirectory.cleanup">

  367. <span class="sig-name descname"><span class="pre">cleanup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.TemporaryDirectory.cleanup" title="Link to this definition">¶</a></dt>

  368. <dd><p>The directory can be explicitly cleaned up by calling the

  369. <code class="xref py py-meth docutils literal notranslate"><span class="pre">cleanup()</span></code> method. If <em>ignore_cleanup_errors</em> is true, any unhandled

  370. exceptions during explicit or implicit cleanup (such as a

  371. <a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">PermissionError</span></code></a> removing open files on Windows) will be ignored,

  372. and the remaining removable items deleted on a “best-effort” basis.

  373. Otherwise, errors will be raised in whatever context cleanup occurs

  374. (the <code class="xref py py-meth docutils literal notranslate"><span class="pre">cleanup()</span></code> call, exiting the context manager, when the object

  375. is garbage-collected or during interpreter shutdown).</p>

  376. </dd></dl>

  377. 

  378. <p>The <em>delete</em> parameter can be used to disable cleanup of the directory tree

  379. upon exiting the context.  While it may seem unusual for a context manager

  380. to disable the action taken when exiting the context, it can be useful during

  381. debugging or when you need your cleanup behavior to be conditional based on

  382. other logic.</p>

  383. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">tempfile.mkdtemp</span></code> with argument <code class="docutils literal notranslate"><span class="pre">fullpath</span></code>.</p>

  384. <div class="versionadded">

  385. <p><span class="versionmodified added">New in version 3.2.</span></p>

  386. </div>

  387. <div class="versionchanged">

  388. <p><span class="versionmodified changed">Changed in version 3.10: </span>Added <em>ignore_cleanup_errors</em> parameter.</p>

  389. </div>

  390. <div class="versionchanged">

  391. <p><span class="versionmodified changed">Changed in version 3.12: </span>Added the <em>delete</em> parameter.</p>

  392. </div>

  393. </dd></dl>

  394. 

  395. <dl class="py function">

  396. <dt class="sig sig-object py" id="tempfile.mkstemp">

  397. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">mkstemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.mkstemp" title="Link to this definition">¶</a></dt>

  398. <dd><p>Creates a temporary file in the most secure manner possible.  There are

  399. no race conditions in the file’s creation, assuming that the platform

  400. 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"><span class="pre">os.O_EXCL</span></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"><span class="pre">os.open()</span></code></a>.  The

  401. file is readable and writable only by the creating user ID.  If the

  402. platform uses permission bits to indicate whether a file is executable,

  403. the file is executable by no one.  The file descriptor is not inherited

  404. by child processes.</p>

  405. <p>Unlike <a class="reference internal" href="#tempfile.TemporaryFile" title="tempfile.TemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">TemporaryFile()</span></code></a>, the user of <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a> is responsible

  406. for deleting the temporary file when done with it.</p>

  407. <p>If <em>suffix</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, the file name will end with that suffix,

  408. 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"><span class="pre">mkstemp()</span></code></a> does not put a dot

  409. between the file name and the suffix; if you need one, put it at the

  410. beginning of <em>suffix</em>.</p>

  411. <p>If <em>prefix</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, the file name will begin with that prefix;

  412. otherwise, a default prefix is used.  The default is the return value of

  413. <a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempprefix()</span></code></a> or <a class="reference internal" href="#tempfile.gettempprefixb" title="tempfile.gettempprefixb"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempprefixb()</span></code></a>, as appropriate.</p>

  414. <p>If <em>dir</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, the file will be created in that directory;

  415. otherwise, a default directory is used.  The default directory is chosen

  416. from a platform-dependent list, but the user of the application can

  417. control the directory location by setting the <em>TMPDIR</em>, <em>TEMP</em> or <em>TMP</em>

  418. environment variables.  There is thus no guarantee that the generated

  419. filename will have any nice properties, such as not requiring quoting

  420. when passed to external commands via <code class="docutils literal notranslate"><span class="pre">os.popen()</span></code>.</p>

  421. <p>If any of <em>suffix</em>, <em>prefix</em>, and <em>dir</em> are not

  422. <code class="docutils literal notranslate"><span class="pre">None</span></code>, they must be the same type.

  423. If they are bytes, the returned name will be bytes instead of str.

  424. If you want to force a bytes return value with otherwise default behavior,

  425. pass <code class="docutils literal notranslate"><span class="pre">suffix=b''</span></code>.</p>

  426. <p>If <em>text</em> is specified and true, the file is opened in text mode.

  427. Otherwise, (the default) the file is opened in binary mode.</p>

  428. <p><a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a> returns a tuple containing an OS-level handle to an open

  429. 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"><span class="pre">os.open()</span></code></a>) and the absolute pathname

  430. of that file, in that order.</p>

  431. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">tempfile.mkstemp</span></code> with argument <code class="docutils literal notranslate"><span class="pre">fullpath</span></code>.</p>

  432. <div class="versionchanged">

  433. <p><span class="versionmodified changed">Changed in version 3.5: </span><em>suffix</em>, <em>prefix</em>, and <em>dir</em> may now be supplied in bytes in order to

  434. obtain a bytes return value.  Prior to this, only str was allowed.

  435. <em>suffix</em> and <em>prefix</em> now accept and default to <code class="docutils literal notranslate"><span class="pre">None</span></code> to cause

  436. an appropriate default value to be used.</p>

  437. </div>

  438. <div class="versionchanged">

  439. <p><span class="versionmodified changed">Changed in version 3.6: </span>The <em>dir</em> parameter now accepts a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  440. </div>

  441. </dd></dl>

  442. 

  443. <dl class="py function">

  444. <dt class="sig sig-object py" id="tempfile.mkdtemp">

  445. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">mkdtemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.mkdtemp" title="Link to this definition">¶</a></dt>

  446. <dd><p>Creates a temporary directory in the most secure manner possible. There

  447. are no race conditions in the directory’s creation.  The directory is

  448. readable, writable, and searchable only by the creating user ID.</p>

  449. <p>The user of <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkdtemp()</span></code></a> is responsible for deleting the temporary

  450. directory and its contents when done with it.</p>

  451. <p>The <em>prefix</em>, <em>suffix</em>, and <em>dir</em> arguments are the same as for

  452. <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a>.</p>

  453. <p><a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkdtemp()</span></code></a> returns the absolute pathname of the new directory.</p>

  454. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">tempfile.mkdtemp</span></code> with argument <code class="docutils literal notranslate"><span class="pre">fullpath</span></code>.</p>

  455. <div class="versionchanged">

  456. <p><span class="versionmodified changed">Changed in version 3.5: </span><em>suffix</em>, <em>prefix</em>, and <em>dir</em> may now be supplied in bytes in order to

  457. obtain a bytes return value.  Prior to this, only str was allowed.

  458. <em>suffix</em> and <em>prefix</em> now accept and default to <code class="docutils literal notranslate"><span class="pre">None</span></code> to cause

  459. an appropriate default value to be used.</p>

  460. </div>

  461. <div class="versionchanged">

  462. <p><span class="versionmodified changed">Changed in version 3.6: </span>The <em>dir</em> parameter now accepts a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  463. </div>

  464. <div class="versionchanged">

  465. <p><span class="versionmodified changed">Changed in version 3.12: </span><a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkdtemp()</span></code></a> now always returns an absolute path, even if <em>dir</em> is relative.</p>

  466. </div>

  467. </dd></dl>

  468. 

  469. <dl class="py function">

  470. <dt class="sig sig-object py" id="tempfile.gettempdir">

  471. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">gettempdir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.gettempdir" title="Link to this definition">¶</a></dt>

  472. <dd><p>Return the name of the directory used for temporary files. This

  473. defines the default value for the <em>dir</em> argument to all functions

  474. in this module.</p>

  475. <p>Python searches a standard list of directories to find one which

  476. the calling user can create files in.  The list is:</p>

  477. <ol class="arabic simple">

  478. <li><p>The directory named by the <span class="target" id="index-1"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">TMPDIR</span></code> environment variable.</p></li>

  479. <li><p>The directory named by the <span class="target" id="index-2"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">TEMP</span></code> environment variable.</p></li>

  480. <li><p>The directory named by the <span class="target" id="index-3"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">TMP</span></code> environment variable.</p></li>

  481. <li><p>A platform-specific location:</p>

  482. <ul class="simple">

  483. <li><p>On Windows, the directories <code class="file docutils literal notranslate"><span class="pre">C:\TEMP</span></code>, <code class="file docutils literal notranslate"><span class="pre">C:\TMP</span></code>,

  484. <code class="file docutils literal notranslate"><span class="pre">\TEMP</span></code>, and <code class="file docutils literal notranslate"><span class="pre">\TMP</span></code>, in that order.</p></li>

  485. <li><p>On all other platforms, the directories <code class="file docutils literal notranslate"><span class="pre">/tmp</span></code>, <code class="file docutils literal notranslate"><span class="pre">/var/tmp</span></code>, and

  486. <code class="file docutils literal notranslate"><span class="pre">/usr/tmp</span></code>, in that order.</p></li>

  487. </ul>

  488. </li>

  489. <li><p>As a last resort, the current working directory.</p></li>

  490. </ol>

  491. <p>The result of this search is cached, see the description of

  492. <a class="reference internal" href="#tempfile.tempdir" title="tempfile.tempdir"><code class="xref py py-data docutils literal notranslate"><span class="pre">tempdir</span></code></a> below.</p>

  493. <div class="versionchanged">

  494. <p><span class="versionmodified changed">Changed in version 3.10: </span>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"><span class="pre">tempdir</span></code></a>

  495. value regardless of type so long as it was not <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  496. </div>

  497. </dd></dl>

  498. 

  499. <dl class="py function">

  500. <dt class="sig sig-object py" id="tempfile.gettempdirb">

  501. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">gettempdirb</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.gettempdirb" title="Link to this definition">¶</a></dt>

  502. <dd><p>Same as <a class="reference internal" href="#tempfile.gettempdir" title="tempfile.gettempdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempdir()</span></code></a> but the return value is in bytes.</p>

  503. <div class="versionadded">

  504. <p><span class="versionmodified added">New in version 3.5.</span></p>

  505. </div>

  506. </dd></dl>

  507. 

  508. <dl class="py function">

  509. <dt class="sig sig-object py" id="tempfile.gettempprefix">

  510. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">gettempprefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.gettempprefix" title="Link to this definition">¶</a></dt>

  511. <dd><p>Return the filename prefix used to create temporary files.  This does not

  512. contain the directory component.</p>

  513. </dd></dl>

  514. 

  515. <dl class="py function">

  516. <dt class="sig sig-object py" id="tempfile.gettempprefixb">

  517. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">gettempprefixb</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.gettempprefixb" title="Link to this definition">¶</a></dt>

  518. <dd><p>Same as <a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempprefix()</span></code></a> but the return value is in bytes.</p>

  519. <div class="versionadded">

  520. <p><span class="versionmodified added">New in version 3.5.</span></p>

  521. </div>

  522. </dd></dl>

  523. 

  524. <p>The module uses a global variable to store the name of the directory

  525. 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"><span class="pre">gettempdir()</span></code></a>.  It can be

  526. set directly to override the selection process, but this is discouraged.

  527. All functions in this module take a <em>dir</em> argument which can be used

  528. to specify the directory. This is the recommended approach that does

  529. not surprise other unsuspecting code by changing global API behavior.</p>

  530. <dl class="py data">

  531. <dt class="sig sig-object py" id="tempfile.tempdir">

  532. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">tempdir</span></span><a class="headerlink" href="#tempfile.tempdir" title="Link to this definition">¶</a></dt>

  533. <dd><p>When set to a value other than <code class="docutils literal notranslate"><span class="pre">None</span></code>, this variable defines the

  534. default value for the <em>dir</em> argument to the functions defined in this

  535. module, including its type, bytes or str.  It cannot be a

  536. <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  537. <p>If <code class="docutils literal notranslate"><span class="pre">tempdir</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code> (the default) at any call to any of the above

  538. functions except <a class="reference internal" href="#tempfile.gettempprefix" title="tempfile.gettempprefix"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempprefix()</span></code></a> it is initialized following the

  539. algorithm described in <a class="reference internal" href="#tempfile.gettempdir" title="tempfile.gettempdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">gettempdir()</span></code></a>.</p>

  540. <div class="admonition note">

  541. <p class="admonition-title">Note</p>

  542. <p>Beware that if you set <code class="docutils literal notranslate"><span class="pre">tempdir</span></code> to a bytes value, there is a

  543. nasty side effect: The global default return type of

  544. <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a> and <a class="reference internal" href="#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkdtemp()</span></code></a> changes to bytes when no

  545. explicit <code class="docutils literal notranslate"><span class="pre">prefix</span></code>, <code class="docutils literal notranslate"><span class="pre">suffix</span></code>, or <code class="docutils literal notranslate"><span class="pre">dir</span></code> arguments of type

  546. str are supplied. Please do not write code expecting or

  547. depending on this. This awkward behavior is maintained for

  548. compatibility with the historical implementation.</p>

  549. </div>

  550. </dd></dl>

  551. 

  552. <section id="examples">

  553. <span id="tempfile-examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>

  554. <p>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"><span class="pre">tempfile</span></code></a> module:</p>

  555. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">tempfile</span>

  556. 

  557. <span class="go"># create a temporary file and write some data to it</span>

  558. <span class="gp">&gt;&gt;&gt; </span><span class="n">fp</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryFile</span><span class="p">()</span>

  559. <span class="gp">&gt;&gt;&gt; </span><span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;Hello world!&#39;</span><span class="p">)</span>

  560. <span class="go"># read data from file</span>

  561. <span class="gp">&gt;&gt;&gt; </span><span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  562. <span class="gp">&gt;&gt;&gt; </span><span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  563. <span class="go">b&#39;Hello world!&#39;</span>

  564. <span class="go"># close the file, it will be removed</span>

  565. <span class="gp">&gt;&gt;&gt; </span><span class="n">fp</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  566. 

  567. <span class="go"># create a temporary file using a context manager</span>

  568. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryFile</span><span class="p">()</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>

  569. <span class="gp">... </span>    <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;Hello world!&#39;</span><span class="p">)</span>

  570. <span class="gp">... </span>    <span class="n">fp</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  571. <span class="gp">... </span>    <span class="n">fp</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  572. <span class="go">b&#39;Hello world!&#39;</span>

  573. <span class="gp">&gt;&gt;&gt;</span>

  574. <span class="go"># file is now closed and removed</span>

  575. 

  576. <span class="go"># create a temporary file using a context manager</span>

  577. <span class="go"># close the file, use the name to open the file again</span>

  578. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">delete_on_close</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>

  579. <span class="gp">... </span>    <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;Hello world!&#39;</span><span class="p">)</span>

  580. <span class="gp">... </span>    <span class="n">fp</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  581. <span class="gp">... </span><span class="c1"># the file is closed, but not removed</span>

  582. <span class="gp">... </span><span class="c1"># open the file again by using its name</span>

  583. <span class="gp">... </span>    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">fp</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  584. <span class="gp">... </span>        <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  585. <span class="go">b&#39;Hello world!&#39;</span>

  586. <span class="gp">&gt;&gt;&gt;</span>

  587. <span class="go"># file is now removed</span>

  588. 

  589. <span class="go"># create a temporary directory using the context manager</span>

  590. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">TemporaryDirectory</span><span class="p">()</span> <span class="k">as</span> <span class="n">tmpdirname</span><span class="p">:</span>

  591. <span class="gp">... </span>    <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;created temporary directory&#39;</span><span class="p">,</span> <span class="n">tmpdirname</span><span class="p">)</span>

  592. <span class="gp">&gt;&gt;&gt;</span>

  593. <span class="go"># directory and contents have been removed</span>

  594. </pre></div>

  595. </div>

  596. </section>

  597. <section id="deprecated-functions-and-variables">

  598. <span id="tempfile-mktemp-deprecated"></span><h2>Deprecated functions and variables<a class="headerlink" href="#deprecated-functions-and-variables" title="Link to this heading">¶</a></h2>

  599. <p>A historical way to create temporary files was to first generate a

  600. file name with the <a class="reference internal" href="#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mktemp()</span></code></a> function and then create a file

  601. using this name. Unfortunately this is not secure, because a different

  602. process may create a file with this name in the time between the call

  603. to <a class="reference internal" href="#tempfile.mktemp" title="tempfile.mktemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mktemp()</span></code></a> and the subsequent attempt to create the file by the

  604. first process. The solution is to combine the two steps and create the

  605. 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"><span class="pre">mkstemp()</span></code></a> and the

  606. other functions described above.</p>

  607. <dl class="py function">

  608. <dt class="sig sig-object py" id="tempfile.mktemp">

  609. <span class="sig-prename descclassname"><span class="pre">tempfile.</span></span><span class="sig-name descname"><span class="pre">mktemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'tmp'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tempfile.mktemp" title="Link to this definition">¶</a></dt>

  610. <dd><div class="deprecated">

  611. <p><span class="versionmodified deprecated">Deprecated since version 2.3: </span>Use <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a> instead.</p>

  612. </div>

  613. <p>Return an absolute pathname of a file that did not exist at the time the

  614. call is made.  The <em>prefix</em>, <em>suffix</em>, and <em>dir</em> arguments are similar

  615. to those of <a class="reference internal" href="#tempfile.mkstemp" title="tempfile.mkstemp"><code class="xref py py-func docutils literal notranslate"><span class="pre">mkstemp()</span></code></a>, except that bytes file names, <code class="docutils literal notranslate"><span class="pre">suffix=None</span></code>

  616. and <code class="docutils literal notranslate"><span class="pre">prefix=None</span></code> are not supported.</p>

  617. <div class="admonition warning">

  618. <p class="admonition-title">Warning</p>

  619. <p>Use of this function may introduce a security hole in your program.  By

  620. the time you get around to doing anything with the file name it returns,

  621. 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"><span class="pre">mktemp()</span></code></a> usage can

  622. be replaced easily with <a class="reference internal" href="#tempfile.NamedTemporaryFile" title="tempfile.NamedTemporaryFile"><code class="xref py py-func docutils literal notranslate"><span class="pre">NamedTemporaryFile()</span></code></a>, passing it the

  623. <code class="docutils literal notranslate"><span class="pre">delete=False</span></code> parameter:</p>

  624. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">delete</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>

  625. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">name</span>

  626. <span class="go">&#39;/tmp/tmptjujjt&#39;</span>

  627. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot;Hello World!</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>

  628. <span class="go">13</span>

  629. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  630. <span class="gp">&gt;&gt;&gt; </span><span class="n">os</span><span class="o">.</span><span class="n">unlink</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

  631. <span class="gp">&gt;&gt;&gt; </span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

  632. <span class="go">False</span>

  633. </pre></div>

  634. </div>

  635. </div>

  636. </dd></dl>

  637. 

  638. </section>

  639. </section>

  640. 

  641. 

  642.             <div class="clearer"></div>

  643.           </div>

  644.         </div>

  645.       </div>

  646.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  647.         <div class="sphinxsidebarwrapper">

  648.   <div>

  649.     <h3><a href="../contents.html">Table of Contents</a></h3>

  650.     <ul>

  651. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code> — Generate temporary files and directories</a><ul>

  652. <li><a class="reference internal" href="#examples">Examples</a></li>

  653. <li><a class="reference internal" href="#deprecated-functions-and-variables">Deprecated functions and variables</a></li>

  654. </ul>

  655. </li>

  656. </ul>

  657. 

  658.   </div>

  659.   <div>

  660.     <h4>Previous topic</h4>

  661.     <p class="topless"><a href="filecmp.html"

  662.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">filecmp</span></code> — File and Directory Comparisons</a></p>

  663.   </div>

  664.   <div>

  665.     <h4>Next topic</h4>

  666.     <p class="topless"><a href="glob.html"

  667.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code> — Unix style pathname pattern expansion</a></p>

  668.   </div>

  669.   <div role="note" aria-label="source link">

  670.     <h3>This Page</h3>

  671.     <ul class="this-page-menu">

  672.       <li><a href="../bugs.html">Report a Bug</a></li>

  673.       <li>

  674.         <a href="https://github.com/python/cpython/blob/main/Doc/library/tempfile.rst"

  675.             rel="nofollow">Show Source

  676.         </a>

  677.       </li>

  678.     </ul>

  679.   </div>

  680.         </div>

  681. <div id="sidebarbutton" title="Collapse sidebar">

  682. <span>«</span>

  683. </div>

  684. 

  685.       </div>

  686.       <div class="clearer"></div>

  687.     </div>  

  688.     <div class="related" role="navigation" aria-label="related navigation">

  689.       <h3>Navigation</h3>

  690.       <ul>

  691.         <li class="right" style="margin-right: 10px">

  692.           <a href="../genindex.html" title="General Index"

  693.              >index</a></li>

  694.         <li class="right" >

  695.           <a href="../py-modindex.html" title="Python Module Index"

  696.              >modules</a> |</li>

  697.         <li class="right" >

  698.           <a href="glob.html" title="glob — Unix style pathname pattern expansion"

  699.              >next</a> |</li>

  700.         <li class="right" >

  701.           <a href="filecmp.html" title="filecmp — File and Directory Comparisons"

  702.              >previous</a> |</li>

  703. 

  704.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  705.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  706.           <li class="switchers">

  707.             <div class="language_switcher_placeholder"></div>

  708.             <div class="version_switcher_placeholder"></div>

  709.           </li>

  710.           <li>

  711.               

  712.           </li>

  713.     <li id="cpython-language-and-version">

  714.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  715.     </li>

  716. 

  717.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  718.           <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> &#187;</li>

  719.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code> — Generate temporary files and directories</a></li>

  720.                 <li class="right">

  721.                     

  722. 

  723.     <div class="inline-search" role="search">

  724.         <form class="inline-search" action="../search.html" method="get">

  725.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  726.           <input type="submit" value="Go" />

  727.         </form>

  728.     </div>

  729.                      |

  730.                 </li>

  731.             <li class="right">

  732. <label class="theme-selector-label">

  733.     Theme

  734.     <select class="theme-selector" oninput="activateTheme(this.value)">

  735.         <option value="auto" selected>Auto</option>

  736.         <option value="light">Light</option>

  737.         <option value="dark">Dark</option>

  738.     </select>

  739. </label> |</li>

  740.             

  741.       </ul>

  742.     </div>  

  743.     <div class="footer">

  744.     &copy; 

  745.       <a href="../copyright.html">

  746.     

  747.     Copyright

  748.     

  749.       </a>

  750.      2001-2024, Python Software Foundation.

  751.     <br />

  752.     This page is licensed under the Python Software Foundation License Version 2.

  753.     <br />

  754.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  755.     <br />

  756.     

  757.       See <a href="/license.html">History and License</a> for more information.<br />

  758.     

  759.     

  760.     <br />

  761. 

  762.     The Python Software Foundation is a non-profit corporation.

  763. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  764. <br />

  765.     <br />

  766.       Last updated on Apr 09, 2024 (13:47 UTC).

  767.     

  768.       <a href="/bugs.html">Found a bug</a>?

  769.     

  770.     <br />

  771. 

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

  773.     </div>

  774. 

  775.   </body>

  776. </html>
上海开阖软件有限公司 沪ICP备12045867号-1