Working on path

gto76 · gto76 · commit 678160695bce · 2019-12-23T16:39:07.000+01:00
diff --git a/README.md b/README.md
@@ -1572,30 +1572,24 @@ from glob import glob
 ```
 
 ```python
-<bool> = path.exists('<path>')
-<bool> = path.isfile('<path>')
-<bool> = path.isdir('<path>')
+<str>  = path.basename('<path>')    # Returns final component.
+<str>  = path.dirname('<path>')     # Returns path without final component.
+<tup.> = path.splitext('<path>')    # Splits on last period of final component.
 ```
 
 ```python
 <list> = listdir('<path>')          # Returns filenames located at path.
 <list> = glob('<pattern>')          # Returns paths matching the wildcard pattern.
 ```
 
-```python
-<str>  = path.basename('<path>')    # Returns final component.
-<str>  = path.dirname('<path>')     # Returns path without final component.
-<str>  = path.splitext('<path>')[1] # Returns final component's extension.
-```
-
-### Pathlib
+### Path Object
 ```python
 from pathlib import Path
 ```
 
 ```python
-<Path> = Path('<path>' [, '<path>', <Path>, ...])
-<Path> = <Path> / '<dir>' / '<file>'
+<Path> = Path(<path> [, ...])       # Accepts strings, Paths and DirEntry objects.
+<Path> = <path> / <path> [/ ...]    # One of the paths must be a Path object.
 ```
 
 ```python
@@ -1606,9 +1600,9 @@ from pathlib import Path
 ```
 
 ```python
-<bool> = <Path>.exists()
-<bool> = <Path>.is_file()
-<bool> = <Path>.is_dir()
+<bool> = <Path>.exists()            # Or: path.exists('<path>')
+<bool> = <Path>.is_file()           # Or: path.isfile('<path>')
+<bool> = <Path>.is_dir()            # Or: path.isdir('<path>')
 ```
 
 ```python
