parthtamu/rag-code-assistant
0
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:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_stat_980f47d9.png" />15<meta property="og:image:alt" 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(), ..." />16<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(), ..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>stat — Interpreting stat() results — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="filecmp — File and Directory Comparisons" href="filecmp.html" />43 <link rel="prev" title="os.path — Common pathname manipulations" href="os.path.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/stat.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <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>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h4>Previous topic</h4>106 <p class="topless"><a href="os.path.html"107 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>108 </div>109 <div>110 <h4>Next topic</h4>111 <p class="topless"><a href="filecmp.html"112 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">filecmp</span></code> — File and Directory Comparisons</a></p>113 </div>114 <script>115 document.addEventListener('DOMContentLoaded', () => {116 const title = document.querySelector('meta[property="og:title"]').content;117 const elements = document.querySelectorAll('.improvepage');118 const pageurl = window.location.href.split('?')[0];119 elements.forEach(element => {120 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));121 url.searchParams.set('pagetitle', title);122 url.searchParams.set('pageurl', pageurl);123 url.searchParams.set('pagesource', "library/stat.rst");124 element.href = url.toString();125 });126 });127 </script>128 <div role="note" aria-label="source link">129 <h3>This page</h3>130 <ul class="this-page-menu">131 <li><a href="../bugs.html">Report a bug</a></li>132 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>133 <li>134 <a href="https://github.com/python/cpython/blob/main/Doc/library/stat.rst?plain=1"135 rel="nofollow">Show source136 </a>137 </li>138 139 </ul>140 </div>141 </nav>142 </div>143</div>144 145 146 <div class="related" role="navigation" aria-label="Related">147 <h3>Navigation</h3>148 <ul>149 <li class="right" style="margin-right: 10px">150 <a href="../genindex.html" title="General Index"151 accesskey="I">index</a></li>152 <li class="right" >153 <a href="../py-modindex.html" title="Python Module Index"154 >modules</a> |</li>155 <li class="right" >156 <a href="filecmp.html" title="filecmp — File and Directory Comparisons"157 accesskey="N">next</a> |</li>158 <li class="right" >159 <a href="os.path.html" title="os.path — Common pathname manipulations"160 accesskey="P">previous</a> |</li>161 162 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>163 <li><a href="https://www.python.org/">Python</a> »</li>164 <li class="switchers">165 <div class="language_switcher_placeholder"></div>166 <div class="version_switcher_placeholder"></div>167 </li>168 <li>169 170 </li>171 <li id="cpython-language-and-version">172 <a href="../index.html">3.15.0a6 Documentation</a> »173 </li>174 175 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>176 <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> »</li>177 <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>178 <li class="right">179 180 181 <div class="inline-search" role="search">182 <form class="inline-search" action="../search.html" method="get">183 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">184 <input type="submit" value="Go">185 </form>186 </div>187 |188 </li>189 <li class="right">190<label class="theme-selector-label">191 Theme192 <select class="theme-selector" oninput="activateTheme(this.value)">193 <option value="auto" selected>Auto</option>194 <option value="light">Light</option>195 <option value="dark">Dark</option>196 </select>197</label> |</li>198 199 </ul>200 </div> 201 202 <div class="document">203 <div class="documentwrapper">204 <div class="bodywrapper">205 <div class="body" role="main">206 207 <section id="module-stat">208<span id="stat-interpreting-stat-results"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> — 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>209<p><strong>Source code:</strong> <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/main/Lib/stat.py">Lib/stat.py</a></p>210<hr class="docutils" />211<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> module defines constants and functions for interpreting the212results 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 they213exist). 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> and214<code class="xref c c-func docutils literal notranslate"><span class="pre">lstat()</span></code> calls, consult the documentation for your system.</p>215<div class="versionchanged">216<p><span class="versionmodified changed">Changed in version 3.4: </span>The stat module is backed by a C implementation.</p>217</div>218<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> module defines the following functions to test for specific file219types:</p>220<dl class="py function">221<dt class="sig sig-object py" id="stat.S_ISDIR">222<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>223<dd><p>Return non-zero if the mode is from a directory.</p>224</dd></dl>225 226<dl class="py function">227<dt class="sig sig-object py" id="stat.S_ISCHR">228<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>229<dd><p>Return non-zero if the mode is from a character special device file.</p>230</dd></dl>231 232<dl class="py function">233<dt class="sig sig-object py" id="stat.S_ISBLK">234<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>235<dd><p>Return non-zero if the mode is from a block special device file.</p>236</dd></dl>237 238<dl class="py function">239<dt class="sig sig-object py" id="stat.S_ISREG">240<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>241<dd><p>Return non-zero if the mode is from a regular file.</p>242</dd></dl>243 244<dl class="py function">245<dt class="sig sig-object py" id="stat.S_ISFIFO">246<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>247<dd><p>Return non-zero if the mode is from a FIFO (named pipe).</p>248</dd></dl>249 250<dl class="py function">251<dt class="sig sig-object py" id="stat.S_ISLNK">252<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>253<dd><p>Return non-zero if the mode is from a symbolic link.</p>254</dd></dl>255 256<dl class="py function">257<dt class="sig sig-object py" id="stat.S_ISSOCK">258<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>259<dd><p>Return non-zero if the mode is from a socket.</p>260</dd></dl>261 262<dl class="py function">263<dt class="sig sig-object py" id="stat.S_ISDOOR">264<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>265<dd><p>Return non-zero if the mode is from a door.</p>266<div class="versionadded">267<p><span class="versionmodified added">Added in version 3.4.</span></p>268</div>269</dd></dl>270 271<dl class="py function">272<dt class="sig sig-object py" id="stat.S_ISPORT">273<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>274<dd><p>Return non-zero if the mode is from an event port.</p>275<div class="versionadded">276<p><span class="versionmodified added">Added in version 3.4.</span></p>277</div>278</dd></dl>279 280<dl class="py function">281<dt class="sig sig-object py" id="stat.S_ISWHT">282<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>283<dd><p>Return non-zero if the mode is from a whiteout.</p>284<div class="versionadded">285<p><span class="versionmodified added">Added in version 3.4.</span></p>286</div>287</dd></dl>288 289<p>Two additional functions are defined for more general manipulation of the file’s290mode:</p>291<dl class="py function">292<dt class="sig sig-object py" id="stat.S_IMODE">293<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>294<dd><p>Return the portion of the file’s mode that can be set by295<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 sticky296bit, set-group-id, and set-user-id bits (on systems that support them).</p>297</dd></dl>298 299<dl class="py function">300<dt class="sig sig-object py" id="stat.S_IFMT">301<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>302<dd><p>Return the portion of the file’s mode that describes the file type (used by the303<code class="xref py py-func docutils literal notranslate"><span class="pre">S_IS*()</span></code> functions above).</p>304</dd></dl>305 306<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 type307of a file; the functions here are useful when you are doing multiple tests of308the 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 call309for each test. These are also useful when checking for information about a file310that 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 character311devices.</p>312<p>Example:</p>313<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span><span class="o">,</span><span class="w"> </span><span class="nn">sys</span>314<span class="kn">from</span><span class="w"> </span><span class="nn">stat</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>315 316<span class="k">def</span><span class="w"> </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>317<span class="w"> </span><span class="sd">'''recursively descend the directory tree rooted at top,</span>318<span class="sd"> calling the callback function for each regular file'''</span>319 320 <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>321 <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>322 <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>323 <span class="k">if</span> <span class="n">S_ISDIR</span><span class="p">(</span><span class="n">mode</span><span class="p">):</span>324 <span class="c1"># It's a directory, recurse into it</span>325 <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>326 <span class="k">elif</span> <span class="n">S_ISREG</span><span class="p">(</span><span class="n">mode</span><span class="p">):</span>327 <span class="c1"># It's a file, call the callback function</span>328 <span class="n">callback</span><span class="p">(</span><span class="n">pathname</span><span class="p">)</span>329 <span class="k">else</span><span class="p">:</span>330 <span class="c1"># Unknown file type, print a message</span>331 <span class="nb">print</span><span class="p">(</span><span class="s1">'Skipping </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">pathname</span><span class="p">)</span>332 333<span class="k">def</span><span class="w"> </span><span class="nf">visitfile</span><span class="p">(</span><span class="n">file</span><span class="p">):</span>334 <span class="nb">print</span><span class="p">(</span><span class="s1">'visiting'</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span>335 336<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>337 <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>338</pre></div>339</div>340<p>An additional utility function is provided to convert a file’s mode in a human341readable string:</p>342<dl class="py function">343<dt class="sig sig-object py" id="stat.filemode">344<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>345<dd><p>Convert a file’s mode to a string of the form ‘-rwxrwxrwx’.</p>346<div class="versionadded">347<p><span class="versionmodified added">Added in version 3.3.</span></p>348</div>349<div class="versionchanged">350<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> and351<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>352</div>353</dd></dl>354 355<p>All the variables below are simply symbolic indexes into the 10-tuple returned356by <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>357<dl class="py data">358<dt class="sig sig-object py" id="stat.ST_MODE">359<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>360<dd><p>Inode protection mode.</p>361</dd></dl>362 363<dl class="py data">364<dt class="sig sig-object py" id="stat.ST_INO">365<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>366<dd><p>Inode number.</p>367</dd></dl>368 369<dl class="py data">370<dt class="sig sig-object py" id="stat.ST_DEV">371<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>372<dd><p>Device inode resides on.</p>373</dd></dl>374 375<dl class="py data">376<dt class="sig sig-object py" id="stat.ST_NLINK">377<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>378<dd><p>Number of links to the inode.</p>379</dd></dl>380 381<dl class="py data">382<dt class="sig sig-object py" id="stat.ST_UID">383<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>384<dd><p>User id of the owner.</p>385</dd></dl>386 387<dl class="py data">388<dt class="sig sig-object py" id="stat.ST_GID">389<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>390<dd><p>Group id of the owner.</p>391</dd></dl>392 393<dl class="py data">394<dt class="sig sig-object py" id="stat.ST_SIZE">395<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>396<dd><p>Size in bytes of a plain file; amount of data waiting on some special files.</p>397</dd></dl>398 399<dl class="py data">400<dt class="sig sig-object py" id="stat.ST_ATIME">401<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>402<dd><p>Time of last access.</p>403</dd></dl>404 405<dl class="py data">406<dt class="sig sig-object py" id="stat.ST_MTIME">407<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>408<dd><p>Time of last modification.</p>409</dd></dl>410 411<dl class="py data">412<dt class="sig sig-object py" id="stat.ST_CTIME">413<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>414<dd><p>The “ctime” as reported by the operating system. On some systems (like Unix) is415the time of the last metadata change, and, on others (like Windows), is the416creation time (see platform documentation for details).</p>417</dd></dl>418 419<p>The interpretation of “file size” changes according to the file type. For plain420files this is the size of the file in bytes. For FIFOs and sockets under most421flavors of Unix (including Linux in particular), the “size” is the number of422bytes 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>,423<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, especially424for polling one of these special files after a non-blocking open. The meaning425of the size field for other character and block devices varies more, depending426on the implementation of the underlying system call.</p>427<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>428<p>Use of the functions above is more portable than use of the first set of flags:</p>429<dl class="py data">430<dt class="sig sig-object py" id="stat.S_IFSOCK">431<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>432<dd><p>Socket.</p>433</dd></dl>434 435<dl class="py data">436<dt class="sig sig-object py" id="stat.S_IFLNK">437<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>438<dd><p>Symbolic link.</p>439</dd></dl>440 441<dl class="py data">442<dt class="sig sig-object py" id="stat.S_IFREG">443<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>444<dd><p>Regular file.</p>445</dd></dl>446 447<dl class="py data">448<dt class="sig sig-object py" id="stat.S_IFBLK">449<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>450<dd><p>Block device.</p>451</dd></dl>452 453<dl class="py data">454<dt class="sig sig-object py" id="stat.S_IFDIR">455<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>456<dd><p>Directory.</p>457</dd></dl>458 459<dl class="py data">460<dt class="sig sig-object py" id="stat.S_IFCHR">461<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>462<dd><p>Character device.</p>463</dd></dl>464 465<dl class="py data">466<dt class="sig sig-object py" id="stat.S_IFIFO">467<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>468<dd><p>FIFO.</p>469</dd></dl>470 471<dl class="py data">472<dt class="sig sig-object py" id="stat.S_IFDOOR">473<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>474<dd><p>Door.</p>475<div class="versionadded">476<p><span class="versionmodified added">Added in version 3.4.</span></p>477</div>478</dd></dl>479 480<dl class="py data">481<dt class="sig sig-object py" id="stat.S_IFPORT">482<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>483<dd><p>Event port.</p>484<div class="versionadded">485<p><span class="versionmodified added">Added in version 3.4.</span></p>486</div>487</dd></dl>488 489<dl class="py data">490<dt class="sig sig-object py" id="stat.S_IFWHT">491<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>492<dd><p>Whiteout.</p>493<div class="versionadded">494<p><span class="versionmodified added">Added in version 3.4.</span></p>495</div>496</dd></dl>497 498<div class="admonition note">499<p class="admonition-title">Note</p>500<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 as5010 when the platform does not have support for the file types.</p>502</div>503<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>504<dl class="py data">505<dt class="sig sig-object py" id="stat.S_ISUID">506<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>507<dd><p>Set UID bit.</p>508</dd></dl>509 510<dl class="py data">511<dt class="sig sig-object py" id="stat.S_ISGID">512<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>513<dd><p>Set-group-ID bit. This bit has several special uses. For a directory514it indicates that BSD semantics is to be used for that directory:515files created there inherit their group ID from the directory, not516from the effective group ID of the creating process, and directories517created there will also get the <code class="xref py py-data docutils literal notranslate"><span class="pre">S_ISGID</span></code> bit set. For a518file 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>)519set, the set-group-ID bit indicates mandatory file/record locking520(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>521</dd></dl>522 523<dl class="py data">524<dt class="sig sig-object py" id="stat.S_ISVTX">525<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>526<dd><p>Sticky bit. When this bit is set on a directory it means that a file527in that directory can be renamed or deleted only by the owner of the528file, by the owner of the directory, or by a privileged process.</p>529</dd></dl>530 531<dl class="py data">532<dt class="sig sig-object py" id="stat.S_IRWXU">533<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>534<dd><p>Mask for file owner permissions.</p>535</dd></dl>536 537<dl class="py data">538<dt class="sig sig-object py" id="stat.S_IRUSR">539<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>540<dd><p>Owner has read permission.</p>541</dd></dl>542 543<dl class="py data">544<dt class="sig sig-object py" id="stat.S_IWUSR">545<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>546<dd><p>Owner has write permission.</p>547</dd></dl>548 549<dl class="py data">550<dt class="sig sig-object py" id="stat.S_IXUSR">551<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>552<dd><p>Owner has execute permission.</p>553</dd></dl>554 555<dl class="py data">556<dt class="sig sig-object py" id="stat.S_IRWXG">557<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>558<dd><p>Mask for group permissions.</p>559</dd></dl>560 561<dl class="py data">562<dt class="sig sig-object py" id="stat.S_IRGRP">563<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>564<dd><p>Group has read permission.</p>565</dd></dl>566 567<dl class="py data">568<dt class="sig sig-object py" id="stat.S_IWGRP">569<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>570<dd><p>Group has write permission.</p>571</dd></dl>572 573<dl class="py data">574<dt class="sig sig-object py" id="stat.S_IXGRP">575<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>576<dd><p>Group has execute permission.</p>577</dd></dl>578 579<dl class="py data">580<dt class="sig sig-object py" id="stat.S_IRWXO">581<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>582<dd><p>Mask for permissions for others (not in group).</p>583</dd></dl>584 585<dl class="py data">586<dt class="sig sig-object py" id="stat.S_IROTH">587<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>588<dd><p>Others have read permission.</p>589</dd></dl>590 591<dl class="py data">592<dt class="sig sig-object py" id="stat.S_IWOTH">593<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>594<dd><p>Others have write permission.</p>595</dd></dl>596 597<dl class="py data">598<dt class="sig sig-object py" id="stat.S_IXOTH">599<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>600<dd><p>Others have execute permission.</p>601</dd></dl>602 603<dl class="py data">604<dt class="sig sig-object py" id="stat.S_ENFMT">605<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>606<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>:607file/record locking is enforced on files that do not have the group608execution 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>609</dd></dl>610 611<dl class="py data">612<dt class="sig sig-object py" id="stat.S_IREAD">613<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>614<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>615</dd></dl>616 617<dl class="py data">618<dt class="sig sig-object py" id="stat.S_IWRITE">619<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>620<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>621</dd></dl>622 623<dl class="py data">624<dt class="sig sig-object py" id="stat.S_IEXEC">625<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>626<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>627</dd></dl>628 629<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>630<dl class="py data">631<dt class="sig sig-object py" id="stat.UF_SETTABLE">632<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">UF_SETTABLE</span></span><a class="headerlink" href="#stat.UF_SETTABLE" title="Link to this definition">¶</a></dt>633<dd><p>All user settable flags.</p>634<div class="versionadded">635<p><span class="versionmodified added">Added in version 3.13.</span></p>636</div>637</dd></dl>638 639<dl class="py data">640<dt class="sig sig-object py" id="stat.UF_NODUMP">641<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>642<dd><p>Do not dump the file.</p>643</dd></dl>644 645<dl class="py data">646<dt class="sig sig-object py" id="stat.UF_IMMUTABLE">647<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>648<dd><p>The file may not be changed.</p>649</dd></dl>650 651<dl class="py data">652<dt class="sig sig-object py" id="stat.UF_APPEND">653<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>654<dd><p>The file may only be appended to.</p>655</dd></dl>656 657<dl class="py data">658<dt class="sig sig-object py" id="stat.UF_OPAQUE">659<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>660<dd><p>The directory is opaque when viewed through a union stack.</p>661</dd></dl>662 663<dl class="py data">664<dt class="sig sig-object py" id="stat.UF_NOUNLINK">665<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>666<dd><p>The file may not be renamed or deleted.</p>667</dd></dl>668 669<dl class="py data">670<dt class="sig sig-object py" id="stat.UF_COMPRESSED">671<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>672<dd><p>The file is stored compressed (macOS 10.6+).</p>673</dd></dl>674 675<dl class="py data">676<dt class="sig sig-object py" id="stat.UF_TRACKED">677<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">UF_TRACKED</span></span><a class="headerlink" href="#stat.UF_TRACKED" title="Link to this definition">¶</a></dt>678<dd><p>Used for handling document IDs (macOS)</p>679<div class="versionadded">680<p><span class="versionmodified added">Added in version 3.13.</span></p>681</div>682</dd></dl>683 684<dl class="py data">685<dt class="sig sig-object py" id="stat.UF_DATAVAULT">686<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">UF_DATAVAULT</span></span><a class="headerlink" href="#stat.UF_DATAVAULT" title="Link to this definition">¶</a></dt>687<dd><p>The file needs an entitlement for reading or writing (macOS 10.13+)</p>688<div class="versionadded">689<p><span class="versionmodified added">Added in version 3.13.</span></p>690</div>691</dd></dl>692 693<dl class="py data">694<dt class="sig sig-object py" id="stat.UF_HIDDEN">695<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>696<dd><p>The file should not be displayed in a GUI (macOS 10.5+).</p>697</dd></dl>698 699<dl class="py data">700<dt class="sig sig-object py" id="stat.SF_SETTABLE">701<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_SETTABLE</span></span><a class="headerlink" href="#stat.SF_SETTABLE" title="Link to this definition">¶</a></dt>702<dd><p>All super-user changeable flags</p>703<div class="versionadded">704<p><span class="versionmodified added">Added in version 3.13.</span></p>705</div>706</dd></dl>707 708<dl class="py data">709<dt class="sig sig-object py" id="stat.SF_SUPPORTED">710<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_SUPPORTED</span></span><a class="headerlink" href="#stat.SF_SUPPORTED" title="Link to this definition">¶</a></dt>711<dd><p>All super-user supported flags</p>712<div class="availability docutils container">713<p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: macOS</p>714</div>715<div class="versionadded">716<p><span class="versionmodified added">Added in version 3.13.</span></p>717</div>718</dd></dl>719 720<dl class="py data">721<dt class="sig sig-object py" id="stat.SF_SYNTHETIC">722<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_SYNTHETIC</span></span><a class="headerlink" href="#stat.SF_SYNTHETIC" title="Link to this definition">¶</a></dt>723<dd><p>All super-user read-only synthetic flags</p>724<div class="availability docutils container">725<p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: macOS</p>726</div>727<div class="versionadded">728<p><span class="versionmodified added">Added in version 3.13.</span></p>729</div>730</dd></dl>731 732<dl class="py data">733<dt class="sig sig-object py" id="stat.SF_ARCHIVED">734<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>735<dd><p>The file may be archived.</p>736</dd></dl>737 738<dl class="py data">739<dt class="sig sig-object py" id="stat.SF_IMMUTABLE">740<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>741<dd><p>The file may not be changed.</p>742</dd></dl>743 744<dl class="py data">745<dt class="sig sig-object py" id="stat.SF_APPEND">746<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>747<dd><p>The file may only be appended to.</p>748</dd></dl>749 750<dl class="py data">751<dt class="sig sig-object py" id="stat.SF_RESTRICTED">752<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_RESTRICTED</span></span><a class="headerlink" href="#stat.SF_RESTRICTED" title="Link to this definition">¶</a></dt>753<dd><p>The file needs an entitlement to write to (macOS 10.13+)</p>754<div class="versionadded">755<p><span class="versionmodified added">Added in version 3.13.</span></p>756</div>757</dd></dl>758 759<dl class="py data">760<dt class="sig sig-object py" id="stat.SF_NOUNLINK">761<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>762<dd><p>The file may not be renamed or deleted.</p>763</dd></dl>764 765<dl class="py data">766<dt class="sig sig-object py" id="stat.SF_SNAPSHOT">767<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>768<dd><p>The file is a snapshot file.</p>769</dd></dl>770 771<dl class="py data">772<dt class="sig sig-object py" id="stat.SF_FIRMLINK">773<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_FIRMLINK</span></span><a class="headerlink" href="#stat.SF_FIRMLINK" title="Link to this definition">¶</a></dt>774<dd><p>The file is a firmlink (macOS 10.15+)</p>775<div class="versionadded">776<p><span class="versionmodified added">Added in version 3.13.</span></p>777</div>778</dd></dl>779 780<dl class="py data">781<dt class="sig sig-object py" id="stat.SF_DATALESS">782<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">SF_DATALESS</span></span><a class="headerlink" href="#stat.SF_DATALESS" title="Link to this definition">¶</a></dt>783<dd><p>The file is a dataless object (macOS 10.15+)</p>784<div class="versionadded">785<p><span class="versionmodified added">Added in version 3.13.</span></p>786</div>787</dd></dl>788 789<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>790<p>On Windows, the following file attribute constants are available for use when791testing 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>.792See the <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx">Windows API documentation</a>793for more detail on the meaning of these constants.</p>794<dl class="py data">795<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_ARCHIVE">796<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>797<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_COMPRESSED">798<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>799<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_DEVICE">800<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>801<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_DIRECTORY">802<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>803<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_ENCRYPTED">804<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>805<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_HIDDEN">806<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>807<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_INTEGRITY_STREAM">808<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>809<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NORMAL">810<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>811<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED">812<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>813<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_NO_SCRUB_DATA">814<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>815<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_OFFLINE">816<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>817<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_READONLY">818<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>819<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_REPARSE_POINT">820<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>821<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_SPARSE_FILE">822<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>823<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_SYSTEM">824<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>825<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_TEMPORARY">826<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>827<dt class="sig sig-object py" id="stat.FILE_ATTRIBUTE_VIRTUAL">828<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>829<dd><div class="versionadded">830<p><span class="versionmodified added">Added in version 3.5.</span></p>831</div>832</dd></dl>833 834<p>On Windows, the following constants are available for comparing against the835<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-known836constants, but are not an exhaustive list.</p>837<dl class="py data">838<dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_SYMLINK">839<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>840<dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_MOUNT_POINT">841<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>842<dt class="sig sig-object py" id="stat.IO_REPARSE_TAG_APPEXECLINK">843<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>844<dd><div class="versionadded">845<p><span class="versionmodified added">Added in version 3.8.</span></p>846</div>847</dd></dl>848 849<p>On Linux, the following file attribute constants are available for use when850testing bits in the <a class="reference internal" href="os.html#os.statx_result.stx_attributes" title="os.statx_result.stx_attributes"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stx_attributes</span></code></a> and851<a class="reference internal" href="os.html#os.statx_result.stx_attributes_mask" title="os.statx_result.stx_attributes_mask"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stx_attributes_mask</span></code></a> members returned by852<a class="reference internal" href="os.html#os.statx" title="os.statx"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.statx()</span></code></a>. See the <em class="manpage"><a class="manpage reference external" href="https://manpages.debian.org/statx(2)">statx(2)</a></em> man page for more detail on the853meaning of these constants.</p>854<dl class="py data">855<dt class="sig sig-object py" id="stat.STATX_ATTR_COMPRESSED">856<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_COMPRESSED</span></span><a class="headerlink" href="#stat.STATX_ATTR_COMPRESSED" title="Link to this definition">¶</a></dt>857<dt class="sig sig-object py" id="stat.STATX_ATTR_IMMUTABLE">858<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_IMMUTABLE</span></span><a class="headerlink" href="#stat.STATX_ATTR_IMMUTABLE" title="Link to this definition">¶</a></dt>859<dt class="sig sig-object py" id="stat.STATX_ATTR_APPEND">860<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_APPEND</span></span><a class="headerlink" href="#stat.STATX_ATTR_APPEND" title="Link to this definition">¶</a></dt>861<dt class="sig sig-object py" id="stat.STATX_ATTR_NODUMP">862<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_NODUMP</span></span><a class="headerlink" href="#stat.STATX_ATTR_NODUMP" title="Link to this definition">¶</a></dt>863<dt class="sig sig-object py" id="stat.STATX_ATTR_ENCRYPTED">864<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_ENCRYPTED</span></span><a class="headerlink" href="#stat.STATX_ATTR_ENCRYPTED" title="Link to this definition">¶</a></dt>865<dt class="sig sig-object py" id="stat.STATX_ATTR_AUTOMOUNT">866<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_AUTOMOUNT</span></span><a class="headerlink" href="#stat.STATX_ATTR_AUTOMOUNT" title="Link to this definition">¶</a></dt>867<dt class="sig sig-object py" id="stat.STATX_ATTR_MOUNT_ROOT">868<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_MOUNT_ROOT</span></span><a class="headerlink" href="#stat.STATX_ATTR_MOUNT_ROOT" title="Link to this definition">¶</a></dt>869<dt class="sig sig-object py" id="stat.STATX_ATTR_VERITY">870<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_VERITY</span></span><a class="headerlink" href="#stat.STATX_ATTR_VERITY" title="Link to this definition">¶</a></dt>871<dt class="sig sig-object py" id="stat.STATX_ATTR_DAX">872<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_DAX</span></span><a class="headerlink" href="#stat.STATX_ATTR_DAX" title="Link to this definition">¶</a></dt>873<dt class="sig sig-object py" id="stat.STATX_ATTR_WRITE_ATOMIC">874<span class="sig-prename descclassname"><span class="pre">stat.</span></span><span class="sig-name descname"><span class="pre">STATX_ATTR_WRITE_ATOMIC</span></span><a class="headerlink" href="#stat.STATX_ATTR_WRITE_ATOMIC" title="Link to this definition">¶</a></dt>875<dd><div class="versionadded">876<p><span class="versionmodified added">Added in version 3.15.</span></p>877</div>878</dd></dl>879 880</section>881 882 883 <div class="clearer"></div>884 </div>885 </div>886 </div>887 <div class="sphinxsidebar" role="navigation" aria-label="Main">888 <div class="sphinxsidebarwrapper">889 <div>890 <h4>Previous topic</h4>891 <p class="topless"><a href="os.path.html"892 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>893 </div>894 <div>895 <h4>Next topic</h4>896 <p class="topless"><a href="filecmp.html"897 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">filecmp</span></code> — File and Directory Comparisons</a></p>898 </div>899 <script>900 document.addEventListener('DOMContentLoaded', () => {901 const title = document.querySelector('meta[property="og:title"]').content;902 const elements = document.querySelectorAll('.improvepage');903 const pageurl = window.location.href.split('?')[0];904 elements.forEach(element => {905 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));906 url.searchParams.set('pagetitle', title);907 url.searchParams.set('pageurl', pageurl);908 url.searchParams.set('pagesource', "library/stat.rst");909 element.href = url.toString();910 });911 });912 </script>913 <div role="note" aria-label="source link">914 <h3>This page</h3>915 <ul class="this-page-menu">916 <li><a href="../bugs.html">Report a bug</a></li>917 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>918 <li>919 <a href="https://github.com/python/cpython/blob/main/Doc/library/stat.rst?plain=1"920 rel="nofollow">Show source921 </a>922 </li>923 924 </ul>925 </div>926 </div>927<div id="sidebarbutton" title="Collapse sidebar">928<span>«</span>929</div>930 931 </div>932 <div class="clearer"></div>933 </div> 934 <div class="related" role="navigation" aria-label="Related">935 <h3>Navigation</h3>936 <ul>937 <li class="right" style="margin-right: 10px">938 <a href="../genindex.html" title="General Index"939 >index</a></li>940 <li class="right" >941 <a href="../py-modindex.html" title="Python Module Index"942 >modules</a> |</li>943 <li class="right" >944 <a href="filecmp.html" title="filecmp — File and Directory Comparisons"945 >next</a> |</li>946 <li class="right" >947 <a href="os.path.html" title="os.path — Common pathname manipulations"948 >previous</a> |</li>949 950 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>951 <li><a href="https://www.python.org/">Python</a> »</li>952 <li class="switchers">953 <div class="language_switcher_placeholder"></div>954 <div class="version_switcher_placeholder"></div>955 </li>956 <li>957 958 </li>959 <li id="cpython-language-and-version">960 <a href="../index.html">3.15.0a6 Documentation</a> »961 </li>962 963 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>964 <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> »</li>965 <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>966 <li class="right">967 968 969 <div class="inline-search" role="search">970 <form class="inline-search" action="../search.html" method="get">971 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">972 <input type="submit" value="Go">973 </form>974 </div>975 |976 </li>977 <li class="right">978<label class="theme-selector-label">979 Theme980 <select class="theme-selector" oninput="activateTheme(this.value)">981 <option value="auto" selected>Auto</option>982 <option value="light">Light</option>983 <option value="dark">Dark</option>984 </select>985</label> |</li>986 987 </ul>988 </div> 989 <div class="footer">990 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.991 <br>992 This page is licensed under the Python Software Foundation License Version 2.993 <br>994 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.995 <br>996 997 See <a href="/license.html">History and License</a> for more information.<br>998 999 1000 <br>1001 1002 The Python Software Foundation is a non-profit corporation.1003<a href="https://www.python.org/psf/donations/">Please donate.</a>1004<br>1005 <br>1006 Last updated on Mar 10, 2026 (08:58 UTC).1007 1008 <a href="/bugs.html">Found a bug</a>?1009 1010 <br>1011 1012 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.1013 </div>1014 1015 </body>1016</html>