Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Sledovat 1
Oblíbit 0
Wiki 捐赠
gooderp18绿色标准版
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
Strom: 0f75e31513
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „0f75e31513“
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/stat.html

863 lines
60KB
Surový Blame Historie 

  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="stat — Interpreting stat() results" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/stat.py The stat module defines constants and functions for interpreting the results of os.stat(), os.fstat() and os.lstat()(if they exist). For complete details about the stat(), ..." />

  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/stat.py The stat module defines constants and functions for interpreting the results of os.stat(), os.fstat() and os.lstat()(if they exist). For complete details about the stat(), ..." />

  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>stat — Interpreting stat() results &#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="filecmp — File and Directory Comparisons" href="filecmp.html" />

  39.     <link rel="prev" title="fileinput — Iterate over lines from multiple input streams" href="fileinput.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/stat.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.     <h4>Previous topic</h4>

  97.     <p class="topless"><a href="fileinput.html"

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileinput</span></code> — Iterate over lines from multiple input streams</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

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

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

  104.   </div>

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

  106.     <h3>This Page</h3>

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

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

  109.       <li>

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

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

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

  122.       <h3>Navigation</h3>

  123.       <ul>

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

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

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

  127.         <li class="right" >

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

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

  130.         <li class="right" >

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

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

  133.         <li class="right" >

  134.           <a href="fileinput.html" title="fileinput — Iterate over lines from multiple input streams"

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

  136. 

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

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

  139.           <li class="switchers">

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

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

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

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

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

  148.     </li>

  149. 

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

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

  152.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> — Interpreting <code class="xref py py-func docutils literal notranslate"><span class="pre">stat()</span></code> results</a></li>

  153.                 <li class="right">

  154.                     

  155. 

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

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

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

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

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

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

  166.     Theme

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

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

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

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

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

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

  181.             

  182.   <section id="module-stat">

  183. <span id="stat-interpreting-stat-results"></span><h1><a class="reference internal" href="#module-stat" title="stat: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat()."><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code></a> — Interpreting <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate"><span class="pre">stat()</span></code></a> results<a class="headerlink" href="#module-stat" title="Link to this heading">¶</a></h1>

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

  185. <hr class="docutils" />

  186. <p>The <a class="reference internal" href="#module-stat" title="stat: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat()."><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code></a> module defines constants and functions for interpreting the

  187. results of <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.stat()</span></code></a>, <a class="reference internal" href="os.html#os.fstat" title="os.fstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fstat()</span></code></a> and <a class="reference internal" href="os.html#os.lstat" title="os.lstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.lstat()</span></code></a> (if they

  188. exist).  For complete details about the <code class="xref c c-func docutils literal notranslate"><span class="pre">stat()</span></code>, <code class="xref c c-func docutils literal notranslate"><span class="pre">fstat()</span></code> and

  189. <code class="xref c c-func docutils literal notranslate"><span class="pre">lstat()</span></code> calls, consult the documentation for your system.</p>

  190. <div class="versionchanged">

  191. <p><span class="versionmodified changed">Changed in version 3.4: </span>The stat module is backed by a C implementation.</p>

  192. </div>

  193. <p>The <a class="reference internal" href="#module-stat" title="stat: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat()."><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code></a> module defines the following functions to test for specific file

  194. types:</p>

  195. <dl class="py function">

  196. <dt class="sig sig-object py" id="stat.S_ISDIR">

  197. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISDIR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISDIR" title="Link to this definition">¶</a></dt>

  198. <dd><p>Return non-zero if the mode is from a directory.</p>

  199. </dd></dl>

  200. 

  201. <dl class="py function">

  202. <dt class="sig sig-object py" id="stat.S_ISCHR">

  203. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISCHR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISCHR" title="Link to this definition">¶</a></dt>

  204. <dd><p>Return non-zero if the mode is from a character special device file.</p>

  205. </dd></dl>

  206. 

  207. <dl class="py function">

  208. <dt class="sig sig-object py" id="stat.S_ISBLK">

  209. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISBLK</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISBLK" title="Link to this definition">¶</a></dt>

  210. <dd><p>Return non-zero if the mode is from a block special device file.</p>

  211. </dd></dl>

  212. 

  213. <dl class="py function">

  214. <dt class="sig sig-object py" id="stat.S_ISREG">

  215. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISREG</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISREG" title="Link to this definition">¶</a></dt>

  216. <dd><p>Return non-zero if the mode is from a regular file.</p>

  217. </dd></dl>

  218. 

  219. <dl class="py function">

  220. <dt class="sig sig-object py" id="stat.S_ISFIFO">

  221. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISFIFO</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISFIFO" title="Link to this definition">¶</a></dt>

  222. <dd><p>Return non-zero if the mode is from a FIFO (named pipe).</p>

  223. </dd></dl>

  224. 

  225. <dl class="py function">

  226. <dt class="sig sig-object py" id="stat.S_ISLNK">

  227. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISLNK</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISLNK" title="Link to this definition">¶</a></dt>

  228. <dd><p>Return non-zero if the mode is from a symbolic link.</p>

  229. </dd></dl>

  230. 

  231. <dl class="py function">

  232. <dt class="sig sig-object py" id="stat.S_ISSOCK">

  233. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISSOCK</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISSOCK" title="Link to this definition">¶</a></dt>

  234. <dd><p>Return non-zero if the mode is from a socket.</p>

  235. </dd></dl>

  236. 

  237. <dl class="py function">

  238. <dt class="sig sig-object py" id="stat.S_ISDOOR">

  239. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISDOOR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISDOOR" title="Link to this definition">¶</a></dt>

  240. <dd><p>Return non-zero if the mode is from a door.</p>

  241. <div class="versionadded">

  242. <p><span class="versionmodified added">New in version 3.4.</span></p>

  243. </div>

  244. </dd></dl>

  245. 

  246. <dl class="py function">

  247. <dt class="sig sig-object py" id="stat.S_ISPORT">

  248. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISPORT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISPORT" title="Link to this definition">¶</a></dt>

  249. <dd><p>Return non-zero if the mode is from an event port.</p>

  250. <div class="versionadded">

  251. <p><span class="versionmodified added">New in version 3.4.</span></p>

  252. </div>

  253. </dd></dl>

  254. 

  255. <dl class="py function">

  256. <dt class="sig sig-object py" id="stat.S_ISWHT">

  257. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_ISWHT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_ISWHT" title="Link to this definition">¶</a></dt>

  258. <dd><p>Return non-zero if the mode is from a whiteout.</p>

  259. <div class="versionadded">

  260. <p><span class="versionmodified added">New in version 3.4.</span></p>

  261. </div>

  262. </dd></dl>

  263. 

  264. <p>Two additional functions are defined for more general manipulation of the file’s

  265. mode:</p>

  266. <dl class="py function">

  267. <dt class="sig sig-object py" id="stat.S_IMODE">

  268. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_IMODE</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_IMODE" title="Link to this definition">¶</a></dt>

  269. <dd><p>Return the portion of the file’s mode that can be set by

  270. <a class="reference internal" href="os.html#os.chmod" title="os.chmod"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.chmod()</span></code></a>—that is, the file’s permission bits, plus the sticky

  271. bit, set-group-id, and set-user-id bits (on systems that support them).</p>

  272. </dd></dl>

  273. 

  274. <dl class="py function">

  275. <dt class="sig sig-object py" id="stat.S_IFMT">

  276. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">S_IFMT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.S_IFMT" title="Link to this definition">¶</a></dt>

  277. <dd><p>Return the portion of the file’s mode that describes the file type (used by the

  278. <code class="xref py py-func docutils literal notranslate"><span class="pre">S_IS*()</span></code> functions above).</p>

  279. </dd></dl>

  280. 

  281. <p>Normally, you would use the <code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.is*()</span></code> functions for testing the type

  282. of a file; the functions here are useful when you are doing multiple tests of

  283. the same file and wish to avoid the overhead of the <code class="xref c c-func docutils literal notranslate"><span class="pre">stat()</span></code> system call

  284. for each test.  These are also useful when checking for information about a file

  285. that isn’t handled by <a class="reference internal" href="os.path.html#module-os.path" title="os.path: Operations on pathnames."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code></a>, like the tests for block and character

  286. devices.</p>

  287. <p>Example:</p>

  288. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span>

  289. <span class="kn">from</span> <span class="nn">stat</span> <span class="kn">import</span> <span class="o">*</span>

  290. 

  291. <span class="k">def</span> <span class="nf">walktree</span><span class="p">(</span><span class="n">top</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>

  292. <span class="w">    </span><span class="sd">&#39;&#39;&#39;recursively descend the directory tree rooted at top,</span>

  293. <span class="sd">       calling the callback function for each regular file&#39;&#39;&#39;</span>

  294. 

  295.     <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">top</span><span class="p">):</span>

  296.         <span class="n">pathname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">top</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>

  297.         <span class="n">mode</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">lstat</span><span class="p">(</span><span class="n">pathname</span><span class="p">)</span><span class="o">.</span><span class="n">st_mode</span>

  298.         <span class="k">if</span> <span class="n">S_ISDIR</span><span class="p">(</span><span class="n">mode</span><span class="p">):</span>

  299.             <span class="c1"># It&#39;s a directory, recurse into it</span>

  300.             <span class="n">walktree</span><span class="p">(</span><span class="n">pathname</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>

  301.         <span class="k">elif</span> <span class="n">S_ISREG</span><span class="p">(</span><span class="n">mode</span><span class="p">):</span>

  302.             <span class="c1"># It&#39;s a file, call the callback function</span>

  303.             <span class="n">callback</span><span class="p">(</span><span class="n">pathname</span><span class="p">)</span>

  304.         <span class="k">else</span><span class="p">:</span>

  305.             <span class="c1"># Unknown file type, print a message</span>

  306.             <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Skipping </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">pathname</span><span class="p">)</span>

  307. 

  308. <span class="k">def</span> <span class="nf">visitfile</span><span class="p">(</span><span class="n">file</span><span class="p">):</span>

  309.     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;visiting&#39;</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span>

  310. 

  311. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>

  312.     <span class="n">walktree</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">visitfile</span><span class="p">)</span>

  313. </pre></div>

  314. </div>

  315. <p>An additional utility function is provided to convert a file’s mode in a human

  316. readable string:</p>

  317. <dl class="py function">

  318. <dt class="sig sig-object py" id="stat.filemode">

  319. <span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">filemode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#stat.filemode" title="Link to this definition">¶</a></dt>

  320. <dd><p>Convert a file’s mode to a string of the form ‘-rwxrwxrwx’.</p>

  321. <div class="versionadded">

  322. <p><span class="versionmodified added">New in version 3.3.</span></p>

  323. </div>

  324. <div class="versionchanged">

  325. <p><span class="versionmodified changed">Changed in version 3.4: </span>The function supports <a class="reference internal" href="#stat.S_IFDOOR" title="stat.S_IFDOOR"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFDOOR</span></code></a>, <a class="reference internal" href="#stat.S_IFPORT" title="stat.S_IFPORT"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFPORT</span></code></a> and

  326. <a class="reference internal" href="#stat.S_IFWHT" title="stat.S_IFWHT"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFWHT</span></code></a>.</p>

  327. </div>

  328. </dd></dl>

  329. 

  330. <p>All the variables below are simply symbolic indexes into the 10-tuple returned

  331. by <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.stat()</span></code></a>, <a class="reference internal" href="os.html#os.fstat" title="os.fstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fstat()</span></code></a> or <a class="reference internal" href="os.html#os.lstat" title="os.lstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.lstat()</span></code></a>.</p>

  332. <dl class="py data">

  333. <dt class="sig sig-object py" id="stat.ST_MODE">

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

  335. <dd><p>Inode protection mode.</p>

  336. </dd></dl>

  337. 

  338. <dl class="py data">

  339. <dt class="sig sig-object py" id="stat.ST_INO">

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

  341. <dd><p>Inode number.</p>

  342. </dd></dl>

  343. 

  344. <dl class="py data">

  345. <dt class="sig sig-object py" id="stat.ST_DEV">

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

  347. <dd><p>Device inode resides on.</p>

  348. </dd></dl>

  349. 

  350. <dl class="py data">

  351. <dt class="sig sig-object py" id="stat.ST_NLINK">

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

  353. <dd><p>Number of links to the inode.</p>

  354. </dd></dl>

  355. 

  356. <dl class="py data">

  357. <dt class="sig sig-object py" id="stat.ST_UID">

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

  359. <dd><p>User id of the owner.</p>

  360. </dd></dl>

  361. 

  362. <dl class="py data">

  363. <dt class="sig sig-object py" id="stat.ST_GID">

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

  365. <dd><p>Group id of the owner.</p>

  366. </dd></dl>

  367. 

  368. <dl class="py data">

  369. <dt class="sig sig-object py" id="stat.ST_SIZE">

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

  371. <dd><p>Size in bytes of a plain file; amount of data waiting on some special files.</p>

  372. </dd></dl>

  373. 

  374. <dl class="py data">

  375. <dt class="sig sig-object py" id="stat.ST_ATIME">

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

  377. <dd><p>Time of last access.</p>

  378. </dd></dl>

  379. 

  380. <dl class="py data">

  381. <dt class="sig sig-object py" id="stat.ST_MTIME">

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

  383. <dd><p>Time of last modification.</p>

  384. </dd></dl>

  385. 

  386. <dl class="py data">

  387. <dt class="sig sig-object py" id="stat.ST_CTIME">

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

  389. <dd><p>The “ctime” as reported by the operating system.  On some systems (like Unix) is

  390. the time of the last metadata change, and, on others (like Windows), is the

  391. creation time (see platform documentation for details).</p>

  392. </dd></dl>

  393. 

  394. <p>The interpretation of “file size” changes according to the file type.  For plain

  395. files this is the size of the file in bytes.  For FIFOs and sockets under most

  396. flavors of Unix (including Linux in particular), the “size” is the number of

  397. bytes waiting to be read at the time of the call to <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.stat()</span></code></a>,

  398. <a class="reference internal" href="os.html#os.fstat" title="os.fstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fstat()</span></code></a>, or <a class="reference internal" href="os.html#os.lstat" title="os.lstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.lstat()</span></code></a>; this can sometimes be useful, especially

  399. for polling one of these special files after a non-blocking open.  The meaning

  400. of the size field for other character and block devices varies more, depending

  401. on the implementation of the underlying system call.</p>

  402. <p>The variables below define the flags used in the <a class="reference internal" href="#stat.ST_MODE" title="stat.ST_MODE"><code class="xref py py-data docutils literal notranslate"><span class="pre">ST_MODE</span></code></a> field.</p>

  403. <p>Use of the functions above is more portable than use of the first set of flags:</p>

  404. <dl class="py data">

  405. <dt class="sig sig-object py" id="stat.S_IFSOCK">

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

  407. <dd><p>Socket.</p>

  408. </dd></dl>

  409. 

  410. <dl class="py data">

  411. <dt class="sig sig-object py" id="stat.S_IFLNK">

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

  413. <dd><p>Symbolic link.</p>

  414. </dd></dl>

  415. 

  416. <dl class="py data">

  417. <dt class="sig sig-object py" id="stat.S_IFREG">

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

  419. <dd><p>Regular file.</p>

  420. </dd></dl>

  421. 

  422. <dl class="py data">

  423. <dt class="sig sig-object py" id="stat.S_IFBLK">

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

  425. <dd><p>Block device.</p>

  426. </dd></dl>

  427. 

  428. <dl class="py data">

  429. <dt class="sig sig-object py" id="stat.S_IFDIR">

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

  431. <dd><p>Directory.</p>

  432. </dd></dl>

  433. 

  434. <dl class="py data">

  435. <dt class="sig sig-object py" id="stat.S_IFCHR">

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

  437. <dd><p>Character device.</p>

  438. </dd></dl>

  439. 

  440. <dl class="py data">

  441. <dt class="sig sig-object py" id="stat.S_IFIFO">

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

  443. <dd><p>FIFO.</p>

  444. </dd></dl>

  445. 

  446. <dl class="py data">

  447. <dt class="sig sig-object py" id="stat.S_IFDOOR">

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

  449. <dd><p>Door.</p>

  450. <div class="versionadded">

  451. <p><span class="versionmodified added">New in version 3.4.</span></p>

  452. </div>

  453. </dd></dl>

  454. 

  455. <dl class="py data">

  456. <dt class="sig sig-object py" id="stat.S_IFPORT">

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

  458. <dd><p>Event port.</p>

  459. <div class="versionadded">

  460. <p><span class="versionmodified added">New in version 3.4.</span></p>

  461. </div>

  462. </dd></dl>

  463. 

  464. <dl class="py data">

  465. <dt class="sig sig-object py" id="stat.S_IFWHT">

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

  467. <dd><p>Whiteout.</p>

  468. <div class="versionadded">

  469. <p><span class="versionmodified added">New in version 3.4.</span></p>

  470. </div>

  471. </dd></dl>

  472. 

  473. <div class="admonition note">

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

  475. <p><a class="reference internal" href="#stat.S_IFDOOR" title="stat.S_IFDOOR"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFDOOR</span></code></a>, <a class="reference internal" href="#stat.S_IFPORT" title="stat.S_IFPORT"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFPORT</span></code></a> or <a class="reference internal" href="#stat.S_IFWHT" title="stat.S_IFWHT"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IFWHT</span></code></a> are defined as

  476. 0 when the platform does not have support for the file types.</p>

  477. </div>

  478. <p>The following flags can also be used in the <em>mode</em> argument of <a class="reference internal" href="os.html#os.chmod" title="os.chmod"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.chmod()</span></code></a>:</p>

  479. <dl class="py data">

  480. <dt class="sig sig-object py" id="stat.S_ISUID">

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

  482. <dd><p>Set UID bit.</p>

  483. </dd></dl>

  484. 

  485. <dl class="py data">

  486. <dt class="sig sig-object py" id="stat.S_ISGID">

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

  488. <dd><p>Set-group-ID bit.  This bit has several special uses.  For a directory

  489. it indicates that BSD semantics is to be used for that directory:

  490. files created there inherit their group ID from the directory, not

  491. from the effective group ID of the creating process, and directories

  492. created there will also get the <a class="reference internal" href="#stat.S_ISGID" title="stat.S_ISGID"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_ISGID</span></code></a> bit set.  For a

  493. file that does not have the group execution bit (<a class="reference internal" href="#stat.S_IXGRP" title="stat.S_IXGRP"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IXGRP</span></code></a>)

  494. set, the set-group-ID bit indicates mandatory file/record locking

  495. (see also <a class="reference internal" href="#stat.S_ENFMT" title="stat.S_ENFMT"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_ENFMT</span></code></a>).</p>

  496. </dd></dl>

  497. 

  498. <dl class="py data">

  499. <dt class="sig sig-object py" id="stat.S_ISVTX">

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

  501. <dd><p>Sticky bit.  When this bit is set on a directory it means that a file

  502. in that directory can be renamed or deleted only by the owner of the

  503. file, by the owner of the directory, or by a privileged process.</p>

  504. </dd></dl>

  505. 

  506. <dl class="py data">

  507. <dt class="sig sig-object py" id="stat.S_IRWXU">

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

  509. <dd><p>Mask for file owner permissions.</p>

  510. </dd></dl>

  511. 

  512. <dl class="py data">

  513. <dt class="sig sig-object py" id="stat.S_IRUSR">

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

  515. <dd><p>Owner has read permission.</p>

  516. </dd></dl>

  517. 

  518. <dl class="py data">

  519. <dt class="sig sig-object py" id="stat.S_IWUSR">

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

  521. <dd><p>Owner has write permission.</p>

  522. </dd></dl>

  523. 

  524. <dl class="py data">

  525. <dt class="sig sig-object py" id="stat.S_IXUSR">

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

  527. <dd><p>Owner has execute permission.</p>

  528. </dd></dl>

  529. 

  530. <dl class="py data">

  531. <dt class="sig sig-object py" id="stat.S_IRWXG">

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

  533. <dd><p>Mask for group permissions.</p>

  534. </dd></dl>

  535. 

  536. <dl class="py data">

  537. <dt class="sig sig-object py" id="stat.S_IRGRP">

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

  539. <dd><p>Group has read permission.</p>

  540. </dd></dl>

  541. 

  542. <dl class="py data">

  543. <dt class="sig sig-object py" id="stat.S_IWGRP">

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

  545. <dd><p>Group has write permission.</p>

  546. </dd></dl>

  547. 

  548. <dl class="py data">

  549. <dt class="sig sig-object py" id="stat.S_IXGRP">

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

  551. <dd><p>Group has execute permission.</p>

  552. </dd></dl>

  553. 

  554. <dl class="py data">

  555. <dt class="sig sig-object py" id="stat.S_IRWXO">

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

  557. <dd><p>Mask for permissions for others (not in group).</p>

  558. </dd></dl>

  559. 

  560. <dl class="py data">

  561. <dt class="sig sig-object py" id="stat.S_IROTH">

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

  563. <dd><p>Others have read permission.</p>

  564. </dd></dl>

  565. 

  566. <dl class="py data">

  567. <dt class="sig sig-object py" id="stat.S_IWOTH">

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

  569. <dd><p>Others have write permission.</p>

  570. </dd></dl>

  571. 

  572. <dl class="py data">

  573. <dt class="sig sig-object py" id="stat.S_IXOTH">

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

  575. <dd><p>Others have execute permission.</p>

  576. </dd></dl>

  577. 

  578. <dl class="py data">

  579. <dt class="sig sig-object py" id="stat.S_ENFMT">

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

  581. <dd><p>System V file locking enforcement.  This flag is shared with <a class="reference internal" href="#stat.S_ISGID" title="stat.S_ISGID"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_ISGID</span></code></a>:

  582. file/record locking is enforced on files that do not have the group

  583. execution bit (<a class="reference internal" href="#stat.S_IXGRP" title="stat.S_IXGRP"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IXGRP</span></code></a>) set.</p>

  584. </dd></dl>

  585. 

  586. <dl class="py data">

  587. <dt class="sig sig-object py" id="stat.S_IREAD">

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

  589. <dd><p>Unix V7 synonym for <a class="reference internal" href="#stat.S_IRUSR" title="stat.S_IRUSR"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IRUSR</span></code></a>.</p>

  590. </dd></dl>

  591. 

  592. <dl class="py data">

  593. <dt class="sig sig-object py" id="stat.S_IWRITE">

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

  595. <dd><p>Unix V7 synonym for <a class="reference internal" href="#stat.S_IWUSR" title="stat.S_IWUSR"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IWUSR</span></code></a>.</p>

  596. </dd></dl>

  597. 

  598. <dl class="py data">

  599. <dt class="sig sig-object py" id="stat.S_IEXEC">

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

  601. <dd><p>Unix V7 synonym for <a class="reference internal" href="#stat.S_IXUSR" title="stat.S_IXUSR"><code class="xref py py-data docutils literal notranslate"><span class="pre">S_IXUSR</span></code></a>.</p>

  602. </dd></dl>

  603. 

  604. <p>The following flags can be used in the <em>flags</em> argument of <a class="reference internal" href="os.html#os.chflags" title="os.chflags"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.chflags()</span></code></a>:</p>

  605. <dl class="py data">

  606. <dt class="sig sig-object py" id="stat.UF_NODUMP">

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

  608. <dd><p>Do not dump the file.</p>

  609. </dd></dl>

  610. 

  611. <dl class="py data">

  612. <dt class="sig sig-object py" id="stat.UF_IMMUTABLE">

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

  614. <dd><p>The file may not be changed.</p>

  615. </dd></dl>

  616. 

  617. <dl class="py data">

  618. <dt class="sig sig-object py" id="stat.UF_APPEND">

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

  620. <dd><p>The file may only be appended to.</p>

  621. </dd></dl>

  622. 

  623. <dl class="py data">

  624. <dt class="sig sig-object py" id="stat.UF_OPAQUE">

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

  626. <dd><p>The directory is opaque when viewed through a union stack.</p>

  627. </dd></dl>

  628. 

  629. <dl class="py data">

  630. <dt class="sig sig-object py" id="stat.UF_NOUNLINK">

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

  632. <dd><p>The file may not be renamed or deleted.</p>

  633. </dd></dl>

  634. 

  635. <dl class="py data">

  636. <dt class="sig sig-object py" id="stat.UF_COMPRESSED">

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

  638. <dd><p>The file is stored compressed (macOS 10.6+).</p>

  639. </dd></dl>

  640. 

  641. <dl class="py data">

  642. <dt class="sig sig-object py" id="stat.UF_HIDDEN">

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

  644. <dd><p>The file should not be displayed in a GUI (macOS 10.5+).</p>

  645. </dd></dl>

  646. 

  647. <dl class="py data">

  648. <dt class="sig sig-object py" id="stat.SF_ARCHIVED">

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

  650. <dd><p>The file may be archived.</p>

  651. </dd></dl>

  652. 

  653. <dl class="py data">

  654. <dt class="sig sig-object py" id="stat.SF_IMMUTABLE">

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

  656. <dd><p>The file may not be changed.</p>

  657. </dd></dl>

  658. 

  659. <dl class="py data">

  660. <dt class="sig sig-object py" id="stat.SF_APPEND">

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

  662. <dd><p>The file may only be appended to.</p>

  663. </dd></dl>

  664. 

  665. <dl class="py data">

  666. <dt class="sig sig-object py" id="stat.SF_NOUNLINK">

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

  668. <dd><p>The file may not be renamed or deleted.</p>

  669. </dd></dl>

  670. 

  671. <dl class="py data">

  672. <dt class="sig sig-object py" id="stat.SF_SNAPSHOT">

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

  674. <dd><p>The file is a snapshot file.</p>

  675. </dd></dl>

  676. 

  677. <p>See the *BSD or macOS systems man page <em class="manpage"><a class="manpage reference external" href="https://manpages.debian.org/chflags(2)">chflags(2)</a></em> for more information.</p>

  678. <p>On Windows, the following file attribute constants are available for use when

  679. testing bits in the <code class="docutils literal notranslate"><span class="pre">st_file_attributes</span></code> member returned by <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.stat()</span></code></a>.

  680. See the <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx">Windows API documentation</a>

  681. for more detail on the meaning of these constants.</p>

  682. <dl class="py data">

  683. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_ARCHIVE">

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

  685. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_COMPRESSED">

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

  687. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_DEVICE">

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

  689. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_DIRECTORY">

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

  691. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_ENCRYPTED">

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

  693. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_HIDDEN">

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

  695. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_INTEGRITY_STREAM">

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

  697. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NORMAL">

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

  699. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED">

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

  701. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NO_SCRUB_DATA">

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

  703. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_OFFLINE">

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

  705. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_READONLY">

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

  707. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_REPARSE_POINT">

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

  709. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_SPARSE_FILE">

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

  711. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_SYSTEM">

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

  713. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_TEMPORARY">

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

  715. <dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_VIRTUAL">

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

  717. <dd><div class="versionadded">

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

  719. </div>

  720. </dd></dl>

  721. 

  722. <p>On Windows, the following constants are available for comparing against the

  723. <code class="docutils literal notranslate"><span class="pre">st_reparse_tag</span></code> member returned by <a class="reference internal" href="os.html#os.lstat" title="os.lstat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.lstat()</span></code></a>. These are well-known

  724. constants, but are not an exhaustive list.</p>

  725. <dl class="py data">

  726. <dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_SYMLINK">

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

  728. <dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_MOUNT_POINT">

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

  730. <dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_APPEXECLINK">

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

  732. <dd><div class="versionadded">

  733. <p><span class="versionmodified added">New in version 3.8.</span></p>

  734. </div>

  735. </dd></dl>

  736. 

  737. </section>

  738. 

  739. 

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

  741.           </div>

  742.         </div>

  743.       </div>

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

  745.         <div class="sphinxsidebarwrapper">

  746.   <div>

  747.     <h4>Previous topic</h4>

  748.     <p class="topless"><a href="fileinput.html"

  749.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileinput</span></code> — Iterate over lines from multiple input streams</a></p>

  750.   </div>

  751.   <div>

  752.     <h4>Next topic</h4>

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

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

  755.   </div>

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

  757.     <h3>This Page</h3>

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

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

  760.       <li>

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

  762.             rel="nofollow">Show Source

  763.         </a>

  764.       </li>

  765.     </ul>

  766.   </div>

  767.         </div>

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

  769. <span>«</span>

  770. </div>

  771. 

  772.       </div>

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

  774.     </div>  

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

  776.       <h3>Navigation</h3>

  777.       <ul>

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

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

  780.              >index</a></li>

  781.         <li class="right" >

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

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

  784.         <li class="right" >

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

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

  787.         <li class="right" >

  788.           <a href="fileinput.html" title="fileinput — Iterate over lines from multiple input streams"

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

  790. 

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

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

  793.           <li class="switchers">

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

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

  796.           </li>

  797.           <li>

  798.               

  799.           </li>

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

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

  802.     </li>

  803. 

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

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

  806.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> — Interpreting <code class="xref py py-func docutils literal notranslate"><span class="pre">stat()</span></code> results</a></li>

  807.                 <li class="right">

  808.                     

  809. 

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

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

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

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

  814.         </form>

  815.     </div>

  816.                      |

  817.                 </li>

  818.             <li class="right">

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

  820.     Theme

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

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

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

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

  825.     </select>

  826. </label> |</li>

  827.             

  828.       </ul>

  829.     </div>  

  830.     <div class="footer">

  831.     &copy; 

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

  833.     

  834.     Copyright

  835.     

  836.       </a>

  837.      2001-2024, Python Software Foundation.

  838.     <br />

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

  840.     <br />

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

  842.     <br />

  843.     

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

  845.     

  846.     

  847.     <br />

  848. 

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

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

  851. <br />

  852.     <br />

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

  854.     

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

  856.     

  857.     <br />

  858. 

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

  860.     </div>

  861. 

  862.   </body>

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