@@ -1629,7 +1623,7 @@ from pathlib import Path
 ```
 
 ### DirEntry
-**Using scandir() instead of listdir() can significantly increase the performance of code that also needs file type or file attribute information.**
+**Using scandir() instead of listdir() or iterdir() can significantly increase the performance of code that also needs file type or file attribute information.**
 ```python
 <iter> = os.scandir(path='.')       # Returns DirEntry objects located at path.
 ```
diff --git a/index.html b/index.html
@@ -1451,31 +1451,27 @@
 &lt;str&gt;  = path.join(<span class="hljs-string">'&lt;path&gt;'</span>, ...)   <span class="hljs-comment"># Joins two or more pathname components.</span>
 &lt;str&gt;  = path.abspath(<span class="hljs-string">'&lt;path&gt;'</span>)     <span class="hljs-comment"># Return an absolute path.</span>
 </code></pre>
-<pre><code class="python language-python hljs">&lt;bool&gt; = path.exists(<span class="hljs-string">'&lt;path&gt;'</span>)
-&lt;bool&gt; = path.isfile(<span class="hljs-string">'&lt;path&gt;'</span>)
-&lt;bool&gt; = path.isdir(<span class="hljs-string">'&lt;path&gt;'</span>)
+<pre><code class="python language-python hljs">&lt;str&gt;  = path.basename(<span class="hljs-string">'&lt;path&gt;'</span>)    <span class="hljs-comment"># Returns final component.</span>
+&lt;str&gt;  = path.dirname(<span class="hljs-string">'&lt;path&gt;'</span>)     <span class="hljs-comment"># Returns path without final component.</span>
+&lt;tup.&gt; = path.splitext(<span class="hljs-string">'&lt;path&gt;'</span>)    <span class="hljs-comment"># Splits on last period of final component.</span>
 </code></pre>
 <pre><code class="python language-python hljs">&lt;list&gt; = listdir(<span class="hljs-string">'&lt;path&gt;'</span>)          <span class="hljs-comment"># Returns filenames located at path.</span>
 &lt;list&gt; = glob(<span class="hljs-string">'&lt;pattern&gt;'</span>)          <span class="hljs-comment"># Returns paths matching the wildcard pattern.</span>
 </code></pre>
-<pre><code class="python language-python hljs">&lt;str&gt;  = path.basename(<span class="hljs-string">'&lt;path&gt;'</span>)    <span class="hljs-comment"># Returns final component.</span>
-&lt;str&gt;  = path.dirname(<span class="hljs-string">'&lt;path&gt;'</span>)     <span class="hljs-comment"># Returns path without final component.</span>
-&lt;str&gt;  = path.splitext(<span class="hljs-string">'&lt;path&gt;'</span>)[<span class="hljs-number">1</span>] <span class="hljs-comment"># Returns final component's extension.</span>
-</code></pre>
-<div><h3 id="pathlib">Pathlib</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
+<div><h3 id="pathobject">Path Object</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
 </code></pre></div>
 
-<pre><code class="python language-python hljs">&lt;Path&gt; = Path(<span class="hljs-string">'&lt;path&gt;'</span> [, <span class="hljs-string">'&lt;path&gt;'</span>, &lt;Path&gt;, ...])
-&lt;Path&gt; = &lt;Path&gt; / <span class="hljs-string">'&lt;dir&gt;'</span> / <span class="hljs-string">'&lt;file&gt;'</span>
+<pre><code class="python language-python hljs">&lt;Path&gt; = Path(&lt;path&gt; [, ...])       <span class="hljs-comment"># Accepts strings, Paths and DirEntry objects.</span>
+&lt;Path&gt; = &lt;path&gt; / &lt;path&gt; [/ ...]    <span class="hljs-comment"># One of the paths must be a Path object.</span>
 </code></pre>
 <pre><code class="python language-python hljs">&lt;Path&gt; = Path()                     <span class="hljs-comment"># Or: Path('.')</span>
 &lt;Path&gt; = Path.cwd()                 <span class="hljs-comment"># Returns absolute cwd. Or: Path().resolve()</span>
 &lt;Path&gt; = &lt;Path&gt;.resolve()           <span class="hljs-comment"># Returns absolute Path without symlinks.</span>
 &lt;Path&gt; = &lt;Path&gt;.parent              <span class="hljs-comment"># Returns Path without final component.</span>
 </code></pre>
-<pre><code class="python language-python hljs">&lt;bool&gt; = &lt;Path&gt;.exists()
-&lt;bool&gt; = &lt;Path&gt;.is_file()
-&lt;bool&gt; = &lt;Path&gt;.is_dir()
+<pre><code class="python language-python hljs">&lt;bool&gt; = &lt;Path&gt;.exists()            <span class="hljs-comment"># Or: path.exists('&lt;path&gt;')</span>
+&lt;bool&gt; = &lt;Path&gt;.is_file()           <span class="hljs-comment"># Or: path.isfile('&lt;path&gt;')</span>
+&lt;bool&gt; = &lt;Path&gt;.is_dir()            <span class="hljs-comment"># Or: path.isdir('&lt;path&gt;')</span>
 </code></pre>
 <pre><code class="python language-python hljs">&lt;iter&gt; = &lt;Path&gt;.iterdir()           <span class="hljs-comment"># Returns dir contents as relative (not true) Path objects.</span>
 &lt;iter&gt; = &lt;Path&gt;.glob(<span class="hljs-string">'&lt;pattern&gt;'</span>)   <span class="hljs-comment"># Returns relative Paths matching the wildcard pattern.</span>
@@ -1488,7 +1484,7 @@
 </code></pre>
 <pre><code class="python language-python hljs">&lt;file&gt; = open(&lt;Path&gt;)               <span class="hljs-comment"># Opens the file and returns a file object.</span>
 </code></pre>
-<div><h3 id="direntry">DirEntry</h3><p><strong>Using scandir() instead of listdir() can significantly increase the performance of code that also needs file type or file attribute information.</strong></p><pre><code class="python language-python hljs">&lt;iter&gt; = os.scandir(path=<span class="hljs-string">'.'</span>)       <span class="hljs-comment"># Returns DirEntry objects located at path.</span>
+<div><h3 id="direntry">DirEntry</h3><p><strong>Using scandir() instead of listdir() or iterdir() can significantly increase the performance of code that also needs file type or file attribute information.</strong></p><pre><code class="python language-python hljs">&lt;iter&gt; = os.scandir(path=<span class="hljs-string">'.'</span>)       <span class="hljs-comment"># Returns DirEntry objects located at path.</span>
 </code></pre></div>
 
 
