Browse Source

Indentation of comments

pull/36/head
Jure Šorn 5 years ago
parent
commit
4274e465a6
2 changed files with 51 additions and 47 deletions
  1. 49
      README.md
  2. 49
      index.html

49
README.md

@ -746,10 +746,10 @@ Inline
### Comprehension ### Comprehension
```python ```python
<list> = [i+1 for i in range(10)] # [1, 2, ..., 10]
<set> = {i for i in range(10) if i > 5} # {6, 7, 8, 9}
<iter> = (i+5 for i in range(10)) # (5, 6, ..., 14)
<dict> = {i: i*2 for i in range(10)} # {0: 0, 1: 2, ..., 9: 18}
<list> = [i+1 for i in range(10)] # [1, 2, ..., 10]
<set> = {i for i in range(10) if i > 5} # {6, 7, 8, 9}
<iter> = (i+5 for i in range(10)) # (5, 6, ..., 14)
<dict> = {i: i*2 for i in range(10)} # {0: 0, 1: 2, ..., 9: 18}
``` ```
```python ```python
@ -774,8 +774,8 @@ from functools import reduce
### Any, All ### Any, All
```python ```python
<bool> = any(<collection>) # False if empty.
<bool> = all(el[1] for el in <collection>) # True if empty.
<bool> = any(<collection>) # False if empty.
<bool> = all(el[1] for el in <collection>) # True if empty.
``` ```
### If - Else ### If - Else
@ -1589,30 +1589,33 @@ Command Execution
```python ```python
import os import os
os.chdir(<path>) # Changes the current working directory.
<str> = os.getcwd() # Returns current working directory.
os.chdir(<path>) # Changes the current working directory.
<str> = os.getcwd() # Returns current working directory.
``` ```
```python ```python
os.remove(<path>) # Deletes the file.
os.rmdir(<path>) # Deletes empty directory.
shutil.rmtree(<path>) # Deletes an entire directory tree.
os.remove(<path>) # Deletes the file.
os.rmdir(<path>) # Deletes empty directory.
shutil.rmtree(<path>) # Deletes an entire directory tree.
``` ```
```python ```python
os.rename(from, to) # Renames the file or directory.
os.replace(from, to) # Same, but overwrites 'to' if it exists.
os.rename(from, to) # Renames the file or directory.
os.replace(from, to) # Same, but overwrites 'to' if it exists.
``` ```
```python ```python
os.mkdir(<path>, mode=0o777) # Creates a directory.
<iter> = os.scandir(path='.') # Returns os.DirEntry objects located at path.
os.mkdir(<path>, mode=0o777) # Creates a directory.
<iter> = os.scandir(path='.') # Returns os.DirEntry objects located at path.
``` ```
#### DirEntry: #### DirEntry:
```python ```python
<str> = <DirEntry>.name # Final component of the path.
<str> = <DirEntry>.path # Path with final component.
<str> = <DirEntry>.name # Final component of the path.
<str> = <DirEntry>.path # Path with final component.
```
```python
<bool> = <DirEntry>.is_file() <bool> = <DirEntry>.is_file()
<bool> = <DirEntry>.is_dir() <bool> = <DirEntry>.is_dir()
<bool> = <DirEntry>.is_symlink() <bool> = <DirEntry>.is_symlink()
@ -1900,8 +1903,8 @@ from collections import deque
```python ```python
<deque>.appendleft(<el>) <deque>.appendleft(<el>)
<el> = <deque>.popleft() <el> = <deque>.popleft()
<deque>.extendleft(<collection>) # Collection gets reversed.
<deque>.rotate(n=1) # Rotates elements to the right.
<deque>.extendleft(<collection>) # Collection gets reversed.
<deque>.rotate(n=1) # Rotates elements to the right.
``` ```
```python ```python
@ -2156,10 +2159,10 @@ Plot
```python ```python
# $ pip3 install matplotlib # $ pip3 install matplotlib
from matplotlib import pyplot from matplotlib import pyplot
pyplot.plot(<data_1> [, <data_2>, ...]) # Or: hist, pie, ...
pyplot.plot(<data_1> [, <data_2>, ...]) # Or: hist(<data>).
pyplot.savefig(<filename>) pyplot.savefig(<filename>)
pyplot.show() pyplot.show()
pyplot.clf() # Clears figure.
pyplot.clf() # Clears figure.
``` ```
@ -2321,7 +2324,7 @@ Profile
### Basic ### Basic
```python ```python
from time import time from time import time
start_time = time() # Seconds since Epoch.
start_time = time() # Seconds since Epoch.
... ...
duration = time() - start_time duration = time() - start_time
``` ```
@ -2329,7 +2332,7 @@ duration = time() - start_time
### High Performance ### High Performance
```python ```python
from time import perf_counter as pc from time import perf_counter as pc
start_time = pc() # Seconds since restart.
start_time = pc() # Seconds since restart.
... ...
duration = pc() - start_time duration = pc() - start_time
``` ```

