Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Следить 1
В избранное 0
Вики 捐赠
gooderp18绿色标准版
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
Дерево: 0f75e31513
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/pathlib.html

2009 lines
200KB
Исходник Blame История 

  1. <!DOCTYPE html>

  2. 

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

  4.   <head>

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

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

  7. <meta property="og:title" content="pathlib — Object-oriented filesystem paths" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/pathlib.py This module offers classes representing filesystem paths with semantics appropriate for different operating systems. Path classes are divided between pure paths, which p..." />

  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/pathlib.py This module offers classes representing filesystem paths with semantics appropriate for different operating systems. Path classes are divided between pure paths, which p..." />

  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>pathlib — Object-oriented filesystem paths &#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="os.path — Common pathname manipulations" href="os.path.html" />

  39.     <link rel="prev" title="File and Directory Access" href="filesys.html" />

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

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

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

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

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

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

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

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

  59. 

  60.   </head>

  61. <body>

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

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

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

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

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

  67.             <span></span>

  68.         </label>

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

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

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

  72.             </a>

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

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

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

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

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

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

  80.             </form>

  81.         </span>

  82.     </nav>

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

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

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

  86.             

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

  88.     Theme

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

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

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

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

  93.     </select>

  94. </label>

  95.   <div>

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

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code> — Object-oriented filesystem paths</a><ul>

  99. <li><a class="reference internal" href="#basic-use">Basic use</a></li>

  100. <li><a class="reference internal" href="#pure-paths">Pure paths</a><ul>

  101. <li><a class="reference internal" href="#general-properties">General properties</a></li>

  102. <li><a class="reference internal" href="#operators">Operators</a></li>

  103. <li><a class="reference internal" href="#accessing-individual-parts">Accessing individual parts</a></li>

  104. <li><a class="reference internal" href="#methods-and-properties">Methods and properties</a></li>

  105. </ul>

  106. </li>

  107. <li><a class="reference internal" href="#concrete-paths">Concrete paths</a><ul>

  108. <li><a class="reference internal" href="#methods">Methods</a></li>

  109. </ul>

  110. </li>

  111. <li><a class="reference internal" href="#correspondence-to-tools-in-the-os-module">Correspondence to tools in the <code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code> module</a></li>

  112. </ul>

  113. </li>

  114. </ul>

  115. 

  116.   </div>

  117.   <div>

  118.     <h4>Previous topic</h4>

  119.     <p class="topless"><a href="filesys.html"

  120.                           title="previous chapter">File and Directory Access</a></p>

  121.   </div>

  122.   <div>

  123.     <h4>Next topic</h4>

  124.     <p class="topless"><a href="os.path.html"

  125.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>

  126.   </div>

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

  128.     <h3>This Page</h3>

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

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

  131.       <li>

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

  133.             rel="nofollow">Show Source

  134.         </a>

  135.       </li>

  136.     </ul>

  137.   </div>

  138.         </nav>

  139.     </div>

  140. </div>

  141. 

  142.   

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

  144.       <h3>Navigation</h3>

  145.       <ul>

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

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

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

  149.         <li class="right" >

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

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

  152.         <li class="right" >

  153.           <a href="os.path.html" title="os.path — Common pathname manipulations"

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

  155.         <li class="right" >

  156.           <a href="filesys.html" title="File and Directory Access"

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

  158. 

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

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

  161.           <li class="switchers">

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

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

  164.           </li>

  165.           <li>

  166.               

  167.           </li>

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

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

  170.     </li>

  171. 

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

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

  174.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code> — Object-oriented filesystem paths</a></li>

  175.                 <li class="right">

  176.                     

  177. 

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

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

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

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

  182.         </form>

  183.     </div>

  184.                      |

  185.                 </li>

  186.             <li class="right">

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

  188.     Theme

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

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

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

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

  193.     </select>

  194. </label> |</li>

  195.             

  196.       </ul>

  197.     </div>    

  198. 

  199.     <div class="document">

  200.       <div class="documentwrapper">

  201.         <div class="bodywrapper">

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

  203.             

  204.   <section id="module-pathlib">

  205. <span id="pathlib-object-oriented-filesystem-paths"></span><h1><a class="reference internal" href="#module-pathlib" title="pathlib: Object-oriented filesystem paths"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code></a> — Object-oriented filesystem paths<a class="headerlink" href="#module-pathlib" title="Link to this heading">¶</a></h1>

  206. <div class="versionadded">

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

  208. </div>

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

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

  211. <p>This module offers classes representing filesystem paths with semantics

  212. appropriate for different operating systems.  Path classes are divided

  213. between <a class="reference internal" href="#pure-paths"><span class="std std-ref">pure paths</span></a>, which provide purely computational

  214. operations without I/O, and <a class="reference internal" href="#concrete-paths"><span class="std std-ref">concrete paths</span></a>, which

  215. inherit from pure paths but also provide I/O operations.</p>

  216. <img alt="../_images/pathlib-inheritance.png" class="invert-in-dark-mode align-center" src="../_images/pathlib-inheritance.png" />

  217. <p>If you’ve never used this module before or just aren’t sure which class is

  218. right for your task, <a class="reference internal" href="#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> is most likely what you need. It instantiates

  219. a <a class="reference internal" href="#concrete-paths"><span class="std std-ref">concrete path</span></a> for the platform the code is running on.</p>

  220. <p>Pure paths are useful in some special cases; for example:</p>

  221. <ol class="arabic simple">

  222. <li><p>If you want to manipulate Windows paths on a Unix machine (or vice versa).

  223. You cannot instantiate a <a class="reference internal" href="#pathlib.WindowsPath" title="pathlib.WindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsPath</span></code></a> when running on Unix, but you

  224. can instantiate <a class="reference internal" href="#pathlib.PureWindowsPath" title="pathlib.PureWindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PureWindowsPath</span></code></a>.</p></li>

  225. <li><p>You want to make sure that your code only manipulates paths without actually

  226. accessing the OS. In this case, instantiating one of the pure classes may be

  227. useful since those simply don’t have any OS-accessing operations.</p></li>

  228. </ol>

  229. <div class="admonition seealso">

  230. <p class="admonition-title">See also</p>

  231. <p><span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0428/"><strong>PEP 428</strong></a>: The pathlib module – object-oriented filesystem paths.</p>

  232. </div>

  233. <div class="admonition seealso">

  234. <p class="admonition-title">See also</p>

  235. <p>For low-level path manipulation on strings, you can also use the

  236. <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> module.</p>

  237. </div>

  238. <section id="basic-use">

  239. <h2>Basic use<a class="headerlink" href="#basic-use" title="Link to this heading">¶</a></h2>

  240. <p>Importing the main class:</p>

  241. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>

  242. </pre></div>

  243. </div>

  244. <p>Listing subdirectories:</p>

  245. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>

  246. <span class="gp">&gt;&gt;&gt; </span><span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">p</span><span class="o">.</span><span class="n">iterdir</span><span class="p">()</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">is_dir</span><span class="p">()]</span>

  247. <span class="go">[PosixPath(&#39;.hg&#39;), PosixPath(&#39;docs&#39;), PosixPath(&#39;dist&#39;),</span>

  248. <span class="go"> PosixPath(&#39;__pycache__&#39;), PosixPath(&#39;build&#39;)]</span>

  249. </pre></div>

  250. </div>

  251. <p>Listing Python source files in this directory tree:</p>

  252. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s1">&#39;**/*.py&#39;</span><span class="p">))</span>

  253. <span class="go">[PosixPath(&#39;test_pathlib.py&#39;), PosixPath(&#39;setup.py&#39;),</span>

  254. <span class="go"> PosixPath(&#39;pathlib.py&#39;), PosixPath(&#39;docs/conf.py&#39;),</span>

  255. <span class="go"> PosixPath(&#39;build/lib/pathlib.py&#39;)]</span>

  256. </pre></div>

  257. </div>

  258. <p>Navigating inside a directory tree:</p>

  259. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  260. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">p</span> <span class="o">/</span> <span class="s1">&#39;init.d&#39;</span> <span class="o">/</span> <span class="s1">&#39;reboot&#39;</span>

  261. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span>

  262. <span class="go">PosixPath(&#39;/etc/init.d/reboot&#39;)</span>

  263. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>

  264. <span class="go">PosixPath(&#39;/etc/rc.d/init.d/halt&#39;)</span>

  265. </pre></div>

  266. </div>

  267. <p>Querying path properties:</p>

  268. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>

  269. <span class="go">True</span>

  270. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">is_dir</span><span class="p">()</span>

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

  272. </pre></div>

  273. </div>

  274. <p>Opening a file:</p>

  275. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">q</span><span class="o">.</span><span class="n">open</span><span class="p">()</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>

  276. <span class="gp">...</span>

  277. <span class="go">&#39;#!/bin/bash\n&#39;</span>

  278. </pre></div>

  279. </div>

  280. </section>

  281. <section id="pure-paths">

  282. <span id="id1"></span><h2>Pure paths<a class="headerlink" href="#pure-paths" title="Link to this heading">¶</a></h2>

  283. <p>Pure path objects provide path-handling operations which don’t actually

  284. access a filesystem.  There are three ways to access these classes, which

  285. we also call <em>flavours</em>:</p>

  286. <dl class="py class">

  287. <dt class="sig sig-object py" id="pathlib.PurePath">

  288. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">PurePath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath" title="Link to this definition">¶</a></dt>

  289. <dd><p>A generic class that represents the system’s path flavour (instantiating

  290. it creates either a <a class="reference internal" href="#pathlib.PurePosixPath" title="pathlib.PurePosixPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePosixPath</span></code></a> or a <a class="reference internal" href="#pathlib.PureWindowsPath" title="pathlib.PureWindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PureWindowsPath</span></code></a>):</p>

  291. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>      <span class="c1"># Running on a Unix machine</span>

  292. <span class="go">PurePosixPath(&#39;setup.py&#39;)</span>

  293. </pre></div>

  294. </div>

  295. <p>Each element of <em>pathsegments</em> can be either a string representing a

  296. path segment, or an object implementing the <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code></a> interface

  297. where the <a class="reference internal" href="os.html#os.PathLike.__fspath__" title="os.PathLike.__fspath__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__fspath__()</span></code></a> method returns a string,

  298. such as another path object:</p>

  299. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;some/path&#39;</span><span class="p">,</span> <span class="s1">&#39;bar&#39;</span><span class="p">)</span>

  300. <span class="go">PurePosixPath(&#39;foo/some/path/bar&#39;)</span>

  301. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">),</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;bar&#39;</span><span class="p">))</span>

  302. <span class="go">PurePosixPath(&#39;foo/bar&#39;)</span>

  303. </pre></div>

  304. </div>

  305. <p>When <em>pathsegments</em> is empty, the current directory is assumed:</p>

  306. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">()</span>

  307. <span class="go">PurePosixPath(&#39;.&#39;)</span>

  308. </pre></div>

  309. </div>

  310. <p>If a segment is an absolute path, all previous segments are ignored

  311. (like <a class="reference internal" href="os.path.html#os.path.join" title="os.path.join"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.join()</span></code></a>):</p>

  312. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">,</span> <span class="s1">&#39;/usr&#39;</span><span class="p">,</span> <span class="s1">&#39;lib64&#39;</span><span class="p">)</span>

  313. <span class="go">PurePosixPath(&#39;/usr/lib64&#39;)</span>

  314. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Windows&#39;</span><span class="p">,</span> <span class="s1">&#39;d:bar&#39;</span><span class="p">)</span>

  315. <span class="go">PureWindowsPath(&#39;d:bar&#39;)</span>

  316. </pre></div>

  317. </div>

  318. <p>On Windows, the drive is not reset when a rooted relative path

  319. segment (e.g., <code class="docutils literal notranslate"><span class="pre">r'\foo'</span></code>) is encountered:</p>

  320. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Windows&#39;</span><span class="p">,</span> <span class="s1">&#39;/Program Files&#39;</span><span class="p">)</span>

  321. <span class="go">PureWindowsPath(&#39;c:/Program Files&#39;)</span>

  322. </pre></div>

  323. </div>

  324. <p>Spurious slashes and single dots are collapsed, but double dots (<code class="docutils literal notranslate"><span class="pre">'..'</span></code>)

  325. and leading double slashes (<code class="docutils literal notranslate"><span class="pre">'//'</span></code>) are not, since this would change the

  326. meaning of a path for various reasons (e.g. symbolic links, UNC paths):</p>

  327. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;foo//bar&#39;</span><span class="p">)</span>

  328. <span class="go">PurePosixPath(&#39;foo/bar&#39;)</span>

  329. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;//foo/bar&#39;</span><span class="p">)</span>

  330. <span class="go">PurePosixPath(&#39;//foo/bar&#39;)</span>

  331. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;foo/./bar&#39;</span><span class="p">)</span>

  332. <span class="go">PurePosixPath(&#39;foo/bar&#39;)</span>

  333. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;foo/../bar&#39;</span><span class="p">)</span>

  334. <span class="go">PurePosixPath(&#39;foo/../bar&#39;)</span>

  335. </pre></div>

  336. </div>

  337. <p>(a naïve approach would make <code class="docutils literal notranslate"><span class="pre">PurePosixPath('foo/../bar')</span></code> equivalent

  338. to <code class="docutils literal notranslate"><span class="pre">PurePosixPath('bar')</span></code>, which is wrong if <code class="docutils literal notranslate"><span class="pre">foo</span></code> is a symbolic link

  339. to another directory)</p>

  340. <p>Pure path objects implement the <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code></a> interface, allowing them

  341. to be used anywhere the interface is accepted.</p>

  342. <div class="versionchanged">

  343. <p><span class="versionmodified changed">Changed in version 3.6: </span>Added support for the <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code></a> interface.</p>

  344. </div>

  345. </dd></dl>

  346. 

  347. <dl class="py class">

  348. <dt class="sig sig-object py" id="pathlib.PurePosixPath">

  349. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">PurePosixPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePosixPath" title="Link to this definition">¶</a></dt>

  350. <dd><p>A subclass of <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>, this path flavour represents non-Windows

  351. filesystem paths:</p>

  352. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  353. <span class="go">PurePosixPath(&#39;/etc&#39;)</span>

  354. </pre></div>

  355. </div>

  356. <p><em>pathsegments</em> is specified similarly to <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>.</p>

  357. </dd></dl>

  358. 

  359. <dl class="py class">

  360. <dt class="sig sig-object py" id="pathlib.PureWindowsPath">

  361. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">PureWindowsPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PureWindowsPath" title="Link to this definition">¶</a></dt>

  362. <dd><p>A subclass of <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>, this path flavour represents Windows

  363. filesystem paths, including <a class="reference external" href="https://en.wikipedia.org/wiki/Path_(computing)#UNC">UNC paths</a>:</p>

  364. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/&#39;</span><span class="p">)</span>

  365. <span class="go">PureWindowsPath(&#39;c:/Program Files&#39;)</span>

  366. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//server/share/file&#39;</span><span class="p">)</span>

  367. <span class="go">PureWindowsPath(&#39;//server/share/file&#39;)</span>

  368. </pre></div>

  369. </div>

  370. <p><em>pathsegments</em> is specified similarly to <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>.</p>

  371. </dd></dl>

  372. 

  373. <p>Regardless of the system you’re running on, you can instantiate all of

  374. these classes, since they don’t provide any operation that does system calls.</p>

  375. <section id="general-properties">

  376. <h3>General properties<a class="headerlink" href="#general-properties" title="Link to this heading">¶</a></h3>

  377. <p>Paths are immutable and <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>.  Paths of a same flavour are comparable

  378. and orderable.  These properties respect the flavour’s case-folding

  379. semantics:</p>

  380. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;FOO&#39;</span><span class="p">)</span>

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

  382. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;FOO&#39;</span><span class="p">)</span>

  383. <span class="go">True</span>

  384. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;FOO&#39;</span><span class="p">)</span> <span class="ow">in</span> <span class="p">{</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span> <span class="p">}</span>

  385. <span class="go">True</span>

  386. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;C:&#39;</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;d:&#39;</span><span class="p">)</span>

  387. <span class="go">True</span>

  388. </pre></div>

  389. </div>

  390. <p>Paths of a different flavour compare unequal and cannot be ordered:</p>

  391. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span>

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

  393. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span>

  394. <span class="gt">Traceback (most recent call last):</span>

  395.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  396. <span class="gr">TypeError</span>: <span class="n">&#39;&lt;&#39; not supported between instances of &#39;PureWindowsPath&#39; and &#39;PurePosixPath&#39;</span>

  397. </pre></div>

  398. </div>

  399. </section>

  400. <section id="operators">

  401. <h3>Operators<a class="headerlink" href="#operators" title="Link to this heading">¶</a></h3>

  402. <p>The slash operator helps create child paths, like <a class="reference internal" href="os.path.html#os.path.join" title="os.path.join"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.join()</span></code></a>.

  403. If the argument is an absolute path, the previous path is ignored.

  404. On Windows, the drive is not reset when the argument is a rooted

  405. relative path (e.g., <code class="docutils literal notranslate"><span class="pre">r'\foo'</span></code>):</p>

  406. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  407. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span>

  408. <span class="go">PurePosixPath(&#39;/etc&#39;)</span>

  409. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">/</span> <span class="s1">&#39;init.d&#39;</span> <span class="o">/</span> <span class="s1">&#39;apache2&#39;</span>

  410. <span class="go">PurePosixPath(&#39;/etc/init.d/apache2&#39;)</span>

  411. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;bin&#39;</span><span class="p">)</span>

  412. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;/usr&#39;</span> <span class="o">/</span> <span class="n">q</span>

  413. <span class="go">PurePosixPath(&#39;/usr/bin&#39;)</span>

  414. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">/</span> <span class="s1">&#39;/an_absolute_path&#39;</span>

  415. <span class="go">PurePosixPath(&#39;/an_absolute_path&#39;)</span>

  416. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Windows&#39;</span><span class="p">,</span> <span class="s1">&#39;/Program Files&#39;</span><span class="p">)</span>

  417. <span class="go">PureWindowsPath(&#39;c:/Program Files&#39;)</span>

  418. </pre></div>

  419. </div>

  420. <p>A path object can be used anywhere an object implementing <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code></a>

  421. is accepted:</p>

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

  423. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  424. <span class="gp">&gt;&gt;&gt; </span><span class="n">os</span><span class="o">.</span><span class="n">fspath</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>

  425. <span class="go">&#39;/etc&#39;</span>

  426. </pre></div>

  427. </div>

  428. <p>The string representation of a path is the raw filesystem path itself

  429. (in native form, e.g. with backslashes under Windows), which you can

  430. pass to any function taking a file path as a string:</p>

  431. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  432. <span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>

  433. <span class="go">&#39;/etc&#39;</span>

  434. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files&#39;</span><span class="p">)</span>

  435. <span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>

  436. <span class="go">&#39;c:\\Program Files&#39;</span>

  437. </pre></div>

  438. </div>

  439. <p>Similarly, calling <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> on a path gives the raw filesystem path as a

  440. bytes object, as encoded by <a class="reference internal" href="os.html#os.fsencode" title="os.fsencode"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fsencode()</span></code></a>:</p>

  441. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">bytes</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>

  442. <span class="go">b&#39;/etc&#39;</span>

  443. </pre></div>

  444. </div>

  445. <div class="admonition note">

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

  447. <p>Calling <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> is only recommended under Unix.  Under Windows,

  448. the unicode form is the canonical representation of filesystem paths.</p>

  449. </div>

  450. </section>

  451. <section id="accessing-individual-parts">

  452. <h3>Accessing individual parts<a class="headerlink" href="#accessing-individual-parts" title="Link to this heading">¶</a></h3>

  453. <p>To access the individual “parts” (components) of a path, use the following

  454. property:</p>

  455. <dl class="py attribute">

  456. <dt class="sig sig-object py" id="pathlib.PurePath.parts">

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

  458. <dd><p>A tuple giving access to the path’s various components:</p>

  459. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/usr/bin/python3&#39;</span><span class="p">)</span>

  460. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parts</span>

  461. <span class="go">(&#39;/&#39;, &#39;usr&#39;, &#39;bin&#39;, &#39;python3&#39;)</span>

  462. 

  463. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/PSF&#39;</span><span class="p">)</span>

  464. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parts</span>

  465. <span class="go">(&#39;c:\\&#39;, &#39;Program Files&#39;, &#39;PSF&#39;)</span>

  466. </pre></div>

  467. </div>

  468. <p>(note how the drive and local root are regrouped in a single part)</p>

  469. </dd></dl>

  470. 

  471. </section>

  472. <section id="methods-and-properties">

  473. <h3>Methods and properties<a class="headerlink" href="#methods-and-properties" title="Link to this heading">¶</a></h3>

  474. <p>Pure paths provide the following methods and properties:</p>

  475. <dl class="py attribute">

  476. <dt class="sig sig-object py" id="pathlib.PurePath.drive">

  477. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">drive</span></span><a class="headerlink" href="#pathlib.PurePath.drive" title="Link to this definition">¶</a></dt>

  478. <dd><p>A string representing the drive letter or name, if any:</p>

  479. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">drive</span>

  480. <span class="go">&#39;c:&#39;</span>

  481. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;/Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">drive</span>

  482. <span class="go">&#39;&#39;</span>

  483. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">drive</span>

  484. <span class="go">&#39;&#39;</span>

  485. </pre></div>

  486. </div>

  487. <p>UNC shares are also considered drives:</p>

  488. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//host/share/foo.txt&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">drive</span>

  489. <span class="go">&#39;\\\\host\\share&#39;</span>

  490. </pre></div>

  491. </div>

  492. </dd></dl>

  493. 

  494. <dl class="py attribute">

  495. <dt class="sig sig-object py" id="pathlib.PurePath.root">

  496. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">root</span></span><a class="headerlink" href="#pathlib.PurePath.root" title="Link to this definition">¶</a></dt>

  497. <dd><p>A string representing the (local or global) root, if any:</p>

  498. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  499. <span class="go">&#39;\\&#39;</span>

  500. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  501. <span class="go">&#39;&#39;</span>

  502. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  503. <span class="go">&#39;/&#39;</span>

  504. </pre></div>

  505. </div>

  506. <p>UNC shares always have a root:</p>

  507. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//host/share&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  508. <span class="go">&#39;\\&#39;</span>

  509. </pre></div>

  510. </div>

  511. <p>If the path starts with more than two successive slashes,

  512. <a class="reference internal" href="#pathlib.PurePosixPath" title="pathlib.PurePosixPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePosixPath</span></code></a> collapses them:</p>

  513. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;//etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  514. <span class="go">&#39;//&#39;</span>

  515. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;///etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  516. <span class="go">&#39;/&#39;</span>

  517. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;////etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">root</span>

  518. <span class="go">&#39;/&#39;</span>

  519. </pre></div>

  520. </div>

  521. <div class="admonition note">

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

  523. <p>This behavior conforms to <em>The Open Group Base Specifications Issue 6</em>,

  524. paragraph <a class="reference external" href="https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11">4.11 Pathname Resolution</a>:</p>

  525. <p><em>“A pathname that begins with two successive slashes may be interpreted in

  526. an implementation-defined manner, although more than two leading slashes

  527. shall be treated as a single slash.”</em></p>

  528. </div>

  529. </dd></dl>

  530. 

  531. <dl class="py attribute">

  532. <dt class="sig sig-object py" id="pathlib.PurePath.anchor">

  533. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">anchor</span></span><a class="headerlink" href="#pathlib.PurePath.anchor" title="Link to this definition">¶</a></dt>

  534. <dd><p>The concatenation of the drive and root:</p>

  535. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">anchor</span>

  536. <span class="go">&#39;c:\\&#39;</span>

  537. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:Program Files/&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">anchor</span>

  538. <span class="go">&#39;c:&#39;</span>

  539. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">anchor</span>

  540. <span class="go">&#39;/&#39;</span>

  541. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//host/share&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">anchor</span>

  542. <span class="go">&#39;\\\\host\\share\\&#39;</span>

  543. </pre></div>

  544. </div>

  545. </dd></dl>

  546. 

  547. <dl class="py attribute">

  548. <dt class="sig sig-object py" id="pathlib.PurePath.parents">

  549. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">parents</span></span><a class="headerlink" href="#pathlib.PurePath.parents" title="Link to this definition">¶</a></dt>

  550. <dd><p>An immutable sequence providing access to the logical ancestors of

  551. the path:</p>

  552. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/foo/bar/setup.py&#39;</span><span class="p">)</span>

  553. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parents</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

  554. <span class="go">PureWindowsPath(&#39;c:/foo/bar&#39;)</span>

  555. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parents</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>

  556. <span class="go">PureWindowsPath(&#39;c:/foo&#39;)</span>

  557. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parents</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>

  558. <span class="go">PureWindowsPath(&#39;c:/&#39;)</span>

  559. </pre></div>

  560. </div>

  561. <div class="versionchanged">

  562. <p><span class="versionmodified changed">Changed in version 3.10: </span>The parents sequence now supports <a class="reference internal" href="../glossary.html#term-slice"><span class="xref std std-term">slices</span></a> and negative index values.</p>

  563. </div>

  564. </dd></dl>

  565. 

  566. <dl class="py attribute">

  567. <dt class="sig sig-object py" id="pathlib.PurePath.parent">

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

  569. <dd><p>The logical parent of the path:</p>

  570. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/a/b/c/d&#39;</span><span class="p">)</span>

  571. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parent</span>

  572. <span class="go">PurePosixPath(&#39;/a/b/c&#39;)</span>

  573. </pre></div>

  574. </div>

  575. <p>You cannot go past an anchor, or empty path:</p>

  576. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>

  577. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parent</span>

  578. <span class="go">PurePosixPath(&#39;/&#39;)</span>

  579. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>

  580. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parent</span>

  581. <span class="go">PurePosixPath(&#39;.&#39;)</span>

  582. </pre></div>

  583. </div>

  584. <div class="admonition note">

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

  586. <p>This is a purely lexical operation, hence the following behaviour:</p>

  587. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;foo/..&#39;</span><span class="p">)</span>

  588. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">parent</span>

  589. <span class="go">PurePosixPath(&#39;foo&#39;)</span>

  590. </pre></div>

  591. </div>

  592. <p>If you want to walk an arbitrary filesystem path upwards, it is

  593. recommended to first call <a class="reference internal" href="#pathlib.Path.resolve" title="pathlib.Path.resolve"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.resolve()</span></code></a> so as to resolve

  594. symlinks and eliminate <code class="docutils literal notranslate"><span class="pre">&quot;..&quot;</span></code> components.</p>

  595. </div>

  596. </dd></dl>

  597. 

  598. <dl class="py attribute">

  599. <dt class="sig sig-object py" id="pathlib.PurePath.name">

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

  601. <dd><p>A string representing the final path component, excluding the drive and

  602. root, if any:</p>

  603. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library/setup.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>

  604. <span class="go">&#39;setup.py&#39;</span>

  605. </pre></div>

  606. </div>

  607. <p>UNC drive names are not considered:</p>

  608. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//some/share/setup.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>

  609. <span class="go">&#39;setup.py&#39;</span>

  610. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//some/share&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>

  611. <span class="go">&#39;&#39;</span>

  612. </pre></div>

  613. </div>

  614. </dd></dl>

  615. 

  616. <dl class="py attribute">

  617. <dt class="sig sig-object py" id="pathlib.PurePath.suffix">

  618. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">suffix</span></span><a class="headerlink" href="#pathlib.PurePath.suffix" title="Link to this definition">¶</a></dt>

  619. <dd><p>The file extension of the final component, if any:</p>

  620. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library/setup.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffix</span>

  621. <span class="go">&#39;.py&#39;</span>

  622. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library.tar.gz&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffix</span>

  623. <span class="go">&#39;.gz&#39;</span>

  624. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffix</span>

  625. <span class="go">&#39;&#39;</span>

  626. </pre></div>

  627. </div>

  628. </dd></dl>

  629. 

  630. <dl class="py attribute">

  631. <dt class="sig sig-object py" id="pathlib.PurePath.suffixes">

  632. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">suffixes</span></span><a class="headerlink" href="#pathlib.PurePath.suffixes" title="Link to this definition">¶</a></dt>

  633. <dd><p>A list of the path’s file extensions:</p>

  634. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library.tar.gar&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffixes</span>

  635. <span class="go">[&#39;.tar&#39;, &#39;.gar&#39;]</span>

  636. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library.tar.gz&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffixes</span>

  637. <span class="go">[&#39;.tar&#39;, &#39;.gz&#39;]</span>

  638. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">suffixes</span>

  639. <span class="go">[]</span>

  640. </pre></div>

  641. </div>

  642. </dd></dl>

  643. 

  644. <dl class="py attribute">

  645. <dt class="sig sig-object py" id="pathlib.PurePath.stem">

  646. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">stem</span></span><a class="headerlink" href="#pathlib.PurePath.stem" title="Link to this definition">¶</a></dt>

  647. <dd><p>The final path component, without its suffix:</p>

  648. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library.tar.gz&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">stem</span>

  649. <span class="go">&#39;library.tar&#39;</span>

  650. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library.tar&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">stem</span>

  651. <span class="go">&#39;library&#39;</span>

  652. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;my/library&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">stem</span>

  653. <span class="go">&#39;library&#39;</span>

  654. </pre></div>

  655. </div>

  656. </dd></dl>

  657. 

  658. <dl class="py method">

  659. <dt class="sig sig-object py" id="pathlib.PurePath.as_posix">

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

  661. <dd><p>Return a string representation of the path with forward slashes (<code class="docutils literal notranslate"><span class="pre">/</span></code>):</p>

  662. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:</span><span class="se">\\</span><span class="s1">windows&#39;</span><span class="p">)</span>

  663. <span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>

  664. <span class="go">&#39;c:\\windows&#39;</span>

  665. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">as_posix</span><span class="p">()</span>

  666. <span class="go">&#39;c:/windows&#39;</span>

  667. </pre></div>

  668. </div>

  669. </dd></dl>

  670. 

  671. <dl class="py method">

  672. <dt class="sig sig-object py" id="pathlib.PurePath.as_uri">

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

  674. <dd><p>Represent the path as a <code class="docutils literal notranslate"><span class="pre">file</span></code> URI.  <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if

  675. the path isn’t absolute.</p>

  676. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc/passwd&#39;</span><span class="p">)</span>

  677. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">as_uri</span><span class="p">()</span>

  678. <span class="go">&#39;file:///etc/passwd&#39;</span>

  679. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Windows&#39;</span><span class="p">)</span>

  680. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">as_uri</span><span class="p">()</span>

  681. <span class="go">&#39;file:///c:/Windows&#39;</span>

  682. </pre></div>

  683. </div>

  684. </dd></dl>

  685. 

  686. <dl class="py method">

  687. <dt class="sig sig-object py" id="pathlib.PurePath.is_absolute">

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

  689. <dd><p>Return whether the path is absolute or not.  A path is considered absolute

  690. if it has both a root and (if the flavour allows) a drive:</p>

  691. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/a/b&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

  692. <span class="go">True</span>

  693. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;a/b&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

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

  695. 

  696. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/a/b&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

  697. <span class="go">True</span>

  698. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;/a/b&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

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

  700. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

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

  702. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;//some/share&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_absolute</span><span class="p">()</span>

  703. <span class="go">True</span>

  704. </pre></div>

  705. </div>

  706. </dd></dl>

  707. 

  708. <dl class="py method">

  709. <dt class="sig sig-object py" id="pathlib.PurePath.is_relative_to">

  710. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">is_relative_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.is_relative_to" title="Link to this definition">¶</a></dt>

  711. <dd><p>Return whether or not this path is relative to the <em>other</em> path.</p>

  712. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/etc/passwd&#39;</span><span class="p">)</span>

  713. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">is_relative_to</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  714. <span class="go">True</span>

  715. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">is_relative_to</span><span class="p">(</span><span class="s1">&#39;/usr&#39;</span><span class="p">)</span>

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

  717. </pre></div>

  718. </div>

  719. <p>This method is string-based; it neither accesses the filesystem nor treats

  720. “<code class="docutils literal notranslate"><span class="pre">..</span></code>” segments specially. The following code is equivalent:</p>

  721. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">u</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/usr&#39;</span><span class="p">)</span>

  722. <span class="gp">&gt;&gt;&gt; </span><span class="n">u</span> <span class="o">==</span> <span class="n">p</span> <span class="ow">or</span> <span class="n">u</span> <span class="ow">in</span> <span class="n">p</span><span class="o">.</span><span class="n">parents</span>

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

  724. </pre></div>

  725. </div>

  726. <div class="versionadded">

  727. <p><span class="versionmodified added">New in version 3.9.</span></p>

  728. </div>

  729. <div class="deprecated-removed">

  730. <p><span class="versionmodified">Deprecated since version 3.12, will be removed in version 3.14: </span>Passing additional arguments is deprecated; if supplied, they are joined

  731. with <em>other</em>.</p>

  732. </div>

  733. </dd></dl>

  734. 

  735. <dl class="py method">

  736. <dt class="sig sig-object py" id="pathlib.PurePath.is_reserved">

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

  738. <dd><p>With <a class="reference internal" href="#pathlib.PureWindowsPath" title="pathlib.PureWindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PureWindowsPath</span></code></a>, return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path is considered

  739. reserved under Windows, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.  With <a class="reference internal" href="#pathlib.PurePosixPath" title="pathlib.PurePosixPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePosixPath</span></code></a>,

  740. <code class="docutils literal notranslate"><span class="pre">False</span></code> is always returned.</p>

  741. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;nul&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_reserved</span><span class="p">()</span>

  742. <span class="go">True</span>

  743. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;nul&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_reserved</span><span class="p">()</span>

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

  745. </pre></div>

  746. </div>

  747. <p>File system calls on reserved paths can fail mysteriously or have

  748. unintended effects.</p>

  749. </dd></dl>

  750. 

  751. <dl class="py method">

  752. <dt class="sig sig-object py" id="pathlib.PurePath.joinpath">

  753. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">joinpath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.joinpath" title="Link to this definition">¶</a></dt>

  754. <dd><p>Calling this method is equivalent to combining the path with each of

  755. the given <em>pathsegments</em> in turn:</p>

  756. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;passwd&#39;</span><span class="p">)</span>

  757. <span class="go">PurePosixPath(&#39;/etc/passwd&#39;)</span>

  758. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;passwd&#39;</span><span class="p">))</span>

  759. <span class="go">PurePosixPath(&#39;/etc/passwd&#39;)</span>

  760. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;init.d&#39;</span><span class="p">,</span> <span class="s1">&#39;apache2&#39;</span><span class="p">)</span>

  761. <span class="go">PurePosixPath(&#39;/etc/init.d/apache2&#39;)</span>

  762. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;/Program Files&#39;</span><span class="p">)</span>

  763. <span class="go">PureWindowsPath(&#39;c:/Program Files&#39;)</span>

  764. </pre></div>

  765. </div>

  766. </dd></dl>

  767. 

  768. <dl class="py method">

  769. <dt class="sig sig-object py" id="pathlib.PurePath.match">

  770. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">match</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.match" title="Link to this definition">¶</a></dt>

  771. <dd><p>Match this path against the provided glob-style pattern.  Return <code class="docutils literal notranslate"><span class="pre">True</span></code>

  772. if matching is successful, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>

  773. <p>If <em>pattern</em> is relative, the path can be either relative or absolute,

  774. and matching is done from the right:</p>

  775. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;a/b.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;*.py&#39;</span><span class="p">)</span>

  776. <span class="go">True</span>

  777. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/a/b/c.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;b/*.py&#39;</span><span class="p">)</span>

  778. <span class="go">True</span>

  779. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/a/b/c.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;a/*.py&#39;</span><span class="p">)</span>

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

  781. </pre></div>

  782. </div>

  783. <p>If <em>pattern</em> is absolute, the path must be absolute, and the whole path

  784. must match:</p>

  785. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;/a.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;/*.py&#39;</span><span class="p">)</span>

  786. <span class="go">True</span>

  787. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;a/b.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;/*.py&#39;</span><span class="p">)</span>

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

  789. </pre></div>

  790. </div>

  791. <p>The <em>pattern</em> may be another path object; this speeds up matching the same

  792. pattern against multiple files:</p>

  793. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pattern</span> <span class="o">=</span> <span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;*.py&#39;</span><span class="p">)</span>

  794. <span class="gp">&gt;&gt;&gt; </span><span class="n">PurePath</span><span class="p">(</span><span class="s1">&#39;a/b.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">pattern</span><span class="p">)</span>

  795. <span class="go">True</span>

  796. </pre></div>

  797. </div>

  798. <div class="versionchanged">

  799. <p><span class="versionmodified changed">Changed in version 3.12: </span>Accepts an object implementing the <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.PathLike</span></code></a> interface.</p>

  800. </div>

  801. <p>As with other methods, case-sensitivity follows platform defaults:</p>

  802. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;b.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;*.PY&#39;</span><span class="p">)</span>

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

  804. <span class="gp">&gt;&gt;&gt; </span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;b.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">&#39;*.PY&#39;</span><span class="p">)</span>

  805. <span class="go">True</span>

  806. </pre></div>

  807. </div>

  808. <p>Set <em>case_sensitive</em> to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code> to override this behaviour.</p>

  809. <div class="versionchanged">

  810. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <em>case_sensitive</em> parameter was added.</p>

  811. </div>

  812. </dd></dl>

  813. 

  814. <dl class="py method">

  815. <dt class="sig sig-object py" id="pathlib.PurePath.relative_to">

  816. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">relative_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">walk_up</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.relative_to" title="Link to this definition">¶</a></dt>

  817. <dd><p>Compute a version of this path relative to the path represented by

  818. <em>other</em>.  If it’s impossible, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised:</p>

  819. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PurePosixPath</span><span class="p">(</span><span class="s1">&#39;/etc/passwd&#39;</span><span class="p">)</span>

  820. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>

  821. <span class="go">PurePosixPath(&#39;etc/passwd&#39;)</span>

  822. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  823. <span class="go">PurePosixPath(&#39;passwd&#39;)</span>

  824. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="s1">&#39;/usr&#39;</span><span class="p">)</span>

  825. <span class="gt">Traceback (most recent call last):</span>

  826.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  827.   File <span class="nb">&quot;pathlib.py&quot;</span>, line <span class="m">941</span>, in <span class="n">relative_to</span>

  828. <span class="w">    </span><span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_message</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">formatted</span><span class="p">)))</span>

  829. <span class="gr">ValueError</span>: <span class="n">&#39;/etc/passwd&#39; is not in the subpath of &#39;/usr&#39; OR one path is relative and the other is absolute.</span>

  830. </pre></div>

  831. </div>

  832. <p>When <em>walk_up</em> is False (the default), the path must start with <em>other</em>.

  833. When the argument is True, <code class="docutils literal notranslate"><span class="pre">..</span></code> entries may be added to form the

  834. relative path. In all other cases, such as the paths referencing

  835. different drives, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised.:</p>

  836. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="s1">&#39;/usr&#39;</span><span class="p">,</span> <span class="n">walk_up</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  837. <span class="go">PurePosixPath(&#39;../etc/passwd&#39;)</span>

  838. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">relative_to</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">walk_up</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  839. <span class="gt">Traceback (most recent call last):</span>

  840.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  841.   File <span class="nb">&quot;pathlib.py&quot;</span>, line <span class="m">941</span>, in <span class="n">relative_to</span>

  842. <span class="w">    </span><span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_message</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">formatted</span><span class="p">)))</span>

  843. <span class="gr">ValueError</span>: <span class="n">&#39;/etc/passwd&#39; is not on the same drive as &#39;foo&#39; OR one path is relative and the other is absolute.</span>

  844. </pre></div>

  845. </div>

  846. <div class="admonition warning">

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

  848. <p>This function is part of <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a> and works with strings.

  849. It does not check or access the underlying file structure.

  850. This can impact the <em>walk_up</em> option as it assumes that no symlinks

  851. are present in the path; call <a class="reference internal" href="#pathlib.Path.resolve" title="pathlib.Path.resolve"><code class="xref py py-meth docutils literal notranslate"><span class="pre">resolve()</span></code></a> first if

  852. necessary to resolve symlinks.</p>

  853. </div>

  854. <div class="versionchanged">

  855. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <em>walk_up</em> parameter was added (old behavior is the same as <code class="docutils literal notranslate"><span class="pre">walk_up=False</span></code>).</p>

  856. </div>

  857. <div class="deprecated-removed">

  858. <p><span class="versionmodified">Deprecated since version 3.12, will be removed in version 3.14: </span>Passing additional positional arguments is deprecated; if supplied,

  859. they are joined with <em>other</em>.</p>

  860. </div>

  861. </dd></dl>

  862. 

  863. <dl class="py method">

  864. <dt class="sig sig-object py" id="pathlib.PurePath.with_name">

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

  866. <dd><p>Return a new path with the <a class="reference internal" href="#pathlib.PurePath.name" title="pathlib.PurePath.name"><code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code></a> changed.  If the original path

  867. doesn’t have a name, ValueError is raised:</p>

  868. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Downloads/pathlib.tar.gz&#39;</span><span class="p">)</span>

  869. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  870. <span class="go">PureWindowsPath(&#39;c:/Downloads/setup.py&#39;)</span>

  871. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/&#39;</span><span class="p">)</span>

  872. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  873. <span class="gt">Traceback (most recent call last):</span>

  874.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  875.   File <span class="nb">&quot;/home/antoine/cpython/default/Lib/pathlib.py&quot;</span>, line <span class="m">751</span>, in <span class="n">with_name</span>

  876. <span class="w">    </span><span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%r</span><span class="s2"> has an empty name&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="p">,))</span>

  877. <span class="gr">ValueError</span>: <span class="n">PureWindowsPath(&#39;c:/&#39;) has an empty name</span>

  878. </pre></div>

  879. </div>

  880. </dd></dl>

  881. 

  882. <dl class="py method">

  883. <dt class="sig sig-object py" id="pathlib.PurePath.with_stem">

  884. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">with_stem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stem</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.with_stem" title="Link to this definition">¶</a></dt>

  885. <dd><p>Return a new path with the <a class="reference internal" href="#pathlib.PurePath.stem" title="pathlib.PurePath.stem"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stem</span></code></a> changed.  If the original path

  886. doesn’t have a name, ValueError is raised:</p>

  887. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Downloads/draft.txt&#39;</span><span class="p">)</span>

  888. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_stem</span><span class="p">(</span><span class="s1">&#39;final&#39;</span><span class="p">)</span>

  889. <span class="go">PureWindowsPath(&#39;c:/Downloads/final.txt&#39;)</span>

  890. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Downloads/pathlib.tar.gz&#39;</span><span class="p">)</span>

  891. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_stem</span><span class="p">(</span><span class="s1">&#39;lib&#39;</span><span class="p">)</span>

  892. <span class="go">PureWindowsPath(&#39;c:/Downloads/lib.gz&#39;)</span>

  893. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/&#39;</span><span class="p">)</span>

  894. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_stem</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>

  895. <span class="gt">Traceback (most recent call last):</span>

  896.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  897.   File <span class="nb">&quot;/home/antoine/cpython/default/Lib/pathlib.py&quot;</span>, line <span class="m">861</span>, in <span class="n">with_stem</span>

  898. <span class="w">    </span><span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">with_name</span><span class="p">(</span><span class="n">stem</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">suffix</span><span class="p">)</span>

  899.   File <span class="nb">&quot;/home/antoine/cpython/default/Lib/pathlib.py&quot;</span>, line <span class="m">851</span>, in <span class="n">with_name</span>

  900. <span class="w">    </span><span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%r</span><span class="s2"> has an empty name&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="p">,))</span>

  901. <span class="gr">ValueError</span>: <span class="n">PureWindowsPath(&#39;c:/&#39;) has an empty name</span>

  902. </pre></div>

  903. </div>

  904. <div class="versionadded">

  905. <p><span class="versionmodified added">New in version 3.9.</span></p>

  906. </div>

  907. </dd></dl>

  908. 

  909. <dl class="py method">

  910. <dt class="sig sig-object py" id="pathlib.PurePath.with_suffix">

  911. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">with_suffix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">suffix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.with_suffix" title="Link to this definition">¶</a></dt>

  912. <dd><p>Return a new path with the <a class="reference internal" href="#pathlib.PurePath.suffix" title="pathlib.PurePath.suffix"><code class="xref py py-attr docutils literal notranslate"><span class="pre">suffix</span></code></a> changed.  If the original path

  913. doesn’t have a suffix, the new <em>suffix</em> is appended instead.  If the

  914. <em>suffix</em> is an empty string, the original suffix is removed:</p>

  915. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Downloads/pathlib.tar.gz&#39;</span><span class="p">)</span>

  916. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_suffix</span><span class="p">(</span><span class="s1">&#39;.bz2&#39;</span><span class="p">)</span>

  917. <span class="go">PureWindowsPath(&#39;c:/Downloads/pathlib.tar.bz2&#39;)</span>

  918. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;README&#39;</span><span class="p">)</span>

  919. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_suffix</span><span class="p">(</span><span class="s1">&#39;.txt&#39;</span><span class="p">)</span>

  920. <span class="go">PureWindowsPath(&#39;README.txt&#39;)</span>

  921. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PureWindowsPath</span><span class="p">(</span><span class="s1">&#39;README.txt&#39;</span><span class="p">)</span>

  922. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">with_suffix</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">)</span>

  923. <span class="go">PureWindowsPath(&#39;README&#39;)</span>

  924. </pre></div>

  925. </div>

  926. </dd></dl>

  927. 

  928. <dl class="py method">

  929. <dt class="sig sig-object py" id="pathlib.PurePath.with_segments">

  930. <span class="sig-prename descclassname"><span class="pre">PurePath.</span></span><span class="sig-name descname"><span class="pre">with_segments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PurePath.with_segments" title="Link to this definition">¶</a></dt>

  931. <dd><p>Create a new path object of the same type by combining the given

  932. <em>pathsegments</em>. This method is called whenever a derivative path is created,

  933. such as from <a class="reference internal" href="#pathlib.PurePath.parent" title="pathlib.PurePath.parent"><code class="xref py py-attr docutils literal notranslate"><span class="pre">parent</span></code></a> and <a class="reference internal" href="#pathlib.PurePath.relative_to" title="pathlib.PurePath.relative_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">relative_to()</span></code></a>. Subclasses may

  934. override this method to pass information to derivative paths, for example:</p>

  935. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">PurePosixPath</span>

  936. 

  937. <span class="k">class</span> <span class="nc">MyPath</span><span class="p">(</span><span class="n">PurePosixPath</span><span class="p">):</span>

  938.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">pathsegments</span><span class="p">,</span> <span class="n">session_id</span><span class="p">):</span>

  939.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">pathsegments</span><span class="p">)</span>

  940.         <span class="bp">self</span><span class="o">.</span><span class="n">session_id</span> <span class="o">=</span> <span class="n">session_id</span>

  941. 

  942.     <span class="k">def</span> <span class="nf">with_segments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">pathsegments</span><span class="p">):</span>

  943.         <span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)(</span><span class="o">*</span><span class="n">pathsegments</span><span class="p">,</span> <span class="n">session_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">session_id</span><span class="p">)</span>

  944. 

  945. <span class="n">etc</span> <span class="o">=</span> <span class="n">MyPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">,</span> <span class="n">session_id</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>

  946. <span class="n">hosts</span> <span class="o">=</span> <span class="n">etc</span> <span class="o">/</span> <span class="s1">&#39;hosts&#39;</span>

  947. <span class="nb">print</span><span class="p">(</span><span class="n">hosts</span><span class="o">.</span><span class="n">session_id</span><span class="p">)</span>  <span class="c1"># 42</span>

  948. </pre></div>

  949. </div>

  950. <div class="versionadded">

  951. <p><span class="versionmodified added">New in version 3.12.</span></p>

  952. </div>

  953. </dd></dl>

  954. 

  955. </section>

  956. </section>

  957. <section id="concrete-paths">

  958. <span id="id2"></span><h2>Concrete paths<a class="headerlink" href="#concrete-paths" title="Link to this heading">¶</a></h2>

  959. <p>Concrete paths are subclasses of the pure path classes.  In addition to

  960. operations provided by the latter, they also provide methods to do system

  961. calls on path objects.  There are three ways to instantiate concrete paths:</p>

  962. <dl class="py class">

  963. <dt class="sig sig-object py" id="pathlib.Path">

  964. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">Path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path" title="Link to this definition">¶</a></dt>

  965. <dd><p>A subclass of <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>, this class represents concrete paths of

  966. the system’s path flavour (instantiating it creates either a

  967. <a class="reference internal" href="#pathlib.PosixPath" title="pathlib.PosixPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PosixPath</span></code></a> or a <a class="reference internal" href="#pathlib.WindowsPath" title="pathlib.WindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowsPath</span></code></a>):</p>

  968. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  969. <span class="go">PosixPath(&#39;setup.py&#39;)</span>

  970. </pre></div>

  971. </div>

  972. <p><em>pathsegments</em> is specified similarly to <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>.</p>

  973. </dd></dl>

  974. 

  975. <dl class="py class">

  976. <dt class="sig sig-object py" id="pathlib.PosixPath">

  977. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">PosixPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.PosixPath" title="Link to this definition">¶</a></dt>

  978. <dd><p>A subclass of <a class="reference internal" href="#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> and <a class="reference internal" href="#pathlib.PurePosixPath" title="pathlib.PurePosixPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePosixPath</span></code></a>, this class

  979. represents concrete non-Windows filesystem paths:</p>

  980. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">PosixPath</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span>

  981. <span class="go">PosixPath(&#39;/etc&#39;)</span>

  982. </pre></div>

  983. </div>

  984. <p><em>pathsegments</em> is specified similarly to <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>.</p>

  985. </dd></dl>

  986. 

  987. <dl class="py class">

  988. <dt class="sig sig-object py" id="pathlib.WindowsPath">

  989. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pathlib.</span></span><span class="sig-name descname"><span class="pre">WindowsPath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.WindowsPath" title="Link to this definition">¶</a></dt>

  990. <dd><p>A subclass of <a class="reference internal" href="#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> and <a class="reference internal" href="#pathlib.PureWindowsPath" title="pathlib.PureWindowsPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PureWindowsPath</span></code></a>, this class

  991. represents concrete Windows filesystem paths:</p>

  992. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">WindowsPath</span><span class="p">(</span><span class="s1">&#39;c:/Program Files/&#39;</span><span class="p">)</span>

  993. <span class="go">WindowsPath(&#39;c:/Program Files&#39;)</span>

  994. </pre></div>

  995. </div>

  996. <p><em>pathsegments</em> is specified similarly to <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>.</p>

  997. </dd></dl>

  998. 

  999. <p>You can only instantiate the class flavour that corresponds to your system

  1000. (allowing system calls on non-compatible path flavours could lead to

  1001. bugs or failures in your application):</p>

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

  1003. <span class="gp">&gt;&gt;&gt; </span><span class="n">os</span><span class="o">.</span><span class="n">name</span>

  1004. <span class="go">&#39;posix&#39;</span>

  1005. <span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1006. <span class="go">PosixPath(&#39;setup.py&#39;)</span>

  1007. <span class="gp">&gt;&gt;&gt; </span><span class="n">PosixPath</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1008. <span class="go">PosixPath(&#39;setup.py&#39;)</span>

  1009. <span class="gp">&gt;&gt;&gt; </span><span class="n">WindowsPath</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1010. <span class="gt">Traceback (most recent call last):</span>

  1011.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  1012.   File <span class="nb">&quot;pathlib.py&quot;</span>, line <span class="m">798</span>, in <span class="n">__new__</span>

  1013. <span class="w">    </span><span class="o">%</span> <span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,))</span>

  1014. <span class="gr">NotImplementedError</span>: <span class="n">cannot instantiate &#39;WindowsPath&#39; on your system</span>

  1015. </pre></div>

  1016. </div>

  1017. <section id="methods">

  1018. <h3>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶</a></h3>

  1019. <p>Concrete paths provide the following methods in addition to pure paths

  1020. methods.  Many of these methods can raise an <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> if a system

  1021. call fails (for example because the path doesn’t exist).</p>

  1022. <div class="versionchanged">

  1023. <p><span class="versionmodified changed">Changed in version 3.8: </span><a class="reference internal" href="#pathlib.Path.exists" title="pathlib.Path.exists"><code class="xref py py-meth docutils literal notranslate"><span class="pre">exists()</span></code></a>, <a class="reference internal" href="#pathlib.Path.is_dir" title="pathlib.Path.is_dir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_dir()</span></code></a>, <a class="reference internal" href="#pathlib.Path.is_file" title="pathlib.Path.is_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_file()</span></code></a>,

  1024. <a class="reference internal" href="#pathlib.Path.is_mount" title="pathlib.Path.is_mount"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_mount()</span></code></a>, <a class="reference internal" href="#pathlib.Path.is_symlink" title="pathlib.Path.is_symlink"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_symlink()</span></code></a>,

  1025. <a class="reference internal" href="#pathlib.Path.is_block_device" title="pathlib.Path.is_block_device"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_block_device()</span></code></a>, <a class="reference internal" href="#pathlib.Path.is_char_device" title="pathlib.Path.is_char_device"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_char_device()</span></code></a>,

  1026. <a class="reference internal" href="#pathlib.Path.is_fifo" title="pathlib.Path.is_fifo"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_fifo()</span></code></a>, <a class="reference internal" href="#pathlib.Path.is_socket" title="pathlib.Path.is_socket"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_socket()</span></code></a> now return <code class="docutils literal notranslate"><span class="pre">False</span></code>

  1027. instead of raising an exception for paths that contain characters

  1028. unrepresentable at the OS level.</p>

  1029. </div>

  1030. <dl class="py method">

  1031. <dt class="sig sig-object py" id="pathlib.Path.cwd">

  1032. <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">cwd</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.cwd" title="Link to this definition">¶</a></dt>

  1033. <dd><p>Return a new path object representing the current directory (as returned

  1034. by <a class="reference internal" href="os.html#os.getcwd" title="os.getcwd"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.getcwd()</span></code></a>):</p>

  1035. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">()</span>

  1036. <span class="go">PosixPath(&#39;/home/antoine/pathlib&#39;)</span>

  1037. </pre></div>

  1038. </div>

  1039. </dd></dl>

  1040. 

  1041. <dl class="py method">

  1042. <dt class="sig sig-object py" id="pathlib.Path.home">

  1043. <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">home</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.home" title="Link to this definition">¶</a></dt>

  1044. <dd><p>Return a new path object representing the user’s home directory (as

  1045. returned by <a class="reference internal" href="os.path.html#os.path.expanduser" title="os.path.expanduser"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.expanduser()</span></code></a> with <code class="docutils literal notranslate"><span class="pre">~</span></code> construct). If the home

  1046. directory can’t be resolved, <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> is raised.</p>

  1047. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="o">.</span><span class="n">home</span><span class="p">()</span>

  1048. <span class="go">PosixPath(&#39;/home/antoine&#39;)</span>

  1049. </pre></div>

  1050. </div>

  1051. <div class="versionadded">

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

  1053. </div>

  1054. </dd></dl>

  1055. 

  1056. <dl class="py method">

  1057. <dt class="sig sig-object py" id="pathlib.Path.stat">

  1058. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">stat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">follow_symlinks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.stat" title="Link to this definition">¶</a></dt>

  1059. <dd><p>Return a <a class="reference internal" href="os.html#os.stat_result" title="os.stat_result"><code class="xref py py-class docutils literal notranslate"><span class="pre">os.stat_result</span></code></a> object containing information about this path, like <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>.

  1060. The result is looked up at each call to this method.</p>

  1061. <p>This method normally follows symlinks; to stat a symlink add the argument

  1062. <code class="docutils literal notranslate"><span class="pre">follow_symlinks=False</span></code>, or use <a class="reference internal" href="#pathlib.Path.lstat" title="pathlib.Path.lstat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">lstat()</span></code></a>.</p>

  1063. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1064. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span>

  1065. <span class="go">956</span>

  1066. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_mtime</span>

  1067. <span class="go">1327883547.852554</span>

  1068. </pre></div>

  1069. </div>

  1070. <div class="versionchanged">

  1071. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <em>follow_symlinks</em> parameter was added.</p>

  1072. </div>

  1073. </dd></dl>

  1074. 

  1075. <dl class="py method">

  1076. <dt class="sig sig-object py" id="pathlib.Path.chmod">

  1077. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">chmod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">follow_symlinks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.chmod" title="Link to this definition">¶</a></dt>

  1078. <dd><p>Change the file mode and permissions, like <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>

  1079. <p>This method normally follows symlinks. Some Unix flavours support changing

  1080. permissions on the symlink itself; on these platforms you may add the

  1081. argument <code class="docutils literal notranslate"><span class="pre">follow_symlinks=False</span></code>, or use <a class="reference internal" href="#pathlib.Path.lchmod" title="pathlib.Path.lchmod"><code class="xref py py-meth docutils literal notranslate"><span class="pre">lchmod()</span></code></a>.</p>

  1082. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1083. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_mode</span>

  1084. <span class="go">33277</span>

  1085. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="mo">0o444</span><span class="p">)</span>

  1086. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_mode</span>

  1087. <span class="go">33060</span>

  1088. </pre></div>

  1089. </div>

  1090. <div class="versionchanged">

  1091. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <em>follow_symlinks</em> parameter was added.</p>

  1092. </div>

  1093. </dd></dl>

  1094. 

  1095. <dl class="py method">

  1096. <dt class="sig sig-object py" id="pathlib.Path.exists">

  1097. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">follow_symlinks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.exists" title="Link to this definition">¶</a></dt>

  1098. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to an existing file or directory.</p>

  1099. <p>This method normally follows symlinks; to check if a symlink exists, add

  1100. the argument <code class="docutils literal notranslate"><span class="pre">follow_symlinks=False</span></code>.</p>

  1101. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>

  1102. <span class="go">True</span>

  1103. <span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>

  1104. <span class="go">True</span>

  1105. <span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;/etc&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>

  1106. <span class="go">True</span>

  1107. <span class="gp">&gt;&gt;&gt; </span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;nonexistentfile&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>

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

  1109. </pre></div>

  1110. </div>

  1111. <div class="versionchanged">

  1112. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <em>follow_symlinks</em> parameter was added.</p>

  1113. </div>

  1114. </dd></dl>

  1115. 

  1116. <dl class="py method">

  1117. <dt class="sig sig-object py" id="pathlib.Path.expanduser">

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

  1119. <dd><p>Return a new path with expanded <code class="docutils literal notranslate"><span class="pre">~</span></code> and <code class="docutils literal notranslate"><span class="pre">~user</span></code> constructs,

  1120. as returned by <a class="reference internal" href="os.path.html#os.path.expanduser" title="os.path.expanduser"><code class="xref py py-meth docutils literal notranslate"><span class="pre">os.path.expanduser()</span></code></a>. If a home directory can’t be

  1121. resolved, <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> is raised.</p>

  1122. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">PosixPath</span><span class="p">(</span><span class="s1">&#39;~/films/Monty Python&#39;</span><span class="p">)</span>

  1123. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">expanduser</span><span class="p">()</span>

  1124. <span class="go">PosixPath(&#39;/home/eric/films/Monty Python&#39;)</span>

  1125. </pre></div>

  1126. </div>

  1127. <div class="versionadded">

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

  1129. </div>

  1130. </dd></dl>

  1131. 

  1132. <dl class="py method">

  1133. <dt class="sig sig-object py" id="pathlib.Path.glob">

  1134. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">glob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.glob" title="Link to this definition">¶</a></dt>

  1135. <dd><p>Glob the given relative <em>pattern</em> in the directory represented by this path,

  1136. yielding all matching files (of any kind):</p>

  1137. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">sorted</span><span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s1">&#39;*.py&#39;</span><span class="p">))</span>

  1138. <span class="go">[PosixPath(&#39;pathlib.py&#39;), PosixPath(&#39;setup.py&#39;), PosixPath(&#39;test_pathlib.py&#39;)]</span>

  1139. <span class="gp">&gt;&gt;&gt; </span><span class="nb">sorted</span><span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s1">&#39;*/*.py&#39;</span><span class="p">))</span>

  1140. <span class="go">[PosixPath(&#39;docs/conf.py&#39;)]</span>

  1141. </pre></div>

  1142. </div>

  1143. <p>Patterns are the same as for <a class="reference internal" href="fnmatch.html#module-fnmatch" title="fnmatch: Unix shell style filename pattern matching."><code class="xref py py-mod docutils literal notranslate"><span class="pre">fnmatch</span></code></a>, with the addition of “<code class="docutils literal notranslate"><span class="pre">**</span></code>”

  1144. which means “this directory and all subdirectories, recursively”.  In other

  1145. words, it enables recursive globbing:</p>

  1146. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">sorted</span><span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s1">&#39;**/*.py&#39;</span><span class="p">))</span>

  1147. <span class="go">[PosixPath(&#39;build/lib/pathlib.py&#39;),</span>

  1148. <span class="go"> PosixPath(&#39;docs/conf.py&#39;),</span>

  1149. <span class="go"> PosixPath(&#39;pathlib.py&#39;),</span>

  1150. <span class="go"> PosixPath(&#39;setup.py&#39;),</span>

  1151. <span class="go"> PosixPath(&#39;test_pathlib.py&#39;)]</span>

  1152. </pre></div>

  1153. </div>

  1154. <p>This method calls <a class="reference internal" href="#pathlib.Path.is_dir" title="pathlib.Path.is_dir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.is_dir()</span></code></a> on the top-level directory and

  1155. propagates any <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> exception that is raised. Subsequent

  1156. <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> exceptions from scanning directories are suppressed.</p>

  1157. <p>By default, or when the <em>case_sensitive</em> keyword-only argument is set to

  1158. <code class="docutils literal notranslate"><span class="pre">None</span></code>, this method matches paths using platform-specific casing rules:

  1159. typically, case-sensitive on POSIX, and case-insensitive on Windows.

  1160. Set <em>case_sensitive</em> to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code> to override this behaviour.</p>

  1161. <div class="admonition note">

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

  1163. <p>Using the “<code class="docutils literal notranslate"><span class="pre">**</span></code>” pattern in large directory trees may consume

  1164. an inordinate amount of time.</p>

  1165. </div>

  1166. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">pathlib.Path.glob</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">pattern</span></code>.</p>

  1167. <div class="versionchanged">

  1168. <p><span class="versionmodified changed">Changed in version 3.11: </span>Return only directories if <em>pattern</em> ends with a pathname components

  1169. separator (<a class="reference internal" href="os.html#os.sep" title="os.sep"><code class="xref py py-data docutils literal notranslate"><span class="pre">sep</span></code></a> or <a class="reference internal" href="os.html#os.altsep" title="os.altsep"><code class="xref py py-data docutils literal notranslate"><span class="pre">altsep</span></code></a>).</p>

  1170. </div>

  1171. <div class="versionchanged">

  1172. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <em>case_sensitive</em> parameter was added.</p>

  1173. </div>

  1174. </dd></dl>

  1175. 

  1176. <dl class="py method">

  1177. <dt class="sig sig-object py" id="pathlib.Path.group">

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

  1179. <dd><p>Return the name of the group owning the file.  <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is raised

  1180. if the file’s gid isn’t found in the system database.</p>

  1181. </dd></dl>

  1182. 

  1183. <dl class="py method">

  1184. <dt class="sig sig-object py" id="pathlib.Path.is_dir">

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

  1186. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a directory (or a symbolic link

  1187. pointing to a directory), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1188. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1189. other errors (such as permission errors) are propagated.</p>

  1190. </dd></dl>

  1191. 

  1192. <dl class="py method">

  1193. <dt class="sig sig-object py" id="pathlib.Path.is_file">

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

  1195. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a regular file (or a symbolic link

  1196. pointing to a regular file), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1197. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1198. other errors (such as permission errors) are propagated.</p>

  1199. </dd></dl>

  1200. 

  1201. <dl class="py method">

  1202. <dt class="sig sig-object py" id="pathlib.Path.is_junction">

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

  1204. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a junction, and <code class="docutils literal notranslate"><span class="pre">False</span></code> for any other

  1205. type of file. Currently only Windows supports junctions.</p>

  1206. <div class="versionadded">

  1207. <p><span class="versionmodified added">New in version 3.12.</span></p>

  1208. </div>

  1209. </dd></dl>

  1210. 

  1211. <dl class="py method">

  1212. <dt class="sig sig-object py" id="pathlib.Path.is_mount">

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

  1214. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path is a <em class="dfn">mount point</em>: a point in a

  1215. file system where a different file system has been mounted.  On POSIX, the

  1216. function checks whether <em>path</em>’s parent, <code class="file docutils literal notranslate"><span class="pre">path/..</span></code>, is on a different

  1217. device than <em>path</em>, or whether <code class="file docutils literal notranslate"><span class="pre">path/..</span></code> and <em>path</em> point to the same

  1218. i-node on the same device — this should detect mount points for all Unix

  1219. and POSIX variants.  On Windows, a mount point is considered to be a drive

  1220. letter root (e.g. <code class="docutils literal notranslate"><span class="pre">c:\</span></code>), a UNC share (e.g. <code class="docutils literal notranslate"><span class="pre">\\server\share</span></code>), or a

  1221. mounted filesystem directory.</p>

  1222. <div class="versionadded">

  1223. <p><span class="versionmodified added">New in version 3.7.</span></p>

  1224. </div>

  1225. <div class="versionchanged">

  1226. <p><span class="versionmodified changed">Changed in version 3.12: </span>Windows support was added.</p>

  1227. </div>

  1228. </dd></dl>

  1229. 

  1230. <dl class="py method">

  1231. <dt class="sig sig-object py" id="pathlib.Path.is_symlink">

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

  1233. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a symbolic link, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>

  1234. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist; other errors (such

  1235. as permission errors) are propagated.</p>

  1236. </dd></dl>

  1237. 

  1238. <dl class="py method">

  1239. <dt class="sig sig-object py" id="pathlib.Path.is_socket">

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

  1241. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a Unix socket (or a symbolic link

  1242. pointing to a Unix socket), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1243. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1244. other errors (such as permission errors) are propagated.</p>

  1245. </dd></dl>

  1246. 

  1247. <dl class="py method">

  1248. <dt class="sig sig-object py" id="pathlib.Path.is_fifo">

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

  1250. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a FIFO (or a symbolic link

  1251. pointing to a FIFO), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1252. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1253. other errors (such as permission errors) are propagated.</p>

  1254. </dd></dl>

  1255. 

  1256. <dl class="py method">

  1257. <dt class="sig sig-object py" id="pathlib.Path.is_block_device">

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

  1259. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a block device (or a symbolic link

  1260. pointing to a block device), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1261. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1262. other errors (such as permission errors) are propagated.</p>

  1263. </dd></dl>

  1264. 

  1265. <dl class="py method">

  1266. <dt class="sig sig-object py" id="pathlib.Path.is_char_device">

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

  1268. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the path points to a character device (or a symbolic link

  1269. pointing to a character device), <code class="docutils literal notranslate"><span class="pre">False</span></code> if it points to another kind of file.</p>

  1270. <p><code class="docutils literal notranslate"><span class="pre">False</span></code> is also returned if the path doesn’t exist or is a broken symlink;

  1271. other errors (such as permission errors) are propagated.</p>

  1272. </dd></dl>

  1273. 

  1274. <dl class="py method">

  1275. <dt class="sig sig-object py" id="pathlib.Path.iterdir">

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

  1277. <dd><p>When the path points to a directory, yield path objects of the directory

  1278. contents:</p>

  1279. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;docs&#39;</span><span class="p">)</span>

  1280. <span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">p</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span> <span class="n">child</span>

  1281. <span class="gp">...</span>

  1282. <span class="go">PosixPath(&#39;docs/conf.py&#39;)</span>

  1283. <span class="go">PosixPath(&#39;docs/_templates&#39;)</span>

  1284. <span class="go">PosixPath(&#39;docs/make.bat&#39;)</span>

  1285. <span class="go">PosixPath(&#39;docs/index.rst&#39;)</span>

  1286. <span class="go">PosixPath(&#39;docs/_build&#39;)</span>

  1287. <span class="go">PosixPath(&#39;docs/_static&#39;)</span>

  1288. <span class="go">PosixPath(&#39;docs/Makefile&#39;)</span>

  1289. </pre></div>

  1290. </div>

  1291. <p>The children are yielded in arbitrary order, and the special entries

  1292. <code class="docutils literal notranslate"><span class="pre">'.'</span></code> and <code class="docutils literal notranslate"><span class="pre">'..'</span></code> are not included.  If a file is removed from or added

  1293. to the directory after creating the iterator, whether a path object for

  1294. that file be included is unspecified.</p>

  1295. </dd></dl>

  1296. 

  1297. <dl class="py method">

  1298. <dt class="sig sig-object py" id="pathlib.Path.walk">

  1299. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">walk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">top_down</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">follow_symlinks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.walk" title="Link to this definition">¶</a></dt>

  1300. <dd><p>Generate the file names in a directory tree by walking the tree

  1301. either top-down or bottom-up.</p>

  1302. <p>For each directory in the directory tree rooted at <em>self</em> (including

  1303. <em>self</em> but excluding ‘.’ and ‘..’), the method yields a 3-tuple of

  1304. <code class="docutils literal notranslate"><span class="pre">(dirpath,</span> <span class="pre">dirnames,</span> <span class="pre">filenames)</span></code>.</p>

  1305. <p><em>dirpath</em> is a <a class="reference internal" href="#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> to the directory currently being walked,

  1306. <em>dirnames</em> is a list of strings for the names of subdirectories in <em>dirpath</em>

  1307. (excluding <code class="docutils literal notranslate"><span class="pre">'.'</span></code> and <code class="docutils literal notranslate"><span class="pre">'..'</span></code>), and <em>filenames</em> is a list of strings for

  1308. the names of the non-directory files in <em>dirpath</em>. To get a full path

  1309. (which begins with <em>self</em>) to a file or directory in <em>dirpath</em>, do

  1310. <code class="docutils literal notranslate"><span class="pre">dirpath</span> <span class="pre">/</span> <span class="pre">name</span></code>. Whether or not the lists are sorted is file

  1311. system-dependent.</p>

  1312. <p>If the optional argument <em>top_down</em> is true (which is the default), the triple for a

  1313. directory is generated before the triples for any of its subdirectories

  1314. (directories are walked top-down).  If <em>top_down</em> is false, the triple

  1315. for a directory is generated after the triples for all of its subdirectories

  1316. (directories are walked bottom-up). No matter the value of <em>top_down</em>, the

  1317. list of subdirectories is retrieved before the triples for the directory and

  1318. its subdirectories are walked.</p>

  1319. <p>When <em>top_down</em> is true, the caller can modify the <em>dirnames</em> list in-place

  1320. (for example, using <a class="reference internal" href="../reference/simple_stmts.html#del"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">del</span></code></a> or slice assignment), and <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a>

  1321. will only recurse into the subdirectories whose names remain in <em>dirnames</em>.

  1322. This can be used to prune the search, or to impose a specific order of visiting,

  1323. or even to inform <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> about directories the caller creates or

  1324. renames before it resumes <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> again. Modifying <em>dirnames</em> when

  1325. <em>top_down</em> is false has no effect on the behavior of <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> since the

  1326. directories in <em>dirnames</em> have already been generated by the time <em>dirnames</em>

  1327. is yielded to the caller.</p>

  1328. <p>By default, errors from <a class="reference internal" href="os.html#os.scandir" title="os.scandir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.scandir()</span></code></a> are ignored.  If the optional

  1329. argument <em>on_error</em> is specified, it should be a callable; it will be

  1330. called with one argument, an <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> instance. The callable can handle the

  1331. error to continue the walk or re-raise it to stop the walk. Note that the

  1332. filename is available as the <code class="docutils literal notranslate"><span class="pre">filename</span></code> attribute of the exception object.</p>

  1333. <p>By default, <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> does not follow symbolic links, and instead adds them

  1334. to the <em>filenames</em> list. Set <em>follow_symlinks</em> to true to resolve symlinks

  1335. and place them in <em>dirnames</em> and <em>filenames</em> as appropriate for their targets, and

  1336. consequently visit directories pointed to by symlinks (where supported).</p>

  1337. <div class="admonition note">

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

  1339. <p>Be aware that setting <em>follow_symlinks</em> to true can lead to infinite

  1340. recursion if a link points to a parent directory of itself. <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a>

  1341. does not keep track of the directories it has already visited.</p>

  1342. </div>

  1343. <div class="admonition note">

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

  1345. <p><a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> assumes the directories it walks are not modified during

  1346. execution. For example, if a directory from <em>dirnames</em> has been replaced

  1347. with a symlink and <em>follow_symlinks</em> is false, <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> will

  1348. still try to descend into it. To prevent such behavior, remove directories

  1349. from <em>dirnames</em> as appropriate.</p>

  1350. </div>

  1351. <div class="admonition note">

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

  1353. <p>Unlike <a class="reference internal" href="os.html#os.walk" title="os.walk"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.walk()</span></code></a>, <a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a> lists symlinks to directories in

  1354. <em>filenames</em> if <em>follow_symlinks</em> is false.</p>

  1355. </div>

  1356. <p>This example displays the number of bytes used by all files in each directory,

  1357. while ignoring <code class="docutils literal notranslate"><span class="pre">__pycache__</span></code> directories:</p>

  1358. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>

  1359. <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">dirs</span><span class="p">,</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;cpython/Lib/concurrent&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">on_error</span><span class="o">=</span><span class="nb">print</span><span class="p">):</span>

  1360.   <span class="nb">print</span><span class="p">(</span>

  1361.       <span class="n">root</span><span class="p">,</span>

  1362.       <span class="s2">&quot;consumes&quot;</span><span class="p">,</span>

  1363.       <span class="nb">sum</span><span class="p">((</span><span class="n">root</span> <span class="o">/</span> <span class="n">file</span><span class="p">)</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">files</span><span class="p">),</span>

  1364.       <span class="s2">&quot;bytes in&quot;</span><span class="p">,</span>

  1365.       <span class="nb">len</span><span class="p">(</span><span class="n">files</span><span class="p">),</span>

  1366.       <span class="s2">&quot;non-directory files&quot;</span>

  1367.   <span class="p">)</span>

  1368.   <span class="k">if</span> <span class="s1">&#39;__pycache__&#39;</span> <span class="ow">in</span> <span class="n">dirs</span><span class="p">:</span>

  1369.         <span class="n">dirs</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s1">&#39;__pycache__&#39;</span><span class="p">)</span>

  1370. </pre></div>

  1371. </div>

  1372. <p>This next example is a simple implementation of <a class="reference internal" href="shutil.html#shutil.rmtree" title="shutil.rmtree"><code class="xref py py-func docutils literal notranslate"><span class="pre">shutil.rmtree()</span></code></a>.

  1373. Walking the tree bottom-up is essential as <a class="reference internal" href="#pathlib.Path.rmdir" title="pathlib.Path.rmdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">rmdir()</span></code></a> doesn’t allow

  1374. deleting a directory before it is empty:</p>

  1375. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Delete everything reachable from the directory &quot;top&quot;.</span>

  1376. <span class="c1"># CAUTION:  This is dangerous! For example, if top == Path(&#39;/&#39;),</span>

  1377. <span class="c1"># it could delete all of your files.</span>

  1378. <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">dirs</span><span class="p">,</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">top</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">top_down</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>

  1379.     <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>

  1380.         <span class="p">(</span><span class="n">root</span> <span class="o">/</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>

  1381.     <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">dirs</span><span class="p">:</span>

  1382.         <span class="p">(</span><span class="n">root</span> <span class="o">/</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">rmdir</span><span class="p">()</span>

  1383. </pre></div>

  1384. </div>

  1385. <div class="versionadded">

  1386. <p><span class="versionmodified added">New in version 3.12.</span></p>

  1387. </div>

  1388. </dd></dl>

  1389. 

  1390. <dl class="py method">

  1391. <dt class="sig sig-object py" id="pathlib.Path.lchmod">

  1392. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">lchmod</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="#pathlib.Path.lchmod" title="Link to this definition">¶</a></dt>

  1393. <dd><p>Like <a class="reference internal" href="#pathlib.Path.chmod" title="pathlib.Path.chmod"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.chmod()</span></code></a> but, if the path points to a symbolic link, the

  1394. symbolic link’s mode is changed rather than its target’s.</p>

  1395. </dd></dl>

  1396. 

  1397. <dl class="py method">

  1398. <dt class="sig sig-object py" id="pathlib.Path.lstat">

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

  1400. <dd><p>Like <a class="reference internal" href="#pathlib.Path.stat" title="pathlib.Path.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.stat()</span></code></a> but, if the path points to a symbolic link, return

  1401. the symbolic link’s information rather than its target’s.</p>

  1402. </dd></dl>

  1403. 

  1404. <dl class="py method">

  1405. <dt class="sig sig-object py" id="pathlib.Path.mkdir">

  1406. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">mkdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0o777</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exist_ok</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.mkdir" title="Link to this definition">¶</a></dt>

  1407. <dd><p>Create a new directory at this given path.  If <em>mode</em> is given, it is

  1408. combined with the process’ <code class="docutils literal notranslate"><span class="pre">umask</span></code> value to determine the file mode

  1409. and access flags.  If the path already exists, <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileExistsError</span></code></a>

  1410. is raised.</p>

  1411. <p>If <em>parents</em> is true, any missing parents of this path are created

  1412. as needed; they are created with the default permissions without taking

  1413. <em>mode</em> into account (mimicking the POSIX <code class="docutils literal notranslate"><span class="pre">mkdir</span> <span class="pre">-p</span></code> command).</p>

  1414. <p>If <em>parents</em> is false (the default), a missing parent raises

  1415. <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a>.</p>

  1416. <p>If <em>exist_ok</em> is false (the default), <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileExistsError</span></code></a> is

  1417. raised if the target directory already exists.</p>

  1418. <p>If <em>exist_ok</em> is true, <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileExistsError</span></code></a> will not be raised unless the given

  1419. path already exists in the file system and is not a directory (same

  1420. behavior as the POSIX <code class="docutils literal notranslate"><span class="pre">mkdir</span> <span class="pre">-p</span></code> command).</p>

  1421. <div class="versionchanged">

  1422. <p><span class="versionmodified changed">Changed in version 3.5: </span>The <em>exist_ok</em> parameter was added.</p>

  1423. </div>

  1424. </dd></dl>

  1425. 

  1426. <dl class="py method">

  1427. <dt class="sig sig-object py" id="pathlib.Path.open">

  1428. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.open" title="Link to this definition">¶</a></dt>

  1429. <dd><p>Open the file pointed to by the path, like the built-in <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>

  1430. function does:</p>

  1431. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1432. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">p</span><span class="o">.</span><span class="n">open</span><span class="p">()</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  1433. <span class="gp">... </span>    <span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>

  1434. <span class="gp">...</span>

  1435. <span class="go">&#39;#!/usr/bin/env python3\n&#39;</span>

  1436. </pre></div>

  1437. </div>

  1438. </dd></dl>

  1439. 

  1440. <dl class="py method">

  1441. <dt class="sig sig-object py" id="pathlib.Path.owner">

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

  1443. <dd><p>Return the name of the user owning the file.  <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is raised

  1444. if the file’s uid isn’t found in the system database.</p>

  1445. </dd></dl>

  1446. 

  1447. <dl class="py method">

  1448. <dt class="sig sig-object py" id="pathlib.Path.read_bytes">

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

  1450. <dd><p>Return the binary contents of the pointed-to file as a bytes object:</p>

  1451. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;my_binary_file&#39;</span><span class="p">)</span>

  1452. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">write_bytes</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;Binary file contents&#39;</span><span class="p">)</span>

  1453. <span class="go">20</span>

  1454. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">()</span>

  1455. <span class="go">b&#39;Binary file contents&#39;</span>

  1456. </pre></div>

  1457. </div>

  1458. <div class="versionadded">

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

  1460. </div>

  1461. </dd></dl>

  1462. 

  1463. <dl class="py method">

  1464. <dt class="sig sig-object py" id="pathlib.Path.read_text">

  1465. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">read_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.read_text" title="Link to this definition">¶</a></dt>

  1466. <dd><p>Return the decoded contents of the pointed-to file as a string:</p>

  1467. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;my_text_file&#39;</span><span class="p">)</span>

  1468. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">write_text</span><span class="p">(</span><span class="s1">&#39;Text file contents&#39;</span><span class="p">)</span>

  1469. <span class="go">18</span>

  1470. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">read_text</span><span class="p">()</span>

  1471. <span class="go">&#39;Text file contents&#39;</span>

  1472. </pre></div>

  1473. </div>

  1474. <p>The file is opened and then closed. The optional parameters have the same

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

  1476. <div class="versionadded">

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

  1478. </div>

  1479. </dd></dl>

  1480. 

  1481. <dl class="py method">

  1482. <dt class="sig sig-object py" id="pathlib.Path.readlink">

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

  1484. <dd><p>Return the path to which the symbolic link points (as returned by

  1485. <a class="reference internal" href="os.html#os.readlink" title="os.readlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.readlink()</span></code></a>):</p>

  1486. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;mylink&#39;</span><span class="p">)</span>

  1487. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">symlink_to</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1488. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">readlink</span><span class="p">()</span>

  1489. <span class="go">PosixPath(&#39;setup.py&#39;)</span>

  1490. </pre></div>

  1491. </div>

  1492. <div class="versionadded">

  1493. <p><span class="versionmodified added">New in version 3.9.</span></p>

  1494. </div>

  1495. </dd></dl>

  1496. 

  1497. <dl class="py method">

  1498. <dt class="sig sig-object py" id="pathlib.Path.rename">

  1499. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">rename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.rename" title="Link to this definition">¶</a></dt>

  1500. <dd><p>Rename this file or directory to the given <em>target</em>, and return a new Path

  1501. instance pointing to <em>target</em>.  On Unix, if <em>target</em> exists and is a file,

  1502. it will be replaced silently if the user has permission.

  1503. On Windows, if <em>target</em> exists, <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileExistsError</span></code></a> will be raised.

  1504. <em>target</em> can be either a string or another path object:</p>

  1505. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;foo&#39;</span><span class="p">)</span>

  1506. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;w&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;some text&#39;</span><span class="p">)</span>

  1507. <span class="go">9</span>

  1508. <span class="gp">&gt;&gt;&gt; </span><span class="n">target</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;bar&#39;</span><span class="p">)</span>

  1509. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>

  1510. <span class="go">PosixPath(&#39;bar&#39;)</span>

  1511. <span class="gp">&gt;&gt;&gt; </span><span class="n">target</span><span class="o">.</span><span class="n">open</span><span class="p">()</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  1512. <span class="go">&#39;some text&#39;</span>

  1513. </pre></div>

  1514. </div>

  1515. <p>The target path may be absolute or relative. Relative paths are interpreted

  1516. relative to the current working directory, <em>not</em> the directory of the Path

  1517. object.</p>

  1518. <p>It is implemented in terms of <a class="reference internal" href="os.html#os.rename" title="os.rename"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.rename()</span></code></a> and gives the same guarantees.</p>

  1519. <div class="versionchanged">

  1520. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added return value, return the new Path instance.</p>

  1521. </div>

  1522. </dd></dl>

  1523. 

  1524. <dl class="py method">

  1525. <dt class="sig sig-object py" id="pathlib.Path.replace">

  1526. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.replace" title="Link to this definition">¶</a></dt>

  1527. <dd><p>Rename this file or directory to the given <em>target</em>, and return a new Path

  1528. instance pointing to <em>target</em>.  If <em>target</em> points to an existing file or

  1529. empty directory, it will be unconditionally replaced.</p>

  1530. <p>The target path may be absolute or relative. Relative paths are interpreted

  1531. relative to the current working directory, <em>not</em> the directory of the Path

  1532. object.</p>

  1533. <div class="versionchanged">

  1534. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added return value, return the new Path instance.</p>

  1535. </div>

  1536. </dd></dl>

  1537. 

  1538. <dl class="py method">

  1539. <dt class="sig sig-object py" id="pathlib.Path.absolute">

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

  1541. <dd><p>Make the path absolute, without normalization or resolving symlinks.

  1542. Returns a new path object:</p>

  1543. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;tests&#39;</span><span class="p">)</span>

  1544. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span>

  1545. <span class="go">PosixPath(&#39;tests&#39;)</span>

  1546. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">absolute</span><span class="p">()</span>

  1547. <span class="go">PosixPath(&#39;/home/antoine/pathlib/tests&#39;)</span>

  1548. </pre></div>

  1549. </div>

  1550. </dd></dl>

  1551. 

  1552. <dl class="py method">

  1553. <dt class="sig sig-object py" id="pathlib.Path.resolve">

  1554. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">resolve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.resolve" title="Link to this definition">¶</a></dt>

  1555. <dd><p>Make the path absolute, resolving any symlinks.  A new path object is

  1556. returned:</p>

  1557. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">()</span>

  1558. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span>

  1559. <span class="go">PosixPath(&#39;.&#39;)</span>

  1560. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>

  1561. <span class="go">PosixPath(&#39;/home/antoine/pathlib&#39;)</span>

  1562. </pre></div>

  1563. </div>

  1564. <p>“<code class="docutils literal notranslate"><span class="pre">..</span></code>” components are also eliminated (this is the only method to do so):</p>

  1565. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;docs/../setup.py&#39;</span><span class="p">)</span>

  1566. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>

  1567. <span class="go">PosixPath(&#39;/home/antoine/pathlib/setup.py&#39;)</span>

  1568. </pre></div>

  1569. </div>

  1570. <p>If the path doesn’t exist and <em>strict</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a>

  1571. is raised.  If <em>strict</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the path is resolved as far as possible

  1572. and any remainder is appended without checking whether it exists.  If an

  1573. infinite loop is encountered along the resolution path, <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a>

  1574. is raised.</p>

  1575. <div class="versionchanged">

  1576. <p><span class="versionmodified changed">Changed in version 3.6: </span>The <em>strict</em> parameter was added (pre-3.6 behavior is strict).</p>

  1577. </div>

  1578. </dd></dl>

  1579. 

  1580. <dl class="py method">

  1581. <dt class="sig sig-object py" id="pathlib.Path.rglob">

  1582. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">rglob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.rglob" title="Link to this definition">¶</a></dt>

  1583. <dd><p>Glob the given relative <em>pattern</em> recursively.  This is like calling

  1584. <a class="reference internal" href="#pathlib.Path.glob" title="pathlib.Path.glob"><code class="xref py py-func docutils literal notranslate"><span class="pre">Path.glob()</span></code></a> with “<code class="docutils literal notranslate"><span class="pre">**/</span></code>” added in front of the <em>pattern</em>, where

  1585. <em>patterns</em> are the same as for <a class="reference internal" href="fnmatch.html#module-fnmatch" title="fnmatch: Unix shell style filename pattern matching."><code class="xref py py-mod docutils literal notranslate"><span class="pre">fnmatch</span></code></a>:</p>

  1586. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">sorted</span><span class="p">(</span><span class="n">Path</span><span class="p">()</span><span class="o">.</span><span class="n">rglob</span><span class="p">(</span><span class="s2">&quot;*.py&quot;</span><span class="p">))</span>

  1587. <span class="go">[PosixPath(&#39;build/lib/pathlib.py&#39;),</span>

  1588. <span class="go"> PosixPath(&#39;docs/conf.py&#39;),</span>

  1589. <span class="go"> PosixPath(&#39;pathlib.py&#39;),</span>

  1590. <span class="go"> PosixPath(&#39;setup.py&#39;),</span>

  1591. <span class="go"> PosixPath(&#39;test_pathlib.py&#39;)]</span>

  1592. </pre></div>

  1593. </div>

  1594. <p>By default, or when the <em>case_sensitive</em> keyword-only argument is set to

  1595. <code class="docutils literal notranslate"><span class="pre">None</span></code>, this method matches paths using platform-specific casing rules:

  1596. typically, case-sensitive on POSIX, and case-insensitive on Windows.

  1597. Set <em>case_sensitive</em> to <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code> to override this behaviour.</p>

  1598. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">pathlib.Path.rglob</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">pattern</span></code>.</p>

  1599. <div class="versionchanged">

  1600. <p><span class="versionmodified changed">Changed in version 3.11: </span>Return only directories if <em>pattern</em> ends with a pathname components

  1601. separator (<a class="reference internal" href="os.html#os.sep" title="os.sep"><code class="xref py py-data docutils literal notranslate"><span class="pre">sep</span></code></a> or <a class="reference internal" href="os.html#os.altsep" title="os.altsep"><code class="xref py py-data docutils literal notranslate"><span class="pre">altsep</span></code></a>).</p>

  1602. </div>

  1603. <div class="versionchanged">

  1604. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <em>case_sensitive</em> parameter was added.</p>

  1605. </div>

  1606. </dd></dl>

  1607. 

  1608. <dl class="py method">

  1609. <dt class="sig sig-object py" id="pathlib.Path.rmdir">

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

  1611. <dd><p>Remove this directory.  The directory must be empty.</p>

  1612. </dd></dl>

  1613. 

  1614. <dl class="py method">

  1615. <dt class="sig sig-object py" id="pathlib.Path.samefile">

  1616. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">samefile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.samefile" title="Link to this definition">¶</a></dt>

  1617. <dd><p>Return whether this path points to the same file as <em>other_path</em>, which

  1618. can be either a Path object, or a string.  The semantics are similar

  1619. to <a class="reference internal" href="os.path.html#os.path.samefile" title="os.path.samefile"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.samefile()</span></code></a> and <a class="reference internal" href="os.path.html#os.path.samestat" title="os.path.samestat"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.samestat()</span></code></a>.</p>

  1620. <p>An <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> can be raised if either file cannot be accessed for some

  1621. reason.</p>

  1622. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;spam&#39;</span><span class="p">)</span>

  1623. <span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;eggs&#39;</span><span class="p">)</span>

  1624. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">samefile</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>

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

  1626. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">samefile</span><span class="p">(</span><span class="s1">&#39;spam&#39;</span><span class="p">)</span>

  1627. <span class="go">True</span>

  1628. </pre></div>

  1629. </div>

  1630. <div class="versionadded">

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

  1632. </div>

  1633. </dd></dl>

  1634. 

  1635. <dl class="py method">

  1636. <dt class="sig sig-object py" id="pathlib.Path.symlink_to">

  1637. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">symlink_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_is_directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.symlink_to" title="Link to this definition">¶</a></dt>

  1638. <dd><p>Make this path a symbolic link pointing to <em>target</em>.</p>

  1639. <p>On Windows, a symlink represents either a file or a directory, and does not

  1640. morph to the target dynamically.  If the target is present, the type of the

  1641. symlink will be created to match. Otherwise, the symlink will be created

  1642. as a directory if <em>target_is_directory</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> or a file symlink (the

  1643. default) otherwise.  On non-Windows platforms, <em>target_is_directory</em> is ignored.</p>

  1644. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;mylink&#39;</span><span class="p">)</span>

  1645. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">symlink_to</span><span class="p">(</span><span class="s1">&#39;setup.py&#39;</span><span class="p">)</span>

  1646. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>

  1647. <span class="go">PosixPath(&#39;/home/antoine/pathlib/setup.py&#39;)</span>

  1648. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span>

  1649. <span class="go">956</span>

  1650. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">lstat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span>

  1651. <span class="go">8</span>

  1652. </pre></div>

  1653. </div>

  1654. <div class="admonition note">

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

  1656. <p>The order of arguments (link, target) is the reverse

  1657. of <a class="reference internal" href="os.html#os.symlink" title="os.symlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.symlink()</span></code></a>’s.</p>

  1658. </div>

  1659. </dd></dl>

  1660. 

  1661. <dl class="py method">

  1662. <dt class="sig sig-object py" id="pathlib.Path.hardlink_to">

  1663. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">hardlink_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.hardlink_to" title="Link to this definition">¶</a></dt>

  1664. <dd><p>Make this path a hard link to the same file as <em>target</em>.</p>

  1665. <div class="admonition note">

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

  1667. <p>The order of arguments (link, target) is the reverse

  1668. of <a class="reference internal" href="os.html#os.link" title="os.link"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.link()</span></code></a>’s.</p>

  1669. </div>

  1670. <div class="versionadded">

  1671. <p><span class="versionmodified added">New in version 3.10.</span></p>

  1672. </div>

  1673. </dd></dl>

  1674. 

  1675. <dl class="py method">

  1676. <dt class="sig sig-object py" id="pathlib.Path.touch">

  1677. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">touch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0o666</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exist_ok</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.touch" title="Link to this definition">¶</a></dt>

  1678. <dd><p>Create a file at this given path.  If <em>mode</em> is given, it is combined

  1679. with the process’ <code class="docutils literal notranslate"><span class="pre">umask</span></code> value to determine the file mode and access

  1680. flags.  If the file already exists, the function succeeds if <em>exist_ok</em>

  1681. is true (and its modification time is updated to the current time),

  1682. otherwise <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileExistsError</span></code></a> is raised.</p>

  1683. </dd></dl>

  1684. 

  1685. <dl class="py method">

  1686. <dt class="sig sig-object py" id="pathlib.Path.unlink">

  1687. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">unlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">missing_ok</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.unlink" title="Link to this definition">¶</a></dt>

  1688. <dd><p>Remove this file or symbolic link.  If the path points to a directory,

  1689. use <a class="reference internal" href="#pathlib.Path.rmdir" title="pathlib.Path.rmdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">Path.rmdir()</span></code></a> instead.</p>

  1690. <p>If <em>missing_ok</em> is false (the default), <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a> is

  1691. raised if the path does not exist.</p>

  1692. <p>If <em>missing_ok</em> is true, <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a> exceptions will be

  1693. ignored (same behavior as the POSIX <code class="docutils literal notranslate"><span class="pre">rm</span> <span class="pre">-f</span></code> command).</p>

  1694. <div class="versionchanged">

  1695. <p><span class="versionmodified changed">Changed in version 3.8: </span>The <em>missing_ok</em> parameter was added.</p>

  1696. </div>

  1697. </dd></dl>

  1698. 

  1699. <dl class="py method">

  1700. <dt class="sig sig-object py" id="pathlib.Path.write_bytes">

  1701. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">write_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.write_bytes" title="Link to this definition">¶</a></dt>

  1702. <dd><p>Open the file pointed to in bytes mode, write <em>data</em> to it, and close the

  1703. file:</p>

  1704. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;my_binary_file&#39;</span><span class="p">)</span>

  1705. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">write_bytes</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;Binary file contents&#39;</span><span class="p">)</span>

  1706. <span class="go">20</span>

  1707. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">()</span>

  1708. <span class="go">b&#39;Binary file contents&#39;</span>

  1709. </pre></div>

  1710. </div>

  1711. <p>An existing file of the same name is overwritten.</p>

  1712. <div class="versionadded">

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

  1714. </div>

  1715. </dd></dl>

  1716. 

  1717. <dl class="py method">

  1718. <dt class="sig sig-object py" id="pathlib.Path.write_text">

  1719. <span class="sig-prename descclassname"><span class="pre">Path.</span></span><span class="sig-name descname"><span class="pre">write_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pathlib.Path.write_text" title="Link to this definition">¶</a></dt>

  1720. <dd><p>Open the file pointed to in text mode, write <em>data</em> to it, and close the

  1721. file:</p>

  1722. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">p</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">&#39;my_text_file&#39;</span><span class="p">)</span>

  1723. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">write_text</span><span class="p">(</span><span class="s1">&#39;Text file contents&#39;</span><span class="p">)</span>

  1724. <span class="go">18</span>

  1725. <span class="gp">&gt;&gt;&gt; </span><span class="n">p</span><span class="o">.</span><span class="n">read_text</span><span class="p">()</span>

  1726. <span class="go">&#39;Text file contents&#39;</span>

  1727. </pre></div>

  1728. </div>

  1729. <p>An existing file of the same name is overwritten. The optional parameters

  1730. have the same meaning as in <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  1731. <div class="versionadded">

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

  1733. </div>

  1734. <div class="versionchanged">

  1735. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <em>newline</em> parameter was added.</p>

  1736. </div>

  1737. </dd></dl>

  1738. 

  1739. </section>

  1740. </section>

  1741. <section id="correspondence-to-tools-in-the-os-module">

  1742. <h2>Correspondence to tools in the <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> module<a class="headerlink" href="#correspondence-to-tools-in-the-os-module" title="Link to this heading">¶</a></h2>

  1743. <p>Below is a table mapping various <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> functions to their corresponding

  1744. <a class="reference internal" href="#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">PurePath</span></code></a>/<a class="reference internal" href="#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> equivalent.</p>

  1745. <div class="admonition note">

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

  1747. <p>Not all pairs of functions/methods below are equivalent. Some of them,

  1748. despite having some overlapping use-cases, have different semantics. They

  1749. include <a class="reference internal" href="os.path.html#os.path.abspath" title="os.path.abspath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.abspath()</span></code></a> and <a class="reference internal" href="#pathlib.Path.absolute" title="pathlib.Path.absolute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.absolute()</span></code></a>,

  1750. <a class="reference internal" href="os.path.html#os.path.relpath" title="os.path.relpath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.relpath()</span></code></a> and <a class="reference internal" href="#pathlib.PurePath.relative_to" title="pathlib.PurePath.relative_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">PurePath.relative_to()</span></code></a>.</p>

  1751. </div>

  1752. <table class="docutils align-default">

  1753. <thead>

  1754. <tr class="row-odd"><th class="head"><p><a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> and <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></p></th>

  1755. <th class="head"><p><a class="reference internal" href="#module-pathlib" title="pathlib: Object-oriented filesystem paths"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code></a></p></th>

  1756. </tr>

  1757. </thead>

  1758. <tbody>

  1759. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.abspath" title="os.path.abspath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.abspath()</span></code></a></p></td>

  1760. <td><p><a class="reference internal" href="#pathlib.Path.absolute" title="pathlib.Path.absolute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.absolute()</span></code></a> <a class="footnote-reference brackets" href="#id5" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></td>

  1761. </tr>

  1762. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.realpath" title="os.path.realpath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.realpath()</span></code></a></p></td>

  1763. <td><p><a class="reference internal" href="#pathlib.Path.resolve" title="pathlib.Path.resolve"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.resolve()</span></code></a></p></td>

  1764. </tr>

  1765. <tr class="row-even"><td><p><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></td>

  1766. <td><p><a class="reference internal" href="#pathlib.Path.chmod" title="pathlib.Path.chmod"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.chmod()</span></code></a></p></td>

  1767. </tr>

  1768. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.mkdir" title="os.mkdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.mkdir()</span></code></a></p></td>

  1769. <td><p><a class="reference internal" href="#pathlib.Path.mkdir" title="pathlib.Path.mkdir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.mkdir()</span></code></a></p></td>

  1770. </tr>

  1771. <tr class="row-even"><td><p><a class="reference internal" href="os.html#os.makedirs" title="os.makedirs"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.makedirs()</span></code></a></p></td>

  1772. <td><p><a class="reference internal" href="#pathlib.Path.mkdir" title="pathlib.Path.mkdir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.mkdir()</span></code></a></p></td>

  1773. </tr>

  1774. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.rename" title="os.rename"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.rename()</span></code></a></p></td>

  1775. <td><p><a class="reference internal" href="#pathlib.Path.rename" title="pathlib.Path.rename"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.rename()</span></code></a></p></td>

  1776. </tr>

  1777. <tr class="row-even"><td><p><a class="reference internal" href="os.html#os.replace" title="os.replace"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.replace()</span></code></a></p></td>

  1778. <td><p><a class="reference internal" href="#pathlib.Path.replace" title="pathlib.Path.replace"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.replace()</span></code></a></p></td>

  1779. </tr>

  1780. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.rmdir" title="os.rmdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.rmdir()</span></code></a></p></td>

  1781. <td><p><a class="reference internal" href="#pathlib.Path.rmdir" title="pathlib.Path.rmdir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.rmdir()</span></code></a></p></td>

  1782. </tr>

  1783. <tr class="row-even"><td><p><a class="reference internal" href="os.html#os.remove" title="os.remove"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.remove()</span></code></a>, <a class="reference internal" href="os.html#os.unlink" title="os.unlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.unlink()</span></code></a></p></td>

  1784. <td><p><a class="reference internal" href="#pathlib.Path.unlink" title="pathlib.Path.unlink"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.unlink()</span></code></a></p></td>

  1785. </tr>

  1786. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.getcwd" title="os.getcwd"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.getcwd()</span></code></a></p></td>

  1787. <td><p><a class="reference internal" href="#pathlib.Path.cwd" title="pathlib.Path.cwd"><code class="xref py py-func docutils literal notranslate"><span class="pre">Path.cwd()</span></code></a></p></td>

  1788. </tr>

  1789. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.exists" title="os.path.exists"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.exists()</span></code></a></p></td>

  1790. <td><p><a class="reference internal" href="#pathlib.Path.exists" title="pathlib.Path.exists"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.exists()</span></code></a></p></td>

  1791. </tr>

  1792. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.expanduser" title="os.path.expanduser"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.expanduser()</span></code></a></p></td>

  1793. <td><p><a class="reference internal" href="#pathlib.Path.expanduser" title="pathlib.Path.expanduser"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.expanduser()</span></code></a> and

  1794. <a class="reference internal" href="#pathlib.Path.home" title="pathlib.Path.home"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.home()</span></code></a></p></td>

  1795. </tr>

  1796. <tr class="row-even"><td><p><a class="reference internal" href="os.html#os.listdir" title="os.listdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.listdir()</span></code></a></p></td>

  1797. <td><p><a class="reference internal" href="#pathlib.Path.iterdir" title="pathlib.Path.iterdir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.iterdir()</span></code></a></p></td>

  1798. </tr>

  1799. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.walk" title="os.walk"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.walk()</span></code></a></p></td>

  1800. <td><p><a class="reference internal" href="#pathlib.Path.walk" title="pathlib.Path.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.walk()</span></code></a></p></td>

  1801. </tr>

  1802. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.isdir" title="os.path.isdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isdir()</span></code></a></p></td>

  1803. <td><p><a class="reference internal" href="#pathlib.Path.is_dir" title="pathlib.Path.is_dir"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.is_dir()</span></code></a></p></td>

  1804. </tr>

  1805. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.isfile" title="os.path.isfile"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isfile()</span></code></a></p></td>

  1806. <td><p><a class="reference internal" href="#pathlib.Path.is_file" title="pathlib.Path.is_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.is_file()</span></code></a></p></td>

  1807. </tr>

  1808. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.islink" title="os.path.islink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.islink()</span></code></a></p></td>

  1809. <td><p><a class="reference internal" href="#pathlib.Path.is_symlink" title="pathlib.Path.is_symlink"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.is_symlink()</span></code></a></p></td>

  1810. </tr>

  1811. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.link" title="os.link"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.link()</span></code></a></p></td>

  1812. <td><p><a class="reference internal" href="#pathlib.Path.hardlink_to" title="pathlib.Path.hardlink_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.hardlink_to()</span></code></a></p></td>

  1813. </tr>

  1814. <tr class="row-even"><td><p><a class="reference internal" href="os.html#os.symlink" title="os.symlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.symlink()</span></code></a></p></td>

  1815. <td><p><a class="reference internal" href="#pathlib.Path.symlink_to" title="pathlib.Path.symlink_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.symlink_to()</span></code></a></p></td>

  1816. </tr>

  1817. <tr class="row-odd"><td><p><a class="reference internal" href="os.html#os.readlink" title="os.readlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.readlink()</span></code></a></p></td>

  1818. <td><p><a class="reference internal" href="#pathlib.Path.readlink" title="pathlib.Path.readlink"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.readlink()</span></code></a></p></td>

  1819. </tr>

  1820. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.relpath" title="os.path.relpath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.relpath()</span></code></a></p></td>

  1821. <td><p><a class="reference internal" href="#pathlib.PurePath.relative_to" title="pathlib.PurePath.relative_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">PurePath.relative_to()</span></code></a> <a class="footnote-reference brackets" href="#id6" id="id4" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a></p></td>

  1822. </tr>

  1823. <tr class="row-odd"><td><p><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></p></td>

  1824. <td><p><a class="reference internal" href="#pathlib.Path.stat" title="pathlib.Path.stat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.stat()</span></code></a>,

  1825. <a class="reference internal" href="#pathlib.Path.owner" title="pathlib.Path.owner"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.owner()</span></code></a>,

  1826. <a class="reference internal" href="#pathlib.Path.group" title="pathlib.Path.group"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.group()</span></code></a></p></td>

  1827. </tr>

  1828. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.isabs" title="os.path.isabs"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isabs()</span></code></a></p></td>

  1829. <td><p><a class="reference internal" href="#pathlib.PurePath.is_absolute" title="pathlib.PurePath.is_absolute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">PurePath.is_absolute()</span></code></a></p></td>

  1830. </tr>

  1831. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.join" title="os.path.join"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.join()</span></code></a></p></td>

  1832. <td><p><a class="reference internal" href="#pathlib.PurePath.joinpath" title="pathlib.PurePath.joinpath"><code class="xref py py-func docutils literal notranslate"><span class="pre">PurePath.joinpath()</span></code></a></p></td>

  1833. </tr>

  1834. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.basename" title="os.path.basename"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.basename()</span></code></a></p></td>

  1835. <td><p><a class="reference internal" href="#pathlib.PurePath.name" title="pathlib.PurePath.name"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PurePath.name</span></code></a></p></td>

  1836. </tr>

  1837. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.dirname" title="os.path.dirname"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.dirname()</span></code></a></p></td>

  1838. <td><p><a class="reference internal" href="#pathlib.PurePath.parent" title="pathlib.PurePath.parent"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PurePath.parent</span></code></a></p></td>

  1839. </tr>

  1840. <tr class="row-even"><td><p><a class="reference internal" href="os.path.html#os.path.samefile" title="os.path.samefile"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.samefile()</span></code></a></p></td>

  1841. <td><p><a class="reference internal" href="#pathlib.Path.samefile" title="pathlib.Path.samefile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.samefile()</span></code></a></p></td>

  1842. </tr>

  1843. <tr class="row-odd"><td><p><a class="reference internal" href="os.path.html#os.path.splitext" title="os.path.splitext"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.splitext()</span></code></a></p></td>

  1844. <td><p><a class="reference internal" href="#pathlib.PurePath.stem" title="pathlib.PurePath.stem"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PurePath.stem</span></code></a> and

  1845. <a class="reference internal" href="#pathlib.PurePath.suffix" title="pathlib.PurePath.suffix"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PurePath.suffix</span></code></a></p></td>

  1846. </tr>

  1847. </tbody>

  1848. </table>

  1849. <p class="rubric">Footnotes</p>

  1850. <aside class="footnote-list brackets">

  1851. <aside class="footnote brackets" id="id5" role="doc-footnote">

  1852. <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">1</a><span class="fn-bracket">]</span></span>

  1853. <p><a class="reference internal" href="os.path.html#os.path.abspath" title="os.path.abspath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.abspath()</span></code></a> normalizes the resulting path, which may change its meaning in the presence of symlinks, while <a class="reference internal" href="#pathlib.Path.absolute" title="pathlib.Path.absolute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Path.absolute()</span></code></a> does not.</p>

  1854. </aside>

  1855. <aside class="footnote brackets" id="id6" role="doc-footnote">

  1856. <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id4">2</a><span class="fn-bracket">]</span></span>

  1857. <p><a class="reference internal" href="#pathlib.PurePath.relative_to" title="pathlib.PurePath.relative_to"><code class="xref py py-meth docutils literal notranslate"><span class="pre">PurePath.relative_to()</span></code></a> requires <code class="docutils literal notranslate"><span class="pre">self</span></code> to be the subpath of the argument, but <a class="reference internal" href="os.path.html#os.path.relpath" title="os.path.relpath"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.relpath()</span></code></a> does not.</p>

  1858. </aside>

  1859. </aside>

  1860. </section>

  1861. </section>

  1862. 

  1863. 

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

  1865.           </div>

  1866.         </div>

  1867.       </div>

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

  1869.         <div class="sphinxsidebarwrapper">

  1870.   <div>

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

  1872.     <ul>

  1873. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code> — Object-oriented filesystem paths</a><ul>

  1874. <li><a class="reference internal" href="#basic-use">Basic use</a></li>

  1875. <li><a class="reference internal" href="#pure-paths">Pure paths</a><ul>

  1876. <li><a class="reference internal" href="#general-properties">General properties</a></li>

  1877. <li><a class="reference internal" href="#operators">Operators</a></li>

  1878. <li><a class="reference internal" href="#accessing-individual-parts">Accessing individual parts</a></li>

  1879. <li><a class="reference internal" href="#methods-and-properties">Methods and properties</a></li>

  1880. </ul>

  1881. </li>

  1882. <li><a class="reference internal" href="#concrete-paths">Concrete paths</a><ul>

  1883. <li><a class="reference internal" href="#methods">Methods</a></li>

  1884. </ul>

  1885. </li>

  1886. <li><a class="reference internal" href="#correspondence-to-tools-in-the-os-module">Correspondence to tools in the <code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code> module</a></li>

  1887. </ul>

  1888. </li>

  1889. </ul>

  1890. 

  1891.   </div>

  1892.   <div>

  1893.     <h4>Previous topic</h4>

  1894.     <p class="topless"><a href="filesys.html"

  1895.                           title="previous chapter">File and Directory Access</a></p>

  1896.   </div>

  1897.   <div>

  1898.     <h4>Next topic</h4>

  1899.     <p class="topless"><a href="os.path.html"

  1900.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>

  1901.   </div>

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

  1903.     <h3>This Page</h3>

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

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

  1906.       <li>

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

  1908.             rel="nofollow">Show Source

  1909.         </a>

  1910.       </li>

  1911.     </ul>

  1912.   </div>

  1913.         </div>

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

  1915. <span>«</span>

  1916. </div>

  1917. 

  1918.       </div>

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

  1920.     </div>  

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

  1922.       <h3>Navigation</h3>

  1923.       <ul>

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

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

  1926.              >index</a></li>

  1927.         <li class="right" >

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

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

  1930.         <li class="right" >

  1931.           <a href="os.path.html" title="os.path — Common pathname manipulations"

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

  1933.         <li class="right" >

  1934.           <a href="filesys.html" title="File and Directory Access"

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

  1936. 

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

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

  1939.           <li class="switchers">

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

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

  1942.           </li>

  1943.           <li>

  1944.               

  1945.           </li>

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

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

  1948.     </li>

  1949. 

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

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

  1952.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pathlib</span></code> — Object-oriented filesystem paths</a></li>

  1953.                 <li class="right">

  1954.                     

  1955. 

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

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

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

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

  1960.         </form>

  1961.     </div>

  1962.                      |

  1963.                 </li>

  1964.             <li class="right">

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

  1966.     Theme

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

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

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

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

  1971.     </select>

  1972. </label> |</li>

  1973.             

  1974.       </ul>

  1975.     </div>  

  1976.     <div class="footer">

  1977.     &copy; 

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

  1979.     

  1980.     Copyright

  1981.     

  1982.       </a>

  1983.      2001-2024, Python Software Foundation.

  1984.     <br />

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

  1986.     <br />

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

  1988.     <br />

  1989.     

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

  1991.     

  1992.     

  1993.     <br />

  1994. 

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

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

  1997. <br />

  1998.     <br />

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

  2000.     

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

  2002.     

  2003.     <br />

  2004. 

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

  2006.     </div>

  2007. 

  2008.   </body>

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