Browse Source

Working on path

pull/46/head
Jure Šorn 5 years ago
parent
commit
5766c53658
3 changed files with 67 additions and 63 deletions
  1. 71
      README.md
  2. 57
      index.html
  3. 2
      parse.js

71
README.md

@ -1576,8 +1576,8 @@ from glob import glob
```
```python
<list> = listdir('<path>') # List of filenames located at path.
<list> = glob('<pattern>') # Filenames matching the wildcard pattern.
<list> = listdir('<path>') # Returns filenames located at path.
<list> = glob('<pattern>') # Returns paths matching the wildcard pattern.
```
### Pathlib
@ -1586,11 +1586,16 @@ from pathlib import Path
```
```python
cwd = Path()
<Path> = Path('<path>' [, '<path>', <Path>, ...])
<Path> = <Path> / '<dir>' / '<file>'
```
```python
<Path> = Path() # Or: Path('.')
<Path> = <Path>.resolve() # Returns absolute Path without symlinks.
<Path> = <Path>.parent # Returns path without final component.
```
```python
<bool> = <Path>.exists()
<bool> = <Path>.is_file()
@ -1598,24 +1603,42 @@ cwd = Path()
```
```python
<iter> = <Path>.iterdir() # Returns dir contents as Path objects.
<iter> = <Path>.glob('<pattern>') # Returns Paths matching the wildcard pattern.
<iter> = <Path>.iterdir() # Returns dir contents as relative (not true) Path objects.
<iter> = <Path>.glob('<pattern>') # Returns relative Paths matching the wildcard pattern.
```
```python
<str> = str(<Path>) # Path as a string.
<str> = <Path>.name # Final component.
<str> = <Path>.stem # Final component without extension.
<str> = <Path>.suffix # Final component's extension.
<tup.> = <Path>.parts # All components as strings.
<str> = str(<Path>) # Returns Path as a string.
<str> = <Path>.name # Returns final component.
<str> = <Path>.stem # Returns final component without extension.
<str> = <Path>.suffix # Returns final component's extension.
<tup.> = <Path>.parts # Returns all components as strings.
```
```python
<Path> = <Path>.resolve() # Returns absolute path without symlinks.
<Path> = <Path>.parent # Returns path without final component.
<file> = open(<Path>) # Opens the file and returns a file object.
```
### DirEntry
```python
<iter> = os.scandir(path='.') # Returns DirEntry objects located at path.
```
```python
<bool> = <DirEntry>.is_file()
<bool> = <DirEntry>.is_dir()
```
```python
<str> = <DirEntry>.path # Returns relative path as a string.
<str> = <DirEntry>.name # Returns final component.
```
```python
<Path> = Path(<DirEntry>) # Returns relative Path object.
<file> = open(<DirEntry>) # Opens the file and returns a file object.
```
OS Commands
-----------
@ -1634,7 +1657,7 @@ os.mkdir(<path>, mode=0o777) # Creates a directory. Mode is in octal.
```python
shutil.copy(from, to) # Copies the file.
shutil.copytree(from, to) # Copies the entire directory tree.
shutil.copytree(from, to) # Copies the directory.
```
```python
@ -1645,27 +1668,7 @@ os.replace(from, to) # Same, but overwrites 'to' if it exists.
```python
os.remove(<path>) # Deletes the file.
os.rmdir(<path>) # Deletes empty directory.
shutil.rmtree(<path>) # Deletes the entire directory tree.
```
```python
<iter> = os.scandir(path='.') # Returns os.DirEntry objects located at path.
```
#### DirEntry:
```python
<bool> = <DirEntry>.is_file()
<bool> = <DirEntry>.is_dir()
```
```python
<str> = <DirEntry>.path # Path as a string.
<str> = <DirEntry>.name # Final component.
```
```python
<Path> = Path(<DirEntry>) # Path object.
<file> = open(<DirEntry>) # File object.
shutil.rmtree(<path>) # Deletes non-empty directory.
```
### Shell Commands

57
index.html

@ -1453,32 +1453,45 @@ value = args.&lt;name&gt;
&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>)
</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"># List of filenames located at path.</span>
&lt;list&gt; = glob(<span class="hljs-string">'&lt;pattern&gt;'</span>) <span class="hljs-comment"># Filenames matching the wildcard pattern.</span>
<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>
<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
</code></pre></div>
<pre><code class="python language-python hljs">cwd = Path()
&lt;Path&gt; = Path(<span class="hljs-string">'&lt;path&gt;'</span> [, <span class="hljs-string">'&lt;path&gt;'</span>, &lt;Path&gt;, ...])
<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>
</code></pre>
<pre><code class="python language-python hljs">&lt;Path&gt; = Path() <span class="hljs-comment"># Or: Path('.')</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()
</code></pre>
<pre><code class="python language-python hljs">&lt;iter&gt; = &lt;Path&gt;.iterdir() <span class="hljs-comment"># Returns dir contents as Path objects.</span>
&lt;iter&gt; = &lt;Path&gt;.glob(<span class="hljs-string">'&lt;pattern&gt;'</span>) <span class="hljs-comment"># Returns Paths matching the wildcard pattern.</span>
<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>
</code></pre>
<pre><code class="python language-python hljs">&lt;str&gt; = str(&lt;Path&gt;) <span class="hljs-comment"># Path as a string.</span>
&lt;str&gt; = &lt;Path&gt;.name <span class="hljs-comment"># Final component.</span>
&lt;str&gt; = &lt;Path&gt;.stem <span class="hljs-comment"># Final component without extension.</span>
&lt;str&gt; = &lt;Path&gt;.suffix <span class="hljs-comment"># Final component's extension.</span>
&lt;tup.&gt; = &lt;Path&gt;.parts <span class="hljs-comment"># All components as strings.</span>
<pre><code class="python language-python hljs">&lt;str&gt; = str(&lt;Path&gt;) <span class="hljs-comment"># Returns Path as a string.</span>
&lt;str&gt; = &lt;Path&gt;.name <span class="hljs-comment"># Returns final component.</span>
&lt;str&gt; = &lt;Path&gt;.stem <span class="hljs-comment"># Returns final component without extension.</span>
&lt;str&gt; = &lt;Path&gt;.suffix <span class="hljs-comment"># Returns final component's extension.</span>
&lt;tup.&gt; = &lt;Path&gt;.parts <span class="hljs-comment"># Returns all components as strings.</span>
</code></pre>
<pre><code class="python language-python hljs">&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>
&lt;file&gt; = open(&lt;Path&gt;) <span class="hljs-comment"># Opens the file and returns a file object.</span>
<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><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>
<pre><code class="python language-python hljs">&lt;bool&gt; = &lt;DirEntry&gt;.is_file()
&lt;bool&gt; = &lt;DirEntry&gt;.is_dir()
</code></pre>
<pre><code class="python language-python hljs">&lt;str&gt; = &lt;DirEntry&gt;.path <span class="hljs-comment"># Returns relative path as a string.</span>
&lt;str&gt; = &lt;DirEntry&gt;.name <span class="hljs-comment"># Returns final component.</span>
</code></pre>
<pre><code class="python language-python hljs">&lt;Path&gt; = Path(&lt;DirEntry&gt;) <span class="hljs-comment"># Returns relative Path object.</span>
&lt;file&gt; = open(&lt;DirEntry&gt;) <span class="hljs-comment"># Opens the file and returns a file object.</span>
</code></pre>
<div><h2 id="oscommands"><a href="#oscommands" name="oscommands">#</a>OS Commands</h2><div><h3 id="filesanddirectories">Files and Directories</h3><ul>
<li><strong>Paths can be either strings, Paths, or DirEntry objects.</strong></li>
@ -1492,26 +1505,14 @@ value = args.&lt;name&gt;
os.mkdir(&lt;path&gt;, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates a directory. Mode is in octal.</span>
</code></pre>
<pre><code class="python language-python hljs">shutil.copy(from, to) <span class="hljs-comment"># Copies the file.</span>
shutil.copytree(from, to) <span class="hljs-comment"># Copies the entire directory tree.</span>
shutil.copytree(from, to) <span class="hljs-comment"># Copies the directory.</span>
</code></pre>
<pre><code class="python language-python hljs">os.rename(from, to) <span class="hljs-comment"># Renames the file or directory.</span>
os.replace(from, to) <span class="hljs-comment"># Same, but overwrites 'to' if it exists.</span>
</code></pre>
<pre><code class="python language-python hljs">os.remove(&lt;path&gt;) <span class="hljs-comment"># Deletes the file.</span>
os.rmdir(&lt;path&gt;) <span class="hljs-comment"># Deletes empty directory.</span>
shutil.rmtree(&lt;path&gt;) <span class="hljs-comment"># Deletes the entire directory tree.</span>
</code></pre>
<pre><code class="python language-python hljs">&lt;iter&gt; = os.scandir(path=<span class="hljs-string">'.'</span>) <span class="hljs-comment"># Returns os.DirEntry objects located at path.</span>
</code></pre>
<div><h4 id="direntry">DirEntry:</h4><pre><code class="python language-python hljs">&lt;bool&gt; = &lt;DirEntry&gt;.is_file()
&lt;bool&gt; = &lt;DirEntry&gt;.is_dir()
</code></pre></div>
<pre><code class="python language-python hljs">&lt;str&gt; = &lt;DirEntry&gt;.path <span class="hljs-comment"># Path as a string.</span>
&lt;str&gt; = &lt;DirEntry&gt;.name <span class="hljs-comment"># Final component.</span>
</code></pre>
<pre><code class="python language-python hljs">&lt;Path&gt; = Path(&lt;DirEntry&gt;) <span class="hljs-comment"># Path object.</span>
&lt;file&gt; = open(&lt;DirEntry&gt;) <span class="hljs-comment"># File object.</span>
shutil.rmtree(&lt;path&gt;) <span class="hljs-comment"># Deletes non-empty directory.</span>
</code></pre>
<div><h3 id="shellcommands">Shell Commands</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
&lt;str&gt; = os.popen(<span class="hljs-string">'&lt;shell_command&gt;'</span>).read()

2
parse.js

@ -36,7 +36,7 @@ const OS_RENAME =
const SHUTIL_COPY =
'shutil.copy(from, to) <span class="hljs-comment"># Copies the file.</span>\n' +
'shutil.copytree(from, to) <span class="hljs-comment"># Copies the entire directory tree.</span>\n';
'shutil.copytree(from, to) <span class="hljs-comment"># Copies the directory.</span>\n';
const EVAL =
'<span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> ast <span class="hljs-keyword">import</span> literal_eval\n' +

Loading…
Cancel
Save