49
index.html

@ -745,10 +745,10 @@ func(*args, **kwargs)
&lt;function&gt; = <span class="hljs-keyword">lambda</span> &lt;argument_1&gt;, &lt;argument_2&gt;: &lt;return_value&gt; &lt;function&gt; = <span class="hljs-keyword">lambda</span> &lt;argument_1&gt;, &lt;argument_2&gt;: &lt;return_value&gt;
</code></pre> </code></pre>
<h3 id="comprehension">Comprehension</h3> <h3 id="comprehension">Comprehension</h3>
<pre><code class="python language-python hljs">&lt;list&gt; = [i+<span class="hljs-number">1</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)] <span class="hljs-comment"># [1, 2, ..., 10]</span>
&lt;set&gt; = {i <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>) <span class="hljs-keyword">if</span> i &gt; <span class="hljs-number">5</span>} <span class="hljs-comment"># {6, 7, 8, 9}</span>
&lt;iter&gt; = (i+<span class="hljs-number">5</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># (5, 6, ..., 14)</span>
&lt;dict&gt; = {i: i*<span class="hljs-number">2</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)} <span class="hljs-comment"># {0: 0, 1: 2, ..., 9: 18}</span>
<pre><code class="python language-python hljs">&lt;list&gt; = [i+<span class="hljs-number">1</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)] <span class="hljs-comment"># [1, 2, ..., 10]</span>
&lt;set&gt; = {i <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>) <span class="hljs-keyword">if</span> i &gt; <span class="hljs-number">5</span>} <span class="hljs-comment"># {6, 7, 8, 9}</span>
&lt;iter&gt; = (i+<span class="hljs-number">5</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># (5, 6, ..., 14)</span>
&lt;dict&gt; = {i: i*<span class="hljs-number">2</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)} <span class="hljs-comment"># {0: 0, 1: 2, ..., 9: 18}</span>
</code></pre> </code></pre>
<pre><code class="python language-python hljs">out = [i+j <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>) <span class="hljs-keyword">for</span> j <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)] <pre><code class="python language-python hljs">out = [i+j <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>) <span class="hljs-keyword">for</span> j <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)]
</code></pre> </code></pre>
@ -765,8 +765,8 @@ func(*args, **kwargs)
&lt;int&gt; = reduce(<span class="hljs-keyword">lambda</span> out, x: out + x, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># 45</span> &lt;int&gt; = reduce(<span class="hljs-keyword">lambda</span> out, x: out + x, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># 45</span>
</code></pre> </code></pre>
<h3 id="anyall">Any, All</h3> <h3 id="anyall">Any, All</h3>
<pre><code class="python language-python hljs">&lt;bool&gt; = any(&lt;collection&gt;) <span class="hljs-comment"># False if empty.</span>
&lt;bool&gt; = all(el[<span class="hljs-number">1</span>] <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> &lt;collection&gt;) <span class="hljs-comment"># True if empty.</span>
<pre><code class="python language-python hljs">&lt;bool&gt; = any(&lt;collection&gt;) <span class="hljs-comment"># False if empty.</span>
&lt;bool&gt; = all(el[<span class="hljs-number">1</span>] <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> &lt;collection&gt;) <span class="hljs-comment"># True if empty.</span>
</code></pre> </code></pre>
<h3 id="ifelse">If - Else</h3> <h3 id="ifelse">If - Else</h3>
<pre><code class="python language-python hljs">&lt;expression_if_true&gt; <span class="hljs-keyword">if</span> &lt;condition&gt; <span class="hljs-keyword">else</span> &lt;expression_if_false&gt; <pre><code class="python language-python hljs">&lt;expression_if_true&gt; <span class="hljs-keyword">if</span> &lt;condition&gt; <span class="hljs-keyword">else</span> &lt;expression_if_false&gt;
@ -1431,23 +1431,24 @@ value = args.&lt;name&gt;
<li><strong>All exceptions are either 'OSError' or its subclasses.</strong></li> <li><strong>All exceptions are either 'OSError' or its subclasses.</strong></li>
</ul> </ul>
<pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
os.chdir(&lt;path&gt;) <span class="hljs-comment"># Changes the current working directory.</span>
&lt;str&gt; = os.getcwd() <span class="hljs-comment"># Returns current working directory.</span>
os.chdir(&lt;path&gt;) <span class="hljs-comment"># Changes the current working directory.</span>
&lt;str&gt; = os.getcwd() <span class="hljs-comment"># Returns current working directory.</span>
</code></pre> </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 an entire directory tree.</span>
<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 an entire directory tree.</span>
</code></pre> </code></pre>
<pre><code class="python language-python hljs">os.rename(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Renames the file or directory.</span>
os.replace(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Same, but overwrites 'to' if it exists.</span>
<pre><code class="python language-python hljs">os.rename(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Renames the file or directory.</span>
os.replace(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Same, but overwrites 'to' if it exists.</span>
</code></pre> </code></pre>
<pre><code class="python language-python hljs">os.mkdir(&lt;path&gt;, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates a directory.</span>
&lt;iter&gt; = os.scandir(path=<span class="hljs-string">'.'</span>) <span class="hljs-comment"># Returns os.DirEntry objects located at path.</span>
<pre><code class="python language-python hljs">os.mkdir(&lt;path&gt;, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates a directory.</span>
&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> </code></pre>
<h4 id="direntry">DirEntry:</h4> <h4 id="direntry">DirEntry:</h4>
<pre><code class="python language-python hljs">&lt;str&gt; = &lt;DirEntry&gt;.name <span class="hljs-comment"># Final component of the path.</span>
&lt;str&gt; = &lt;DirEntry&gt;.path <span class="hljs-comment"># Path with final component.</span>
&lt;bool&gt; = &lt;DirEntry&gt;.is_file()
<pre><code class="python language-python hljs">&lt;str&gt; = &lt;DirEntry&gt;.name <span class="hljs-comment"># Final component of the path.</span>
&lt;str&gt; = &lt;DirEntry&gt;.path <span class="hljs-comment"># Path with final component.</span>
</code></pre>
<pre><code class="python language-python hljs">&lt;bool&gt; = &lt;DirEntry&gt;.is_file()
&lt;bool&gt; = &lt;DirEntry&gt;.is_dir() &lt;bool&gt; = &lt;DirEntry&gt;.is_dir()
&lt;bool&gt; = &lt;DirEntry&gt;.is_symlink() &lt;bool&gt; = &lt;DirEntry&gt;.is_symlink()
&lt;Path&gt; = Path(&lt;DirEntry&gt;) &lt;Path&gt; = Path(&lt;DirEntry&gt;)
@ -1667,8 +1668,8 @@ cursor.execute(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;dict/namedt
</code></pre> </code></pre>
<pre><code class="python language-python hljs">&lt;deque&gt;.appendleft(&lt;el&gt;) <pre><code class="python language-python hljs">&lt;deque&gt;.appendleft(&lt;el&gt;)
&lt;el&gt; = &lt;deque&gt;.popleft() &lt;el&gt; = &lt;deque&gt;.popleft()
&lt;deque&gt;.extendleft(&lt;collection&gt;) <span class="hljs-comment"># Collection gets reversed.</span>
&lt;deque&gt;.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Rotates elements to the right.</span>
&lt;deque&gt;.extendleft(&lt;collection&gt;) <span class="hljs-comment"># Collection gets reversed.</span>
&lt;deque&gt;.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Rotates elements to the right.</span>
</code></pre> </code></pre>
<pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>a = deque([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], maxlen=<span class="hljs-number">3</span>) <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>a = deque([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], maxlen=<span class="hljs-number">3</span>)
<span class="hljs-meta">&gt;&gt;&gt; </span>a.append(<span class="hljs-number">4</span>) <span class="hljs-meta">&gt;&gt;&gt; </span>a.append(<span class="hljs-number">4</span>)
@ -1854,10 +1855,10 @@ reader(adder(printer())) <span class="hljs-comment"># 100, 101, ..., 109</span>
<h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2> <h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2>
<pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span> <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span>
<span class="hljs-keyword">from</span> matplotlib <span class="hljs-keyword">import</span> pyplot <span class="hljs-keyword">from</span> matplotlib <span class="hljs-keyword">import</span> pyplot
pyplot.plot(&lt;data_1&gt; [, &lt;data_2&gt;, ...]) <span class="hljs-comment"># Or: hist, pie, ...</span>
pyplot.plot(&lt;data_1&gt; [, &lt;data_2&gt;, ...]) <span class="hljs-comment"># Or: hist(&lt;data&gt;).</span>
pyplot.savefig(&lt;filename&gt;) pyplot.savefig(&lt;filename&gt;)
pyplot.show() pyplot.show()
pyplot.clf() <span class="hljs-comment"># Clears figure.</span>
pyplot.clf() <span class="hljs-comment"># Clears figure.</span>
</code></pre> </code></pre>
<h2 id="table"><a href="#table" name="table">#</a>Table</h2> <h2 id="table"><a href="#table" name="table">#</a>Table</h2>
<h4 id="printsacsvfileasanasciitable">Prints a CSV file as an ASCII table:</h4> <h4 id="printsacsvfileasanasciitable">Prints a CSV file as an ASCII table:</h4>
@ -1982,13 +1983,13 @@ run(host=<span class="hljs-string">'0.0.0.0'</span>, port=<span class="hljs-numb
<h2 id="profile"><a href="#profile" name="profile">#</a>Profile</h2> <h2 id="profile"><a href="#profile" name="profile">#</a>Profile</h2>
<h3 id="basic">Basic</h3> <h3 id="basic">Basic</h3>
<pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> time <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> time
start_time = time() <span class="hljs-comment"># Seconds since Epoch.</span>
start_time = time() <span class="hljs-comment"># Seconds since Epoch.</span>
... ...
duration = time() - start_time duration = time() - start_time
</code></pre> </code></pre>
<h3 id="highperformance">High Performance</h3> <h3 id="highperformance">High Performance</h3>
<pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> perf_counter <span class="hljs-keyword">as</span> pc <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> perf_counter <span class="hljs-keyword">as</span> pc
start_time = pc() <span class="hljs-comment"># Seconds since restart.</span>
start_time = pc() <span class="hljs-comment"># Seconds since restart.</span>
... ...
duration = pc() - start_time duration = pc() - start_time
</code></pre> </code></pre>

Loading…
Cancel
Save