You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1723 lines
141 KiB

6 years ago
6 years ago
6 years ago
  1. <!DOCTYPE html>
  2. <html class="ocks-org do-not-copy">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
  6. <title>Comprehensive Python Cheatsheet</title>
  7. <link rel="icon" href="web/favicon.png">
  8. <link rel="stylesheet" href="web/default.min.css">
  9. <meta name="twitter:card" content="summary">
  10. <meta name="twitter:title" content="Comprehensive Python Cheatsheet">
  11. <meta name="twitter:description" content="Exhaustive, simple, beautiful and concise. A truly pythonic cheat sheet about Python programming language.">
  12. <meta name="twitter:image" content="https://gto76.github.io/python-cheatsheet/web/image_twitter_card_2.jpeg">
  13. </head>
  14. <style>
  15. @import url(web/style.css);
  16. .join,
  17. .link,
  18. .node rect {
  19. fill: none;
  20. stroke: #636363;
  21. stroke-width: 1.5px;
  22. }
  23. .link {
  24. stroke: #969696;
  25. }
  26. .node rect {
  27. fill: white;
  28. }
  29. .link path,
  30. .node rect,
  31. .node text,
  32. .join {
  33. -webkit-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  34. -moz-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  35. -ms-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  36. -o-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  37. transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  38. }
  39. .node .element rect {
  40. fill: #bdbdbd;
  41. stroke: none;
  42. }
  43. .node .null rect {
  44. fill: none;
  45. stroke: none;
  46. }
  47. .node .null text {
  48. fill: #636363;
  49. }
  50. .node .selection rect {
  51. stroke: #e6550d;
  52. }
  53. .node .data rect {
  54. stroke: #3182bd;
  55. }
  56. .node .datum rect {
  57. fill: #d9d9d9;
  58. stroke: none;
  59. }
  60. .node .code text {
  61. font-family: monospace;
  62. }
  63. .node .key rect {
  64. fill: #a1d99b;
  65. stroke: none;
  66. }
  67. .link .to-key,
  68. .join {
  69. stroke: #a1d99b;
  70. }
  71. .join {
  72. stroke-dasharray: 2,2;
  73. }
  74. .link .to-null {
  75. stroke-dasharray: .5,3.5;
  76. stroke-linecap: round;
  77. }
  78. .link .from-data {
  79. stroke: #3182bd;
  80. }
  81. .play circle {
  82. fill: #fff;
  83. stroke: #000;
  84. stroke-width: 3px;
  85. }
  86. .play:hover path {
  87. fill: #f00;
  88. }
  89. .play.mousedown circle {
  90. fill: #f00;
  91. }
  92. .play.mousedown path {
  93. fill: #fff;
  94. }
  95. .play rect {
  96. fill: none;
  97. pointer-events: all;
  98. cursor: pointer;
  99. }
  100. code span {
  101. -webkit-transition: background 250ms linear;
  102. -moz-transition: background 250ms linear;
  103. -ms-transition: background 250ms linear;
  104. -o-transition: background 250ms linear;
  105. transition: background 250ms linear;
  106. }
  107. pre.prettyprint, code.prettyprint {
  108. background-color: #222;
  109. border-radius: 8px;
  110. font-size: 15px;
  111. }
  112. pre.prettyprint {
  113. width: 90%;
  114. margin: 0.5em;
  115. padding: 1em;
  116. white-space: pre-wrap;
  117. }
  118. </style>
  119. <body>
  120. <header>
  121. <aside>March 14, 2018</aside>
  122. <a href="../" rel="author">Jure Šorn</a>
  123. </header>
  124. <h1 id="comprehensivepythoncheatsheet">Comprehensive Python Cheatsheet</h1>
  125. <p class="banner"><sup><a href="https://raw.githubusercontent.com/gto76/python-cheatsheet/master/README.md">Download text file</a>, <a href="https://github.com/gto76/python-cheatsheet">Fork me on GitHub</a> or <a href="https://github.com/gto76/python-cheatsheet/wiki/Frequently-Asked-Questions">Check out FAQ</a>.
  126. </sup></p>
  127. <p class="banner"><img src="web/image_888.jpeg" alt="Monty Python"></p>
  128. <br><h2 id="toc"><a href="#toc" name="toc">#</a>Contents</h2>
  129. <pre><code class="hljs bash"><strong>ToC</strong> = {
  130. <strong><span class="hljs-string"><span class="hljs-string">'1. Collections'</span></span></strong>: [<a href="#list">List</a>, <a href="#dictionary">Dict</a>, <a href="#set">Set</a>, <a href="#range">Range</a>, <a href="#enumerate">Enumerate</a>, <a href="#namedtuple">Namedtuple</a>, <a href="#iterator">Iterator</a>, <a href="#generator">Generator</a>],
  131. <strong><span class="hljs-string"><span class="hljs-string">'2. Types'</span></span></strong>: [<a href="#type">Type</a>, <a href="#string">String</a>, <a href="#regex">Regex</a>, <a href="#format">Format</a>, <a href="#numbers">Numbers</a>, <a href="#combinatorics">Combinatorics</a>, <a href="#datetime">Datetime</a>ᴺᴱᵂ],
  132. <strong><span class="hljs-string"><span class="hljs-string">'3. Syntax'</span></span></strong>: [<a href="#arguments">Arguments</a>, <a href="#splatoperator">Splat</a>, <a href="#inline">Inline</a>, <a href="#closure">Closure</a>, <a href="#decorator">Decorator</a>, <a href="#class">Class</a>, <a href="#enum">Enum</a>, <a href="#exceptions">Exceptions</a>],
  133. <strong><span class="hljs-string"><span class="hljs-string">'4. System'</span></span></strong>: [<a href="#print">Print</a>, <a href="#input">Input</a>, <a href="#commandlinearguments">Command_Line_Arguments</a>, <a href="#open">Open</a>, <a href="#path">Path</a>ᴺᴱᵂ, <a href="#commandexecution">Command_Execution</a>],
  134. <strong><span class="hljs-string"><span class="hljs-string">'5. Data'</span></span></strong>: [<a href="#csv">CSV</a>, <a href="#json">JSON</a>, <a href="#pickle">Pickle</a>, <a href="#sqlite">SQLite</a>, <a href="#bytes">Bytes</a>, <a href="#struct">Struct</a>, <a href="#array">Array</a>, <a href="#memoryview">MemoryView</a>, <a href="#deque">Deque</a>],
  135. <strong><span class="hljs-string"><span class="hljs-string">'6. Advanced'</span></span></strong>: [<a href="#threading">Threading</a>, <a href="#introspection">Introspection</a>, <a href="#metaprograming">Metaprograming</a>, <a href="#operator">Operator</a>, <a href="#eval">Eval</a>, <a href="#coroutine">Coroutine</a>],
  136. <strong><span class="hljs-string"><span class="hljs-string">'7. Libraries'</span></span></strong>: [<a href="#progressbar">Progress_Bar</a>, <a href="#plot">Plot</a>, <a href="#table">Table</a>, <a href="#curses">Curses</a>, <a href="#logging">Logging</a>ᴺᴱᵂ, <a href="#scraping">Scraping</a>, <a href="#web">Web</a>, <a href="#profile">Profile</a>,
  137. <a href="#numpy">NumPy</a>, <a href="#image">Image</a>, <a href="#audio">Audio</a>]
  138. }
  139. </code></pre>
  140. <h2 id="main"><a href="#main" name="main">#</a>Main</h2>
  141. <pre><code class="python language-python hljs"><span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>: <span class="hljs-comment"># Runs main() if file wasn't imported.</span>
  142. main()
  143. </code></pre>
  144. <h2 id="list"><a href="#list" name="list">#</a>List</h2>
  145. <pre><code class="python language-python hljs">&lt;list&gt; = &lt;list&gt;[from_inclusive : to_exclusive : ±step_size]
  146. </code></pre>
  147. <pre><code class="python language-python hljs">&lt;list&gt;.append(&lt;el&gt;) <span class="hljs-comment"># Or: &lt;list&gt; += [&lt;el&gt;]</span>
  148. &lt;list&gt;.extend(&lt;collection&gt;) <span class="hljs-comment"># Or: &lt;list&gt; += &lt;collection&gt;</span>
  149. </code></pre>
  150. <pre><code class="python language-python hljs">&lt;list&gt;.sort()
  151. &lt;list&gt;.reverse()
  152. &lt;list&gt; = sorted(&lt;collection&gt;)
  153. &lt;iter&gt; = reversed(&lt;list&gt;)
  154. </code></pre>
  155. <pre><code class="python language-python hljs">sum_of_elements = sum(&lt;collection&gt;)
  156. elementwise_sum = [sum(pair) <span class="hljs-keyword">for</span> pair <span class="hljs-keyword">in</span> zip(list_a, list_b)]
  157. sorted_by_second = sorted(&lt;collection&gt;, key=<span class="hljs-keyword">lambda</span> el: el[<span class="hljs-number">1</span>])
  158. sorted_by_both = sorted(&lt;collection&gt;, key=<span class="hljs-keyword">lambda</span> el: (el[<span class="hljs-number">1</span>], el[<span class="hljs-number">0</span>]))
  159. flatter_list = list(itertools.chain.from_iterable(&lt;list&gt;))
  160. product_of_elems = functools.reduce(<span class="hljs-keyword">lambda</span> out, x: out * x, &lt;collection&gt;)
  161. list_of_chars = list(&lt;str&gt;)
  162. </code></pre>
  163. <pre><code class="python language-python hljs">index = &lt;list&gt;.index(&lt;el&gt;) <span class="hljs-comment"># Returns first index of item.</span>
  164. &lt;list&gt;.insert(index, &lt;el&gt;) <span class="hljs-comment"># Inserts item at index and moves the rest to the right.</span>
  165. &lt;el&gt; = &lt;list&gt;.pop([index]) <span class="hljs-comment"># Removes and returns item at index or from the end.</span>
  166. &lt;list&gt;.remove(&lt;el&gt;) <span class="hljs-comment"># Removes first occurrence of item or raises ValueError.</span>
  167. &lt;list&gt;.clear() <span class="hljs-comment"># Removes all items.</span>
  168. </code></pre>
  169. <h2 id="dictionary"><a href="#dictionary" name="dictionary">#</a>Dictionary</h2>
  170. <pre><code class="python language-python hljs">&lt;view&gt; = &lt;dict&gt;.keys() <span class="hljs-comment"># Coll. of keys that reflects changes.</span>
  171. &lt;view&gt; = &lt;dict&gt;.values() <span class="hljs-comment"># Coll. of values that reflects changes.</span>
  172. &lt;view&gt; = &lt;dict&gt;.items() <span class="hljs-comment"># Coll. of key-value tuples.</span>
  173. </code></pre>
  174. <pre><code class="python language-python hljs">value = &lt;dict&gt;.get(key, default=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Returns default if key does not exist.</span>
  175. value = &lt;dict&gt;.setdefault(key, default=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Same, but also adds default to dict.</span>
  176. &lt;dict&gt; = collections.defaultdict(&lt;type&gt;) <span class="hljs-comment"># Creates a dict with default value of type.</span>
  177. &lt;dict&gt; = collections.defaultdict(<span class="hljs-keyword">lambda</span>: <span class="hljs-number">1</span>) <span class="hljs-comment"># Creates a dict with default value 1.</span>
  178. </code></pre>
  179. <pre><code class="python language-python hljs">&lt;dict&gt;.update(&lt;dict&gt;) <span class="hljs-comment"># Or: dict_a = {**dict_a, **dict_b}.</span>
  180. &lt;dict&gt; = dict(&lt;collection&gt;) <span class="hljs-comment"># Creates a dict from coll. of key-value pairs.</span>
  181. &lt;dict&gt; = dict(zip(keys, values)) <span class="hljs-comment"># Creates a dict from two collections.</span>
  182. &lt;dict&gt; = dict.fromkeys(keys [, value]) <span class="hljs-comment"># Creates a dict from collection of keys.</span>
  183. </code></pre>
  184. <pre><code class="python language-python hljs">value = &lt;dict&gt;.pop(key) <span class="hljs-comment"># Removes item from dictionary.</span>
  185. {k: v <span class="hljs-keyword">for</span> k, v <span class="hljs-keyword">in</span> &lt;dict&gt;.items() <span class="hljs-keyword">if</span> k <span class="hljs-keyword">in</span> keys} <span class="hljs-comment"># Filters dictionary by keys.</span>
  186. </code></pre>
  187. <h3 id="counter">Counter</h3>
  188. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> Counter
  189. <span class="hljs-meta">&gt;&gt;&gt; </span>colors = [<span class="hljs-string">'red'</span>, <span class="hljs-string">'blue'</span>, <span class="hljs-string">'yellow'</span>, <span class="hljs-string">'blue'</span>, <span class="hljs-string">'red'</span>, <span class="hljs-string">'blue'</span>]
  190. <span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter(colors)
  191. Counter({<span class="hljs-string">'blue'</span>: <span class="hljs-number">3</span>, <span class="hljs-string">'red'</span>: <span class="hljs-number">2</span>, <span class="hljs-string">'yellow'</span>: <span class="hljs-number">1</span>})
  192. <span class="hljs-meta">&gt;&gt;&gt; </span>counter.most_common()[<span class="hljs-number">0</span>]
  193. (<span class="hljs-string">'blue'</span>, <span class="hljs-number">3</span>)
  194. </code></pre>
  195. <h2 id="set"><a href="#set" name="set">#</a>Set</h2>
  196. <pre><code class="python language-python hljs">&lt;set&gt; = set()
  197. </code></pre>
  198. <pre><code class="python language-python hljs">&lt;set&gt;.add(&lt;el&gt;) <span class="hljs-comment"># Or: &lt;set&gt; |= {&lt;el&gt;}</span>
  199. &lt;set&gt;.update(&lt;collection&gt;) <span class="hljs-comment"># Or: &lt;set&gt; |= &lt;set&gt;</span>
  200. </code></pre>
  201. <pre><code class="python language-python hljs">&lt;set&gt; = &lt;set&gt;.union(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; | &lt;set&gt;</span>
  202. &lt;set&gt; = &lt;set&gt;.intersection(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &amp; &lt;set&gt;</span>
  203. &lt;set&gt; = &lt;set&gt;.difference(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; - &lt;set&gt;</span>
  204. &lt;set&gt; = &lt;set&gt;.symmetric_difference(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; ^ &lt;set&gt;</span>
  205. &lt;bool&gt; = &lt;set&gt;.issubset(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &lt;= &lt;set&gt;</span>
  206. &lt;bool&gt; = &lt;set&gt;.issuperset(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &gt;= &lt;set&gt;</span>
  207. </code></pre>
  208. <pre><code class="python language-python hljs">&lt;set&gt;.remove(&lt;el&gt;) <span class="hljs-comment"># Raises KeyError.</span>
  209. &lt;set&gt;.discard(&lt;el&gt;) <span class="hljs-comment"># Doesn't raise an error.</span>
  210. </code></pre>
  211. <h3 id="frozenset">Frozenset</h3>
  212. <h4 id="ishashablemeaningitcanbeusedasakeyinadictionaryorasanelementinaset">Is hashable, meaning it can be used as a key in a dictionary or as an element in a set.</h4>
  213. <pre><code class="python language-python hljs">&lt;frozenset&gt; = frozenset(&lt;collection&gt;)
  214. </code></pre>
  215. <h2 id="range"><a href="#range" name="range">#</a>Range</h2>
  216. <pre><code class="python language-python hljs">&lt;range&gt; = range(to_exclusive)
  217. &lt;range&gt; = range(from_inclusive, to_exclusive)
  218. &lt;range&gt; = range(from_inclusive, to_exclusive, ±step_size)
  219. </code></pre>
  220. <pre><code class="python language-python hljs">from_inclusive = &lt;range&gt;.start
  221. to_exclusive = &lt;range&gt;.stop
  222. </code></pre>
  223. <h2 id="enumerate"><a href="#enumerate" name="enumerate">#</a>Enumerate</h2>
  224. <pre><code class="python language-python hljs"><span class="hljs-keyword">for</span> i, el <span class="hljs-keyword">in</span> enumerate(&lt;collection&gt; [, i_start]):
  225. ...
  226. </code></pre>
  227. <h2 id="namedtuple"><a href="#namedtuple" name="namedtuple">#</a>Named Tuple</h2>
  228. <ul>
  229. <li><strong>Tuple is an immutable and hashable list.</strong></li>
  230. <li><strong>Named tuple is its subclass with named elements.</strong></li>
  231. </ul>
  232. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  233. <span class="hljs-meta">&gt;&gt;&gt; </span>Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  234. <span class="hljs-meta">&gt;&gt;&gt; </span>p = Point(<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  235. Point(x=<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  236. <span class="hljs-meta">&gt;&gt;&gt; </span>p[<span class="hljs-number">0</span>]
  237. <span class="hljs-number">1</span>
  238. <span class="hljs-meta">&gt;&gt;&gt; </span>p.x
  239. <span class="hljs-number">1</span>
  240. <span class="hljs-meta">&gt;&gt;&gt; </span>getattr(p, <span class="hljs-string">'y'</span>)
  241. <span class="hljs-number">2</span>
  242. <span class="hljs-meta">&gt;&gt;&gt; </span>p._fields <span class="hljs-comment"># Or: Point._fields</span>
  243. (<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>)
  244. </code></pre>
  245. <h2 id="iterator"><a href="#iterator" name="iterator">#</a>Iterator</h2>
  246. <p><strong>In this cheatsheet <code class="python hljs"><span class="hljs-string">'&lt;collection&gt;'</span></code> can also mean an iterator.</strong></p>
  247. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> itertools <span class="hljs-keyword">import</span> count, repeat, cycle, chain, islice
  248. </code></pre>
  249. <pre><code class="python language-python hljs">&lt;iter&gt; = iter(&lt;collection&gt;)
  250. &lt;iter&gt; = iter(&lt;function&gt;, to_exclusive) <span class="hljs-comment"># Sequence of return values until 'to_exclusive'.</span>
  251. &lt;el&gt; = next(&lt;iter&gt; [, default]) <span class="hljs-comment"># Raises StopIteration or returns 'default' on end.</span>
  252. </code></pre>
  253. <pre><code class="python language-python hljs">&lt;iter&gt; = count(start=<span class="hljs-number">0</span>, step=<span class="hljs-number">1</span>) <span class="hljs-comment"># Returns incremented value endlessly.</span>
  254. &lt;iter&gt; = repeat(&lt;el&gt; [, times]) <span class="hljs-comment"># Returns element endlessly or 'times' times.</span>
  255. &lt;iter&gt; = cycle(&lt;collection&gt;) <span class="hljs-comment"># Repeats the sequence indefinitely.</span>
  256. </code></pre>
  257. <pre><code class="python language-python hljs">&lt;iter&gt; = chain(&lt;coll.&gt;, &lt;coll.&gt;, ...) <span class="hljs-comment"># Empties collections in order.</span>
  258. &lt;iter&gt; = chain.from_iterable(&lt;collection&gt;) <span class="hljs-comment"># Empties collections inside a collection in order.</span>
  259. </code></pre>
  260. <pre><code class="python language-python hljs">&lt;iter&gt; = islice(&lt;collection&gt;, to_exclusive)
  261. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive)
  262. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive, step_size)
  263. </code></pre>
  264. <h2 id="generator"><a href="#generator" name="generator">#</a>Generator</h2>
  265. <p><strong>Convenient way to implement the iterator protocol.</strong></p>
  266. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">count</span><span class="hljs-params">(start, step)</span>:</span>
  267. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  268. <span class="hljs-keyword">yield</span> start
  269. start += step
  270. </code></pre>
  271. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = count(<span class="hljs-number">10</span>, <span class="hljs-number">2</span>)
  272. <span class="hljs-meta">&gt;&gt;&gt; </span>next(counter), next(counter), next(counter)
  273. (<span class="hljs-number">10</span>, <span class="hljs-number">12</span>, <span class="hljs-number">14</span>)
  274. </code></pre>
  275. <h2 id="type"><a href="#type" name="type">#</a>Type</h2>
  276. <pre><code class="python language-python hljs">&lt;type&gt; = type(&lt;el&gt;) <span class="hljs-comment"># &lt;class 'int'&gt; / &lt;class 'str'&gt; / ...</span>
  277. </code></pre>
  278. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> numbers <span class="hljs-keyword">import</span> Integral, Rational, Real, Complex, Number
  279. &lt;bool&gt; = isinstance(&lt;el&gt;, Number)
  280. </code></pre>
  281. <pre><code class="python language-python hljs">&lt;bool&gt; = callable(&lt;el&gt;)
  282. </code></pre>
  283. <h2 id="string"><a href="#string" name="string">#</a>String</h2>
  284. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;str&gt;.strip() <span class="hljs-comment"># Strips all whitespace characters from both ends.</span>
  285. &lt;str&gt; = &lt;str&gt;.strip(<span class="hljs-string">'&lt;chars&gt;'</span>) <span class="hljs-comment"># Strips all passed characters from both ends.</span>
  286. </code></pre>
  287. <pre><code class="python language-python hljs">&lt;list&gt; = &lt;str&gt;.split() <span class="hljs-comment"># Splits on any whitespace character.</span>
  288. &lt;list&gt; = &lt;str&gt;.split(sep=<span class="hljs-keyword">None</span>, maxsplit=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Splits on 'sep' str at most 'maxsplit' times.</span>
  289. &lt;str&gt; = &lt;str&gt;.join(&lt;collection&gt;) <span class="hljs-comment"># Joins elements using string as separator.</span>
  290. </code></pre>
  291. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;str&gt;.replace(old, new [, count]) <span class="hljs-comment"># Replaces 'old' with 'new' at most 'count' times.</span>
  292. &lt;bool&gt; = &lt;str&gt;.startswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  293. &lt;bool&gt; = &lt;str&gt;.endswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  294. &lt;int&gt; = &lt;str&gt;.index(&lt;sub_str&gt;) <span class="hljs-comment"># Returns start index of first match.</span>
  295. </code></pre>
  296. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;str&gt;.isnumeric() <span class="hljs-comment"># True if str contains only numeric characters.</span>
  297. &lt;list&gt; = textwrap.wrap(&lt;str&gt;, width) <span class="hljs-comment"># Nicely breaks string into lines.</span>
  298. </code></pre>
  299. <h3 id="char">Char</h3>
  300. <pre><code class="python language-python hljs">&lt;str&gt; = chr(&lt;int&gt;) <span class="hljs-comment"># Converts int to unicode char.</span>
  301. &lt;int&gt; = ord(&lt;str&gt;) <span class="hljs-comment"># Converts unicode char to int.</span>
  302. </code></pre>
  303. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'0'</span>), ord(<span class="hljs-string">'9'</span>)
  304. (<span class="hljs-number">48</span>, <span class="hljs-number">57</span>)
  305. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'A'</span>), ord(<span class="hljs-string">'Z'</span>)
  306. (<span class="hljs-number">65</span>, <span class="hljs-number">90</span>)
  307. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'a'</span>), ord(<span class="hljs-string">'z'</span>)
  308. (<span class="hljs-number">97</span>, <span class="hljs-number">122</span>)
  309. </code></pre>
  310. <h2 id="regex"><a href="#regex" name="regex">#</a>Regex</h2>
  311. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> re
  312. &lt;str&gt; = re.sub(&lt;regex&gt;, new, text, count=<span class="hljs-number">0</span>) <span class="hljs-comment"># Substitutes all occurrences.</span>
  313. &lt;list&gt; = re.findall(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences.</span>
  314. &lt;list&gt; = re.split(&lt;regex&gt;, text, maxsplit=<span class="hljs-number">0</span>) <span class="hljs-comment"># Use brackets in regex to keep the matches.</span>
  315. &lt;Match&gt; = re.search(&lt;regex&gt;, text) <span class="hljs-comment"># Searches for first occurrence of pattern.</span>
  316. &lt;Match&gt; = re.match(&lt;regex&gt;, text) <span class="hljs-comment"># Searches only at the beginning of the text.</span>
  317. &lt;iter&gt; = re.finditer(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences as match objects.</span>
  318. </code></pre>
  319. <ul>
  320. <li><strong>Parameter <code class="python hljs"><span class="hljs-string">'flags=re.IGNORECASE'</span></code> can be used with all functions.</strong></li>
  321. <li><strong>Parameter <code class="python hljs"><span class="hljs-string">'flags=re.DOTALL'</span></code> makes dot also accept newline.</strong></li>
  322. <li><strong>Use <code class="python hljs"><span class="hljs-string">r'\1'</span></code> or <code class="python hljs"><span class="hljs-string">'\\1'</span></code> for backreference.</strong></li>
  323. <li><strong>Use <code class="python hljs"><span class="hljs-string">'?'</span></code> to make an operator non-greedy.</strong></li>
  324. </ul>
  325. <h3 id="matchobject">Match Object</h3>
  326. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Match&gt;.group() <span class="hljs-comment"># Whole match.</span>
  327. &lt;str&gt; = &lt;Match&gt;.group(<span class="hljs-number">1</span>) <span class="hljs-comment"># Part in first bracket.</span>
  328. &lt;tuple&gt; = &lt;Match&gt;.groups() <span class="hljs-comment"># All bracketed parts.</span>
  329. &lt;int&gt; = &lt;Match&gt;.start() <span class="hljs-comment"># Start index of a match.</span>
  330. &lt;int&gt; = &lt;Match&gt;.end() <span class="hljs-comment"># Exclusive end index of a match.</span>
  331. </code></pre>
  332. <h3 id="specialsequences">Special Sequences</h3>
  333. <p><strong>Expressions below hold true for strings that contain only ASCII characters. Use capital letters for negation.</strong></p>
  334. <pre><code class="python language-python hljs"><span class="hljs-string">'\d'</span> == <span class="hljs-string">'[0-9]'</span> <span class="hljs-comment"># Digit</span>
  335. <span class="hljs-string">'\s'</span> == <span class="hljs-string">'[ \t\n\r\f\v]'</span> <span class="hljs-comment"># Whitespace</span>
  336. <span class="hljs-string">'\w'</span> == <span class="hljs-string">'[a-zA-Z0-9_]'</span> <span class="hljs-comment"># Alphanumeric</span>
  337. </code></pre>
  338. <h2 id="format"><a href="#format" name="format">#</a>Format</h2>
  339. <pre><code class="python language-python hljs">&lt;str&gt; = <span class="hljs-string">f'<span class="hljs-subst">{&lt;el_1&gt;}</span>, <span class="hljs-subst">{&lt;el_2&gt;}</span>'</span>
  340. &lt;str&gt; = <span class="hljs-string">'{}, {}'</span>.format(&lt;el_1&gt;, &lt;el_2&gt;)
  341. </code></pre>
  342. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  343. <span class="hljs-meta">&gt;&gt;&gt; </span>Person = namedtuple(<span class="hljs-string">'Person'</span>, <span class="hljs-string">'name height'</span>)
  344. <span class="hljs-meta">&gt;&gt;&gt; </span>person = Person(<span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>)
  345. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">f'<span class="hljs-subst">{person.height}</span>'</span>
  346. <span class="hljs-string">'187'</span>
  347. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">'{p.height}'</span>.format(p=person)
  348. <span class="hljs-string">'187'</span>
  349. </code></pre>
  350. <h3 id="generaloptions">General Options</h3>
  351. <pre><code class="python language-python hljs">{&lt;el&gt;:&lt;<span class="hljs-number">10</span>} <span class="hljs-comment"># '&lt;el&gt; '</span>
  352. {&lt;el&gt;:&gt;<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt;'</span>
  353. {&lt;el&gt;:^<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt; '</span>
  354. {&lt;el&gt;:.&gt;<span class="hljs-number">10</span>} <span class="hljs-comment"># '......&lt;el&gt;'</span>
  355. {&lt;el&gt;:&gt;<span class="hljs-number">0</span>} <span class="hljs-comment"># '&lt;el&gt;'</span>
  356. </code></pre>
  357. <h3 id="stringoptions">String Options</h3>
  358. <p><strong><code class="python hljs"><span class="hljs-string">'!r'</span></code> calls object's repr() method, instead of format(), to get a string.</strong></p>
  359. <pre><code class="python language-python hljs">{<span class="hljs-string">'abcde'</span>!r:&lt;<span class="hljs-number">10</span>} <span class="hljs-comment"># "'abcde' "</span>
  360. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">.3</span>} <span class="hljs-comment"># 'abc'</span>
  361. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># 'abc '</span>
  362. </code></pre>
  363. <h3 id="numberoptions">Number Options</h3>
  364. <pre><code class="python language-python hljs">{ <span class="hljs-number">123456</span>:<span class="hljs-number">10</span>,} <span class="hljs-comment"># ' 123,456'</span>
  365. { <span class="hljs-number">123456</span>:<span class="hljs-number">10</span>_} <span class="hljs-comment"># ' 123_456'</span>
  366. { <span class="hljs-number">123456</span>:+<span class="hljs-number">10</span>} <span class="hljs-comment"># ' +123456'</span>
  367. {<span class="hljs-number">-123456</span>:=<span class="hljs-number">10</span>} <span class="hljs-comment"># '- 123456'</span>
  368. { <span class="hljs-number">123456</span>: } <span class="hljs-comment"># ' 123456'</span>
  369. {<span class="hljs-number">-123456</span>: } <span class="hljs-comment"># '-123456'</span>
  370. </code></pre>
  371. <h4 id="floattypes">Float types:</h4>
  372. <pre><code class="python language-python hljs">{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>f} <span class="hljs-comment"># ' 1.235'</span>
  373. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>e} <span class="hljs-comment"># ' 1.235e+00'</span>
  374. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>%} <span class="hljs-comment"># ' 123.456%'</span>
  375. </code></pre>
  376. <h4 id="inttypes">Int types:</h4>
  377. <pre><code class="python language-python hljs">{<span class="hljs-number">90</span>:c} <span class="hljs-comment"># 'Z'</span>
  378. {<span class="hljs-number">90</span>:X} <span class="hljs-comment"># '5A'</span>
  379. {<span class="hljs-number">90</span>:b} <span class="hljs-comment"># '1011010'</span>
  380. </code></pre>
  381. <h2 id="numbers"><a href="#numbers" name="numbers">#</a>Numbers</h2>
  382. <h3 id="basicfunctions">Basic Functions</h3>
  383. <pre><code class="python language-python hljs">&lt;num&gt; = pow(&lt;num&gt;, &lt;num&gt;) <span class="hljs-comment"># Or: &lt;num&gt; ** &lt;num&gt;</span>
  384. &lt;real&gt; = abs(&lt;num&gt;)
  385. &lt;int&gt; = round(&lt;real&gt;)
  386. &lt;real&gt; = round(&lt;real&gt;, ±ndigits)
  387. </code></pre>
  388. <h3 id="math">Math</h3>
  389. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> e, pi
  390. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> cos, acos, sin, asin, tan, atan, degrees, radians
  391. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> log, log10, log2
  392. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> inf, nan, isinf, isnan
  393. </code></pre>
  394. <h3 id="statistics">Statistics</h3>
  395. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> statistics <span class="hljs-keyword">import</span> mean, median, variance, pvariance, pstdev
  396. </code></pre>
  397. <h3 id="random">Random</h3>
  398. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> random, randint, choice, shuffle
  399. &lt;float&gt; = random()
  400. &lt;int&gt; = randint(from_inclusive, to_inclusive)
  401. &lt;el&gt; = choice(&lt;list&gt;)
  402. shuffle(&lt;list&gt;)
  403. </code></pre>
  404. <h2 id="combinatorics"><a href="#combinatorics" name="combinatorics">#</a>Combinatorics</h2>
  405. <ul>
  406. <li><strong>Every function returns an iterator.</strong></li>
  407. <li><strong>If you want to print the iterator, you need to pass it to the list() function!</strong></li>
  408. </ul>
  409. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> itertools <span class="hljs-keyword">import</span> product, combinations, combinations_with_replacement, permutations
  410. </code></pre>
  411. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>product([<span class="hljs-number">0</span>, <span class="hljs-number">1</span>], repeat=<span class="hljs-number">3</span>)
  412. [(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>), (<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1</span>), (<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">0</span>), (<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">1</span>),
  413. (<span class="hljs-number">1</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>), (<span class="hljs-number">1</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1</span>), (<span class="hljs-number">1</span>, <span class="hljs-number">1</span>, <span class="hljs-number">0</span>), (<span class="hljs-number">1</span>, <span class="hljs-number">1</span>, <span class="hljs-number">1</span>)]
  414. </code></pre>
  415. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>product(<span class="hljs-string">'ab'</span>, <span class="hljs-string">'12'</span>)
  416. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'2'</span>),
  417. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'2'</span>)]
  418. </code></pre>
  419. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>combinations(<span class="hljs-string">'abc'</span>, <span class="hljs-number">2</span>)
  420. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'c'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>)]
  421. </code></pre>
  422. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>combinations_with_replacement(<span class="hljs-string">'abc'</span>, <span class="hljs-number">2</span>)
  423. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'c'</span>),
  424. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  425. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'c'</span>)]
  426. </code></pre>
  427. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>permutations(<span class="hljs-string">'abc'</span>, <span class="hljs-number">2</span>)
  428. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'c'</span>),
  429. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  430. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'c'</span>, <span class="hljs-string">'b'</span>)]
  431. </code></pre>
  432. <h2 id="datetime"><a href="#datetime" name="datetime">#</a>Datetime</h2>
  433. <ul>
  434. <li><strong>Module 'datetime' provides 'date' <code class="python hljs">&lt;D&gt;</code>, 'time' <code class="python hljs">&lt;T&gt;</code>, 'datetime' <code class="python hljs">&lt;DT&gt;</code> and 'timedelta' <code class="python hljs">&lt;TD&gt;</code> classes. All are immutable and hashable.</strong></li>
  435. <li><strong>Time and datetime can be 'aware' <code class="python hljs">&lt;a&gt;</code>, meaning they have defined timezone, or 'naive' <code class="python hljs">&lt;n&gt;</code>, meaning they don't.</strong></li>
  436. <li><strong>If object is naive it is presumed to be in system's timezone.</strong></li>
  437. </ul>
  438. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> date, time, datetime, timedelta
  439. <span class="hljs-keyword">from</span> dateutil.tz <span class="hljs-keyword">import</span> UTC, tzlocal, gettz
  440. </code></pre>
  441. <h3 id="constructors">Constructors</h3>
  442. <pre><code class="python language-python hljs">&lt;D&gt; = date(year, month, day)
  443. &lt;T&gt; = time(hour=<span class="hljs-number">0</span>, minute=<span class="hljs-number">0</span>, second=<span class="hljs-number">0</span>, microsecond=<span class="hljs-number">0</span>, tzinfo=<span class="hljs-keyword">None</span>, fold=<span class="hljs-number">0</span>)
  444. &lt;DT&gt; = datetime(year, month, day, hour=<span class="hljs-number">0</span>, minute=<span class="hljs-number">0</span>, second=<span class="hljs-number">0</span>, ...)
  445. &lt;TD&gt; = timedelta(days=<span class="hljs-number">0</span>, seconds=<span class="hljs-number">0</span>, microseconds=<span class="hljs-number">0</span>, milliseconds=<span class="hljs-number">0</span>,
  446. minutes=<span class="hljs-number">0</span>, hours=<span class="hljs-number">0</span>, weeks=<span class="hljs-number">0</span>)
  447. </code></pre>
  448. <ul>
  449. <li><strong>Use <code class="python hljs"><span class="hljs-string">'&lt;D/DT&gt;.weekday()'</span></code> to get the day of the week (Mon == 0).</strong></li>
  450. <li><strong><code class="python hljs"><span class="hljs-string">'fold=1'</span></code> means second pass in case of time jumping back for one hour.</strong></li>
  451. </ul>
  452. <h3 id="now">Now</h3>
  453. <pre><code class="python language-python hljs">&lt;D/DTn&gt; = D/DT.today() <span class="hljs-comment"># Current local date or naive datetime.</span>
  454. &lt;DTn&gt; = DT.utcnow() <span class="hljs-comment"># Naive datetime from current UTC time.</span>
  455. &lt;DTa&gt; = DT.now(&lt;tz&gt;) <span class="hljs-comment"># Aware datetime from current tz time.</span>
  456. </code></pre>
  457. <h3 id="timezone">Timezone</h3>
  458. <pre><code class="python language-python hljs">&lt;tz&gt; = UTC <span class="hljs-comment"># UTC timezone.</span>
  459. &lt;tz&gt; = tzlocal() <span class="hljs-comment"># Local timezone.</span>
  460. &lt;tz&gt; = gettz(<span class="hljs-string">'&lt;Cont.&gt;/&lt;City&gt;'</span>) <span class="hljs-comment"># Timezone from 'Continent/City_Name' str.</span>
  461. </code></pre>
  462. <pre><code class="python language-python hljs">&lt;DTa&gt; = &lt;DT&gt;.astimezone(&lt;tz&gt;) <span class="hljs-comment"># Datetime, converted to passed timezone.</span>
  463. &lt;Ta/DTa&gt; = &lt;T/DT&gt;.replace(tzinfo=&lt;tz&gt;) <span class="hljs-comment"># Unconverted object with new timezone.</span>
  464. </code></pre>
  465. <h3 id="encode">Encode</h3>
  466. <pre><code class="python language-python hljs">&lt;D/T/DT&gt; = D/T/DT.fromisoformat(<span class="hljs-string">'&lt;iso&gt;'</span>) <span class="hljs-comment"># Object from ISO string.</span>
  467. &lt;DT&gt; = DT.strptime(&lt;str&gt;, <span class="hljs-string">'&lt;format&gt;'</span>) <span class="hljs-comment"># Datetime from str, according to format.</span>
  468. &lt;D/DTn&gt; = D/DT.fromordinal(&lt;int&gt;) <span class="hljs-comment"># D/DTn from days since Christ.</span>
  469. &lt;DTa&gt; = DT.fromtimestamp(&lt;real&gt;, &lt;tz&gt;) <span class="hljs-comment"># DTa from seconds since Epoch in tz time.</span>
  470. </code></pre>
  471. <ul>
  472. <li><strong>ISO strings come in following forms: <code class="python hljs"><span class="hljs-string">'YYYY-MM-DD'</span></code>, <code class="python hljs"><span class="hljs-string">'HH:MM:SS.ffffff[±&lt;offset&gt;]'</span></code>, or both separated by <code class="python hljs"><span class="hljs-string">'T'</span></code>. Offset is formatted as: <code class="python hljs"><span class="hljs-string">'HH:MM'</span></code>.</strong></li>
  473. <li><strong>On Unix systems Epoch is <code class="python hljs"><span class="hljs-string">'1970-01-01 00:00 UTC'</span></code>, <code class="python hljs"><span class="hljs-string">'1970-01-01 01:00 CET'</span></code>, …</strong></li>
  474. </ul>
  475. <h3 id="decode">Decode</h3>
  476. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;D/T/DT&gt;.isoformat() <span class="hljs-comment"># ISO string representation.</span>
  477. &lt;str&gt; = &lt;D/T/DT&gt;.strftime(<span class="hljs-string">'&lt;format&gt;'</span>) <span class="hljs-comment"># Custom string representation.</span>
  478. &lt;int&gt; = &lt;D/DT&gt;.toordinal() <span class="hljs-comment"># Days since Christ, ignoring time and tz.</span>
  479. &lt;float&gt; = &lt;DT&gt;.timestamp() <span class="hljs-comment"># Seconds since Epoch in local time or tz.</span>
  480. </code></pre>
  481. <h3 id="format-1">Format</h3>
  482. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> datetime
  483. <span class="hljs-meta">&gt;&gt;&gt; </span>dt = datetime.strptime(<span class="hljs-string">'2015-05-14 23:39:00.00 +0200'</span>, <span class="hljs-string">'%Y-%m-%d %H:%M:%S.%f %z'</span>)
  484. <span class="hljs-meta">&gt;&gt;&gt; </span>dt.strftime(<span class="hljs-string">"%A, %dth of %B '%y, %I:%M%p %Z"</span>)
  485. <span class="hljs-string">"Thursday, 14th of May '15, 11:39PM UTC+02:00"</span>
  486. </code></pre>
  487. <h4 id="restofthecodes">Rest of the codes:</h4>
  488. <ul>
  489. <li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Weekday, abbreviated name.</strong></li>
  490. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Month, abbreviated name.</strong></li>
  491. </ul>
  492. <h2 id="arguments"><a href="#arguments" name="arguments">#</a>Arguments</h2>
  493. <h3 id="insidefunctioncall">Inside Function Call</h3>
  494. <pre><code class="python language-python hljs">&lt;function&gt;(&lt;positional_args&gt;) <span class="hljs-comment"># f(0, 0)</span>
  495. &lt;function&gt;(&lt;keyword_args&gt;) <span class="hljs-comment"># f(x=0, y=0)</span>
  496. &lt;function&gt;(&lt;positional_args&gt;, &lt;keyword_args&gt;) <span class="hljs-comment"># f(0, y=0)</span>
  497. </code></pre>
  498. <h3 id="insidefunctiondefinition">Inside Function Definition</h3>
  499. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(&lt;nondefault_args&gt;)</span>:</span> <span class="hljs-comment"># def f(x, y)</span>
  500. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(&lt;default_args&gt;)</span>:</span> <span class="hljs-comment"># def f(x=0, y=0)</span>
  501. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(&lt;nondefault_args&gt;, &lt;default_args&gt;)</span>:</span> <span class="hljs-comment"># def f(x, y=0)</span>
  502. </code></pre>
  503. <h2 id="splatoperator"><a href="#splatoperator" name="splatoperator">#</a>Splat Operator</h2>
  504. <h3 id="insidefunctioncall-1">Inside Function Call</h3>
  505. <p><strong>Splat expands a collection into positional arguments, while splatty-splat expands a dictionary into keyword arguments.</strong></p>
  506. <pre><code class="python language-python hljs">args = (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>)
  507. kwargs = {<span class="hljs-string">'x'</span>: <span class="hljs-number">3</span>, <span class="hljs-string">'y'</span>: <span class="hljs-number">4</span>, <span class="hljs-string">'z'</span>: <span class="hljs-number">5</span>}
  508. func(*args, **kwargs)
  509. </code></pre>
  510. <h4 id="isthesameas">Is the same as:</h4>
  511. <pre><code class="python language-python hljs">func(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, x=<span class="hljs-number">3</span>, y=<span class="hljs-number">4</span>, z=<span class="hljs-number">5</span>)
  512. </code></pre>
  513. <h3 id="insidefunctiondefinition-1">Inside Function Definition</h3>
  514. <p><strong>Splat combines zero or more positional arguments into a tuple, while splatty-splat combines zero or more keyword arguments into a dictionary.</strong></p>
  515. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(*a)</span>:</span>
  516. <span class="hljs-keyword">return</span> sum(a)
  517. </code></pre>
  518. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>add(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  519. <span class="hljs-number">6</span>
  520. </code></pre>
  521. <h4 id="legalargumentcombinations">Legal argument combinations:</h4>
  522. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(*args)</span>:</span> <span class="hljs-comment"># f(1, 2, 3)</span>
  523. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, *args)</span>:</span> <span class="hljs-comment"># f(1, 2, 3)</span>
  524. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(*args, z)</span>:</span> <span class="hljs-comment"># f(1, 2, z=3)</span>
  525. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, *args, z)</span>:</span> <span class="hljs-comment"># f(1, 2, z=3)</span>
  526. </code></pre>
  527. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(**kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3)</span>
  528. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, **kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3)</span>
  529. </code></pre>
  530. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(*args, **kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3) | f(1, 2, z=3) | f(1, 2, 3)</span>
  531. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, *args, **kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3) | f(1, 2, z=3) | f(1, 2, 3)</span>
  532. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(*args, y, **kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3)</span>
  533. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, *args, z, **kwargs)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3) | f(1, 2, z=3)</span>
  534. </code></pre>
  535. <h3 id="otheruses">Other Uses</h3>
  536. <pre><code class="python language-python hljs">&lt;list&gt; = [*&lt;collection&gt; [, ...]]
  537. &lt;set&gt; = {*&lt;collection&gt; [, ...]}
  538. &lt;tuple&gt; = (*&lt;collection&gt;, [...])
  539. &lt;dict&gt; = {**&lt;dict&gt; [, ...]}
  540. </code></pre>
  541. <pre><code class="python language-python hljs">head, *body, tail = &lt;collection&gt;
  542. </code></pre>
  543. <h2 id="inline"><a href="#inline" name="inline">#</a>Inline</h2>
  544. <h3 id="lambda">Lambda</h3>
  545. <pre><code class="python language-python hljs">&lt;function&gt; = <span class="hljs-keyword">lambda</span>: &lt;return_value&gt;
  546. &lt;function&gt; = <span class="hljs-keyword">lambda</span> &lt;argument_1&gt;, &lt;argument_2&gt;: &lt;return_value&gt;
  547. </code></pre>
  548. <h3 id="comprehension">Comprehension</h3>
  549. <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>
  550. &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>
  551. &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>
  552. &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>
  553. </code></pre>
  554. <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>)]
  555. </code></pre>
  556. <h4 id="isthesameas-1">Is the same as:</h4>
  557. <pre><code class="python language-python hljs">out = []
  558. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  559. <span class="hljs-keyword">for</span> j <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  560. out.append(i+j)
  561. </code></pre>
  562. <h3 id="mapfilterreduce">Map, Filter, Reduce</h3>
  563. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> reduce
  564. &lt;iter&gt; = map(<span class="hljs-keyword">lambda</span> x: x + <span class="hljs-number">1</span>, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># (1, 2, ..., 10)</span>
  565. &lt;iter&gt; = filter(<span class="hljs-keyword">lambda</span> x: x &gt; <span class="hljs-number">5</span>, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># (6, 7, 8, 9)</span>
  566. &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>
  567. </code></pre>
  568. <h3 id="anyall">Any, All</h3>
  569. <pre><code class="python language-python hljs">&lt;bool&gt; = any(&lt;collection&gt;) <span class="hljs-comment"># False if empty.</span>
  570. &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>
  571. </code></pre>
  572. <h3 id="ifelse">If - Else</h3>
  573. <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;
  574. </code></pre>
  575. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>[a <span class="hljs-keyword">if</span> a <span class="hljs-keyword">else</span> <span class="hljs-string">'zero'</span> <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> (<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">0</span>, <span class="hljs-number">3</span>)]
  576. [<span class="hljs-string">'zero'</span>, <span class="hljs-number">1</span>, <span class="hljs-string">'zero'</span>, <span class="hljs-number">3</span>]
  577. </code></pre>
  578. <h3 id="namedtupleenumclass">Namedtuple, Enum, Class</h3>
  579. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  580. Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  581. point = Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>)
  582. </code></pre>
  583. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  584. Direction = Enum(<span class="hljs-string">'Direction'</span>, <span class="hljs-string">'n e s w'</span>)
  585. Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, {<span class="hljs-string">'fork'</span>: <span class="hljs-number">1</span>, <span class="hljs-string">'knife'</span>: <span class="hljs-number">2</span>, <span class="hljs-string">'spoon'</span>: <span class="hljs-number">3</span>})
  586. </code></pre>
  587. <pre><code class="python language-python hljs"><span class="hljs-comment"># Warning: Objects will share the objects that are initialized in the dictionary!</span>
  588. Creature = type(<span class="hljs-string">'Creature'</span>, (), {<span class="hljs-string">'p'</span>: Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>), <span class="hljs-string">'d'</span>: Direction.n})
  589. creature = Creature()
  590. </code></pre>
  591. <h2 id="closure"><a href="#closure" name="closure">#</a>Closure</h2>
  592. <p><strong>We have a closure in Python when:</strong></p>
  593. <ul>
  594. <li><strong>A nested function references a value of its enclosing function and then</strong></li>
  595. <li><strong>the enclosing function returns the nested function.</strong></li>
  596. </ul>
  597. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_multiplier</span><span class="hljs-params">(a)</span>:</span>
  598. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(b)</span>:</span>
  599. <span class="hljs-keyword">return</span> a * b
  600. <span class="hljs-keyword">return</span> out
  601. </code></pre>
  602. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3 = get_multiplier(<span class="hljs-number">3</span>)
  603. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  604. <span class="hljs-number">30</span>
  605. </code></pre>
  606. <ul>
  607. <li><strong>If multiple nested functions within enclosing function reference the same value, that value gets shared.</strong></li>
  608. <li><strong>To dynamically access function's first free variable use <code class="python hljs"><span class="hljs-string">'&lt;function&gt;.__closure__[0].cell_contents'</span></code>.</strong></li>
  609. </ul>
  610. <h3 id="partial">Partial</h3>
  611. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  612. &lt;function&gt; = partial(&lt;function&gt; [, &lt;arg_1&gt;, &lt;arg_2&gt;, ...])
  613. </code></pre>
  614. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
  615. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3 = partial(op.mul, <span class="hljs-number">3</span>)
  616. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  617. <span class="hljs-number">30</span>
  618. </code></pre>
  619. <h3 id="nonlocal">Nonlocal</h3>
  620. <p><strong>If variable is being assigned to anywhere in the scope, it is regarded as a local variable, unless it is declared as a 'global' or a 'nonlocal'.</strong></p>
  621. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_counter</span><span class="hljs-params">()</span>:</span>
  622. i = <span class="hljs-number">0</span>
  623. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">()</span>:</span>
  624. <span class="hljs-keyword">nonlocal</span> i
  625. i += <span class="hljs-number">1</span>
  626. <span class="hljs-keyword">return</span> i
  627. <span class="hljs-keyword">return</span> out
  628. </code></pre>
  629. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = get_counter()
  630. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  631. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  632. </code></pre>
  633. <h2 id="decorator"><a href="#decorator" name="decorator">#</a>Decorator</h2>
  634. <p><strong>A decorator takes a function, adds some functionality and returns it.</strong></p>
  635. <pre><code class="python language-python hljs"><span class="hljs-meta">@decorator_name</span>
  636. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">function_that_gets_passed_to_decorator</span><span class="hljs-params">()</span>:</span>
  637. ...
  638. </code></pre>
  639. <h3 id="debuggerexample">Debugger Example</h3>
  640. <p><strong>Decorator that prints function's name every time it gets called.</strong></p>
  641. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  642. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(func)</span>:</span>
  643. <span class="hljs-meta"> @wraps(func)</span>
  644. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  645. print(func.__name__)
  646. <span class="hljs-keyword">return</span> func(*args, **kwargs)
  647. <span class="hljs-keyword">return</span> out
  648. <span class="hljs-meta">@debug</span>
  649. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  650. <span class="hljs-keyword">return</span> x + y
  651. </code></pre>
  652. <ul>
  653. <li><strong>Wraps is a helper decorator that copies metadata of function add() to function out().</strong></li>
  654. <li><strong>Without it <code class="python hljs"><span class="hljs-string">'add.__name__'</span></code> would return <code class="python hljs"><span class="hljs-string">'out'</span></code>.</strong></li>
  655. </ul>
  656. <h3 id="lrucache">LRU Cache</h3>
  657. <p><strong>Decorator that caches function's return values. All function's arguments must be hashable.</strong></p>
  658. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> lru_cache
  659. <span class="hljs-meta">@lru_cache(maxsize=None)</span>
  660. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">fib</span><span class="hljs-params">(n)</span>:</span>
  661. <span class="hljs-keyword">return</span> n <span class="hljs-keyword">if</span> n &lt; <span class="hljs-number">2</span> <span class="hljs-keyword">else</span> fib(n<span class="hljs-number">-2</span>) + fib(n<span class="hljs-number">-1</span>)
  662. </code></pre>
  663. <ul>
  664. <li><strong>Recursion depth is limited to 1000 by default. To increase it use <code class="python hljs"><span class="hljs-string">'sys.setrecursionlimit(&lt;depth&gt;)'</span></code>.</strong></li>
  665. </ul>
  666. <h3 id="parametrizeddecorator">Parametrized Decorator</h3>
  667. <p><strong>A decorator that accepts arguments and returns a normal decorator that accepts a function.</strong></p>
  668. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  669. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(print_result=False)</span>:</span>
  670. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">decorator</span><span class="hljs-params">(func)</span>:</span>
  671. <span class="hljs-meta"> @wraps(func)</span>
  672. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  673. result = func(*args, **kwargs)
  674. print(func.__name__, result <span class="hljs-keyword">if</span> print_result <span class="hljs-keyword">else</span> <span class="hljs-string">''</span>)
  675. <span class="hljs-keyword">return</span> result
  676. <span class="hljs-keyword">return</span> out
  677. <span class="hljs-keyword">return</span> decorator
  678. <span class="hljs-meta">@debug(print_result=True)</span>
  679. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  680. <span class="hljs-keyword">return</span> x + y
  681. </code></pre>
  682. <h2 id="class"><a href="#class" name="class">#</a>Class</h2>
  683. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> &lt;<span class="hljs-title">name</span>&gt;:</span>
  684. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  685. self.a = a
  686. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
  687. class_name = self.__class__.__name__
  688. <span class="hljs-keyword">return</span> <span class="hljs-string">f'<span class="hljs-subst">{class_name}</span>(<span class="hljs-subst">{self.a!r}</span>)'</span>
  689. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__str__</span><span class="hljs-params">(self)</span>:</span>
  690. <span class="hljs-keyword">return</span> str(self.a)
  691. <span class="hljs-meta"> @classmethod</span>
  692. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_class_name</span><span class="hljs-params">(cls)</span>:</span>
  693. <span class="hljs-keyword">return</span> cls.__name__
  694. </code></pre>
  695. <h3 id="constructoroverloading">Constructor Overloading</h3>
  696. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> &lt;<span class="hljs-title">name</span>&gt;:</span>
  697. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a=None)</span>:</span>
  698. self.a = a
  699. </code></pre>
  700. <h3 id="inheritance">Inheritance</h3>
  701. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span>:</span>
  702. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, name, age)</span>:</span>
  703. self.name = name
  704. self.age = age
  705. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Employee</span><span class="hljs-params">(Person)</span>:</span>
  706. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, name, age, staff_num)</span>:</span>
  707. super().__init__(name, age)
  708. self.staff_num = staff_num
  709. </code></pre>
  710. <h3 id="multipleinheritance">Multiple Inheritance</h3>
  711. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">A</span>:</span> <span class="hljs-keyword">pass</span>
  712. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B</span>:</span> <span class="hljs-keyword">pass</span>
  713. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">C</span><span class="hljs-params">(A, B)</span>:</span> <span class="hljs-keyword">pass</span>
  714. </code></pre>
  715. <p><strong>MRO determines the order in which parent classes are traversed when searching for a method:</strong></p>
  716. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>C.mro()
  717. [&lt;<span class="hljs-class"><span class="hljs-keyword">class</span> '<span class="hljs-title">C</span>'&gt;, &lt;<span class="hljs-title">class</span> '<span class="hljs-title">A</span>'&gt;, &lt;<span class="hljs-title">class</span> '<span class="hljs-title">B</span>'&gt;, &lt;<span class="hljs-title">class</span> '<span class="hljs-title">object</span>'&gt;]
  718. </span></code></pre>
  719. <h3 id="copy">Copy</h3>
  720. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> copy <span class="hljs-keyword">import</span> copy, deepcopy
  721. &lt;object&gt; = copy(&lt;object&gt;)
  722. &lt;object&gt; = deepcopy(&lt;object&gt;)
  723. </code></pre>
  724. <h2 id="ducktypes"><a href="#ducktypes" name="ducktypes">#</a>Duck Types</h2>
  725. <p><strong>A duck type is an implicit type that prescribes a set of special methods. Any object that has those methods defined is considered a member of that duck type.</strong></p>
  726. <h3 id="comparable">Comparable</h3>
  727. <ul>
  728. <li><strong>If eq() method is not overridden, it returns <code class="python hljs"><span class="hljs-string">'id(self) == id(other)'</span></code>, which is the same as <code class="python hljs"><span class="hljs-string">'self is other'</span></code>.</strong></li>
  729. <li><strong>That means all objects compare not equal by default.</strong></li>
  730. </ul>
  731. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyComparable</span>:</span>
  732. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  733. self.a = a
  734. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  735. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  736. <span class="hljs-keyword">return</span> self.a == other.a
  737. <span class="hljs-keyword">return</span> <span class="hljs-keyword">False</span>
  738. </code></pre>
  739. <h3 id="hashable">Hashable</h3>
  740. <ul>
  741. <li><strong>Hashable object needs both hash() and eq() methods and its hash value should never change.</strong></li>
  742. <li><strong>Hashable objects that compare equal must have the same hash value, meaning default hash() that returns <code class="python hljs"><span class="hljs-string">'id(self)'</span></code> will not do.</strong></li>
  743. <li><strong>That is why Python automatically makes classes unhashable if you only implement eq().</strong></li>
  744. </ul>
  745. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyHashable</span>:</span>
  746. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  747. self.__a = copy.deepcopy(a)
  748. <span class="hljs-meta"> @property</span>
  749. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
  750. <span class="hljs-keyword">return</span> self.__a
  751. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  752. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  753. <span class="hljs-keyword">return</span> self.a == other.a
  754. <span class="hljs-keyword">return</span> <span class="hljs-keyword">False</span>
  755. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__hash__</span><span class="hljs-params">(self)</span>:</span>
  756. <span class="hljs-keyword">return</span> hash(self.a)
  757. </code></pre>
  758. <h3 id="collection">Collection</h3>
  759. <ul>
  760. <li><strong>Methods do not depend on each other, so they can be skipped if not needed.</strong></li>
  761. <li><strong>Any object with defined getitem() is considered iterable, even if it lacks iter().</strong></li>
  762. </ul>
  763. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyCollection</span>:</span>
  764. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  765. self.a = a
  766. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
  767. <span class="hljs-keyword">return</span> len(self.a)
  768. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
  769. <span class="hljs-keyword">return</span> self.a[i]
  770. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__setitem__</span><span class="hljs-params">(self, i, value)</span>:</span>
  771. self.a[i] = value
  772. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, value)</span>:</span>
  773. <span class="hljs-keyword">return</span> value <span class="hljs-keyword">in</span> self.a
  774. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  775. <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> self.a:
  776. <span class="hljs-keyword">yield</span> el
  777. </code></pre>
  778. <h3 id="callable">Callable</h3>
  779. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
  780. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
  781. self.i = <span class="hljs-number">0</span>
  782. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__call__</span><span class="hljs-params">(self)</span>:</span>
  783. self.i += <span class="hljs-number">1</span>
  784. <span class="hljs-keyword">return</span> self.i
  785. </code></pre>
  786. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter()
  787. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  788. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  789. </code></pre>
  790. <h3 id="contextmanager">Context Manager</h3>
  791. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyOpen</span><span class="hljs-params">()</span>:</span>
  792. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, filename)</span>:</span>
  793. self.filename = filename
  794. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__enter__</span><span class="hljs-params">(self)</span>:</span>
  795. self.file = open(self.filename)
  796. <span class="hljs-keyword">return</span> self.file
  797. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__exit__</span><span class="hljs-params">(self, *args)</span>:</span>
  798. self.file.close()
  799. </code></pre>
  800. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">with</span> open(<span class="hljs-string">'test.txt'</span>, <span class="hljs-string">'w'</span>) <span class="hljs-keyword">as</span> file:
  801. <span class="hljs-meta">... </span> file.write(<span class="hljs-string">'Hello World!'</span>)
  802. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">with</span> MyOpen(<span class="hljs-string">'test.txt'</span>) <span class="hljs-keyword">as</span> file:
  803. <span class="hljs-meta">... </span> print(file.read())
  804. Hello World!
  805. </code></pre>
  806. <h2 id="enum"><a href="#enum" name="enum">#</a>Enum</h2>
  807. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum, auto
  808. <span class="hljs-class"><span class="hljs-keyword">class</span> &lt;<span class="hljs-title">enum_name</span>&gt;<span class="hljs-params">(Enum)</span>:</span>
  809. &lt;member_name_1&gt; = &lt;value_1&gt;
  810. &lt;member_name_2&gt; = &lt;value_2_a&gt;, &lt;value_2_b&gt;
  811. &lt;member_name_3&gt; = auto()
  812. <span class="hljs-meta"> @classmethod</span>
  813. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_member_names</span><span class="hljs-params">(cls)</span>:</span>
  814. <span class="hljs-keyword">return</span> [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> cls.__members__.values()]
  815. </code></pre>
  816. <pre><code class="python language-python hljs">&lt;member&gt; = &lt;enum&gt;.&lt;member_name&gt;
  817. &lt;member&gt; = &lt;enum&gt;[<span class="hljs-string">'&lt;member_name&gt;'</span>]
  818. &lt;member&gt; = &lt;enum&gt;(&lt;value&gt;)
  819. name = &lt;member&gt;.name
  820. value = &lt;member&gt;.value
  821. </code></pre>
  822. <pre><code class="python language-python hljs">list_of_members = list(&lt;enum&gt;)
  823. member_names = [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  824. member_values = [a.value <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  825. random_member = random.choice(list(&lt;enum&gt;))
  826. </code></pre>
  827. <h3 id="inline-1">Inline</h3>
  828. <pre><code class="python language-python hljs">Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, [<span class="hljs-string">'fork'</span>, <span class="hljs-string">'knife'</span>, <span class="hljs-string">'spoon'</span>])
  829. Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, <span class="hljs-string">'fork knife spoon'</span>)
  830. Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, {<span class="hljs-string">'fork'</span>: <span class="hljs-number">1</span>, <span class="hljs-string">'knife'</span>: <span class="hljs-number">2</span>, <span class="hljs-string">'spoon'</span>: <span class="hljs-number">3</span>})
  831. </code></pre>
  832. <h4 id="functionscannotbevaluessotheymustbewrapped">Functions can not be values, so they must be wrapped:</h4>
  833. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  834. LogicOp = Enum(<span class="hljs-string">'LogicOp'</span>, {<span class="hljs-string">'AND'</span>: partial(<span class="hljs-keyword">lambda</span> l, r: l <span class="hljs-keyword">and</span> r),
  835. <span class="hljs-string">'OR'</span> : partial(<span class="hljs-keyword">lambda</span> l, r: l <span class="hljs-keyword">or</span> r)})
  836. </code></pre>
  837. <h2 id="exceptions"><a href="#exceptions" name="exceptions">#</a>Exceptions</h2>
  838. <pre><code class="python language-python hljs"><span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  839. <span class="hljs-keyword">try</span>:
  840. x = int(input(<span class="hljs-string">'Please enter a number: '</span>))
  841. <span class="hljs-keyword">except</span> ValueError:
  842. print(<span class="hljs-string">'Oops! That was no valid number. Try again...'</span>)
  843. <span class="hljs-keyword">else</span>:
  844. print(<span class="hljs-string">'Thank you.'</span>)
  845. <span class="hljs-keyword">break</span>
  846. </code></pre>
  847. <h3 id="raisingexception">Raising Exception</h3>
  848. <pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> ValueError(<span class="hljs-string">'A very specific message!'</span>)
  849. </code></pre>
  850. <h3 id="finally">Finally</h3>
  851. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">try</span>:
  852. <span class="hljs-meta">... </span> <span class="hljs-keyword">raise</span> KeyboardInterrupt
  853. <span class="hljs-meta">... </span><span class="hljs-keyword">finally</span>:
  854. <span class="hljs-meta">... </span> print(<span class="hljs-string">'Goodbye, world!'</span>)
  855. Goodbye, world!
  856. Traceback (most recent call last):
  857. File <span class="hljs-string">"&lt;stdin&gt;"</span>, line <span class="hljs-number">2</span>, <span class="hljs-keyword">in</span> &lt;module&gt;
  858. KeyboardInterrupt
  859. </code></pre>
  860. <h2 id="print"><a href="#print" name="print">#</a>Print</h2>
  861. <pre><code class="python language-python hljs">print(&lt;el_1&gt;, ..., sep=<span class="hljs-string">' '</span>, end=<span class="hljs-string">'\n'</span>, file=sys.stdout, flush=<span class="hljs-keyword">False</span>)
  862. </code></pre>
  863. <ul>
  864. <li><strong>Use <code class="python hljs"><span class="hljs-string">'file=sys.stderr'</span></code> for errors.</strong></li>
  865. </ul>
  866. <h3 id="prettyprint">Pretty Print</h3>
  867. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> pprint <span class="hljs-keyword">import</span> pprint
  868. <span class="hljs-meta">&gt;&gt;&gt; </span>pprint(dir())
  869. [<span class="hljs-string">'__annotations__'</span>,
  870. <span class="hljs-string">'__builtins__'</span>,
  871. <span class="hljs-string">'__doc__'</span>, ...]
  872. </code></pre>
  873. <h2 id="input"><a href="#input" name="input">#</a>Input</h2>
  874. <ul>
  875. <li><strong>Reads a line from user input or pipe if present.</strong></li>
  876. <li><strong>Trailing newline gets stripped.</strong></li>
  877. <li><strong>Prompt string is printed to the standard output before reading input.</strong></li>
  878. </ul>
  879. <pre><code class="python language-python hljs">&lt;str&gt; = input(prompt=<span class="hljs-keyword">None</span>)
  880. </code></pre>
  881. <h4 id="printslinesuntileof">Prints lines until EOF:</h4>
  882. <pre><code class="python language-python hljs"><span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  883. <span class="hljs-keyword">try</span>:
  884. print(input())
  885. <span class="hljs-keyword">except</span> EOFError:
  886. <span class="hljs-keyword">break</span>
  887. </code></pre>
  888. <h2 id="commandlinearguments"><a href="#commandlinearguments" name="commandlinearguments">#</a>Command Line Arguments</h2>
  889. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sys
  890. script_name = sys.argv[<span class="hljs-number">0</span>]
  891. arguments = sys.argv[<span class="hljs-number">1</span>:]
  892. </code></pre>
  893. <h3 id="argparse">Argparse</h3>
  894. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> argparse <span class="hljs-keyword">import</span> ArgumentParser, FileType
  895. p = ArgumentParser(description=&lt;str&gt;)
  896. p.add_argument(<span class="hljs-string">'-&lt;short_name&gt;'</span>, <span class="hljs-string">'--&lt;name&gt;'</span>, action=<span class="hljs-string">'store_true'</span>) <span class="hljs-comment"># Flag</span>
  897. p.add_argument(<span class="hljs-string">'-&lt;short_name&gt;'</span>, <span class="hljs-string">'--&lt;name&gt;'</span>, type=&lt;type&gt;) <span class="hljs-comment"># Option</span>
  898. p.add_argument(<span class="hljs-string">'&lt;name&gt;'</span>, type=&lt;type&gt;, nargs=<span class="hljs-number">1</span>) <span class="hljs-comment"># Argument</span>
  899. p.add_argument(<span class="hljs-string">'&lt;name&gt;'</span>, type=&lt;type&gt;, nargs=<span class="hljs-string">'+'</span>) <span class="hljs-comment"># Arguments</span>
  900. args = p.parse_args()
  901. value = args.&lt;name&gt;
  902. </code></pre>
  903. <ul>
  904. <li><strong>Use <code class="python hljs"><span class="hljs-string">'help=&lt;str&gt;'</span></code> for argument description.</strong></li>
  905. <li><strong>Use <code class="python hljs"><span class="hljs-string">'type=FileType(&lt;mode&gt;)'</span></code> for files.</strong></li>
  906. </ul>
  907. <h2 id="open"><a href="#open" name="open">#</a>Open</h2>
  908. <p><strong>Opens a file and returns a corresponding file object.</strong></p>
  909. <pre><code class="python language-python hljs">&lt;file&gt; = open(<span class="hljs-string">'&lt;path&gt;'</span>, mode=<span class="hljs-string">'r'</span>, encoding=<span class="hljs-keyword">None</span>)
  910. </code></pre>
  911. <h3 id="modes">Modes</h3>
  912. <ul>
  913. <li><strong><code class="python hljs"><span class="hljs-string">'r'</span></code> - Read (default).</strong></li>
  914. <li><strong><code class="python hljs"><span class="hljs-string">'w'</span></code> - Write (truncate).</strong></li>
  915. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - Write or fail if the file already exists.</strong></li>
  916. <li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Append.</strong></li>
  917. <li><strong><code class="python hljs"><span class="hljs-string">'w+'</span></code> - Read and write (truncate).</strong></li>
  918. <li><strong><code class="python hljs"><span class="hljs-string">'r+'</span></code> - Read and write from the start.</strong></li>
  919. <li><strong><code class="python hljs"><span class="hljs-string">'a+'</span></code> - Read and write from the end.</strong></li>
  920. <li><strong><code class="python hljs"><span class="hljs-string">'t'</span></code> - Text mode (default).</strong></li>
  921. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Binary mode.</strong></li>
  922. </ul>
  923. <h3 id="file">File</h3>
  924. <pre><code class="python language-python hljs">&lt;file&gt;.seek(<span class="hljs-number">0</span>) <span class="hljs-comment"># Moves to the start of the file.</span>
  925. &lt;file&gt;.seek(offset) <span class="hljs-comment"># Moves 'offset' chars/bytes from the start.</span>
  926. &lt;file&gt;.seek(offset, &lt;anchor&gt;) <span class="hljs-comment"># Anchor: 0 start, 1 current pos., 2 end.</span>
  927. </code></pre>
  928. <pre><code class="python language-python hljs">&lt;str/bytes&gt; = &lt;file&gt;.read(size=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Reads 'size' chars/bytes or until EOF.</span>
  929. &lt;str/bytes&gt; = &lt;file&gt;.readline() <span class="hljs-comment"># Returns a line.</span>
  930. &lt;list&gt; = &lt;file&gt;.readlines() <span class="hljs-comment"># Returns a list of lines.</span>
  931. &lt;str/bytes&gt; = next(&lt;file&gt;) <span class="hljs-comment"># Returns a line using buffer. Do not mix.</span>
  932. </code></pre>
  933. <pre><code class="python language-python hljs">&lt;file&gt;.write(&lt;str/bytes&gt;) <span class="hljs-comment"># Writes a string or bytes object.</span>
  934. &lt;file&gt;.writelines(&lt;list&gt;) <span class="hljs-comment"># Writes a list of strings or bytes objects.</span>
  935. &lt;file&gt;.flush() <span class="hljs-comment"># Flushes write buffer.</span>
  936. </code></pre>
  937. <ul>
  938. <li><strong>Methods do not add or strip trailing newlines.</strong></li>
  939. </ul>
  940. <h3 id="readtextfromfile">Read Text from File</h3>
  941. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_file</span><span class="hljs-params">(filename)</span>:</span>
  942. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  943. <span class="hljs-keyword">return</span> file.readlines()
  944. </code></pre>
  945. <h3 id="writetexttofile">Write Text to File</h3>
  946. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_to_file</span><span class="hljs-params">(filename, text)</span>:</span>
  947. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'w'</span>, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  948. file.write(text)
  949. </code></pre>
  950. <h2 id="path"><a href="#path" name="path">#</a>Path</h2>
  951. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> os <span class="hljs-keyword">import</span> path, listdir
  952. &lt;bool&gt; = path.exists(<span class="hljs-string">'&lt;path&gt;'</span>)
  953. &lt;bool&gt; = path.isfile(<span class="hljs-string">'&lt;path&gt;'</span>)
  954. &lt;bool&gt; = path.isdir(<span class="hljs-string">'&lt;path&gt;'</span>)
  955. &lt;list&gt; = listdir(<span class="hljs-string">'&lt;path&gt;'</span>)
  956. </code></pre>
  957. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> glob <span class="hljs-keyword">import</span> glob
  958. <span class="hljs-meta">&gt;&gt;&gt; </span>glob(<span class="hljs-string">'../*.gif'</span>)
  959. [<span class="hljs-string">'1.gif'</span>, <span class="hljs-string">'card.gif'</span>]
  960. </code></pre>
  961. <h3 id="pathlib">Pathlib</h3>
  962. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
  963. cwd = Path()
  964. &lt;Path&gt; = Path(<span class="hljs-string">'&lt;path&gt;'</span> [, <span class="hljs-string">'&lt;path&gt;'</span>, &lt;Path&gt;, ...])
  965. &lt;Path&gt; = &lt;Path&gt; / <span class="hljs-string">'&lt;dir&gt;'</span> / <span class="hljs-string">'&lt;file&gt;'</span>
  966. </code></pre>
  967. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;Path&gt;.exists()
  968. &lt;bool&gt; = &lt;Path&gt;.is_file()
  969. &lt;bool&gt; = &lt;Path&gt;.is_dir()
  970. &lt;iter&gt; = &lt;Path&gt;.iterdir()
  971. </code></pre>
  972. <pre><code class="python language-python hljs">&lt;iter&gt; = &lt;Path&gt;.glob(<span class="hljs-string">'&lt;pattern&gt;'</span>)
  973. </code></pre>
  974. <pre><code class="python language-python hljs">&lt;str&gt; = str(&lt;Path&gt;) <span class="hljs-comment"># Returns path as a string.</span>
  975. &lt;tup.&gt; = &lt;Path&gt;.parts <span class="hljs-comment"># Returns all components as strings.</span>
  976. &lt;Path&gt; = &lt;Path&gt;.resolve() <span class="hljs-comment"># Returns absolute Path without symlinks.</span>
  977. </code></pre>
  978. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Path&gt;.name <span class="hljs-comment"># Final component.</span>
  979. &lt;str&gt; = &lt;Path&gt;.stem <span class="hljs-comment"># Final component without extension.</span>
  980. &lt;str&gt; = &lt;Path&gt;.suffix <span class="hljs-comment"># Final component's extension.</span>
  981. &lt;Path&gt; = &lt;Path&gt;.parent <span class="hljs-comment"># Path without final component.</span>
  982. </code></pre>
  983. <h2 id="commandexecution"><a href="#commandexecution" name="commandexecution">#</a>Command Execution</h2>
  984. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
  985. &lt;str&gt; = os.popen(&lt;command&gt;).read()
  986. </code></pre>
  987. <h3 id="subprocess">Subprocess</h3>
  988. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> subprocess
  989. <span class="hljs-meta">&gt;&gt;&gt; </span>a = subprocess.run([<span class="hljs-string">'ls'</span>, <span class="hljs-string">'-a'</span>], stdout=subprocess.PIPE)
  990. <span class="hljs-meta">&gt;&gt;&gt; </span>a.stdout
  991. <span class="hljs-string">b'.\n..\nfile1.txt\nfile2.txt\n'</span>
  992. <span class="hljs-meta">&gt;&gt;&gt; </span>a.returncode
  993. <span class="hljs-number">0</span>
  994. </code></pre>
  995. <h2 id="csv"><a href="#csv" name="csv">#</a>CSV</h2>
  996. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> csv
  997. </code></pre>
  998. <h3 id="readrowsfromcsvfile">Read Rows from CSV File</h3>
  999. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_csv_file</span><span class="hljs-params">(filename)</span>:</span>
  1000. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1001. <span class="hljs-keyword">return</span> csv.reader(file, delimiter=<span class="hljs-string">';'</span>)
  1002. </code></pre>
  1003. <h3 id="writerowstocsvfile">Write Rows to CSV File</h3>
  1004. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_to_csv_file</span><span class="hljs-params">(filename, rows)</span>:</span>
  1005. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'w'</span>, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1006. writer = csv.writer(file, delimiter=<span class="hljs-string">';'</span>)
  1007. writer.writerows(rows)
  1008. </code></pre>
  1009. <h2 id="json"><a href="#json" name="json">#</a>JSON</h2>
  1010. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> json
  1011. &lt;str&gt; = json.dumps(&lt;object&gt;, ensure_ascii=<span class="hljs-keyword">True</span>, indent=<span class="hljs-keyword">None</span>)
  1012. &lt;object&gt; = json.loads(&lt;str&gt;)
  1013. </code></pre>
  1014. <h3 id="readobjectfromjsonfile">Read Object from JSON File</h3>
  1015. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_json_file</span><span class="hljs-params">(filename)</span>:</span>
  1016. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1017. <span class="hljs-keyword">return</span> json.load(file)
  1018. </code></pre>
  1019. <h3 id="writeobjecttojsonfile">Write Object to JSON File</h3>
  1020. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_to_json_file</span><span class="hljs-params">(filename, an_object)</span>:</span>
  1021. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'w'</span>, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1022. json.dump(an_object, file, ensure_ascii=<span class="hljs-keyword">False</span>, indent=<span class="hljs-number">2</span>)
  1023. </code></pre>
  1024. <h2 id="pickle"><a href="#pickle" name="pickle">#</a>Pickle</h2>
  1025. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> pickle
  1026. &lt;bytes&gt; = pickle.dumps(&lt;object&gt;)
  1027. &lt;object&gt; = pickle.loads(&lt;bytes&gt;)
  1028. </code></pre>
  1029. <h3 id="readobjectfromfile">Read Object from File</h3>
  1030. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_pickle_file</span><span class="hljs-params">(filename)</span>:</span>
  1031. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1032. <span class="hljs-keyword">return</span> pickle.load(file)
  1033. </code></pre>
  1034. <h3 id="writeobjecttofile">Write Object to File</h3>
  1035. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_to_pickle_file</span><span class="hljs-params">(filename, an_object)</span>:</span>
  1036. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1037. pickle.dump(an_object, file)
  1038. </code></pre>
  1039. <h2 id="sqlite"><a href="#sqlite" name="sqlite">#</a>SQLite</h2>
  1040. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sqlite3
  1041. db = sqlite3.connect(<span class="hljs-string">'&lt;path&gt;'</span>)
  1042. ...
  1043. db.close()
  1044. </code></pre>
  1045. <h3 id="read">Read</h3>
  1046. <pre><code class="python language-python hljs">cursor = db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1047. <span class="hljs-keyword">if</span> cursor:
  1048. &lt;tuple&gt; = cursor.fetchone() <span class="hljs-comment"># First row.</span>
  1049. &lt;list&gt; = cursor.fetchall() <span class="hljs-comment"># Remaining rows.</span>
  1050. </code></pre>
  1051. <h3 id="write">Write</h3>
  1052. <pre><code class="python language-python hljs">db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1053. db.commit()
  1054. </code></pre>
  1055. <h2 id="bytes"><a href="#bytes" name="bytes">#</a>Bytes</h2>
  1056. <p><strong>Bytes object is an immutable sequence of single bytes. Mutable version is called 'bytearray'.</strong></p>
  1057. <pre><code class="python language-python hljs">&lt;bytes&gt; = <span class="hljs-string">b'&lt;str&gt;'</span>
  1058. &lt;int&gt; = &lt;bytes&gt;[&lt;index&gt;]
  1059. &lt;bytes&gt; = &lt;bytes&gt;[&lt;slice&gt;]
  1060. &lt;ints&gt; = list(&lt;bytes&gt;)
  1061. &lt;bytes&gt; = <span class="hljs-string">b''</span>.join(&lt;coll_of_bytes&gt;)
  1062. </code></pre>
  1063. <h3 id="encode-1">Encode</h3>
  1064. <pre><code class="python language-python hljs">&lt;bytes&gt; = &lt;str&gt;.encode(encoding=<span class="hljs-string">'utf-8'</span>)
  1065. &lt;bytes&gt; = &lt;int&gt;.to_bytes(&lt;length&gt;, byteorder=<span class="hljs-string">'big|little'</span>, signed=<span class="hljs-keyword">False</span>)
  1066. &lt;bytes&gt; = bytes.fromhex(<span class="hljs-string">'&lt;hex&gt;'</span>)
  1067. </code></pre>
  1068. <h3 id="decode-1">Decode</h3>
  1069. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;bytes&gt;.decode(encoding=<span class="hljs-string">'utf-8'</span>)
  1070. &lt;int&gt; = int.from_bytes(&lt;bytes&gt;, byteorder=<span class="hljs-string">'big|little'</span>, signed=<span class="hljs-keyword">False</span>)
  1071. &lt;hex&gt; = &lt;bytes&gt;.hex()
  1072. </code></pre>
  1073. <h3 id="readbytesfromfile">Read Bytes from File</h3>
  1074. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_bytes</span><span class="hljs-params">(filename)</span>:</span>
  1075. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1076. <span class="hljs-keyword">return</span> file.read()
  1077. </code></pre>
  1078. <h3 id="writebytestofile">Write Bytes to File</h3>
  1079. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_bytes</span><span class="hljs-params">(filename, bytes_obj)</span>:</span>
  1080. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1081. file.write(bytes_obj)
  1082. </code></pre>
  1083. <h2 id="struct"><a href="#struct" name="struct">#</a>Struct</h2>
  1084. <ul>
  1085. <li><strong>Module that performs conversions between Python values and a C struct, represented as a Python bytes object.</strong></li>
  1086. <li><strong>Machine’s native type sizes and byte order are used by default.</strong></li>
  1087. </ul>
  1088. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> struct <span class="hljs-keyword">import</span> pack, unpack, iter_unpack, calcsize
  1089. &lt;bytes&gt; = pack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;value_1&gt; [, &lt;value_2&gt;, ...])
  1090. &lt;tuple&gt; = unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1091. &lt;tuples&gt; = iter_unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1092. </code></pre>
  1093. <h3 id="example">Example</h3>
  1094. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>pack(<span class="hljs-string">'&gt;hhl'</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1095. <span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>
  1096. <span class="hljs-meta">&gt;&gt;&gt; </span>unpack(<span class="hljs-string">'&gt;hhl'</span>, <span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>)
  1097. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1098. <span class="hljs-meta">&gt;&gt;&gt; </span>calcsize(<span class="hljs-string">'&gt;hhl'</span>)
  1099. <span class="hljs-number">8</span>
  1100. </code></pre>
  1101. <h3 id="format-2">Format</h3>
  1102. <h4 id="forstandardsizesstartformatstringwith">For standard sizes start format string with:</h4>
  1103. <ul>
  1104. <li><strong><code class="python hljs"><span class="hljs-string">'='</span></code> - native byte order</strong></li>
  1105. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;'</span></code> - little-endian</strong></li>
  1106. <li><strong><code class="python hljs"><span class="hljs-string">'&gt;'</span></code> - big-endian</strong></li>
  1107. </ul>
  1108. <h4 id="usecapitalletterforunsignedtypestandardsizesareinbrackets">Use capital letter for unsigned type. Standard sizes are in brackets:</h4>
  1109. <ul>
  1110. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - pad byte</strong></li>
  1111. <li><strong><code class="python hljs"><span class="hljs-string">'c'</span></code> - char (1)</strong></li>
  1112. <li><strong><code class="python hljs"><span class="hljs-string">'h'</span></code> - short (2)</strong></li>
  1113. <li><strong><code class="python hljs"><span class="hljs-string">'i'</span></code> - int (4)</strong></li>
  1114. <li><strong><code class="python hljs"><span class="hljs-string">'l'</span></code> - long (4)</strong></li>
  1115. <li><strong><code class="python hljs"><span class="hljs-string">'q'</span></code> - long long (8)</strong></li>
  1116. <li><strong><code class="python hljs"><span class="hljs-string">'f'</span></code> - float (4)</strong></li>
  1117. <li><strong><code class="python hljs"><span class="hljs-string">'d'</span></code> - double (8)</strong></li>
  1118. </ul>
  1119. <h2 id="array"><a href="#array" name="array">#</a>Array</h2>
  1120. <p><strong>List that can hold only elements of predefined type. Available types are listed above.</strong></p>
  1121. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> array <span class="hljs-keyword">import</span> array
  1122. &lt;array&gt; = array(<span class="hljs-string">'&lt;typecode&gt;'</span> [, &lt;collection&gt;])
  1123. </code></pre>
  1124. <h2 id="memoryview"><a href="#memoryview" name="memoryview">#</a>Memory View</h2>
  1125. <p><strong>Used for accessing the internal data of an object that supports the buffer protocol.</strong></p>
  1126. <pre><code class="python language-python hljs">&lt;memoryview&gt; = memoryview(&lt;bytes&gt; / &lt;bytearray&gt; / &lt;array&gt;)
  1127. &lt;memoryview&gt;.release()
  1128. </code></pre>
  1129. <h2 id="deque"><a href="#deque" name="deque">#</a>Deque</h2>
  1130. <p><strong>Thread-safe list with efficient appends and pops from either side. Pronounced "deck".</strong></p>
  1131. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> deque
  1132. &lt;deque&gt; = deque(&lt;collection&gt;, maxlen=<span class="hljs-keyword">None</span>)
  1133. </code></pre>
  1134. <pre><code class="python language-python hljs">&lt;deque&gt;.appendleft(&lt;el&gt;)
  1135. &lt;el&gt; = &lt;deque&gt;.popleft()
  1136. </code></pre>
  1137. <pre><code class="python language-python hljs">&lt;deque&gt;.extendleft(&lt;collection&gt;) <span class="hljs-comment"># Collection gets reversed.</span>
  1138. &lt;deque&gt;.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Rotates elements to the right.</span>
  1139. </code></pre>
  1140. <h2 id="threading"><a href="#threading" name="threading">#</a>Threading</h2>
  1141. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> threading <span class="hljs-keyword">import</span> Thread, RLock
  1142. </code></pre>
  1143. <h3 id="thread">Thread</h3>
  1144. <pre><code class="python language-python hljs">thread = Thread(target=&lt;function&gt;, args=(&lt;first_arg&gt;, ))
  1145. thread.start()
  1146. ...
  1147. thread.join()
  1148. </code></pre>
  1149. <h3 id="lock">Lock</h3>
  1150. <pre><code class="python language-python hljs">lock = RLock()
  1151. lock.acquire()
  1152. ...
  1153. lock.release()
  1154. </code></pre>
  1155. <h2 id="introspection"><a href="#introspection" name="introspection">#</a>Introspection</h2>
  1156. <p><strong>Inspecting code at runtime.</strong></p>
  1157. <h3 id="variables">Variables</h3>
  1158. <pre><code class="python language-python hljs">&lt;list&gt; = dir() <span class="hljs-comment"># Names of variables in current scope.</span>
  1159. &lt;dict&gt; = locals() <span class="hljs-comment"># Dict of local variables. Also vars().</span>
  1160. &lt;dict&gt; = globals() <span class="hljs-comment"># Dict of global variables.</span>
  1161. </code></pre>
  1162. <h3 id="attributes">Attributes</h3>
  1163. <pre><code class="python language-python hljs">&lt;dict&gt; = vars(&lt;object&gt;)
  1164. &lt;bool&gt; = hasattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1165. value = getattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1166. setattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>, value)
  1167. </code></pre>
  1168. <h3 id="parameters">Parameters</h3>
  1169. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> inspect <span class="hljs-keyword">import</span> signature
  1170. &lt;sig&gt; = signature(&lt;function&gt;)
  1171. no_of_params = len(&lt;sig&gt;.parameters)
  1172. param_names = list(&lt;sig&gt;.parameters.keys())
  1173. </code></pre>
  1174. <h2 id="metaprograming"><a href="#metaprograming" name="metaprograming">#</a>Metaprograming</h2>
  1175. <p><strong>Code that generates code.</strong></p>
  1176. <h3 id="type-1">Type</h3>
  1177. <p><strong>Type is the root class. If only passed the object it returns its type (class). Otherwise it creates a new class.</strong></p>
  1178. <pre><code class="python language-python hljs">&lt;<span class="hljs-class"><span class="hljs-keyword">class</span>&gt; = <span class="hljs-title">type</span><span class="hljs-params">(&lt;class_name&gt;, &lt;parents_tuple&gt;, &lt;attributes_dict&gt;)</span>
  1179. </span></code></pre>
  1180. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>Z = type(<span class="hljs-string">'Z'</span>, (), {<span class="hljs-string">'a'</span>: <span class="hljs-string">'abcde'</span>, <span class="hljs-string">'b'</span>: <span class="hljs-number">12345</span>})
  1181. <span class="hljs-meta">&gt;&gt;&gt; </span>z = Z()
  1182. </code></pre>
  1183. <h3 id="metaclass">Meta Class</h3>
  1184. <p><strong>Class that creates class.</strong></p>
  1185. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">my_meta_class</span><span class="hljs-params">(name, parents, attrs)</span>:</span>
  1186. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1187. <span class="hljs-keyword">return</span> type(name, parents, attrs)
  1188. </code></pre>
  1189. <h4 id="or">Or:</h4>
  1190. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyMetaClass</span><span class="hljs-params">(type)</span>:</span>
  1191. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__new__</span><span class="hljs-params">(cls, name, parents, attrs)</span>:</span>
  1192. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1193. <span class="hljs-keyword">return</span> type.__new__(cls, name, parents, attrs)
  1194. </code></pre>
  1195. <ul>
  1196. <li><strong>New() is a class method that gets called before init(). If it returns an instance of its class, then that instance gets passed to init() as a 'self' argument.</strong></li>
  1197. <li><strong>It receives the same arguments as init(), except for the first one that specifies the desired class of returned instance (</strong><code class="python hljs"><span class="hljs-string">'MyMetaClass'</span></code> <strong>in our case).</strong></li>
  1198. <li><strong>New() can also be called directly, usually from a new() method of a child class (</strong><code class="python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__new__</span><span class="hljs-params">(cls)</span>:</span> <span class="hljs-keyword">return</span> super().__new__(cls)</code><strong>), in which case init() is not called.</strong></li>
  1199. </ul>
  1200. <h3 id="metaclassattribute">Metaclass Attribute</h3>
  1201. <p><strong>When class is created it checks if it has metaclass defined. If not, it recursively checks if any of his parents has it defined and eventually comes to type().</strong></p>
  1202. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span><span class="hljs-params">(metaclass=MyMetaClass)</span>:</span>
  1203. b = <span class="hljs-number">12345</span>
  1204. </code></pre>
  1205. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>MyClass.a, MyClass.b
  1206. (<span class="hljs-string">'abcde'</span>, <span class="hljs-number">12345</span>)
  1207. </code></pre>
  1208. <h2 id="operator"><a href="#operator" name="operator">#</a>Operator</h2>
  1209. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> add, sub, mul, truediv, floordiv, mod, pow, neg, abs
  1210. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> eq, ne, lt, le, gt, ge
  1211. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> not_, and_, or_
  1212. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> itemgetter, attrgetter, methodcaller
  1213. </code></pre>
  1214. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
  1215. product_of_elems = functools.reduce(op.mul, &lt;collection&gt;)
  1216. sorted_by_second = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>))
  1217. sorted_by_both = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>))
  1218. LogicOp = enum.Enum(<span class="hljs-string">'LogicOp'</span>, {<span class="hljs-string">'AND'</span>: op.and_, <span class="hljs-string">'OR'</span> : op.or_})
  1219. last_el = op.methodcaller(<span class="hljs-string">'pop'</span>)(&lt;list&gt;)
  1220. </code></pre>
  1221. <h2 id="eval"><a href="#eval" name="eval">#</a>Eval</h2>
  1222. <h3 id="basic">Basic</h3>
  1223. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> ast <span class="hljs-keyword">import</span> literal_eval
  1224. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'1 + 2'</span>)
  1225. <span class="hljs-number">3</span>
  1226. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'[1, 2, 3]'</span>)
  1227. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
  1228. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'abs(1)'</span>)
  1229. ValueError: malformed node <span class="hljs-keyword">or</span> string
  1230. </code></pre>
  1231. <h3 id="usingabstractsyntaxtrees">Using Abstract Syntax Trees</h3>
  1232. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> ast
  1233. <span class="hljs-keyword">from</span> ast <span class="hljs-keyword">import</span> Num, BinOp, UnaryOp
  1234. <span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
  1235. LEGAL_OPERATORS = {ast.Add: op.add, <span class="hljs-comment"># &lt;el&gt; + &lt;el&gt;</span>
  1236. ast.Sub: op.sub, <span class="hljs-comment"># &lt;el&gt; - &lt;el&gt;</span>
  1237. ast.Mult: op.mul, <span class="hljs-comment"># &lt;el&gt; * &lt;el&gt;</span>
  1238. ast.Div: op.truediv, <span class="hljs-comment"># &lt;el&gt; / &lt;el&gt;</span>
  1239. ast.Pow: op.pow, <span class="hljs-comment"># &lt;el&gt; ** &lt;el&gt;</span>
  1240. ast.BitXor: op.xor, <span class="hljs-comment"># &lt;el&gt; ^ &lt;el&gt;</span>
  1241. ast.USub: op.neg} <span class="hljs-comment"># - &lt;el&gt;</span>
  1242. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">evaluate</span><span class="hljs-params">(expression)</span>:</span>
  1243. root = ast.parse(expression, mode=<span class="hljs-string">'eval'</span>)
  1244. <span class="hljs-keyword">return</span> eval_node(root.body)
  1245. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">eval_node</span><span class="hljs-params">(node)</span>:</span>
  1246. node_type = type(node)
  1247. <span class="hljs-keyword">if</span> node_type == Num:
  1248. <span class="hljs-keyword">return</span> node.n
  1249. <span class="hljs-keyword">if</span> node_type <span class="hljs-keyword">not</span> <span class="hljs-keyword">in</span> [BinOp, UnaryOp]:
  1250. <span class="hljs-keyword">raise</span> TypeError(node)
  1251. operator_type = type(node.op)
  1252. <span class="hljs-keyword">if</span> operator_type <span class="hljs-keyword">not</span> <span class="hljs-keyword">in</span> LEGAL_OPERATORS:
  1253. <span class="hljs-keyword">raise</span> TypeError(<span class="hljs-string">f'Illegal operator <span class="hljs-subst">{node.op}</span>'</span>)
  1254. operator = LEGAL_OPERATORS[operator_type]
  1255. <span class="hljs-keyword">if</span> node_type == BinOp:
  1256. left, right = eval_node(node.left), eval_node(node.right)
  1257. <span class="hljs-keyword">return</span> operator(left, right)
  1258. <span class="hljs-keyword">elif</span> node_type == UnaryOp:
  1259. operand = eval_node(node.operand)
  1260. <span class="hljs-keyword">return</span> operator(operand)
  1261. </code></pre>
  1262. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>evaluate(<span class="hljs-string">'2 ^ 6'</span>)
  1263. <span class="hljs-number">4</span>
  1264. <span class="hljs-meta">&gt;&gt;&gt; </span>evaluate(<span class="hljs-string">'2 ** 6'</span>)
  1265. <span class="hljs-number">64</span>
  1266. <span class="hljs-meta">&gt;&gt;&gt; </span>evaluate(<span class="hljs-string">'1 + 2 * 3 ** (4 ^ 5) / (6 + -7)'</span>)
  1267. <span class="hljs-number">-5.0</span>
  1268. </code></pre>
  1269. <h2 id="coroutine"><a href="#coroutine" name="coroutine">#</a>Coroutine</h2>
  1270. <ul>
  1271. <li><strong>Similar to generator, but generator pulls data through the pipe with iteration, while coroutine pushes data into the pipeline with send().</strong></li>
  1272. <li><strong>Coroutines provide more powerful data routing possibilities than iterators.</strong></li>
  1273. <li><strong>If you build a collection of simple data processing components, you can glue them together into complex arrangements of pipes, branches, merging, etc.</strong></li>
  1274. </ul>
  1275. <h3 id="helperdecorator">Helper Decorator</h3>
  1276. <ul>
  1277. <li><strong>All coroutines must be "primed" by first calling next().</strong></li>
  1278. <li><strong>Remembering to call next() is easy to forget.</strong></li>
  1279. <li><strong>Solved by wrapping coroutines with a decorator:</strong></li>
  1280. </ul>
  1281. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">coroutine</span><span class="hljs-params">(func)</span>:</span>
  1282. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  1283. cr = func(*args, **kwargs)
  1284. next(cr)
  1285. <span class="hljs-keyword">return</span> cr
  1286. <span class="hljs-keyword">return</span> out
  1287. </code></pre>
  1288. <h3 id="pipelineexample">Pipeline Example</h3>
  1289. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">reader</span><span class="hljs-params">(target)</span>:</span>
  1290. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  1291. target.send(i)
  1292. target.close()
  1293. <span class="hljs-meta">@coroutine</span>
  1294. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">adder</span><span class="hljs-params">(target)</span>:</span>
  1295. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1296. value = (<span class="hljs-keyword">yield</span>)
  1297. target.send(value + <span class="hljs-number">100</span>)
  1298. <span class="hljs-meta">@coroutine</span>
  1299. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">printer</span><span class="hljs-params">()</span>:</span>
  1300. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1301. value = (<span class="hljs-keyword">yield</span>)
  1302. print(value)
  1303. reader(adder(printer())) <span class="hljs-comment"># 100, 101, ..., 109</span>
  1304. </code></pre>
  1305. <p><br><br></p>
  1306. <h1 id="libraries">Libraries</h1>
  1307. <h2 id="progressbar"><a href="#progressbar" name="progressbar">#</a>Progress Bar</h2>
  1308. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tqdm</span>
  1309. <span class="hljs-keyword">from</span> tqdm <span class="hljs-keyword">import</span> tqdm
  1310. <span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> sleep
  1311. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> tqdm([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]):
  1312. sleep(<span class="hljs-number">0.2</span>)
  1313. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> tqdm(range(<span class="hljs-number">100</span>)):
  1314. sleep(<span class="hljs-number">0.02</span>)
  1315. </code></pre>
  1316. <h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2>
  1317. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span>
  1318. <span class="hljs-keyword">from</span> matplotlib <span class="hljs-keyword">import</span> pyplot
  1319. pyplot.plot(&lt;data_1&gt; [, &lt;data_2&gt;, ...])
  1320. pyplot.savefig(&lt;filename&gt;)
  1321. pyplot.show()
  1322. </code></pre>
  1323. <h2 id="table"><a href="#table" name="table">#</a>Table</h2>
  1324. <h4 id="printsacsvfileasanasciitable">Prints a CSV file as an ASCII table:</h4>
  1325. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tabulate</span>
  1326. <span class="hljs-keyword">from</span> tabulate <span class="hljs-keyword">import</span> tabulate
  1327. <span class="hljs-keyword">import</span> csv
  1328. <span class="hljs-keyword">with</span> open(&lt;filename&gt;, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1329. lines = csv.reader(file, delimiter=<span class="hljs-string">';'</span>)
  1330. headers = [header.title() <span class="hljs-keyword">for</span> header <span class="hljs-keyword">in</span> next(lines)]
  1331. table = tabulate(lines, headers)
  1332. print(table)
  1333. </code></pre>
  1334. <h2 id="curses"><a href="#curses" name="curses">#</a>Curses</h2>
  1335. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> curses <span class="hljs-keyword">import</span> wrapper, ascii
  1336. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1337. wrapper(draw)
  1338. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">draw</span><span class="hljs-params">(screen)</span>:</span>
  1339. screen.clear()
  1340. screen.addstr(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-string">'Press ESC to quit.'</span>)
  1341. <span class="hljs-keyword">while</span> screen.getch() != ascii.ESC:
  1342. <span class="hljs-keyword">pass</span>
  1343. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_border</span><span class="hljs-params">(screen)</span>:</span>
  1344. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  1345. P = namedtuple(<span class="hljs-string">'P'</span>, <span class="hljs-string">'y x'</span>)
  1346. height, width = screen.getmaxyx()
  1347. <span class="hljs-keyword">return</span> P(height<span class="hljs-number">-1</span>, width<span class="hljs-number">-1</span>)
  1348. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  1349. main()
  1350. </code></pre>
  1351. <h2 id="logging"><a href="#logging" name="logging">#</a>Logging</h2>
  1352. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install loguru</span>
  1353. <span class="hljs-keyword">from</span> loguru <span class="hljs-keyword">import</span> logger
  1354. </code></pre>
  1355. <pre><code class="python language-python hljs">logger.add(<span class="hljs-string">'debug_{time}.log'</span>, colorize=<span class="hljs-keyword">True</span>) <span class="hljs-comment"># Connects a log file.</span>
  1356. logger.add(<span class="hljs-string">'error_{time}.log'</span>, level=<span class="hljs-string">'ERROR'</span>) <span class="hljs-comment"># Another file for errors or higher.</span>
  1357. logger.&lt;level&gt;(<span class="hljs-string">'A logging message'</span>)
  1358. </code></pre>
  1359. <ul>
  1360. <li><strong>Levels: <code class="python hljs"><span class="hljs-string">'debug'</span></code>, <code class="python hljs"><span class="hljs-string">'info'</span></code>, <code class="python hljs"><span class="hljs-string">'success'</span></code>, <code class="python hljs"><span class="hljs-string">'warning'</span></code>, <code class="python hljs"><span class="hljs-string">'error'</span></code>, <code class="python hljs"><span class="hljs-string">'critical'</span></code>.</strong></li>
  1361. </ul>
  1362. <h3 id="rotation">Rotation</h3>
  1363. <p><strong>Parameter that sets a condition when a new log file is created.</strong></p>
  1364. <pre><code class="python language-python hljs">rotation=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;datetime.time&gt;|&lt;str&gt;
  1365. </code></pre>
  1366. <ul>
  1367. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max file size in bytes.</strong></li>
  1368. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1369. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;time&gt;'</span></code> - Time of day.</strong></li>
  1370. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;str&gt;'</span></code> - Any of above as a string: <code class="python hljs"><span class="hljs-string">'100 MB'</span></code>, <code class="python hljs"><span class="hljs-string">'1 month'</span></code>, <code class="python hljs"><span class="hljs-string">'monday at 12:00'</span></code>, …</strong></li>
  1371. </ul>
  1372. <h3 id="retention">Retention</h3>
  1373. <p><strong>Sets a condition which old log files are deleted.</strong></p>
  1374. <pre><code class="python language-python hljs">retention=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;str&gt;
  1375. </code></pre>
  1376. <ul>
  1377. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max number of files.</strong></li>
  1378. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1379. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;str&gt;'</span></code> - Max age as a string: <code class="python hljs"><span class="hljs-string">'1 week, 3 days'</span></code>, <code class="python hljs"><span class="hljs-string">'2 months'</span></code>, …</strong></li>
  1380. </ul>
  1381. <h3 id="compression">Compression</h3>
  1382. <p><strong>Sets how inactive log files are compressed.</strong></p>
  1383. <pre><code class="python language-python hljs">compression=<span class="hljs-string">'gz'</span>|<span class="hljs-string">'bz2'</span>|<span class="hljs-string">'tar'</span>|<span class="hljs-string">'tar.gz'</span>|<span class="hljs-string">'tar.bz2'</span>|<span class="hljs-string">'zip'</span>
  1384. </code></pre>
  1385. <h2 id="scraping"><a href="#scraping" name="scraping">#</a>Scraping</h2>
  1386. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests beautifulsoup4</span>
  1387. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> requests
  1388. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> bs4 <span class="hljs-keyword">import</span> BeautifulSoup
  1389. <span class="hljs-meta">&gt;&gt;&gt; </span>url = <span class="hljs-string">'https://en.wikipedia.org/wiki/Python_(programming_language)'</span>
  1390. <span class="hljs-meta">&gt;&gt;&gt; </span>page = requests.get(url)
  1391. <span class="hljs-meta">&gt;&gt;&gt; </span>doc = BeautifulSoup(page.text, <span class="hljs-string">'html.parser'</span>)
  1392. <span class="hljs-meta">&gt;&gt;&gt; </span>table = doc.find(<span class="hljs-string">'table'</span>, class_=<span class="hljs-string">'infobox vevent'</span>)
  1393. <span class="hljs-meta">&gt;&gt;&gt; </span>rows = table.find_all(<span class="hljs-string">'tr'</span>)
  1394. <span class="hljs-meta">&gt;&gt;&gt; </span>link = rows[<span class="hljs-number">11</span>].find(<span class="hljs-string">'a'</span>)[<span class="hljs-string">'href'</span>]
  1395. <span class="hljs-meta">&gt;&gt;&gt; </span>ver = rows[<span class="hljs-number">6</span>].find(<span class="hljs-string">'div'</span>).text.split()[<span class="hljs-number">0</span>]
  1396. <span class="hljs-meta">&gt;&gt;&gt; </span>link, ver
  1397. (<span class="hljs-string">'https://www.python.org/'</span>, <span class="hljs-string">'3.7.2'</span>)
  1398. </code></pre>
  1399. <h2 id="web"><a href="#web" name="web">#</a>Web</h2>
  1400. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install bottle</span>
  1401. <span class="hljs-keyword">from</span> bottle <span class="hljs-keyword">import</span> run, route, post, template, request, response
  1402. <span class="hljs-keyword">import</span> json
  1403. </code></pre>
  1404. <h3 id="run">Run</h3>
  1405. <pre><code class="python language-python hljs">run(host=<span class="hljs-string">'localhost'</span>, port=<span class="hljs-number">8080</span>)
  1406. run(host=<span class="hljs-string">'0.0.0.0'</span>, port=<span class="hljs-number">80</span>, server=<span class="hljs-string">'cherrypy'</span>)
  1407. </code></pre>
  1408. <h3 id="staticrequest">Static Request</h3>
  1409. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/img/&lt;image&gt;')</span>
  1410. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_image</span><span class="hljs-params">(image)</span>:</span>
  1411. <span class="hljs-keyword">return</span> static_file(image, <span class="hljs-string">'images/'</span>, mimetype=<span class="hljs-string">'image/png'</span>)
  1412. </code></pre>
  1413. <h3 id="dynamicrequest">Dynamic Request</h3>
  1414. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/&lt;sport&gt;')</span>
  1415. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_page</span><span class="hljs-params">(sport)</span>:</span>
  1416. <span class="hljs-keyword">return</span> template(<span class="hljs-string">'&lt;h1&gt;{{title}}&lt;/h1&gt;'</span>, title=sport)
  1417. </code></pre>
  1418. <h3 id="restrequest">REST Request</h3>
  1419. <pre><code class="python language-python hljs"><span class="hljs-meta">@post('/odds/&lt;sport&gt;')</span>
  1420. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">odds_handler</span><span class="hljs-params">(sport)</span>:</span>
  1421. team = request.forms.get(<span class="hljs-string">'team'</span>)
  1422. home_odds, away_odds = <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>
  1423. response.headers[<span class="hljs-string">'Content-Type'</span>] = <span class="hljs-string">'application/json'</span>
  1424. response.headers[<span class="hljs-string">'Cache-Control'</span>] = <span class="hljs-string">'no-cache'</span>
  1425. <span class="hljs-keyword">return</span> json.dumps([team, home_odds, away_odds])
  1426. </code></pre>
  1427. <h4 id="test">Test:</h4>
  1428. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests</span>
  1429. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> requests
  1430. <span class="hljs-meta">&gt;&gt;&gt; </span>url = <span class="hljs-string">'http://localhost:8080/odds/football'</span>
  1431. <span class="hljs-meta">&gt;&gt;&gt; </span>data = {<span class="hljs-string">'team'</span>: <span class="hljs-string">'arsenal f.c.'</span>}
  1432. <span class="hljs-meta">&gt;&gt;&gt; </span>response = requests.post(url, data=data)
  1433. <span class="hljs-meta">&gt;&gt;&gt; </span>response.json()
  1434. [<span class="hljs-string">'arsenal f.c.'</span>, <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>]
  1435. </code></pre>
  1436. <h2 id="profile"><a href="#profile" name="profile">#</a>Profile</h2>
  1437. <h3 id="basic-1">Basic</h3>
  1438. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> time
  1439. start_time = time() <span class="hljs-comment"># Seconds since Epoch.</span>
  1440. ...
  1441. duration = time() - start_time
  1442. </code></pre>
  1443. <h3 id="highperformance">High Performance</h3>
  1444. <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
  1445. start_time = pc() <span class="hljs-comment"># Seconds since restart.</span>
  1446. ...
  1447. duration = pc() - start_time
  1448. </code></pre>
  1449. <h3 id="timingasnippet">Timing a Snippet</h3>
  1450. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> timeit <span class="hljs-keyword">import</span> timeit
  1451. <span class="hljs-meta">&gt;&gt;&gt; </span>timeit(<span class="hljs-string">'"-".join(str(a) for a in range(100))'</span>,
  1452. <span class="hljs-meta">... </span> number=<span class="hljs-number">10000</span>, globals=globals(), setup=<span class="hljs-string">'pass'</span>)
  1453. <span class="hljs-number">0.34986</span>
  1454. </code></pre>
  1455. <h3 id="lineprofiler">Line Profiler</h3>
  1456. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install line_profiler</span>
  1457. <span class="hljs-meta">@profile</span>
  1458. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1459. a = [*range(<span class="hljs-number">10000</span>)]
  1460. b = {*range(<span class="hljs-number">10000</span>)}
  1461. main()
  1462. </code></pre>
  1463. <h4 id="usage">Usage:</h4>
  1464. <pre><code class="text language-text">$ kernprof -lv test.py
  1465. Line # Hits Time Per Hit % Time Line Contents
  1466. ==============================================================
  1467. 1 @profile
  1468. 2 def main():
  1469. 3 1 1128.0 1128.0 27.4 a = [*range(10000)]
  1470. 4 1 2994.0 2994.0 72.6 b = {*range(10000)}
  1471. </code></pre>
  1472. <h3 id="callgraph">Call Graph</h3>
  1473. <h4 id="generatesapngimageofacallgraphwithhighlightedbottlenecks">Generates a PNG image of a call graph with highlighted bottlenecks:</h4>
  1474. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pycallgraph</span>
  1475. <span class="hljs-keyword">from</span> pycallgraph <span class="hljs-keyword">import</span> output, PyCallGraph
  1476. <span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> datetime
  1477. time_str = datetime.now().strftime(<span class="hljs-string">'%Y%m%d%H%M%S'</span>)
  1478. filename = <span class="hljs-string">f'profile-<span class="hljs-subst">{time_str}</span>.png'</span>
  1479. drawer = output.GraphvizOutput(output_file=filename)
  1480. <span class="hljs-keyword">with</span> PyCallGraph(output=drawer):
  1481. &lt;code_to_be_profiled&gt;
  1482. </code></pre>
  1483. <h2 id="numpy"><a href="#numpy" name="numpy">#</a>NumPy</h2>
  1484. <p><strong>Array manipulation mini language. Can run up to one hundred times faster than equivalent Python code.</strong></p>
  1485. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install numpy</span>
  1486. <span class="hljs-keyword">import</span> numpy <span class="hljs-keyword">as</span> np
  1487. </code></pre>
  1488. <pre><code class="python language-python hljs">&lt;array&gt; = np.array(&lt;list&gt;)
  1489. &lt;array&gt; = np.arange(from_inclusive, to_exclusive, ±step_size)
  1490. &lt;array&gt; = np.ones(&lt;shape&gt;)
  1491. &lt;array&gt; = np.random.randint(from_inclusive, to_exclusive, &lt;shape&gt;)
  1492. </code></pre>
  1493. <pre><code class="python language-python hljs">&lt;array&gt;.shape = &lt;shape&gt;
  1494. &lt;view&gt; = &lt;array&gt;.reshape(&lt;shape&gt;)
  1495. &lt;view&gt; = np.broadcast_to(&lt;array&gt;, &lt;shape&gt;)
  1496. </code></pre>
  1497. <pre><code class="python language-python hljs">&lt;array&gt; = &lt;array&gt;.sum(axis)
  1498. indexes = &lt;array&gt;.argmin(axis)
  1499. </code></pre>
  1500. <ul>
  1501. <li><strong>Shape is a tuple of dimension sizes.</strong></li>
  1502. <li><strong>Axis is an index of dimension that gets collapsed. Leftmost dimension has index 0.</strong></li>
  1503. </ul>
  1504. <h3 id="indexing">Indexing</h3>
  1505. <pre><code class="bash language-bash hljs">&lt;el&gt; = &lt;2d_array&gt;[0, 0] <span class="hljs-comment"># First element.</span>
  1506. &lt;1d_view&gt; = &lt;2d_array&gt;[0] <span class="hljs-comment"># First row.</span>
  1507. &lt;1d_view&gt; = &lt;2d_array&gt;[:, 0] <span class="hljs-comment"># First column. Also [..., 0].</span>
  1508. &lt;3d_view&gt; = &lt;2d_array&gt;[None, :, :] <span class="hljs-comment"># Expanded by dimension of size 1.</span>
  1509. </code></pre>
  1510. <pre><code class="bash language-bash hljs">&lt;1d_array&gt; = &lt;2d_array&gt;[&lt;1d_row_indexes&gt;, &lt;1d_column_indexes&gt;]
  1511. &lt;2d_array&gt; = &lt;2d_array&gt;[&lt;2d_row_indexes&gt;, &lt;2d_column_indexes&gt;]
  1512. </code></pre>
  1513. <pre><code class="bash language-bash hljs">&lt;2d_bools&gt; = &lt;2d_array&gt; &gt; 0
  1514. &lt;1d_array&gt; = &lt;2d_array&gt;[&lt;2d_bools&gt;]
  1515. </code></pre>
  1516. <ul>
  1517. <li><strong>If row and column indexes differ in shape, they are combined with broadcasting.</strong></li>
  1518. </ul>
  1519. <h3 id="broadcasting">Broadcasting</h3>
  1520. <p><strong>Broadcasting is a set of rules by which NumPy functions operate on arrays of different sizes and/or dimensions.</strong></p>
  1521. <pre><code class="python language-python hljs">left = [[<span class="hljs-number">0.1</span>], [<span class="hljs-number">0.6</span>], [<span class="hljs-number">0.8</span>]] <span class="hljs-comment"># Shape: (3, 1)</span>
  1522. right = [ <span class="hljs-number">0.1</span> , <span class="hljs-number">0.6</span> , <span class="hljs-number">0.8</span> ] <span class="hljs-comment"># Shape: (3)</span>
  1523. </code></pre>
  1524. <h4 id="1ifarrayshapesdifferinlengthleftpadtheshortershapewithones">1. If array shapes differ in length, left-pad the shorter shape with ones:</h4>
  1525. <pre><code class="python language-python hljs">left = [[<span class="hljs-number">0.1</span>], [<span class="hljs-number">0.6</span>], [<span class="hljs-number">0.8</span>]] <span class="hljs-comment"># Shape: (3, 1)</span>
  1526. right = [[<span class="hljs-number">0.1</span> , <span class="hljs-number">0.6</span> , <span class="hljs-number">0.8</span>]] <span class="hljs-comment"># Shape: (1, 3) &lt;- !</span>
  1527. </code></pre>
  1528. <h4 id="2ifanydimensionsdifferinsizeexpandtheonesthathavesize1byduplicatingtheirelements">2. If any dimensions differ in size, expand the ones that have size 1 by duplicating their elements:</h4>
  1529. <pre><code class="python language-python hljs">left = [[<span class="hljs-number">0.1</span>, <span class="hljs-number">0.1</span>, <span class="hljs-number">0.1</span>], [<span class="hljs-number">0.6</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.6</span>], [<span class="hljs-number">0.8</span>, <span class="hljs-number">0.8</span>, <span class="hljs-number">0.8</span>]] <span class="hljs-comment"># Shape: (3, 3) &lt;- !</span>
  1530. right = [[<span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>], [<span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>], [<span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>]] <span class="hljs-comment"># Shape: (3, 3) &lt;- !</span>
  1531. </code></pre>
  1532. <h4 id="3ifneithernonmatchingdimensionhassize1riseanerror">3. If neither non-matching dimension has size 1, rise an error.</h4>
  1533. <h3 id="example-1">Example</h3>
  1534. <h4 id="foreachpointreturnsindexofitsnearestpoint010608121">For each point returns index of its nearest point (<code class="python hljs">[<span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>] =&gt; [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">1</span>]</code>):</h4>
  1535. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>points = np.array([<span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>])
  1536. [ <span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>]
  1537. <span class="hljs-meta">&gt;&gt;&gt; </span>wrapped_points = points.reshape(<span class="hljs-number">3</span>, <span class="hljs-number">1</span>)
  1538. [[ <span class="hljs-number">0.1</span>],
  1539. [ <span class="hljs-number">0.6</span>],
  1540. [ <span class="hljs-number">0.8</span>]]
  1541. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = wrapped_points - points
  1542. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">-0.5</span>, <span class="hljs-number">-0.7</span>],
  1543. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">-0.2</span>],
  1544. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  1545. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = np.abs(distances)
  1546. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  1547. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">0.2</span>],
  1548. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  1549. <span class="hljs-meta">&gt;&gt;&gt; </span>i = np.arange(<span class="hljs-number">3</span>)
  1550. [<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>]
  1551. <span class="hljs-meta">&gt;&gt;&gt; </span>distances[i, i] = np.inf
  1552. [[ inf, <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  1553. [ <span class="hljs-number">0.5</span>, inf, <span class="hljs-number">0.2</span>],
  1554. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, inf]]
  1555. <span class="hljs-meta">&gt;&gt;&gt; </span>distances.argmin(<span class="hljs-number">1</span>)
  1556. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">1</span>]
  1557. </code></pre>
  1558. <h2 id="image"><a href="#image" name="image">#</a>Image</h2>
  1559. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pillow</span>
  1560. <span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> Image
  1561. </code></pre>
  1562. <h4 id="createsapngimageofarainbowgradient">Creates a PNG image of a rainbow gradient:</h4>
  1563. <pre><code class="python language-python hljs">width = <span class="hljs-number">100</span>
  1564. height = <span class="hljs-number">100</span>
  1565. size = width * height
  1566. pixels = [<span class="hljs-number">255</span> * i/size <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(size)]
  1567. img = Image.new(<span class="hljs-string">'HSV'</span>, (width, height))
  1568. img.putdata([(int(a), <span class="hljs-number">255</span>, <span class="hljs-number">255</span>) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> pixels])
  1569. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  1570. </code></pre>
  1571. <h4 id="addsnoisetoapngimage">Adds noise to a PNG image:</h4>
  1572. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  1573. add_noise = <span class="hljs-keyword">lambda</span> value: max(<span class="hljs-number">0</span>, min(<span class="hljs-number">255</span>, value + randint(<span class="hljs-number">-20</span>, <span class="hljs-number">20</span>)))
  1574. img = Image.open(<span class="hljs-string">'test.png'</span>).convert(mode=<span class="hljs-string">'HSV'</span>)
  1575. img.putdata([(add_noise(h), s, v) <span class="hljs-keyword">for</span> h, s, v <span class="hljs-keyword">in</span> img.getdata()])
  1576. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  1577. </code></pre>
  1578. <h3 id="modes-1">Modes</h3>
  1579. <ul>
  1580. <li><strong><code class="python hljs"><span class="hljs-string">'1'</span></code> - 1-bit pixels, black and white, stored with one pixel per byte.</strong></li>
  1581. <li><strong><code class="python hljs"><span class="hljs-string">'L'</span></code> - 8-bit pixels, greyscale.</strong></li>
  1582. <li><strong><code class="python hljs"><span class="hljs-string">'RGB'</span></code> - 3x8-bit pixels, true color.</strong></li>
  1583. <li><strong><code class="python hljs"><span class="hljs-string">'RGBA'</span></code> - 4x8-bit pixels, true color with transparency mask.</strong></li>
  1584. <li><strong><code class="python hljs"><span class="hljs-string">'HSV'</span></code> - 3x8-bit pixels, Hue, Saturation, Value color space.</strong></li>
  1585. </ul>
  1586. <h2 id="audio"><a href="#audio" name="audio">#</a>Audio</h2>
  1587. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> wave
  1588. <span class="hljs-keyword">from</span> struct <span class="hljs-keyword">import</span> pack, iter_unpack
  1589. </code></pre>
  1590. <h3 id="readframesfromwavfile">Read Frames from WAV File</h3>
  1591. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_wav_file</span><span class="hljs-params">(filename)</span>:</span>
  1592. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> wf:
  1593. frames = wf.readframes(wf.getnframes())
  1594. <span class="hljs-keyword">return</span> [a[<span class="hljs-number">0</span>] <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> iter_unpack(<span class="hljs-string">'&lt;h'</span>, frames)]
  1595. </code></pre>
  1596. <h3 id="writeframestowavfile">Write Frames to WAV File</h3>
  1597. <pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">write_to_wav_file</span><span class="hljs-params">(filename, frames_int, mono=True)</span>:</span>
  1598. frames_short = (pack(<span class="hljs-string">'&lt;h'</span>, a) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> frames_int)
  1599. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> wf:
  1600. wf.setnchannels(<span class="hljs-number">1</span> <span class="hljs-keyword">if</span> mono <span class="hljs-keyword">else</span> <span class="hljs-number">2</span>)
  1601. wf.setsampwidth(<span class="hljs-number">2</span>)
  1602. wf.setframerate(<span class="hljs-number">44100</span>)
  1603. wf.writeframes(<span class="hljs-string">b''</span>.join(frames_short))
  1604. </code></pre>
  1605. <h3 id="examples">Examples</h3>
  1606. <h4 id="savesasinewavetoamonowavfile">Saves a sine wave to a mono WAV file:</h4>
  1607. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> pi, sin
  1608. frames_f = (sin(i * <span class="hljs-number">2</span> * pi * <span class="hljs-number">440</span> / <span class="hljs-number">44100</span>) <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">100000</span>))
  1609. frames_i = (int(a * <span class="hljs-number">30000</span>) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> frames_f)
  1610. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  1611. </code></pre>
  1612. <h4 id="addsnoisetoamonowavfile">Adds noise to a mono WAV file:</h4>
  1613. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  1614. add_noise = <span class="hljs-keyword">lambda</span> value: max(<span class="hljs-number">-32768</span>, min(<span class="hljs-number">32767</span>, value + randint(<span class="hljs-number">-500</span>, <span class="hljs-number">500</span>)))
  1615. frames_i = (add_noise(a) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> read_wav_file(<span class="hljs-string">'test.wav'</span>))
  1616. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  1617. </code></pre>
  1618. <h4 id="playspopcorn">Plays Popcorn:</h4>
  1619. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install simpleaudio</span>
  1620. <span class="hljs-keyword">import</span> simpleaudio, math, struct
  1621. <span class="hljs-keyword">from</span> itertools <span class="hljs-keyword">import</span> chain, repeat
  1622. F = <span class="hljs-number">44100</span>
  1623. P1 = <span class="hljs-string">'71♪,69,,71♪,66,,62♪,66,,59♪,,,'</span>
  1624. P2 = <span class="hljs-string">'71♪,73,,74♪,73,,74,,71,,73♪,71,,73,,69,,71♪,69,,71,,67,,71♪,,,'</span>
  1625. get_pause = <span class="hljs-keyword">lambda</span> seconds: repeat(<span class="hljs-number">0</span>, int(seconds * F))
  1626. sin_f = <span class="hljs-keyword">lambda</span> i, hz: math.sin(i * <span class="hljs-number">2</span> * math.pi * hz / F)
  1627. get_wave = <span class="hljs-keyword">lambda</span> hz, seconds: (sin_f(i, hz) <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(int(seconds * F)))
  1628. get_hz = <span class="hljs-keyword">lambda</span> key: <span class="hljs-number">8.176</span> * <span class="hljs-number">2</span> ** (int(key) / <span class="hljs-number">12</span>)
  1629. parse_n = <span class="hljs-keyword">lambda</span> note: (get_hz(note[:<span class="hljs-number">2</span>]), <span class="hljs-number">0.25</span> <span class="hljs-keyword">if</span> <span class="hljs-string">'♪'</span> <span class="hljs-keyword">in</span> note <span class="hljs-keyword">else</span> <span class="hljs-number">0.125</span>)
  1630. get_note = <span class="hljs-keyword">lambda</span> note: get_wave(*parse_n(note)) <span class="hljs-keyword">if</span> note <span class="hljs-keyword">else</span> get_pause(<span class="hljs-number">0.125</span>)
  1631. frames_i = chain.from_iterable(get_note(n) <span class="hljs-keyword">for</span> n <span class="hljs-keyword">in</span> <span class="hljs-string">f'<span class="hljs-subst">{P1}</span><span class="hljs-subst">{P1}</span><span class="hljs-subst">{P2}</span>'</span>.split(<span class="hljs-string">','</span>))
  1632. frames_b = <span class="hljs-string">b''</span>.join(struct.pack(<span class="hljs-string">'&lt;h'</span>, int(a * <span class="hljs-number">30000</span>)) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> frames_i)
  1633. simpleaudio.play_buffer(frames_b, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, F)
  1634. </code></pre>
  1635. <h2 id="basicscripttemplate"><a href="#basicscripttemplate" name="basicscripttemplate">#</a>Basic Script Template</h2>
  1636. <pre><code class="python language-python hljs"><span class="hljs-comment">#!/usr/bin/env python3</span>
  1637. <span class="hljs-comment">#</span>
  1638. <span class="hljs-comment"># Usage: .py</span>
  1639. <span class="hljs-comment">#</span>
  1640. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  1641. <span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  1642. <span class="hljs-keyword">import</span> re
  1643. <span class="hljs-keyword">import</span> sys
  1644. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1645. <span class="hljs-keyword">pass</span>
  1646. <span class="hljs-comment">###</span>
  1647. <span class="hljs-comment">## UTIL</span>
  1648. <span class="hljs-comment">#</span>
  1649. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_file</span><span class="hljs-params">(filename)</span>:</span>
  1650. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1651. <span class="hljs-keyword">return</span> file.readlines()
  1652. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  1653. main()
  1654. </code></pre>
  1655. <footer>
  1656. <aside>March 14, 2018</aside>
  1657. <a href="../" rel="author">Jure Šorn</a>
  1658. </footer>
  1659. <br>
  1660. <br>
  1661. <br>
  1662. </body>
  1663. </html>