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.

2229 lines
180 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 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. <meta name="description" content="Exhaustive, simple, beautiful and concise. A truly pythonic cheat sheet about Python programming language.">
  8. <link rel="icon" href="web/favicon.png">
  9. <link rel="stylesheet" href="web/default.min.css">
  10. <link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">
  11. <meta name="twitter:card" content="summary">
  12. <meta name="twitter:title" content="Comprehensive Python Cheatsheet">
  13. <meta name="twitter:description" content="Exhaustive, simple, beautiful and concise. A truly pythonic cheat sheet about Python programming language.">
  14. <meta name="twitter:image" content="https://gto76.github.io/python-cheatsheet/web/image_twitter_card_2.jpeg">
  15. <meta name="google-site-verification" content="w3rvuG0D1kUm_w20qsJecSEZh59Am8jK4eSPVU83e_M" />
  16. </head>
  17. <style>
  18. @import url(web/style.css);
  19. .join,
  20. .link,
  21. .node rect {
  22. fill: none;
  23. stroke: #636363;
  24. stroke-width: 1.5px;
  25. }
  26. .link {
  27. stroke: #969696;
  28. }
  29. .node rect {
  30. fill: white;
  31. }
  32. .link path,
  33. .node rect,
  34. .node text,
  35. .join {
  36. -webkit-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  37. -moz-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  38. -ms-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  39. -o-transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  40. transition: stroke-opacity 500ms linear, fill-opacity 500ms linear;
  41. }
  42. .node .element rect {
  43. fill: #bdbdbd;
  44. stroke: none;
  45. }
  46. .node .null rect {
  47. fill: none;
  48. stroke: none;
  49. }
  50. .node .null text {
  51. fill: #636363;
  52. }
  53. .node .selection rect {
  54. stroke: #e6550d;
  55. }
  56. .node .data rect {
  57. stroke: #3182bd;
  58. }
  59. .node .datum rect {
  60. fill: #d9d9d9;
  61. stroke: none;
  62. }
  63. .node .code text {
  64. font-family: monospace;
  65. }
  66. .node .key rect {
  67. fill: #a1d99b;
  68. stroke: none;
  69. }
  70. .link .to-key,
  71. .join {
  72. stroke: #a1d99b;
  73. }
  74. .join {
  75. stroke-dasharray: 2,2;
  76. }
  77. .link .to-null {
  78. stroke-dasharray: .5,3.5;
  79. stroke-linecap: round;
  80. }
  81. .link .from-data {
  82. stroke: #3182bd;
  83. }
  84. .play circle {
  85. fill: #fff;
  86. stroke: #000;
  87. stroke-width: 3px;
  88. }
  89. .play:hover path {
  90. fill: #f00;
  91. }
  92. .play.mousedown circle {
  93. fill: #f00;
  94. }
  95. .play.mousedown path {
  96. fill: #fff;
  97. }
  98. .play rect {
  99. fill: none;
  100. pointer-events: all;
  101. cursor: pointer;
  102. }
  103. code span {
  104. -webkit-transition: background 250ms linear;
  105. -moz-transition: background 250ms linear;
  106. -ms-transition: background 250ms linear;
  107. -o-transition: background 250ms linear;
  108. transition: background 250ms linear;
  109. }
  110. pre.prettyprint, code.prettyprint {
  111. background-color: #222;
  112. border-radius: 8px;
  113. font-size: 15px;
  114. }
  115. pre.prettyprint {
  116. width: 90%;
  117. margin: 0.5em;
  118. padding: 1em;
  119. white-space: pre-wrap;
  120. }
  121. #return-to-top {
  122. position: fixed;
  123. bottom: 20px;
  124. right: 20px;
  125. background: rgb(0, 0, 0);
  126. background: rgba(0, 0, 0, 0.2);
  127. width: 50px;
  128. height: 50px;
  129. display: block;
  130. text-decoration: none;
  131. -webkit-border-radius: 35px;
  132. -moz-border-radius: 35px;
  133. border-radius: 35px;
  134. display: none;
  135. -webkit-transition: all 0.3s linear;
  136. -moz-transition: all 0.3s ease;
  137. -ms-transition: all 0.3s ease;
  138. -o-transition: all 0.3s ease;
  139. transition: all 0.3s ease;
  140. }
  141. #return-to-top i {
  142. color: #fff;
  143. margin: 0;
  144. position: relative;
  145. left: 16px;
  146. top: 13px;
  147. font-size: 19px;
  148. -webkit-transition: all 0.3s ease;
  149. -moz-transition: all 0.3s ease;
  150. -ms-transition: all 0.3s ease;
  151. -o-transition: all 0.3s ease;
  152. transition: all 0.3s ease;
  153. }
  154. #return-to-top:hover {
  155. background: rgba(0, 0, 0, 0.35);
  156. }
  157. #return-to-top:hover i {
  158. color: #f0f0f0;
  159. }
  160. </style>
  161. <body>
  162. <header>
  163. <aside>March 14, 2018</aside>
  164. <a href="../" rel="author">Jure Šorn</a>
  165. </header>
  166. <a href="javascript:" id="return-to-top"><i class="icon-chevron-up"></i></a>
  167. <h1 id="comprehensivepythoncheatsheet">Comprehensive Python Cheatsheet</h1>
  168. <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>.
  169. </sup></p>
  170. <p class="banner"><img src="web/image_888.jpeg" alt="Monty Python"></p>
  171. <br><h2 id="toc"><a href="#toc" name="toc">#</a>Contents</h2>
  172. <pre><code class="hljs bash"><strong>ToC</strong> = {
  173. <strong><span class="hljs-string"><span class="hljs-string">'1. Collections'</span></span></strong>: [<a href="#list">List</a>, <a href="#dictionary">Dictionary</a>, <a href="#set">Set</a>, <a href="#tuple">Tuple</a>, <a href="#range">Range</a>, <a href="#enumerate">Enumerate</a>, <a href="#iterator">Iterator</a>, <a href="#generator">Generator</a>],
  174. <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">Regular_Exp</a>, <a href="#format">Format</a>, <a href="#numbers">Numbers</a>, <a href="#combinatorics">Combinatorics</a>, <a href="#datetime">Datetime</a>],
  175. <strong><span class="hljs-string"><span class="hljs-string">'3. Syntax'</span></span></strong>: [<a href="#arguments">Args</a>, <a href="#inline">Inline</a>, <a href="#closure">Closure</a>, <a href="#decorator">Decorator</a>, <a href="#class">Class</a>, <a href="#ducktypes">Duck_Types</a>, <a href="#enum">Enum</a>, <a href="#exceptions">Exceptions</a>],
  176. <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>],
  177. <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>],
  178. <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>],
  179. <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>,
  180. <a href="#numpy">NumPy</a>, <a href="#image">Image</a>, <a href="#audio">Audio</a>]
  181. }
  182. </code></pre>
  183. <h2 id="main"><a href="#main" name="main">#</a>Main</h2>
  184. <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>
  185. main()
  186. </code></pre>
  187. <h2 id="list"><a href="#list" name="list">#</a>List</h2>
  188. <pre><code class="python language-python hljs">&lt;list&gt; = &lt;list&gt;[from_inclusive : to_exclusive : ±step_size]
  189. </code></pre>
  190. <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>
  191. &lt;list&gt;.extend(&lt;collection&gt;) <span class="hljs-comment"># Or: &lt;list&gt; += &lt;collection&gt;</span>
  192. </code></pre>
  193. <pre><code class="python language-python hljs">&lt;list&gt;.sort()
  194. &lt;list&gt;.reverse()
  195. &lt;list&gt; = sorted(&lt;collection&gt;)
  196. &lt;iter&gt; = reversed(&lt;list&gt;)
  197. </code></pre>
  198. <pre><code class="python language-python hljs">sum_of_elements = sum(&lt;collection&gt;)
  199. elementwise_sum = [sum(pair) <span class="hljs-keyword">for</span> pair <span class="hljs-keyword">in</span> zip(list_a, list_b)]
  200. sorted_by_second = sorted(&lt;collection&gt;, key=<span class="hljs-keyword">lambda</span> el: el[<span class="hljs-number">1</span>])
  201. 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>]))
  202. flatter_list = list(itertools.chain.from_iterable(&lt;list&gt;))
  203. product_of_elems = functools.reduce(<span class="hljs-keyword">lambda</span> out, x: out * x, &lt;collection&gt;)
  204. list_of_chars = list(&lt;str&gt;)
  205. </code></pre>
  206. <pre><code class="python language-python hljs">index = &lt;list&gt;.index(&lt;el&gt;) <span class="hljs-comment"># Returns index of first occurrence or raises ValueError.</span>
  207. &lt;list&gt;.insert(index, &lt;el&gt;) <span class="hljs-comment"># Inserts item at index and moves the rest to the right.</span>
  208. &lt;el&gt; = &lt;list&gt;.pop([index]) <span class="hljs-comment"># Removes and returns item at index or from the end.</span>
  209. &lt;list&gt;.remove(&lt;el&gt;) <span class="hljs-comment"># Removes first occurrence of item or raises ValueError.</span>
  210. &lt;list&gt;.clear() <span class="hljs-comment"># Removes all items. Also works on dict and set.</span>
  211. </code></pre>
  212. <h2 id="dictionary"><a href="#dictionary" name="dictionary">#</a>Dictionary</h2>
  213. <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>
  214. &lt;view&gt; = &lt;dict&gt;.values() <span class="hljs-comment"># Coll. of values that reflects changes.</span>
  215. &lt;view&gt; = &lt;dict&gt;.items() <span class="hljs-comment"># Coll. of key-value tuples.</span>
  216. </code></pre>
  217. <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>
  218. 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>
  219. &lt;dict&gt; = collections.defaultdict(&lt;type&gt;) <span class="hljs-comment"># Creates a dict with default value of type.</span>
  220. &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>
  221. </code></pre>
  222. <pre><code class="python language-python hljs">&lt;dict&gt;.update(&lt;dict&gt;)
  223. &lt;dict&gt; = dict(&lt;collection&gt;) <span class="hljs-comment"># Creates a dict from coll. of key-value pairs.</span>
  224. &lt;dict&gt; = dict(zip(keys, values)) <span class="hljs-comment"># Creates a dict from two collections.</span>
  225. &lt;dict&gt; = dict.fromkeys(keys [, value]) <span class="hljs-comment"># Creates a dict from collection of keys.</span>
  226. </code></pre>
  227. <pre><code class="python language-python hljs">value = &lt;dict&gt;.pop(key) <span class="hljs-comment"># Removes item from dictionary.</span>
  228. {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>
  229. </code></pre>
  230. <h3 id="counter">Counter</h3>
  231. <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
  232. <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>]
  233. <span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter(colors)
  234. 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>})
  235. <span class="hljs-meta">&gt;&gt;&gt; </span>counter.most_common()[<span class="hljs-number">0</span>]
  236. (<span class="hljs-string">'blue'</span>, <span class="hljs-number">3</span>)
  237. </code></pre>
  238. <h2 id="set"><a href="#set" name="set">#</a>Set</h2>
  239. <pre><code class="python language-python hljs">&lt;set&gt; = set()
  240. </code></pre>
  241. <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>
  242. &lt;set&gt;.update(&lt;collection&gt;) <span class="hljs-comment"># Or: &lt;set&gt; |= &lt;set&gt;</span>
  243. </code></pre>
  244. <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>
  245. &lt;set&gt; = &lt;set&gt;.intersection(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &amp; &lt;set&gt;</span>
  246. &lt;set&gt; = &lt;set&gt;.difference(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; - &lt;set&gt;</span>
  247. &lt;set&gt; = &lt;set&gt;.symmetric_difference(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; ^ &lt;set&gt;</span>
  248. &lt;bool&gt; = &lt;set&gt;.issubset(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &lt;= &lt;set&gt;</span>
  249. &lt;bool&gt; = &lt;set&gt;.issuperset(&lt;coll.&gt;) <span class="hljs-comment"># Or: &lt;set&gt; &gt;= &lt;set&gt;</span>
  250. </code></pre>
  251. <pre><code class="python language-python hljs">&lt;set&gt;.remove(&lt;el&gt;) <span class="hljs-comment"># Raises KeyError.</span>
  252. &lt;set&gt;.discard(&lt;el&gt;) <span class="hljs-comment"># Doesn't raise an error.</span>
  253. </code></pre>
  254. <h3 id="frozenset">Frozen Set</h3>
  255. <ul>
  256. <li><strong>Is immutable and hashable.</strong></li>
  257. <li><strong>That means it can be used as a key in a dictionary or as an element in a set.</strong></li>
  258. </ul>
  259. <pre><code class="python language-python hljs">&lt;frozenset&gt; = frozenset(&lt;collection&gt;)
  260. </code></pre>
  261. <h2 id="tuple"><a href="#tuple" name="tuple">#</a>Tuple</h2>
  262. <p><strong>Tuple is an immutable and hashable list.</strong></p>
  263. <pre><code class="python language-python hljs">&lt;tuple&gt; = ()
  264. &lt;tuple&gt; = (&lt;el&gt;, )
  265. &lt;tuple&gt; = (&lt;el_1&gt;, &lt;el_2&gt;, ...)
  266. </code></pre>
  267. <h3 id="namedtuple">Named Tuple</h3>
  268. <p><strong>Tuple's subclass with named elements.</strong></p>
  269. <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
  270. <span class="hljs-meta">&gt;&gt;&gt; </span>Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  271. <span class="hljs-meta">&gt;&gt;&gt; </span>p = Point(<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  272. Point(x=<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  273. <span class="hljs-meta">&gt;&gt;&gt; </span>p[<span class="hljs-number">0</span>]
  274. <span class="hljs-number">1</span>
  275. <span class="hljs-meta">&gt;&gt;&gt; </span>p.x
  276. <span class="hljs-number">1</span>
  277. <span class="hljs-meta">&gt;&gt;&gt; </span>getattr(p, <span class="hljs-string">'y'</span>)
  278. <span class="hljs-number">2</span>
  279. <span class="hljs-meta">&gt;&gt;&gt; </span>p._fields <span class="hljs-comment"># Or: Point._fields</span>
  280. (<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>)
  281. </code></pre>
  282. <h2 id="range"><a href="#range" name="range">#</a>Range</h2>
  283. <pre><code class="python language-python hljs">&lt;range&gt; = range(to_exclusive)
  284. &lt;range&gt; = range(from_inclusive, to_exclusive)
  285. &lt;range&gt; = range(from_inclusive, to_exclusive, ±step_size)
  286. </code></pre>
  287. <pre><code class="python language-python hljs">from_inclusive = &lt;range&gt;.start
  288. to_exclusive = &lt;range&gt;.stop
  289. </code></pre>
  290. <h2 id="enumerate"><a href="#enumerate" name="enumerate">#</a>Enumerate</h2>
  291. <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]):
  292. ...
  293. </code></pre>
  294. <h2 id="iterator"><a href="#iterator" name="iterator">#</a>Iterator</h2>
  295. <pre><code class="python language-python hljs">&lt;iter&gt; = iter(&lt;collection&gt;) <span class="hljs-comment"># Calling `iter(&lt;iter&gt;)` returns unmodified iterator.</span>
  296. &lt;iter&gt; = iter(&lt;function&gt;, to_exclusive) <span class="hljs-comment"># Sequence of return values until 'to_exclusive'.</span>
  297. &lt;el&gt; = next(&lt;iter&gt; [, default]) <span class="hljs-comment"># Raises StopIteration or returns 'default' on end.</span>
  298. </code></pre>
  299. <h3 id="itertools">Itertools</h3>
  300. <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
  301. </code></pre>
  302. <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>
  303. &lt;iter&gt; = repeat(&lt;el&gt; [, times]) <span class="hljs-comment"># Returns element endlessly or 'times' times.</span>
  304. &lt;iter&gt; = cycle(&lt;collection&gt;) <span class="hljs-comment"># Repeats the sequence indefinitely.</span>
  305. </code></pre>
  306. <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>
  307. &lt;iter&gt; = chain.from_iterable(&lt;collection&gt;) <span class="hljs-comment"># Empties collections inside a collection in order.</span>
  308. </code></pre>
  309. <pre><code class="python language-python hljs">&lt;iter&gt; = islice(&lt;collection&gt;, to_exclusive)
  310. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive)
  311. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive, +step_size)
  312. </code></pre>
  313. <h2 id="generator"><a href="#generator" name="generator">#</a>Generator</h2>
  314. <ul>
  315. <li><strong>Convenient way to implement the iterator protocol.</strong></li>
  316. <li><strong>Any function that contains a yield statement returns a generator object.</strong></li>
  317. <li><strong>Generators and iterators are interchangeable.</strong></li>
  318. </ul>
  319. <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>
  320. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  321. <span class="hljs-keyword">yield</span> start
  322. start += step
  323. </code></pre>
  324. <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>)
  325. <span class="hljs-meta">&gt;&gt;&gt; </span>next(counter), next(counter), next(counter)
  326. (<span class="hljs-number">10</span>, <span class="hljs-number">12</span>, <span class="hljs-number">14</span>)
  327. </code></pre>
  328. <h2 id="type"><a href="#type" name="type">#</a>Type</h2>
  329. <ul>
  330. <li><strong>Everything is an object.</strong></li>
  331. <li><strong>Every object has a type.</strong></li>
  332. <li><strong>Type and class are synonymous.</strong></li>
  333. </ul>
  334. <pre><code class="python language-python hljs">&lt;type&gt; = type(&lt;el&gt;) <span class="hljs-comment"># Or: &lt;el&gt;.__class__</span>
  335. &lt;bool&gt; = isinstance(&lt;el&gt;, &lt;type&gt;) <span class="hljs-comment"># Or: issubclass(type(&lt;el&gt;), &lt;type&gt;)</span>
  336. </code></pre>
  337. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>type(<span class="hljs-string">'a'</span>), <span class="hljs-string">'a'</span>.__class__, str
  338. (&lt;<span class="hljs-class"><span class="hljs-title">class</span> '<span class="hljs-title">str</span>'&gt;, &lt;<span class="hljs-title">class</span> '<span class="hljs-title">str</span>'&gt;, &lt;<span class="hljs-title">class</span> '<span class="hljs-title">str</span>'&gt;)
  339. </span></code></pre>
  340. <h4 id="sometypesdonothavebuiltinnamessotheymustbeimported">Some types do not have builtin names, so they must be imported:</h4>
  341. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> types <span class="hljs-keyword">import</span> FunctionType, MethodType, LambdaType, GeneratorType
  342. </code></pre>
  343. <h3 id="abc">ABC</h3>
  344. <p><strong>An abstract base class introduces virtual subclasses, that don’t inherit from it but are still recognized by isinstance() and issubclass().</strong></p>
  345. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> collections.abc <span class="hljs-keyword">import</span> Sequence, Collection, Iterable
  346. <span class="hljs-meta">&gt;&gt;&gt; </span>isinstance([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], Iterable)
  347. <span class="hljs-keyword">True</span>
  348. </code></pre>
  349. <pre><code class="text language-text">+------------------+----------+------------+----------+
  350. | | Sequence | Collection | Iterable |
  351. +------------------+----------+------------+----------+
  352. | list, range, str | yes | yes | yes |
  353. | dict, set | | yes | yes |
  354. | iter | | | yes |
  355. +------------------+----------+------------+----------+
  356. </code></pre>
  357. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> numbers <span class="hljs-keyword">import</span> Integral, Rational, Real, Complex, Number
  358. <span class="hljs-meta">&gt;&gt;&gt; </span>isinstance(<span class="hljs-number">123</span>, Number)
  359. <span class="hljs-keyword">True</span>
  360. </code></pre>
  361. <pre><code class="text language-text">+--------------------+----------+----------+------+---------+--------+
  362. | | Integral | Rational | Real | Complex | Number |
  363. +--------------------+----------+----------+------+---------+--------+
  364. | int | yes | yes | yes | yes | yes |
  365. | fractions.Fraction | | yes | yes | yes | yes |
  366. | float | | | yes | yes | yes |
  367. | complex | | | | yes | yes |
  368. +--------------------+----------+----------+------+---------+--------+
  369. </code></pre>
  370. <h2 id="string"><a href="#string" name="string">#</a>String</h2>
  371. <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>
  372. &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>
  373. </code></pre>
  374. <pre><code class="python language-python hljs">&lt;list&gt; = &lt;str&gt;.split() <span class="hljs-comment"># Splits on one or more whitespace characters.</span>
  375. &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>
  376. &lt;list&gt; = &lt;str&gt;.splitlines(keepends=<span class="hljs-keyword">False</span>) <span class="hljs-comment"># Splits on line breaks. Keeps them if 'keepends'.</span>
  377. &lt;str&gt; = &lt;str&gt;.join(&lt;coll_of_strings&gt;) <span class="hljs-comment"># Joins elements using string as separator.</span>
  378. </code></pre>
  379. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;sub_str&gt; <span class="hljs-keyword">in</span> &lt;str&gt; <span class="hljs-comment"># Checks if string contains a substring.</span>
  380. &lt;bool&gt; = &lt;str&gt;.startswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  381. &lt;bool&gt; = &lt;str&gt;.endswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  382. &lt;int&gt; = &lt;str&gt;.find(&lt;sub_str&gt;) <span class="hljs-comment"># Returns start index of first match or -1.</span>
  383. &lt;int&gt; = &lt;str&gt;.index(&lt;sub_str&gt;) <span class="hljs-comment"># Same but raises ValueError.</span>
  384. </code></pre>
  385. <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>
  386. &lt;bool&gt; = &lt;str&gt;.isnumeric() <span class="hljs-comment"># True if str contains only numeric characters.</span>
  387. &lt;list&gt; = textwrap.wrap(&lt;str&gt;, width) <span class="hljs-comment"># Nicely breaks string into lines.</span>
  388. </code></pre>
  389. <ul>
  390. <li><strong>Also: <code class="python hljs"><span class="hljs-string">'lstrip()'</span></code>, <code class="python hljs"><span class="hljs-string">'rstrip()'</span></code>.</strong></li>
  391. <li><strong>Also: <code class="python hljs"><span class="hljs-string">'lower()'</span></code>, <code class="python hljs"><span class="hljs-string">'upper()'</span></code>, <code class="python hljs"><span class="hljs-string">'capitalize()'</span></code> and <code class="python hljs"><span class="hljs-string">'title()'</span></code>.</strong></li>
  392. </ul>
  393. <h3 id="char">Char</h3>
  394. <pre><code class="python language-python hljs">&lt;str&gt; = chr(&lt;int&gt;) <span class="hljs-comment"># Converts int to unicode char.</span>
  395. &lt;int&gt; = ord(&lt;str&gt;) <span class="hljs-comment"># Converts unicode char to int.</span>
  396. </code></pre>
  397. <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>)
  398. (<span class="hljs-number">48</span>, <span class="hljs-number">57</span>)
  399. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'A'</span>), ord(<span class="hljs-string">'Z'</span>)
  400. (<span class="hljs-number">65</span>, <span class="hljs-number">90</span>)
  401. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'a'</span>), ord(<span class="hljs-string">'z'</span>)
  402. (<span class="hljs-number">97</span>, <span class="hljs-number">122</span>)
  403. </code></pre>
  404. <h2 id="regex"><a href="#regex" name="regex">#</a>Regex</h2>
  405. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> re
  406. &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>
  407. &lt;list&gt; = re.findall(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences.</span>
  408. &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>
  409. &lt;Match&gt; = re.search(&lt;regex&gt;, text) <span class="hljs-comment"># Searches for first occurrence of pattern.</span>
  410. &lt;Match&gt; = re.match(&lt;regex&gt;, text) <span class="hljs-comment"># Searches only at the beginning of the text.</span>
  411. &lt;iter&gt; = re.finditer(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences as match objects.</span>
  412. </code></pre>
  413. <ul>
  414. <li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.IGNORECASE'</span></code> can be used with all functions.</strong></li>
  415. <li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.MULTILINE'</span></code> makes <code class="python hljs"><span class="hljs-string">'^'</span></code> and <code class="python hljs"><span class="hljs-string">'$'</span></code> match the start/end of each line.</strong></li>
  416. <li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.DOTALL'</span></code> makes dot also accept newline.</strong></li>
  417. <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>
  418. <li><strong>Use <code class="python hljs"><span class="hljs-string">'?'</span></code> to make an operator non-greedy.</strong></li>
  419. </ul>
  420. <h3 id="matchobject">Match Object</h3>
  421. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Match&gt;.group() <span class="hljs-comment"># Whole match. Also group(0).</span>
  422. &lt;str&gt; = &lt;Match&gt;.group(<span class="hljs-number">1</span>) <span class="hljs-comment"># Part in first bracket.</span>
  423. &lt;tuple&gt; = &lt;Match&gt;.groups() <span class="hljs-comment"># All bracketed parts.</span>
  424. &lt;int&gt; = &lt;Match&gt;.start() <span class="hljs-comment"># Start index of a match.</span>
  425. &lt;int&gt; = &lt;Match&gt;.end() <span class="hljs-comment"># Exclusive end index of a match.</span>
  426. </code></pre>
  427. <h3 id="specialsequences">Special Sequences</h3>
  428. <ul>
  429. <li><strong>By default digits, whitespaces and alphanumerics from all alphabets are matched, unless <code class="python hljs"><span class="hljs-string">'flags=re.ASCII'</span></code> argument is used.</strong></li>
  430. <li><strong>Use capital letters for negation.</strong></li>
  431. </ul>
  432. <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>
  433. <span class="hljs-string">'\s'</span> == <span class="hljs-string">'[ \t\n\r\f\v]'</span> <span class="hljs-comment"># Whitespace</span>
  434. <span class="hljs-string">'\w'</span> == <span class="hljs-string">'[a-zA-Z0-9_]'</span> <span class="hljs-comment"># Alphanumeric</span>
  435. </code></pre>
  436. <h2 id="format"><a href="#format" name="format">#</a>Format</h2>
  437. <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>
  438. &lt;str&gt; = <span class="hljs-string">'{}, {}'</span>.format(&lt;el_1&gt;, &lt;el_2&gt;)
  439. </code></pre>
  440. <h3 id="attributes">Attributes</h3>
  441. <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
  442. <span class="hljs-meta">&gt;&gt;&gt; </span>Person = namedtuple(<span class="hljs-string">'Person'</span>, <span class="hljs-string">'name height'</span>)
  443. <span class="hljs-meta">&gt;&gt;&gt; </span>person = Person(<span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>)
  444. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">f'<span class="hljs-subst">{person.height}</span>'</span>
  445. <span class="hljs-string">'187'</span>
  446. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">'{p.height}'</span>.format(p=person)
  447. <span class="hljs-string">'187'</span>
  448. </code></pre>
  449. <h3 id="generaloptions">General Options</h3>
  450. <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>
  451. {&lt;el&gt;:^<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt; '</span>
  452. {&lt;el&gt;:&gt;<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt;'</span>
  453. </code></pre>
  454. <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>
  455. {&lt;el&gt;:&gt;<span class="hljs-number">0</span>} <span class="hljs-comment"># '&lt;el&gt;'</span>
  456. </code></pre>
  457. <h3 id="strings">Strings</h3>
  458. <p><strong><code class="python hljs"><span class="hljs-string">'!r'</span></code> calls object's repr() method, instead of str(), to get a string.</strong></p>
  459. <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>
  460. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">.3</span>} <span class="hljs-comment"># 'abc'</span>
  461. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># 'abc '</span>
  462. </code></pre>
  463. <h3 id="numbers-1">Numbers</h3>
  464. <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>
  465. { <span class="hljs-number">123456</span>:<span class="hljs-number">10</span>_} <span class="hljs-comment"># ' 123_456'</span>
  466. { <span class="hljs-number">123456</span>:+<span class="hljs-number">10</span>} <span class="hljs-comment"># ' +123456'</span>
  467. {<span class="hljs-number">-123456</span>:=<span class="hljs-number">10</span>} <span class="hljs-comment"># '- 123456'</span>
  468. { <span class="hljs-number">123456</span>: } <span class="hljs-comment"># ' 123456'</span>
  469. {<span class="hljs-number">-123456</span>: } <span class="hljs-comment"># '-123456'</span>
  470. </code></pre>
  471. <h3 id="floats">Floats</h3>
  472. <pre><code class="python language-python hljs">{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># ' 1.23'</span>
  473. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>f} <span class="hljs-comment"># ' 1.235'</span>
  474. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>e} <span class="hljs-comment"># ' 1.235e+00'</span>
  475. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>%} <span class="hljs-comment"># ' 123.456%'</span>
  476. </code></pre>
  477. <h4 id="comparisonoffloatpresentationtypes">Comparison of float presentation types:</h4>
  478. <pre><code class="text language-text">+----------------+----------------+---------------+----------------+-----------------+
  479. | | {&lt;float&gt;} | {&lt;float&gt;:f} | {&lt;float&gt;:e} | {&lt;float&gt;:%} |
  480. +----------------+----------------+---------------+----------------+-----------------+
  481. | 0.000056789 | '5.6789e-05' | '0.000057' | '5.678900e-05' | '0.005679%' |
  482. | 0.00056789 | '0.00056789' | '0.000568' | '5.678900e-04' | '0.056789%' |
  483. | 0.0056789 | '0.0056789' | '0.005679' | '5.678900e-03' | '0.567890%' |
  484. | 0.056789 | '0.056789' | '0.056789' | '5.678900e-02' | '5.678900%' |
  485. | 0.56789 | '0.56789' | '0.567890' | '5.678900e-01' | '56.789000%' |
  486. | 5.6789 | '5.6789' | '5.678900' | '5.678900e+00' | '567.890000%' |
  487. | 56.789 | '56.789' | '56.789000' | '5.678900e+01' | '5678.900000%' |
  488. | 567.89 | '567.89' | '567.890000' | '5.678900e+02' | '56789.000000%' |
  489. +----------------+----------------+---------------+----------------+-----------------+
  490. </code></pre>
  491. <pre><code class="text language-text">+----------------+----------------+---------------+----------------+-----------------+
  492. | | {&lt;float&gt;:.2} | {&lt;float&gt;:.2f} | {&lt;float&gt;:.2e} | {&lt;float&gt;:.2%} |
  493. +----------------+----------------+---------------+----------------+-----------------+
  494. | 0.000056789 | '5.7e-05' | '0.00' | '5.68e-05' | '0.01%' |
  495. | 0.00056789 | '0.00057' | '0.00' | '5.68e-04' | '0.06%' |
  496. | 0.0056789 | '0.0057' | '0.01' | '5.68e-03' | '0.57%' |
  497. | 0.056789 | '0.057' | '0.06' | '5.68e-02' | '5.68%' |
  498. | 0.56789 | '0.57' | '0.57' | '5.68e-01' | '56.79%' |
  499. | 5.6789 | '5.7' | '5.68' | '5.68e+00' | '567.89%' |
  500. | 56.789 | '5.7e+01' | '56.79' | '5.68e+01' | '5678.90%' |
  501. | 567.89 | '5.7e+02' | '567.89' | '5.68e+02' | '56789.00%' |
  502. +----------------+----------------+---------------+----------------+-----------------+
  503. </code></pre>
  504. <h3 id="ints">Ints</h3>
  505. <pre><code class="python language-python hljs">{<span class="hljs-number">90</span>:c} <span class="hljs-comment"># 'Z'</span>
  506. {<span class="hljs-number">90</span>:X} <span class="hljs-comment"># '5A'</span>
  507. {<span class="hljs-number">90</span>:b} <span class="hljs-comment"># '1011010'</span>
  508. </code></pre>
  509. <h2 id="numbers"><a href="#numbers" name="numbers">#</a>Numbers</h2>
  510. <pre><code class="python language-python hljs">&lt;int&gt; = int(&lt;float/str/bool&gt;) <span class="hljs-comment"># Or: math.floor(&lt;float&gt;)</span>
  511. &lt;float&gt; = float(&lt;int/str/bool&gt;)
  512. &lt;complex&gt; = complex(real=<span class="hljs-number">0</span>, imag=<span class="hljs-number">0</span>) <span class="hljs-comment"># Or: &lt;real&gt; + &lt;real&gt;j</span>
  513. &lt;Fraction&gt; = fractions.Fraction(numerator=<span class="hljs-number">0</span>, denominator=<span class="hljs-number">1</span>)
  514. </code></pre>
  515. <ul>
  516. <li><strong><code class="python hljs"><span class="hljs-string">'int(&lt;str&gt;)'</span></code> and <code class="python hljs"><span class="hljs-string">'float(&lt;str&gt;)'</span></code> raise 'ValueError' on malformed strings.</strong></li>
  517. </ul>
  518. <h3 id="basicfunctions">Basic Functions</h3>
  519. <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>
  520. &lt;real&gt; = abs(&lt;num&gt;)
  521. &lt;int&gt; = round(&lt;real&gt;)
  522. &lt;real&gt; = round(&lt;real&gt;, ±ndigits) <span class="hljs-comment"># `round(126, -1) == 130`</span>
  523. </code></pre>
  524. <h3 id="math">Math</h3>
  525. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> e, pi, inf, nan
  526. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> cos, acos, sin, asin, tan, atan, degrees, radians
  527. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> log, log10, log2
  528. </code></pre>
  529. <h3 id="statistics">Statistics</h3>
  530. <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
  531. </code></pre>
  532. <h3 id="random">Random</h3>
  533. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> random, randint, choice, shuffle
  534. &lt;float&gt; = random()
  535. &lt;int&gt; = randint(from_inclusive, to_inclusive)
  536. &lt;el&gt; = choice(&lt;list&gt;)
  537. shuffle(&lt;list&gt;)
  538. </code></pre>
  539. <h3 id="binhex">Bin, Hex</h3>
  540. <pre><code class="python language-python hljs">&lt;int&gt; = <span class="hljs-number">0</span>b&lt;bin&gt; <span class="hljs-comment"># Or: 0x&lt;hex&gt;</span>
  541. &lt;int&gt; = int(<span class="hljs-string">'0b&lt;bin&gt;'</span>, <span class="hljs-number">0</span>) <span class="hljs-comment"># Or: int('0x&lt;hex&gt;', 0)</span>
  542. &lt;int&gt; = int(<span class="hljs-string">'&lt;bin&gt;'</span>, <span class="hljs-number">2</span>) <span class="hljs-comment"># Or: int('&lt;hex&gt;', 16)</span>
  543. <span class="hljs-string">'0b&lt;bin&gt;'</span> = bin(&lt;int&gt;) <span class="hljs-comment"># Or: '0x&lt;hex&gt;' = hex(&lt;int&gt;)</span>
  544. </code></pre>
  545. <h3 id="bitwiseoperators">Bitwise Operators</h3>
  546. <pre><code class="python language-python hljs">&lt;int&gt; = &lt;int&gt; &amp; &lt;int&gt; <span class="hljs-comment"># And</span>
  547. &lt;int&gt; = &lt;int&gt; | &lt;int&gt; <span class="hljs-comment"># Or</span>
  548. &lt;int&gt; = &lt;int&gt; ^ &lt;int&gt; <span class="hljs-comment"># Xor (0 if both bits equal)</span>
  549. &lt;int&gt; = &lt;int&gt; &lt;&lt; n_bits <span class="hljs-comment"># Shift left</span>
  550. &lt;int&gt; = &lt;int&gt; &gt;&gt; n_bits <span class="hljs-comment"># Shift right</span>
  551. &lt;int&gt; = ~&lt;int&gt; <span class="hljs-comment"># Compliment (flips bits)</span>
  552. </code></pre>
  553. <h2 id="combinatorics"><a href="#combinatorics" name="combinatorics">#</a>Combinatorics</h2>
  554. <ul>
  555. <li><strong>Every function returns an iterator.</strong></li>
  556. <li><strong>If you want to print the iterator, you need to pass it to the list() function!</strong></li>
  557. </ul>
  558. <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
  559. </code></pre>
  560. <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>)
  561. [(<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>),
  562. (<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>)]
  563. </code></pre>
  564. <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>)
  565. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'2'</span>),
  566. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'2'</span>)]
  567. </code></pre>
  568. <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>)
  569. [(<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>)]
  570. </code></pre>
  571. <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>)
  572. [(<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>),
  573. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  574. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'c'</span>)]
  575. </code></pre>
  576. <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>)
  577. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'c'</span>),
  578. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  579. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'c'</span>, <span class="hljs-string">'b'</span>)]
  580. </code></pre>
  581. <h2 id="datetime"><a href="#datetime" name="datetime">#</a>Datetime</h2>
  582. <ul>
  583. <li><strong>Module 'datetime' provides 'date' <code class="apache hljs"><span class="hljs-section">&lt;D&gt;</span></code>, 'time' <code class="apache hljs"><span class="hljs-section">&lt;T&gt;</span></code>, 'datetime' <code class="apache hljs"><span class="hljs-section">&lt;DT&gt;</span></code> and 'timedelta' <code class="apache hljs"><span class="hljs-section">&lt;TD&gt;</span></code> classes. All are immutable and hashable.</strong></li>
  584. <li><strong>Time and datetime can be 'aware' <code class="apache hljs"><span class="hljs-section">&lt;a&gt;</span></code>, meaning they have defined timezone, or 'naive' <code class="apache hljs"><span class="hljs-section">&lt;n&gt;</span></code>, meaning they don't.</strong></li>
  585. <li><strong>If object is naive it is presumed to be in system's timezone.</strong></li>
  586. </ul>
  587. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> date, time, datetime, timedelta
  588. <span class="hljs-keyword">from</span> dateutil.tz <span class="hljs-keyword">import</span> UTC, tzlocal, gettz
  589. </code></pre>
  590. <h3 id="constructors">Constructors</h3>
  591. <pre><code class="python language-python apache hljs">&lt;D&gt; = date(year, month, day)
  592. &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>)
  593. &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>, ...)
  594. &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>,
  595. minutes=<span class="hljs-number">0</span>, hours=<span class="hljs-number">0</span>, weeks=<span class="hljs-number">0</span>)
  596. </code></pre>
  597. <ul>
  598. <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>
  599. <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>
  600. </ul>
  601. <h3 id="now">Now</h3>
  602. <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>
  603. &lt;DTn&gt; = DT.utcnow() <span class="hljs-comment"># Naive datetime from current UTC time.</span>
  604. &lt;DTa&gt; = DT.now(&lt;tzinfo&gt;) <span class="hljs-comment"># Aware datetime from current tz time.</span>
  605. </code></pre>
  606. <ul>
  607. <li><strong>To extract time use <code class="python hljs"><span class="hljs-string">'&lt;DTn&gt;.time()'</span></code>, <code class="python hljs"><span class="hljs-string">'&lt;DTa&gt;.time()'</span></code> or <code class="python hljs"><span class="hljs-string">'&lt;DTa&gt;.timetz()'</span></code>.</strong></li>
  608. </ul>
  609. <h3 id="timezone">Timezone</h3>
  610. <pre><code class="python language-python hljs">&lt;tzinfo&gt; = UTC <span class="hljs-comment"># UTC timezone. London without DST.</span>
  611. &lt;tzinfo&gt; = tzlocal() <span class="hljs-comment"># Local timezone. Also gettz().</span>
  612. &lt;tzinfo&gt; = gettz(<span class="hljs-string">'&lt;Cont.&gt;/&lt;City&gt;'</span>) <span class="hljs-comment"># Timezone from 'Continent/City_Name' str.</span>
  613. </code></pre>
  614. <pre><code class="python language-python apache hljs">&lt;DTa&gt; = &lt;DT&gt;.astimezone(&lt;tzinfo&gt;) <span class="hljs-comment"># Datetime, converted to passed timezone.</span>
  615. &lt;Ta/DTa&gt; = &lt;T/DT&gt;.replace(tzinfo=&lt;tzinfo&gt;) <span class="hljs-comment"># Unconverted object with new timezone.</span>
  616. </code></pre>
  617. <h3 id="encode">Encode</h3>
  618. <pre><code class="python language-python apache 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>
  619. &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>
  620. &lt;D/DTn&gt; = D/DT.fromordinal(&lt;int&gt;) <span class="hljs-comment"># D/DTn from days since Christ, at midnight.</span>
  621. &lt;DTn&gt; = DT.fromtimestamp(&lt;real&gt;) <span class="hljs-comment"># Local time DTn from seconds since Epoch.</span>
  622. &lt;DTa&gt; = DT.fromtimestamp(&lt;real&gt;, &lt;tz.&gt;) <span class="hljs-comment"># Aware datetime from seconds since Epoch.</span>
  623. </code></pre>
  624. <ul>
  625. <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>
  626. <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>
  627. </ul>
  628. <h3 id="decode">Decode</h3>
  629. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;D/T/DT&gt;.isoformat() <span class="hljs-comment"># ISO string representation.</span>
  630. &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>
  631. &lt;int&gt; = &lt;D/DT&gt;.toordinal() <span class="hljs-comment"># Days since Christ, ignoring time and tz.</span>
  632. &lt;float&gt; = &lt;DTn&gt;.timestamp() <span class="hljs-comment"># Seconds since Epoch from DTn in local time.</span>
  633. &lt;float&gt; = &lt;DTa&gt;.timestamp() <span class="hljs-comment"># Seconds since Epoch from DTa.</span>
  634. </code></pre>
  635. <h3 id="format-1">Format</h3>
  636. <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
  637. <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>)
  638. <span class="hljs-meta">&gt;&gt;&gt; </span>dt.strftime(<span class="hljs-string">"%A, %dth of %B '%y, %I:%M%p %Z"</span>)
  639. <span class="hljs-string">"Thursday, 14th of May '15, 11:39PM UTC+02:00"</span>
  640. </code></pre>
  641. <ul>
  642. <li><strong>For abbreviated weekday and month use <code class="python hljs"><span class="hljs-string">'%a'</span></code> and <code class="python hljs"><span class="hljs-string">'%b'</span></code>.</strong></li>
  643. <li><strong>When parsing, <code class="python hljs"><span class="hljs-string">'%z'</span></code> also accepts <code class="python hljs"><span class="hljs-string">'±HH:MM'</span></code>.</strong></li>
  644. </ul>
  645. <h3 id="arithmetics">Arithmetics</h3>
  646. <pre><code class="python language-python apache hljs">&lt;D/DT&gt; = &lt;D/DT&gt; ± &lt;TD&gt;
  647. &lt;TD&gt; = &lt;TD&gt; ± &lt;TD&gt;
  648. &lt;TD&gt; = &lt;TD&gt; */ &lt;real&gt;
  649. &lt;float&gt; = &lt;TD&gt; / &lt;TD&gt;
  650. </code></pre>
  651. <h2 id="arguments"><a href="#arguments" name="arguments">#</a>Arguments</h2>
  652. <h3 id="insidefunctioncall">Inside Function Call</h3>
  653. <pre><code class="python language-python hljs">&lt;function&gt;(&lt;positional_args&gt;) <span class="hljs-comment"># f(0, 0)</span>
  654. &lt;function&gt;(&lt;keyword_args&gt;) <span class="hljs-comment"># f(x=0, y=0)</span>
  655. &lt;function&gt;(&lt;positional_args&gt;, &lt;keyword_args&gt;) <span class="hljs-comment"># f(0, y=0)</span>
  656. </code></pre>
  657. <h3 id="insidefunctiondefinition">Inside Function Definition</h3>
  658. <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>
  659. <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>
  660. <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>
  661. </code></pre>
  662. <h2 id="splatoperator"><a href="#splatoperator" name="splatoperator">#</a>Splat Operator</h2>
  663. <h3 id="insidefunctioncall-1">Inside Function Call</h3>
  664. <p><strong>Splat expands a collection into positional arguments, while splatty-splat expands a dictionary into keyword arguments.</strong></p>
  665. <pre><code class="python language-python hljs">args = (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>)
  666. 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>}
  667. func(*args, **kwargs)
  668. </code></pre>
  669. <h4 id="isthesameas">Is the same as:</h4>
  670. <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>)
  671. </code></pre>
  672. <h3 id="insidefunctiondefinition-1">Inside Function Definition</h3>
  673. <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>
  674. <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>
  675. <span class="hljs-keyword">return</span> sum(a)
  676. </code></pre>
  677. <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>)
  678. <span class="hljs-number">6</span>
  679. </code></pre>
  680. <h4 id="legalargumentcombinations">Legal argument combinations:</h4>
  681. <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">(x, y, z)</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>
  682. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(*, x, y, z)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3)</span>
  683. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, *, y, z)</span>:</span> <span class="hljs-comment"># f(x=1, y=2, z=3) | f(1, y=2, z=3)</span>
  684. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(x, y, *, z)</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>
  685. </code></pre>
  686. <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>
  687. <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>
  688. <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>
  689. <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>
  690. </code></pre>
  691. <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>
  692. <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>
  693. <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)</span>
  694. </code></pre>
  695. <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>
  696. <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>
  697. <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>
  698. <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>
  699. </code></pre>
  700. <h3 id="otheruses">Other Uses</h3>
  701. <pre><code class="python language-python hljs">&lt;list&gt; = [*&lt;collection&gt; [, ...]]
  702. &lt;set&gt; = {*&lt;collection&gt; [, ...]}
  703. &lt;tuple&gt; = (*&lt;collection&gt;, [...])
  704. &lt;dict&gt; = {**&lt;dict&gt; [, ...]}
  705. </code></pre>
  706. <pre><code class="python language-python hljs">head, *body, tail = &lt;collection&gt;
  707. </code></pre>
  708. <h2 id="inline"><a href="#inline" name="inline">#</a>Inline</h2>
  709. <h3 id="lambda">Lambda</h3>
  710. <pre><code class="python language-python hljs">&lt;function&gt; = <span class="hljs-keyword">lambda</span>: &lt;return_value&gt;
  711. &lt;function&gt; = <span class="hljs-keyword">lambda</span> &lt;argument_1&gt;, &lt;argument_2&gt;: &lt;return_value&gt;
  712. </code></pre>
  713. <h3 id="comprehension">Comprehension</h3>
  714. <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>
  715. &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>
  716. &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>
  717. &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>
  718. </code></pre>
  719. <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>)]
  720. </code></pre>
  721. <h4 id="isthesameas-1">Is the same as:</h4>
  722. <pre><code class="python language-python hljs">out = []
  723. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  724. <span class="hljs-keyword">for</span> j <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  725. out.append(i+j)
  726. </code></pre>
  727. <h3 id="mapfilterreduce">Map, Filter, Reduce</h3>
  728. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> reduce
  729. &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>
  730. &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>
  731. &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>
  732. </code></pre>
  733. <h3 id="anyall">Any, All</h3>
  734. <pre><code class="python language-python hljs">&lt;bool&gt; = any(&lt;collection&gt;) <span class="hljs-comment"># False if empty.</span>
  735. &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>
  736. </code></pre>
  737. <h3 id="ifelse">If - Else</h3>
  738. <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;
  739. </code></pre>
  740. <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>)]
  741. [<span class="hljs-string">'zero'</span>, <span class="hljs-number">1</span>, <span class="hljs-string">'zero'</span>, <span class="hljs-number">3</span>]
  742. </code></pre>
  743. <h3 id="namedtupleenumdataclass">Namedtuple, Enum, Dataclass</h3>
  744. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  745. Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  746. point = Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>)
  747. </code></pre>
  748. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  749. Direction = Enum(<span class="hljs-string">'Direction'</span>, <span class="hljs-string">'n e s w'</span>)
  750. direction = Direction.n
  751. </code></pre>
  752. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
  753. Creature = make_dataclass(<span class="hljs-string">'Creature'</span>, [<span class="hljs-string">'location'</span>, <span class="hljs-string">'direction'</span>])
  754. creature = Creature(Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>), Direction.n)
  755. </code></pre>
  756. <h2 id="closure"><a href="#closure" name="closure">#</a>Closure</h2>
  757. <p><strong>We have a closure in Python when:</strong></p>
  758. <ul>
  759. <li><strong>A nested function references a value of its enclosing function and then</strong></li>
  760. <li><strong>the enclosing function returns the nested function.</strong></li>
  761. </ul>
  762. <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>
  763. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(b)</span>:</span>
  764. <span class="hljs-keyword">return</span> a * b
  765. <span class="hljs-keyword">return</span> out
  766. </code></pre>
  767. <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>)
  768. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  769. <span class="hljs-number">30</span>
  770. </code></pre>
  771. <ul>
  772. <li><strong>If multiple nested functions within enclosing function reference the same value, that value gets shared.</strong></li>
  773. <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>
  774. </ul>
  775. <h3 id="partial">Partial</h3>
  776. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  777. &lt;function&gt; = partial(&lt;function&gt; [, &lt;arg_1&gt;, &lt;arg_2&gt;, ...])
  778. </code></pre>
  779. <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
  780. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3 = partial(op.mul, <span class="hljs-number">3</span>)
  781. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  782. <span class="hljs-number">30</span>
  783. </code></pre>
  784. <ul>
  785. <li><strong>Partial is also useful in cases when a function needs to be passed as an argument, because it enables us to set its arguments beforehand.</strong></li>
  786. <li><strong>A few examples being <code class="python hljs"><span class="hljs-string">'defaultdict(&lt;function&gt;)'</span></code>, <code class="python hljs"><span class="hljs-string">'iter(&lt;function&gt;, to_exclusive)'</span></code> and dataclass's <code class="python hljs"><span class="hljs-string">'field(default_factory=&lt;function&gt;)'</span></code>.</strong></li>
  787. </ul>
  788. <h3 id="nonlocal">Nonlocal</h3>
  789. <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>
  790. <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>
  791. i = <span class="hljs-number">0</span>
  792. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">()</span>:</span>
  793. <span class="hljs-keyword">nonlocal</span> i
  794. i += <span class="hljs-number">1</span>
  795. <span class="hljs-keyword">return</span> i
  796. <span class="hljs-keyword">return</span> out
  797. </code></pre>
  798. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = get_counter()
  799. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  800. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  801. </code></pre>
  802. <h2 id="decorator"><a href="#decorator" name="decorator">#</a>Decorator</h2>
  803. <p><strong>A decorator takes a function, adds some functionality and returns it.</strong></p>
  804. <pre><code class="python language-python hljs"><span class="hljs-meta">@decorator_name</span>
  805. <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>
  806. ...
  807. </code></pre>
  808. <h3 id="debuggerexample">Debugger Example</h3>
  809. <p><strong>Decorator that prints function's name every time it gets called.</strong></p>
  810. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  811. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(func)</span>:</span>
  812. <span class="hljs-meta"> @wraps(func)</span>
  813. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  814. print(func.__name__)
  815. <span class="hljs-keyword">return</span> func(*args, **kwargs)
  816. <span class="hljs-keyword">return</span> out
  817. <span class="hljs-meta">@debug</span>
  818. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  819. <span class="hljs-keyword">return</span> x + y
  820. </code></pre>
  821. <ul>
  822. <li><strong>Wraps is a helper decorator that copies metadata of function add() to function out().</strong></li>
  823. <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>
  824. </ul>
  825. <h3 id="lrucache">LRU Cache</h3>
  826. <p><strong>Decorator that caches function's return values. All function's arguments must be hashable.</strong></p>
  827. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> lru_cache
  828. <span class="hljs-meta">@lru_cache(maxsize=None)</span>
  829. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">fib</span><span class="hljs-params">(n)</span>:</span>
  830. <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>)
  831. </code></pre>
  832. <ul>
  833. <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>
  834. </ul>
  835. <h3 id="parametrizeddecorator">Parametrized Decorator</h3>
  836. <p><strong>A decorator that accepts arguments and returns a normal decorator that accepts a function.</strong></p>
  837. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  838. <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>
  839. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">decorator</span><span class="hljs-params">(func)</span>:</span>
  840. <span class="hljs-meta"> @wraps(func)</span>
  841. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  842. result = func(*args, **kwargs)
  843. print(func.__name__, result <span class="hljs-keyword">if</span> print_result <span class="hljs-keyword">else</span> <span class="hljs-string">''</span>)
  844. <span class="hljs-keyword">return</span> result
  845. <span class="hljs-keyword">return</span> out
  846. <span class="hljs-keyword">return</span> decorator
  847. <span class="hljs-meta">@debug(print_result=True)</span>
  848. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  849. <span class="hljs-keyword">return</span> x + y
  850. </code></pre>
  851. <h2 id="class"><a href="#class" name="class">#</a>Class</h2>
  852. <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>
  853. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  854. self.a = a
  855. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
  856. class_name = self.__class__.__name__
  857. <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>
  858. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__str__</span><span class="hljs-params">(self)</span>:</span>
  859. <span class="hljs-keyword">return</span> str(self.a)
  860. <span class="hljs-meta"> @classmethod</span>
  861. <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>
  862. <span class="hljs-keyword">return</span> cls.__name__
  863. </code></pre>
  864. <ul>
  865. <li><strong>Return value of repr() should be unambiguous and of str() readable.</strong></li>
  866. <li><strong>If only repr() is defined, it will be also used for str().</strong></li>
  867. </ul>
  868. <h4 id="strusecases">Str() use cases:</h4>
  869. <pre><code class="python language-python hljs">print(&lt;el&gt;)
  870. print(<span class="hljs-string">f'<span class="hljs-subst">{&lt;el&gt;}</span>'</span>)
  871. <span class="hljs-keyword">raise</span> Exception(&lt;el&gt;)
  872. logging.debug(&lt;el&gt;)
  873. csv.writer(&lt;file&gt;).writerow([&lt;el&gt;])
  874. </code></pre>
  875. <h4 id="reprusecases">Repr() use cases:</h4>
  876. <pre><code class="python language-python hljs">print([&lt;el&gt;])
  877. print(<span class="hljs-string">f'<span class="hljs-subst">{&lt;el&gt;!r}</span>'</span>)
  878. <span class="hljs-meta">&gt;&gt;&gt; </span>&lt;el&gt;
  879. loguru.logger.exception()
  880. Z = dataclasses.make_dataclass(<span class="hljs-string">'Z'</span>, [<span class="hljs-string">'a'</span>]); print(Z(&lt;el&gt;))
  881. </code></pre>
  882. <h3 id="constructoroverloading">Constructor Overloading</h3>
  883. <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>
  884. <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>
  885. self.a = a
  886. </code></pre>
  887. <h3 id="inheritance">Inheritance</h3>
  888. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span>:</span>
  889. <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>
  890. self.name = name
  891. self.age = age
  892. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Employee</span><span class="hljs-params">(Person)</span>:</span>
  893. <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>
  894. super().__init__(name, age)
  895. self.staff_num = staff_num
  896. </code></pre>
  897. <h3 id="multipleinheritance">Multiple Inheritance</h3>
  898. <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>
  899. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B</span>:</span> <span class="hljs-keyword">pass</span>
  900. <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>
  901. </code></pre>
  902. <p><strong>MRO determines the order in which parent classes are traversed when searching for a method:</strong></p>
  903. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>C.mro()
  904. [&lt;<span class="hljs-class"><span class="hljs-title">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;]
  905. </span></code></pre>
  906. <h3 id="property">Property</h3>
  907. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span>:</span>
  908. <span class="hljs-meta"> @property</span>
  909. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
  910. <span class="hljs-keyword">return</span> self._a
  911. <span class="hljs-meta"> @a.setter</span>
  912. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self, value)</span>:</span>
  913. self._a = value
  914. </code></pre>
  915. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>el = MyClass()
  916. <span class="hljs-meta">&gt;&gt;&gt; </span>el.a = <span class="hljs-number">123</span>
  917. <span class="hljs-meta">&gt;&gt;&gt; </span>el.a
  918. <span class="hljs-number">123</span>
  919. </code></pre>
  920. <h3 id="dataclass">Dataclass</h3>
  921. <p><strong>Decorator that automatically generates init(), repr() and eq() special methods.</strong></p>
  922. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> dataclass, field
  923. <span class="hljs-meta">@dataclass(order=False, frozen=False)</span>
  924. <span class="hljs-class"><span class="hljs-keyword">class</span> &lt;<span class="hljs-title">class_name</span>&gt;:</span>
  925. &lt;attr_name_1&gt;: &lt;type&gt;
  926. &lt;attr_name_2&gt;: &lt;type&gt; = &lt;default_value&gt;
  927. &lt;attr_name_3&gt;: list/dict/set = field(default_factory=list/dict/set)
  928. </code></pre>
  929. <ul>
  930. <li><strong>An object can be made sortable with <code class="python hljs"><span class="hljs-string">'order=True'</span></code> or immutable with <code class="python hljs"><span class="hljs-string">'frozen=True'</span></code>.</strong></li>
  931. <li><strong>Function field() is needed because <code class="python hljs"><span class="hljs-string">'&lt;attr_name&gt;: list = []'</span></code> would make a list that is shared among all instances.</strong></li>
  932. <li><strong>Default_factory can be any callable.</strong></li>
  933. </ul>
  934. <h3 id="slots">Slots</h3>
  935. <p><strong>Mechanism that restricts objects to attributes listed in 'slots' and significantly reduces their memory footprint.</strong></p>
  936. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClassWithSlots</span>:</span>
  937. __slots__ = [<span class="hljs-string">'a'</span>]
  938. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
  939. self.a = <span class="hljs-number">1</span>
  940. </code></pre>
  941. <h3 id="copy">Copy</h3>
  942. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> copy <span class="hljs-keyword">import</span> copy, deepcopy
  943. &lt;object&gt; = copy(&lt;object&gt;)
  944. &lt;object&gt; = deepcopy(&lt;object&gt;)
  945. </code></pre>
  946. <h2 id="ducktypes"><a href="#ducktypes" name="ducktypes">#</a>Duck Types</h2>
  947. <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>
  948. <h3 id="comparable">Comparable</h3>
  949. <ul>
  950. <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>
  951. <li><strong>That means all objects compare not equal by default.</strong></li>
  952. <li><strong>Only left side object has eq() method called, unless it returns 'NotImplemented', in which case the right object is consulted.</strong></li>
  953. </ul>
  954. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyComparable</span>:</span>
  955. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  956. self.a = a
  957. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  958. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  959. <span class="hljs-keyword">return</span> self.a == other.a
  960. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  961. </code></pre>
  962. <h3 id="hashable">Hashable</h3>
  963. <ul>
  964. <li><strong>Hashable object needs both hash() and eq() methods and its hash value should never change.</strong></li>
  965. <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>
  966. <li><strong>That is why Python automatically makes classes unhashable if you only implement eq().</strong></li>
  967. </ul>
  968. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyHashable</span>:</span>
  969. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  970. self._a = copy.deepcopy(a)
  971. <span class="hljs-meta"> @property</span>
  972. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
  973. <span class="hljs-keyword">return</span> self._a
  974. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  975. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  976. <span class="hljs-keyword">return</span> self.a == other.a
  977. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  978. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__hash__</span><span class="hljs-params">(self)</span>:</span>
  979. <span class="hljs-keyword">return</span> hash(self.a)
  980. </code></pre>
  981. <h3 id="sortable">Sortable</h3>
  982. <ul>
  983. <li><strong>With 'total_ordering' decorator you only need to provide eq() and one of lt(), gt(), le() or ge() special methods.</strong></li>
  984. </ul>
  985. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> total_ordering
  986. <span class="hljs-meta">@total_ordering</span>
  987. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySortable</span>:</span>
  988. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  989. self.a = a
  990. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  991. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  992. <span class="hljs-keyword">return</span> self.a == other.a
  993. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  994. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__lt__</span><span class="hljs-params">(self, other)</span>:</span>
  995. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  996. <span class="hljs-keyword">return</span> self.a &lt; other.a
  997. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  998. </code></pre>
  999. <h3 id="iterator-1">Iterator</h3>
  1000. <ul>
  1001. <li><strong>Next() should return next item or raise 'StopIteration'.</strong></li>
  1002. <li><strong>Iter() should return 'self'.</strong></li>
  1003. </ul>
  1004. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
  1005. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
  1006. self.i = <span class="hljs-number">0</span>
  1007. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__next__</span><span class="hljs-params">(self)</span>:</span>
  1008. self.i += <span class="hljs-number">1</span>
  1009. <span class="hljs-keyword">return</span> self.i
  1010. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  1011. <span class="hljs-keyword">return</span> self
  1012. </code></pre>
  1013. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter()
  1014. <span class="hljs-meta">&gt;&gt;&gt; </span>next(counter), next(counter), next(counter)
  1015. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1016. </code></pre>
  1017. <h3 id="callable">Callable</h3>
  1018. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
  1019. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
  1020. self.i = <span class="hljs-number">0</span>
  1021. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__call__</span><span class="hljs-params">(self)</span>:</span>
  1022. self.i += <span class="hljs-number">1</span>
  1023. <span class="hljs-keyword">return</span> self.i
  1024. </code></pre>
  1025. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter()
  1026. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  1027. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1028. </code></pre>
  1029. <h3 id="contextmanager">Context Manager</h3>
  1030. <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>
  1031. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, filename)</span>:</span>
  1032. self.filename = filename
  1033. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__enter__</span><span class="hljs-params">(self)</span>:</span>
  1034. self.file = open(self.filename)
  1035. <span class="hljs-keyword">return</span> self.file
  1036. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__exit__</span><span class="hljs-params">(self, *args)</span>:</span>
  1037. self.file.close()
  1038. </code></pre>
  1039. <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:
  1040. <span class="hljs-meta">... </span> file.write(<span class="hljs-string">'Hello World!'</span>)
  1041. <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:
  1042. <span class="hljs-meta">... </span> print(file.read())
  1043. Hello World!
  1044. </code></pre>
  1045. <h4 id="listofexistingcontextmanagers">List of existing context managers:</h4>
  1046. <pre><code class="python language-python hljs"><span class="hljs-keyword">with</span> open(<span class="hljs-string">'&lt;path&gt;'</span>, ...) <span class="hljs-keyword">as</span> file: ...
  1047. <span class="hljs-keyword">with</span> wave.open(<span class="hljs-string">'&lt;path&gt;'</span>, ...) <span class="hljs-keyword">as</span> wave_file: ...
  1048. <span class="hljs-keyword">with</span> memoryview(&lt;bytes/bytearray/array&gt;) <span class="hljs-keyword">as</span> view: ...
  1049. db = sqlite3.connect(<span class="hljs-string">'&lt;path&gt;'</span>); <span class="hljs-keyword">with</span> db: db.execute(<span class="hljs-string">'&lt;insert_query&gt;'</span>)
  1050. lock = threading.RLock(); <span class="hljs-keyword">with</span> lock: ...
  1051. </code></pre>
  1052. <h2 id="iterableducktypes"><a href="#iterableducktypes" name="iterableducktypes">#</a>Iterable Duck Types</h2>
  1053. <h3 id="iterable">Iterable</h3>
  1054. <ul>
  1055. <li><strong>Only required method is iter(). It should return an iterator of object's items.</strong></li>
  1056. <li><strong>Contains() automatically works on any object that has iter() defined.</strong></li>
  1057. </ul>
  1058. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyIterable</span>:</span>
  1059. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  1060. self.a = a
  1061. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  1062. <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> self.a:
  1063. <span class="hljs-keyword">yield</span> el
  1064. </code></pre>
  1065. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>a = MyIterable([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
  1066. <span class="hljs-meta">&gt;&gt;&gt; </span>iter(a)
  1067. &lt;generator object MyIterable.__iter__ at <span class="hljs-number">0x1026c18b8</span>&gt;
  1068. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-number">1</span> <span class="hljs-keyword">in</span> a
  1069. <span class="hljs-keyword">True</span>
  1070. </code></pre>
  1071. <h3 id="collection">Collection</h3>
  1072. <ul>
  1073. <li><strong>Only required methods are iter() and len().</strong></li>
  1074. <li><strong>This cheatsheet actually means <code class="python hljs"><span class="hljs-string">'&lt;iterable&gt;'</span></code> when it uses <code class="python hljs"><span class="hljs-string">'&lt;collection&gt;'</span></code>.</strong></li>
  1075. <li><strong>I chose not to use the name 'iterable' because it sounds scarier and more vague than 'collection'.</strong></li>
  1076. </ul>
  1077. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyCollection</span>:</span>
  1078. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  1079. self.a = a
  1080. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  1081. <span class="hljs-keyword">return</span> iter(self.a)
  1082. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
  1083. <span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
  1084. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
  1085. <span class="hljs-keyword">return</span> len(self.a)
  1086. </code></pre>
  1087. <h3 id="sequence">Sequence</h3>
  1088. <ul>
  1089. <li><strong>Only required methods are len() and getitem(), that should return an item at index or raise 'IndexError'.</strong></li>
  1090. <li><strong>Iter() and contains() automatically work on any object that has getitem() defined.</strong></li>
  1091. <li><strong>Reversed() automatically works on any object that has getitem() and len() defined.</strong></li>
  1092. </ul>
  1093. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySequence</span>:</span>
  1094. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  1095. self.a = a
  1096. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  1097. <span class="hljs-keyword">return</span> iter(self.a)
  1098. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
  1099. <span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
  1100. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
  1101. <span class="hljs-keyword">return</span> len(self.a)
  1102. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
  1103. <span class="hljs-keyword">return</span> self.a[i]
  1104. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__reversed__</span><span class="hljs-params">(self)</span>:</span>
  1105. <span class="hljs-keyword">return</span> reversed(self.a)
  1106. </code></pre>
  1107. <h3 id="collectionsabcsequence">Collections.abc.Sequence</h3>
  1108. <ul>
  1109. <li><strong>It's a richer interface than the basic sequence.</strong></li>
  1110. <li><strong>Extending it generates iter(), contains(), reversed(), index(), and count().</strong></li>
  1111. <li><strong>Unlike <code class="python hljs"><span class="hljs-string">'abc.Iterable'</span></code> and <code class="python hljs"><span class="hljs-string">'abc.Collection'</span></code>, it is not a duck type. That is why <code class="python hljs"><span class="hljs-string">'issubclass(MySequence, collections.abc.Sequence)'</span></code> would return 'False' even if 'MySequence' had all the methods defined.</strong></li>
  1112. </ul>
  1113. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyAbcSequence</span><span class="hljs-params">(collections.abc.Sequence)</span>:</span>
  1114. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  1115. self.a = a
  1116. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
  1117. <span class="hljs-keyword">return</span> len(self.a)
  1118. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
  1119. <span class="hljs-keyword">return</span> self.a[i]
  1120. </code></pre>
  1121. <h4 id="tableofrequiredandavailablespecialmethods">Table of required and available special methods:</h4>
  1122. <pre><code class="text language-text">+------------+----------+------------+----------+--------------+
  1123. | | Iterable | Collection | Sequence | abc.Sequence |
  1124. +------------+----------+------------+----------+--------------+
  1125. | iter() | REQ | REQ | yes | yes |
  1126. | contains() | yes | yes | yes | yes |
  1127. | len() | | REQ | REQ | REQ |
  1128. | getitem() | | | REQ | REQ |
  1129. | reversed() | | | yes | yes |
  1130. | index() | | | | yes |
  1131. | count() | | | | yes |
  1132. +------------+----------+------------+----------+--------------+
  1133. </code></pre>
  1134. <ul>
  1135. <li><strong>Other useful ABCs that automatically generate missing methods are: MutableSequence, Set, MutableSet, Mapping and MutableMapping.</strong></li>
  1136. </ul>
  1137. <h2 id="enum"><a href="#enum" name="enum">#</a>Enum</h2>
  1138. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum, auto
  1139. <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>
  1140. &lt;member_name_1&gt; = &lt;value_1&gt;
  1141. &lt;member_name_2&gt; = &lt;value_2_a&gt;, &lt;value_2_b&gt;
  1142. &lt;member_name_3&gt; = auto()
  1143. <span class="hljs-meta"> @classmethod</span>
  1144. <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>
  1145. <span class="hljs-keyword">return</span> [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> cls.__members__.values()]
  1146. </code></pre>
  1147. <ul>
  1148. <li><strong>If there are no numeric values before auto(), it returns 1.</strong></li>
  1149. <li><strong>Otherwise it returns an increment of last numeric value.</strong></li>
  1150. </ul>
  1151. <pre><code class="python language-python hljs">&lt;member&gt; = &lt;enum&gt;.&lt;member_name&gt;
  1152. &lt;member&gt; = &lt;enum&gt;[<span class="hljs-string">'&lt;member_name&gt;'</span>]
  1153. &lt;member&gt; = &lt;enum&gt;(&lt;value&gt;)
  1154. name = &lt;member&gt;.name
  1155. value = &lt;member&gt;.value
  1156. </code></pre>
  1157. <pre><code class="python language-python hljs">list_of_members = list(&lt;enum&gt;)
  1158. member_names = [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  1159. member_values = [a.value <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  1160. random_member = random.choice(list(&lt;enum&gt;))
  1161. </code></pre>
  1162. <h3 id="inline-1">Inline</h3>
  1163. <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>])
  1164. Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, <span class="hljs-string">'fork knife spoon'</span>)
  1165. 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>})
  1166. </code></pre>
  1167. <h4 id="functionscannotbevaluessotheymustbewrapped">Functions can not be values, so they must be wrapped:</h4>
  1168. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  1169. 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),
  1170. <span class="hljs-string">'OR'</span> : partial(<span class="hljs-keyword">lambda</span> l, r: l <span class="hljs-keyword">or</span> r)})
  1171. </code></pre>
  1172. <ul>
  1173. <li><strong>Another solution in this particular case, is to use <code class="python hljs"><span class="hljs-string">'and_'</span></code> and <code class="python hljs"><span class="hljs-string">'or_'</span></code> functions from module <a href="#operator">Operator</a>.</strong></li>
  1174. </ul>
  1175. <h2 id="exceptions"><a href="#exceptions" name="exceptions">#</a>Exceptions</h2>
  1176. <h3 id="basicexample">Basic Example</h3>
  1177. <pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
  1178. &lt;code&gt;
  1179. <span class="hljs-keyword">except</span> &lt;exception&gt;:
  1180. &lt;code&gt;
  1181. </code></pre>
  1182. <h3 id="complexexample">Complex Example</h3>
  1183. <pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
  1184. &lt;code_1&gt;
  1185. <span class="hljs-keyword">except</span> &lt;exception_a&gt;:
  1186. &lt;code_2_a&gt;
  1187. <span class="hljs-keyword">except</span> &lt;exception_b&gt;:
  1188. &lt;code_2_b&gt;
  1189. <span class="hljs-keyword">else</span>:
  1190. &lt;code_2_c&gt;
  1191. <span class="hljs-keyword">finally</span>:
  1192. &lt;code_3&gt;
  1193. </code></pre>
  1194. <h3 id="catchingexceptions">Catching Exceptions</h3>
  1195. <pre><code class="python language-python hljs"><span class="hljs-keyword">except</span> &lt;exception&gt;:
  1196. <span class="hljs-keyword">except</span> &lt;exception&gt; <span class="hljs-keyword">as</span> &lt;name&gt;:
  1197. <span class="hljs-keyword">except</span> (&lt;exception_1&gt;, &lt;exception_2&gt;, ...):
  1198. <span class="hljs-keyword">except</span> (&lt;exception_1&gt;, &lt;exception_2&gt;, ...) <span class="hljs-keyword">as</span> &lt;name&gt;:
  1199. </code></pre>
  1200. <ul>
  1201. <li><strong>Also catches subclasses of the exception.</strong></li>
  1202. </ul>
  1203. <h3 id="raisingexceptions">Raising Exceptions</h3>
  1204. <pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> &lt;exception&gt;
  1205. <span class="hljs-keyword">raise</span> &lt;exception&gt;()
  1206. <span class="hljs-keyword">raise</span> &lt;exception&gt;(&lt;el&gt;)
  1207. <span class="hljs-keyword">raise</span> &lt;exception&gt;(&lt;el_1&gt;, &lt;el_2&gt;, ...)
  1208. </code></pre>
  1209. <h4 id="usefulbuiltinexceptions">Useful built-in exceptions:</h4>
  1210. <pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> ValueError(<span class="hljs-string">'Argument is of right type but inappropriate value!'</span>)
  1211. <span class="hljs-keyword">raise</span> TypeError(<span class="hljs-string">'Argument is of wrong type!'</span>)
  1212. <span class="hljs-keyword">raise</span> RuntimeError(<span class="hljs-string">'None of above!'</span>)
  1213. </code></pre>
  1214. <h4 id="reraisingcaughtexception">Re-raising caught exception:</h4>
  1215. <pre><code class="python language-python hljs"><span class="hljs-keyword">except</span> &lt;exception&gt;:
  1216. &lt;code&gt;
  1217. <span class="hljs-keyword">raise</span>
  1218. </code></pre>
  1219. <h3 id="commonbuiltinexceptions">Common Built-in Exceptions</h3>
  1220. <pre><code class="text language-text">BaseException
  1221. +-- SystemExit # Raised by the sys.exit() function.
  1222. +-- KeyboardInterrupt # Raised when the user hits the interrupt key.
  1223. +-- Exception # User-defined exceptions should be derived from this class.
  1224. +-- StopIteration # Raised by next() when run on an empty iterator.
  1225. +-- ArithmeticError # Base class for arithmetic errors.
  1226. | +-- ZeroDivisionError # Raised when dividing by zero.
  1227. +-- AttributeError # Raised when an attribute is missing.
  1228. +-- EOFError # Raised by input() when it hits end-of-file condition.
  1229. +-- LookupError # Raised when a look-up on sequence or dict fails.
  1230. | +-- IndexError # Raised when a sequence index is out of range.
  1231. | +-- KeyError # Raised when a dictionary key is not found.
  1232. +-- NameError # Raised when a variable name is not found.
  1233. +-- OSError # Failures such as “file not found” or “disk full”.
  1234. | +-- FileNotFoundError # When a file or directory is requested but doesn't exist.
  1235. +-- RuntimeError # Raised by errors that don't fall in other categories.
  1236. | +-- RecursionError # Raised when the the maximum recursion depth is exceeded.
  1237. +-- TypeError # Raised when an argument is of wrong type.
  1238. +-- ValueError # When an argument is of right type but inappropriate value.
  1239. +-- UnicodeError # Raised when encoding/decoding strings from/to bytes fails.
  1240. </code></pre>
  1241. <h3 id="userdefinedexceptions">User-defined Exceptions</h3>
  1242. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyError</span><span class="hljs-params">(Exception)</span>:</span>
  1243. <span class="hljs-keyword">pass</span>
  1244. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyInputError</span><span class="hljs-params">(MyError)</span>:</span>
  1245. <span class="hljs-keyword">pass</span>
  1246. </code></pre>
  1247. <h2 id="print"><a href="#print" name="print">#</a>Print</h2>
  1248. <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>)
  1249. </code></pre>
  1250. <ul>
  1251. <li><strong>Use <code class="python hljs"><span class="hljs-string">'file=sys.stderr'</span></code> for errors.</strong></li>
  1252. <li><strong>Use <code class="python hljs"><span class="hljs-string">'flush=True'</span></code> to forcibly flush the stream.</strong></li>
  1253. </ul>
  1254. <h3 id="prettyprint">Pretty Print</h3>
  1255. <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
  1256. <span class="hljs-meta">&gt;&gt;&gt; </span>pprint(dir())
  1257. [<span class="hljs-string">'__annotations__'</span>,
  1258. <span class="hljs-string">'__builtins__'</span>,
  1259. <span class="hljs-string">'__doc__'</span>, ...]
  1260. </code></pre>
  1261. <h2 id="input"><a href="#input" name="input">#</a>Input</h2>
  1262. <ul>
  1263. <li><strong>Reads a line from user input or pipe if present.</strong></li>
  1264. <li><strong>Trailing newline gets stripped.</strong></li>
  1265. <li><strong>Prompt string is printed to the standard output before reading input.</strong></li>
  1266. </ul>
  1267. <pre><code class="python language-python hljs">&lt;str&gt; = input(prompt=<span class="hljs-keyword">None</span>)
  1268. </code></pre>
  1269. <h4 id="printslinesuntileof">Prints lines until EOF:</h4>
  1270. <pre><code class="python language-python hljs"><span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1271. <span class="hljs-keyword">try</span>:
  1272. print(input())
  1273. <span class="hljs-keyword">except</span> EOFError:
  1274. <span class="hljs-keyword">break</span>
  1275. </code></pre>
  1276. <h2 id="commandlinearguments"><a href="#commandlinearguments" name="commandlinearguments">#</a>Command Line Arguments</h2>
  1277. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sys
  1278. script_name = sys.argv[<span class="hljs-number">0</span>]
  1279. arguments = sys.argv[<span class="hljs-number">1</span>:]
  1280. </code></pre>
  1281. <h3 id="argparse">Argparse</h3>
  1282. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> argparse <span class="hljs-keyword">import</span> ArgumentParser, FileType
  1283. p = ArgumentParser(description=&lt;str&gt;)
  1284. 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>
  1285. 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>
  1286. 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>
  1287. 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>
  1288. args = p.parse_args()
  1289. value = args.&lt;name&gt;
  1290. </code></pre>
  1291. <ul>
  1292. <li><strong>Use <code class="python hljs"><span class="hljs-string">'help=&lt;str&gt;'</span></code> for argument description.</strong></li>
  1293. <li><strong>Use <code class="python hljs"><span class="hljs-string">'type=FileType(&lt;mode&gt;)'</span></code> for files.</strong></li>
  1294. </ul>
  1295. <h2 id="open"><a href="#open" name="open">#</a>Open</h2>
  1296. <p><strong>Opens a file and returns a corresponding file object.</strong></p>
  1297. <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>, newline=<span class="hljs-keyword">None</span>)
  1298. </code></pre>
  1299. <ul>
  1300. <li><strong><code class="python hljs"><span class="hljs-string">'encoding=None'</span></code> means default encoding is used, which is platform dependent. Best practice is to use <code class="python hljs"><span class="hljs-string">'encoding="utf-8"'</span></code> whenever possible.</strong></li>
  1301. <li><strong><code class="python hljs"><span class="hljs-string">'newline=None'</span></code> means all different end of line combinations are converted to '\n' on read, while on write all '\n' characters are converted to system's default line separator.</strong></li>
  1302. <li><strong><code class="python hljs"><span class="hljs-string">'newline=""'</span></code> means no conversions take place, but lines are still broken by readline() on either '\n', '\r' or '\r\n'.</strong></li>
  1303. </ul>
  1304. <h3 id="modes">Modes</h3>
  1305. <ul>
  1306. <li><strong><code class="python hljs"><span class="hljs-string">'r'</span></code> - Read (default).</strong></li>
  1307. <li><strong><code class="python hljs"><span class="hljs-string">'w'</span></code> - Write (truncate).</strong></li>
  1308. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - Write or fail if the file already exists.</strong></li>
  1309. <li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Append.</strong></li>
  1310. <li><strong><code class="python hljs"><span class="hljs-string">'w+'</span></code> - Read and write (truncate).</strong></li>
  1311. <li><strong><code class="python hljs"><span class="hljs-string">'r+'</span></code> - Read and write from the start.</strong></li>
  1312. <li><strong><code class="python hljs"><span class="hljs-string">'a+'</span></code> - Read and write from the end.</strong></li>
  1313. <li><strong><code class="python hljs"><span class="hljs-string">'t'</span></code> - Text mode (default).</strong></li>
  1314. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Binary mode.</strong></li>
  1315. </ul>
  1316. <h3 id="exceptions-1">Exceptions</h3>
  1317. <ul>
  1318. <li><strong><code class="python hljs"><span class="hljs-string">'FileNotFoundError'</span></code> can be risen when reading with <code class="python hljs"><span class="hljs-string">'r'</span></code> or <code class="python hljs"><span class="hljs-string">'r+'</span></code>.</strong></li>
  1319. <li><strong><code class="python hljs"><span class="hljs-string">'FileExistsError'</span></code> can be risen when writing with <code class="python hljs"><span class="hljs-string">'x'</span></code>.</strong></li>
  1320. <li><strong><code class="python hljs"><span class="hljs-string">'IsADirectoryError'</span></code> and <code class="python hljs"><span class="hljs-string">'PermissionError'</span></code> can be risen by any.</strong></li>
  1321. <li><strong><code class="python hljs"><span class="hljs-string">'OSError'</span></code> is the parent class of all listed exceptions.</strong></li>
  1322. </ul>
  1323. <h3 id="file">File</h3>
  1324. <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>
  1325. &lt;file&gt;.seek(offset) <span class="hljs-comment"># Moves 'offset' chars/bytes from the start.</span>
  1326. &lt;file&gt;.seek(<span class="hljs-number">0</span>, <span class="hljs-number">2</span>) <span class="hljs-comment"># Moves to the end of the file.</span>
  1327. &lt;bin_file&gt;.seek(±offset, &lt;anchor&gt;) <span class="hljs-comment"># Anchor: 0 start, 1 current pos., 2 end.</span>
  1328. </code></pre>
  1329. <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>
  1330. &lt;str/bytes&gt; = &lt;file&gt;.readline() <span class="hljs-comment"># Returns a line or empty string on EOF.</span>
  1331. &lt;list&gt; = &lt;file&gt;.readlines() <span class="hljs-comment"># Returns a list of lines or empty list.</span>
  1332. &lt;str/bytes&gt; = next(&lt;file&gt;) <span class="hljs-comment"># Returns a line using buffer. Do not mix.</span>
  1333. </code></pre>
  1334. <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>
  1335. &lt;file&gt;.writelines(&lt;coll.&gt;) <span class="hljs-comment"># Writes a coll. of strings or bytes objects.</span>
  1336. &lt;file&gt;.flush() <span class="hljs-comment"># Flushes write buffer.</span>
  1337. </code></pre>
  1338. <ul>
  1339. <li><strong>Methods do not add or strip trailing newlines, even writelines().</strong></li>
  1340. </ul>
  1341. <h3 id="readtextfromfile">Read Text from File</h3>
  1342. <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>
  1343. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1344. <span class="hljs-keyword">return</span> file.readlines()
  1345. </code></pre>
  1346. <h3 id="writetexttofile">Write Text to File</h3>
  1347. <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>
  1348. <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:
  1349. file.write(text)
  1350. </code></pre>
  1351. <h2 id="path"><a href="#path" name="path">#</a>Path</h2>
  1352. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> os <span class="hljs-keyword">import</span> path, listdir
  1353. <span class="hljs-keyword">from</span> glob <span class="hljs-keyword">import</span> glob
  1354. </code></pre>
  1355. <pre><code class="python language-python hljs">&lt;bool&gt; = path.exists(<span class="hljs-string">'&lt;path&gt;'</span>)
  1356. &lt;bool&gt; = path.isfile(<span class="hljs-string">'&lt;path&gt;'</span>)
  1357. &lt;bool&gt; = path.isdir(<span class="hljs-string">'&lt;path&gt;'</span>)
  1358. </code></pre>
  1359. <pre><code class="python language-python hljs">&lt;list&gt; = listdir(<span class="hljs-string">'&lt;path&gt;'</span>) <span class="hljs-comment"># List of filenames located at 'path'.</span>
  1360. &lt;list&gt; = glob(<span class="hljs-string">'&lt;pattern&gt;'</span>) <span class="hljs-comment"># Filenames matching the wildcard pattern.</span>
  1361. </code></pre>
  1362. <h3 id="pathlib">Pathlib</h3>
  1363. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
  1364. </code></pre>
  1365. <pre><code class="python language-python hljs">cwd = Path()
  1366. &lt;Path&gt; = Path(<span class="hljs-string">'&lt;path&gt;'</span> [, <span class="hljs-string">'&lt;path&gt;'</span>, &lt;Path&gt;, ...])
  1367. &lt;Path&gt; = &lt;Path&gt; / <span class="hljs-string">'&lt;dir&gt;'</span> / <span class="hljs-string">'&lt;file&gt;'</span>
  1368. </code></pre>
  1369. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;Path&gt;.exists()
  1370. &lt;bool&gt; = &lt;Path&gt;.is_file()
  1371. &lt;bool&gt; = &lt;Path&gt;.is_dir()
  1372. </code></pre>
  1373. <pre><code class="python language-python hljs">&lt;iter&gt; = &lt;Path&gt;.iterdir() <span class="hljs-comment"># Iterator of filenames located at path.</span>
  1374. &lt;iter&gt; = &lt;Path&gt;.glob(<span class="hljs-string">'&lt;pattern&gt;'</span>) <span class="hljs-comment"># Filenames matching the wildcard pattern.</span>
  1375. </code></pre>
  1376. <pre><code class="python language-python hljs">&lt;str&gt; = str(&lt;Path&gt;) <span class="hljs-comment"># Returns path as a string.</span>
  1377. &lt;tup.&gt; = &lt;Path&gt;.parts <span class="hljs-comment"># Returns all components as strings.</span>
  1378. &lt;Path&gt; = &lt;Path&gt;.resolve() <span class="hljs-comment"># Returns absolute Path without symlinks.</span>
  1379. </code></pre>
  1380. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Path&gt;.name <span class="hljs-comment"># Final component.</span>
  1381. &lt;str&gt; = &lt;Path&gt;.stem <span class="hljs-comment"># Final component without extension.</span>
  1382. &lt;str&gt; = &lt;Path&gt;.suffix <span class="hljs-comment"># Final component's extension.</span>
  1383. &lt;Path&gt; = &lt;Path&gt;.parent <span class="hljs-comment"># Path without final component.</span>
  1384. </code></pre>
  1385. <h2 id="commandexecution"><a href="#commandexecution" name="commandexecution">#</a>Command Execution</h2>
  1386. <h3 id="filesanddirectoriescommands">Files and Directories Commands</h3>
  1387. <ul>
  1388. <li><strong>Paths can be either strings or Path objects.</strong></li>
  1389. <li><strong>All exceptions are either 'OSError' or its subclasses.</strong></li>
  1390. </ul>
  1391. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
  1392. os.chdir(&lt;path&gt;) <span class="hljs-comment"># Changes the current working directory.</span>
  1393. &lt;str&gt; = os.getcwd() <span class="hljs-comment"># Returns current working directory.</span>
  1394. </code></pre>
  1395. <pre><code class="python language-python hljs">os.remove(&lt;path&gt;) <span class="hljs-comment"># Deletes the file.</span>
  1396. os.rmdir(&lt;path&gt;) <span class="hljs-comment"># Deletes empty directory.</span>
  1397. shutil.rmtree(&lt;path&gt;) <span class="hljs-comment"># Deletes an entire directory tree.</span>
  1398. </code></pre>
  1399. <pre><code class="python language-python hljs">os.rename(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Renames the file or directory.</span>
  1400. os.replace(<span class="hljs-keyword">from</span>, to) <span class="hljs-comment"># Same, but overwrites 'to' if it exists.</span>
  1401. </code></pre>
  1402. <pre><code class="python language-python hljs">os.mkdir(&lt;path&gt;, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates a directory.</span>
  1403. &lt;iter&gt; = os.scandir(path=<span class="hljs-string">'.'</span>) <span class="hljs-comment"># Returns os.DirEntry objects located at path.</span>
  1404. </code></pre>
  1405. <h4 id="direntry">DirEntry:</h4>
  1406. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;DirEntry&gt;.name <span class="hljs-comment"># Final component of the path.</span>
  1407. &lt;str&gt; = &lt;DirEntry&gt;.path <span class="hljs-comment"># Path with final component.</span>
  1408. &lt;Path&gt; = Path(&lt;DirEntry&gt;) <span class="hljs-comment"># Path object.</span>
  1409. </code></pre>
  1410. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;DirEntry&gt;.is_file()
  1411. &lt;bool&gt; = &lt;DirEntry&gt;.is_dir()
  1412. &lt;bool&gt; = &lt;DirEntry&gt;.is_symlink()
  1413. </code></pre>
  1414. <h3 id="shellcommands">Shell Commands</h3>
  1415. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
  1416. &lt;str&gt; = os.popen(<span class="hljs-string">'&lt;shell_command&gt;'</span>).read()
  1417. </code></pre>
  1418. <h4 id="usingsubprocess">Using subprocess:</h4>
  1419. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> subprocess, shlex
  1420. <span class="hljs-meta">&gt;&gt;&gt; </span>a = subprocess.run(shlex.split(<span class="hljs-string">'ls -a'</span>), stdout=subprocess.PIPE)
  1421. <span class="hljs-meta">&gt;&gt;&gt; </span>a.stdout
  1422. <span class="hljs-string">b'.\n..\nfile1.txt\nfile2.txt\n'</span>
  1423. <span class="hljs-meta">&gt;&gt;&gt; </span>a.returncode
  1424. <span class="hljs-number">0</span>
  1425. </code></pre>
  1426. <h2 id="csv"><a href="#csv" name="csv">#</a>CSV</h2>
  1427. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> csv
  1428. &lt;reader&gt; = csv.reader(&lt;file&gt;, dialect=<span class="hljs-string">'excel'</span>, delimiter=<span class="hljs-string">','</span>)
  1429. &lt;list&gt; = next(&lt;reader&gt;) <span class="hljs-comment"># Returns a row as list of strings.</span>
  1430. </code></pre>
  1431. <pre><code class="python language-python hljs">&lt;writer&gt; = csv.writer(&lt;file&gt;, dialect=<span class="hljs-string">'excel'</span>, delimiter=<span class="hljs-string">','</span>)
  1432. &lt;writer&gt;.writerow(&lt;collection&gt;) <span class="hljs-comment"># Encodes objects using `str(&lt;el&gt;)`.</span>
  1433. &lt;writer&gt;.writerows(&lt;coll_of_coll&gt;)
  1434. </code></pre>
  1435. <ul>
  1436. <li><strong>File must be opened with <code class="python hljs"><span class="hljs-string">'newline=""'</span></code> argument, or newlines embedded inside quoted fields will not be interpreted correctly!</strong></li>
  1437. </ul>
  1438. <h3 id="parameters">Parameters</h3>
  1439. <ul>
  1440. <li><strong><code class="python hljs"><span class="hljs-string">'dialect'</span></code> - Master parameter that sets the default values.</strong></li>
  1441. <li><strong><code class="python hljs"><span class="hljs-string">'delimiter'</span></code> - A one-character string used to separate fields.</strong></li>
  1442. <li><strong><code class="python hljs"><span class="hljs-string">'quotechar'</span></code> - Character for quoting fields that contain special characters.</strong></li>
  1443. <li><strong><code class="python hljs"><span class="hljs-string">'doublequote'</span></code> - Whether quotechars inside fields get doubled or escaped.</strong></li>
  1444. <li><strong><code class="python hljs"><span class="hljs-string">'skipinitialspace'</span></code> - Whether whitespace after delimiter gets stripped.</strong></li>
  1445. <li><strong><code class="python hljs"><span class="hljs-string">'lineterminator'</span></code> - How does writer terminate lines.</strong></li>
  1446. <li><strong><code class="python hljs"><span class="hljs-string">'quoting'</span></code> - Controls the amount of quoting: 0 - as necessary, 1 - all.</strong></li>
  1447. <li><strong><code class="python hljs"><span class="hljs-string">'escapechar'</span></code> - Character for escaping quotechar if doublequote is false.</strong></li>
  1448. </ul>
  1449. <h3 id="dialects">Dialects</h3>
  1450. <pre><code class="text language-text">+------------------+-----------+-----------+--------------+
  1451. | | excel | excel_tab | unix_dialect |
  1452. +------------------+-----------+-----------+--------------+
  1453. | delimiter | ',' | '\t' | ',' |
  1454. | quotechar | '"' | '"' | '"' |
  1455. | doublequote | True | True | True |
  1456. | skipinitialspace | False | False | False |
  1457. | lineterminator | '\r\n' | '\r\n' | '\n' |
  1458. | quoting | 0 | 0 | 1 |
  1459. | escapechar | None | None | None |
  1460. +------------------+-----------+-----------+--------------+
  1461. </code></pre>
  1462. <h3 id="readrowsfromcsvfile">Read Rows from CSV File</h3>
  1463. <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>
  1464. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
  1465. <span class="hljs-keyword">return</span> csv.reader(file)
  1466. </code></pre>
  1467. <h3 id="writerowstocsvfile">Write Rows to CSV File</h3>
  1468. <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>
  1469. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'w'</span>, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
  1470. writer = csv.writer(file)
  1471. writer.writerows(rows)
  1472. </code></pre>
  1473. <h2 id="json"><a href="#json" name="json">#</a>JSON</h2>
  1474. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> json
  1475. &lt;str&gt; = json.dumps(&lt;object&gt;, ensure_ascii=<span class="hljs-keyword">True</span>, indent=<span class="hljs-keyword">None</span>)
  1476. &lt;object&gt; = json.loads(&lt;str&gt;)
  1477. </code></pre>
  1478. <h3 id="readobjectfromjsonfile">Read Object from JSON File</h3>
  1479. <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>
  1480. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1481. <span class="hljs-keyword">return</span> json.load(file)
  1482. </code></pre>
  1483. <h3 id="writeobjecttojsonfile">Write Object to JSON File</h3>
  1484. <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>
  1485. <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:
  1486. json.dump(an_object, file, ensure_ascii=<span class="hljs-keyword">False</span>, indent=<span class="hljs-number">2</span>)
  1487. </code></pre>
  1488. <h2 id="pickle"><a href="#pickle" name="pickle">#</a>Pickle</h2>
  1489. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> pickle
  1490. &lt;bytes&gt; = pickle.dumps(&lt;object&gt;)
  1491. &lt;object&gt; = pickle.loads(&lt;bytes&gt;)
  1492. </code></pre>
  1493. <h3 id="readobjectfromfile">Read Object from File</h3>
  1494. <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>
  1495. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1496. <span class="hljs-keyword">return</span> pickle.load(file)
  1497. </code></pre>
  1498. <h3 id="writeobjecttofile">Write Object to File</h3>
  1499. <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>
  1500. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1501. pickle.dump(an_object, file)
  1502. </code></pre>
  1503. <h2 id="sqlite"><a href="#sqlite" name="sqlite">#</a>SQLite</h2>
  1504. <p><strong>Server-less database engine that stores each database into separate file.</strong></p>
  1505. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sqlite3
  1506. db = sqlite3.connect(<span class="hljs-string">'&lt;path&gt;'</span>) <span class="hljs-comment"># Also ':memory:'.</span>
  1507. ...
  1508. db.close()
  1509. </code></pre>
  1510. <ul>
  1511. <li><strong>New database will be created if path doesn't exist.</strong></li>
  1512. </ul>
  1513. <h3 id="read">Read</h3>
  1514. <pre><code class="python language-python hljs">cursor = db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1515. <span class="hljs-keyword">if</span> cursor:
  1516. &lt;tuple&gt; = cursor.fetchone() <span class="hljs-comment"># First row.</span>
  1517. &lt;list&gt; = cursor.fetchall() <span class="hljs-comment"># Remaining rows.</span>
  1518. </code></pre>
  1519. <ul>
  1520. <li><strong>Returned values can be of type str, int, float, bytes or None.</strong></li>
  1521. </ul>
  1522. <h3 id="write">Write</h3>
  1523. <pre><code class="python language-python hljs">db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1524. db.commit()
  1525. </code></pre>
  1526. <h3 id="placeholders">Placeholders</h3>
  1527. <pre><code class="python language-python hljs">db.execute(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;list/tuple&gt;) <span class="hljs-comment"># Replaces '?'s in query with values.</span>
  1528. db.execute(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;dict/namedtuple&gt;) <span class="hljs-comment"># Replaces ':&lt;key&gt;'s with values.</span>
  1529. db.executemany(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;coll_of_above&gt;) <span class="hljs-comment"># Runs execute() many times.</span>
  1530. </code></pre>
  1531. <ul>
  1532. <li><strong>Passed values can be of type str, int, float, bytes, None, bool, datetime.date or datetime.datetme.</strong></li>
  1533. </ul>
  1534. <h3 id="mysql">MySQL</h3>
  1535. <p><strong>Has a very similar interface, with differences listed below.</strong></p>
  1536. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install mysql-connector</span>
  1537. <span class="hljs-keyword">from</span> mysql <span class="hljs-keyword">import</span> connector
  1538. db = connector.connect(host=&lt;str&gt;, user=&lt;str&gt;, password=&lt;str&gt;, database=&lt;str&gt;)
  1539. cursor = db.cursor()
  1540. cursor.execute(<span class="hljs-string">'&lt;query&gt;'</span>) <span class="hljs-comment"># Connector doesn't have execute method.</span>
  1541. cursor.execute(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;list/tuple&gt;) <span class="hljs-comment"># Replaces '%s's in query with values.</span>
  1542. cursor.execute(<span class="hljs-string">'&lt;query&gt;'</span>, &lt;dict/namedtuple&gt;) <span class="hljs-comment"># Replaces '%(&lt;key&gt;)s's with values.</span>
  1543. </code></pre>
  1544. <h2 id="bytes"><a href="#bytes" name="bytes">#</a>Bytes</h2>
  1545. <p><strong>Bytes object is an immutable sequence of single bytes. Mutable version is called 'bytearray'.</strong></p>
  1546. <pre><code class="python language-python hljs">&lt;bytes&gt; = <span class="hljs-string">b'&lt;str&gt;'</span> <span class="hljs-comment"># Only accepts ASCII characters and \x00 - \xff.</span>
  1547. &lt;int&gt; = &lt;bytes&gt;[&lt;index&gt;] <span class="hljs-comment"># Returns int in range from 0 to 255.</span>
  1548. &lt;bytes&gt; = &lt;bytes&gt;[&lt;slice&gt;] <span class="hljs-comment"># Returns bytes even if it has only one element.</span>
  1549. &lt;bytes&gt; = &lt;bytes&gt;.join(&lt;coll_of_bytes&gt;) <span class="hljs-comment"># Joins elements using bytes object as separator.</span>
  1550. </code></pre>
  1551. <h3 id="encode-1">Encode</h3>
  1552. <pre><code class="python language-python hljs">&lt;bytes&gt; = &lt;str&gt;.encode(<span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Or: bytes(&lt;str&gt;, 'utf-8')</span>
  1553. &lt;bytes&gt; = bytes(&lt;coll_of_ints&gt;) <span class="hljs-comment"># Ints must be in range from 0 to 255.</span>
  1554. &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>)
  1555. &lt;bytes&gt; = bytes.fromhex(<span class="hljs-string">'&lt;hex&gt;'</span>)
  1556. </code></pre>
  1557. <h3 id="decode-1">Decode</h3>
  1558. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;bytes&gt;.decode(<span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Or: str(&lt;bytes&gt;, 'utf-8')</span>
  1559. &lt;list&gt; = list(&lt;bytes&gt;) <span class="hljs-comment"># Returns ints in range from 0 to 255.</span>
  1560. &lt;int&gt; = int.from_bytes(&lt;bytes&gt;, byteorder=<span class="hljs-string">'big|little'</span>, signed=<span class="hljs-keyword">False</span>)
  1561. <span class="hljs-string">'&lt;hex&gt;'</span> = &lt;bytes&gt;.hex()
  1562. </code></pre>
  1563. <h3 id="readbytesfromfile">Read Bytes from File</h3>
  1564. <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>
  1565. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1566. <span class="hljs-keyword">return</span> file.read()
  1567. </code></pre>
  1568. <h3 id="writebytestofile">Write Bytes to File</h3>
  1569. <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>
  1570. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1571. file.write(bytes_obj)
  1572. </code></pre>
  1573. <h2 id="struct"><a href="#struct" name="struct">#</a>Struct</h2>
  1574. <ul>
  1575. <li><strong>Module that performs conversions between a sequence of numbers and a C struct, represented as a Python bytes object.</strong></li>
  1576. <li><strong>Machine’s native type sizes and byte order are used by default.</strong></li>
  1577. </ul>
  1578. <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
  1579. &lt;bytes&gt; = pack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;num_1&gt; [, &lt;num_2&gt;, ...])
  1580. &lt;tuple&gt; = unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1581. &lt;tuples&gt; = iter_unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1582. </code></pre>
  1583. <h3 id="example">Example</h3>
  1584. <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>)
  1585. <span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>
  1586. <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>)
  1587. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1588. <span class="hljs-meta">&gt;&gt;&gt; </span>calcsize(<span class="hljs-string">'&gt;hhl'</span>)
  1589. <span class="hljs-number">8</span>
  1590. </code></pre>
  1591. <h3 id="format-2">Format</h3>
  1592. <h4 id="forstandardsizesstartformatstringwith">For standard sizes start format string with:</h4>
  1593. <ul>
  1594. <li><strong><code class="python hljs"><span class="hljs-string">'='</span></code> - native byte order</strong></li>
  1595. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;'</span></code> - little-endian</strong></li>
  1596. <li><strong><code class="python hljs"><span class="hljs-string">'&gt;'</span></code> - big-endian</strong></li>
  1597. </ul>
  1598. <h4 id="integertypesusecapitalletterforunsignedtypestandardsizesareinbrackets">Integer types. Use capital letter for unsigned type. Standard sizes are in brackets:</h4>
  1599. <ul>
  1600. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - pad byte</strong></li>
  1601. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - char (1)</strong></li>
  1602. <li><strong><code class="python hljs"><span class="hljs-string">'h'</span></code> - short (2)</strong></li>
  1603. <li><strong><code class="python hljs"><span class="hljs-string">'i'</span></code> - int (4)</strong></li>
  1604. <li><strong><code class="python hljs"><span class="hljs-string">'l'</span></code> - long (4)</strong></li>
  1605. <li><strong><code class="python hljs"><span class="hljs-string">'q'</span></code> - long long (8)</strong></li>
  1606. </ul>
  1607. <h4 id="floatingpointtypes">Floating point types:</h4>
  1608. <ul>
  1609. <li><strong><code class="python hljs"><span class="hljs-string">'f'</span></code> - float (4)</strong></li>
  1610. <li><strong><code class="python hljs"><span class="hljs-string">'d'</span></code> - double (8)</strong></li>
  1611. </ul>
  1612. <h2 id="array"><a href="#array" name="array">#</a>Array</h2>
  1613. <p><strong>List that can only hold numbers of predefined type. Available types and their sizes in bytes are listed above.</strong></p>
  1614. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> array <span class="hljs-keyword">import</span> array
  1615. &lt;array&gt; = array(<span class="hljs-string">'&lt;typecode&gt;'</span> [, &lt;collection&gt;])
  1616. </code></pre>
  1617. <h2 id="memoryview"><a href="#memoryview" name="memoryview">#</a>Memory View</h2>
  1618. <p><strong>Used for accessing the internal data of an object that supports the buffer protocol.</strong></p>
  1619. <pre><code class="python language-python hljs">&lt;memoryview&gt; = memoryview(&lt;bytes&gt; / &lt;bytearray&gt; / &lt;array&gt;)
  1620. &lt;memoryview&gt;.release()
  1621. </code></pre>
  1622. <h2 id="deque"><a href="#deque" name="deque">#</a>Deque</h2>
  1623. <p><strong>A thread-safe list with efficient appends and pops from either side. Pronounced "deck".</strong></p>
  1624. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> deque
  1625. &lt;deque&gt; = deque(&lt;collection&gt;, maxlen=<span class="hljs-keyword">None</span>)
  1626. </code></pre>
  1627. <pre><code class="python language-python hljs">&lt;deque&gt;.appendleft(&lt;el&gt;)
  1628. &lt;el&gt; = &lt;deque&gt;.popleft()
  1629. &lt;deque&gt;.extendleft(&lt;collection&gt;) <span class="hljs-comment"># Collection gets reversed.</span>
  1630. &lt;deque&gt;.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Rotates elements to the right.</span>
  1631. </code></pre>
  1632. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>a = deque([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], maxlen=<span class="hljs-number">3</span>)
  1633. <span class="hljs-meta">&gt;&gt;&gt; </span>a.append(<span class="hljs-number">4</span>)
  1634. [<span class="hljs-number">2</span>, <span class="hljs-number">3</span>, <span class="hljs-number">4</span>]
  1635. <span class="hljs-meta">&gt;&gt;&gt; </span>a.appendleft(<span class="hljs-number">5</span>)
  1636. [<span class="hljs-number">5</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
  1637. <span class="hljs-meta">&gt;&gt;&gt; </span>a.insert(<span class="hljs-number">1</span>, <span class="hljs-number">6</span>)
  1638. IndexError: deque already at its maximum size
  1639. </code></pre>
  1640. <h2 id="threading"><a href="#threading" name="threading">#</a>Threading</h2>
  1641. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> threading <span class="hljs-keyword">import</span> Thread, RLock
  1642. </code></pre>
  1643. <h3 id="thread">Thread</h3>
  1644. <pre><code class="python language-python hljs">thread = Thread(target=&lt;function&gt;, args=(&lt;first_arg&gt;, ))
  1645. thread.start()
  1646. ...
  1647. thread.join()
  1648. </code></pre>
  1649. <h3 id="lock">Lock</h3>
  1650. <pre><code class="python language-python hljs">lock = RLock()
  1651. lock.acquire()
  1652. ...
  1653. lock.release()
  1654. </code></pre>
  1655. <h4 id="or">Or:</h4>
  1656. <pre><code class="python language-python hljs">lock = RLock()
  1657. <span class="hljs-keyword">with</span> lock:
  1658. ...
  1659. </code></pre>
  1660. <h2 id="introspection"><a href="#introspection" name="introspection">#</a>Introspection</h2>
  1661. <p><strong>Inspecting code at runtime.</strong></p>
  1662. <h3 id="variables">Variables</h3>
  1663. <pre><code class="python language-python hljs">&lt;list&gt; = dir() <span class="hljs-comment"># Names of variables in current scope.</span>
  1664. &lt;dict&gt; = locals() <span class="hljs-comment"># Dict of local variables. Also vars().</span>
  1665. &lt;dict&gt; = globals() <span class="hljs-comment"># Dict of global variables.</span>
  1666. </code></pre>
  1667. <h3 id="attributes-1">Attributes</h3>
  1668. <pre><code class="python language-python hljs">&lt;dict&gt; = vars(&lt;object&gt;)
  1669. &lt;bool&gt; = hasattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1670. value = getattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1671. setattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>, value)
  1672. </code></pre>
  1673. <h3 id="parameters-1">Parameters</h3>
  1674. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> inspect <span class="hljs-keyword">import</span> signature
  1675. &lt;sig&gt; = signature(&lt;function&gt;)
  1676. no_of_params = len(&lt;sig&gt;.parameters)
  1677. param_names = list(&lt;sig&gt;.parameters.keys())
  1678. </code></pre>
  1679. <h2 id="metaprograming"><a href="#metaprograming" name="metaprograming">#</a>Metaprograming</h2>
  1680. <p><strong>Code that generates code.</strong></p>
  1681. <h3 id="type-1">Type</h3>
  1682. <p><strong>Type is the root class. If only passed an object it returns its type (class). Otherwise it creates a new class.</strong></p>
  1683. <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>
  1684. </span></code></pre>
  1685. <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>})
  1686. <span class="hljs-meta">&gt;&gt;&gt; </span>z = Z()
  1687. </code></pre>
  1688. <h3 id="metaclass">Meta Class</h3>
  1689. <p><strong>Class that creates class.</strong></p>
  1690. <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>
  1691. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1692. <span class="hljs-keyword">return</span> type(name, parents, attrs)
  1693. </code></pre>
  1694. <h4 id="or-1">Or:</h4>
  1695. <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>
  1696. <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>
  1697. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1698. <span class="hljs-keyword">return</span> type.__new__(cls, name, parents, attrs)
  1699. </code></pre>
  1700. <ul>
  1701. <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>
  1702. <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>
  1703. <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>
  1704. </ul>
  1705. <h3 id="metaclassattribute">Metaclass Attribute</h3>
  1706. <p><strong>Right before a 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>
  1707. <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>
  1708. b = <span class="hljs-number">12345</span>
  1709. </code></pre>
  1710. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>MyClass.a, MyClass.b
  1711. (<span class="hljs-string">'abcde'</span>, <span class="hljs-number">12345</span>)
  1712. </code></pre>
  1713. <h3 id="typediagram">Type Diagram</h3>
  1714. <pre><code class="python language-python hljs">type(MyClass) == MyMetaClass <span class="hljs-comment"># MyClass is an instance of MyMetaClass.</span>
  1715. type(MyMetaClass) == type <span class="hljs-comment"># MyMetaClass is an instance of type.</span>
  1716. </code></pre>
  1717. <pre><code class="text language-text">+---------+-------------+
  1718. | Classes | Metaclasses |
  1719. +---------+-------------|
  1720. | MyClass &gt; MyMetaClass |
  1721. | | v |
  1722. | object ---&gt; type &lt;+ |
  1723. | | ^ +---+ |
  1724. | str -------+ |
  1725. +---------+-------------+
  1726. </code></pre>
  1727. <h3 id="inheritancediagram">Inheritance Diagram</h3>
  1728. <pre><code class="python language-python hljs">MyClass.__base__ == object <span class="hljs-comment"># MyClass is a subclass of object.</span>
  1729. MyMetaClass.__base__ == type <span class="hljs-comment"># MyMetaClass is a subclass of type.</span>
  1730. </code></pre>
  1731. <pre><code class="text language-text">+---------+-------------+
  1732. | Classes | Metaclasses |
  1733. +---------+-------------|
  1734. | MyClass | MyMetaClass |
  1735. | v | v |
  1736. | object &lt;--- type |
  1737. | ^ | |
  1738. | str | |
  1739. +---------+-------------+
  1740. </code></pre>
  1741. <h2 id="operator"><a href="#operator" name="operator">#</a>Operator</h2>
  1742. <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
  1743. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> eq, ne, lt, le, gt, ge
  1744. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> and_, or_, not_
  1745. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> itemgetter, attrgetter, methodcaller
  1746. </code></pre>
  1747. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
  1748. sorted_by_second = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>))
  1749. sorted_by_both = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>))
  1750. product_of_elems = functools.reduce(op.mul, &lt;collection&gt;)
  1751. 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_})
  1752. last_el = op.methodcaller(<span class="hljs-string">'pop'</span>)(&lt;list&gt;)
  1753. </code></pre>
  1754. <h2 id="eval"><a href="#eval" name="eval">#</a>Eval</h2>
  1755. <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
  1756. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'1 + 2'</span>)
  1757. <span class="hljs-number">3</span>
  1758. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'[1, 2, 3]'</span>)
  1759. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
  1760. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'abs(1)'</span>)
  1761. ValueError: malformed node <span class="hljs-keyword">or</span> string
  1762. </code></pre>
  1763. <h2 id="coroutine"><a href="#coroutine" name="coroutine">#</a>Coroutine</h2>
  1764. <ul>
  1765. <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>
  1766. <li><strong>Coroutines provide more powerful data routing possibilities than iterators.</strong></li>
  1767. <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>
  1768. </ul>
  1769. <h3 id="helperdecorator">Helper Decorator</h3>
  1770. <ul>
  1771. <li><strong>All coroutines must be "primed" by first calling next().</strong></li>
  1772. <li><strong>Remembering to call next() is easy to forget.</strong></li>
  1773. <li><strong>Solved by wrapping coroutines with a decorator:</strong></li>
  1774. </ul>
  1775. <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>
  1776. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  1777. cr = func(*args, **kwargs)
  1778. next(cr)
  1779. <span class="hljs-keyword">return</span> cr
  1780. <span class="hljs-keyword">return</span> out
  1781. </code></pre>
  1782. <h3 id="pipelineexample">Pipeline Example</h3>
  1783. <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>
  1784. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  1785. target.send(i)
  1786. target.close()
  1787. <span class="hljs-meta">@coroutine</span>
  1788. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">adder</span><span class="hljs-params">(target)</span>:</span>
  1789. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1790. value = (<span class="hljs-keyword">yield</span>)
  1791. target.send(value + <span class="hljs-number">100</span>)
  1792. <span class="hljs-meta">@coroutine</span>
  1793. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">printer</span><span class="hljs-params">()</span>:</span>
  1794. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1795. value = (<span class="hljs-keyword">yield</span>)
  1796. print(value)
  1797. reader(adder(printer())) <span class="hljs-comment"># 100, 101, ..., 109</span>
  1798. </code></pre>
  1799. <p><br><br></p>
  1800. <h1 id="libraries">Libraries</h1>
  1801. <h2 id="progressbar"><a href="#progressbar" name="progressbar">#</a>Progress Bar</h2>
  1802. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tqdm</span>
  1803. <span class="hljs-keyword">from</span> tqdm <span class="hljs-keyword">import</span> tqdm
  1804. <span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> sleep
  1805. <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>]):
  1806. sleep(<span class="hljs-number">0.2</span>)
  1807. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> tqdm(range(<span class="hljs-number">100</span>)):
  1808. sleep(<span class="hljs-number">0.02</span>)
  1809. </code></pre>
  1810. <h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2>
  1811. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span>
  1812. <span class="hljs-keyword">from</span> matplotlib <span class="hljs-keyword">import</span> pyplot
  1813. pyplot.plot(&lt;data_1&gt; [, &lt;data_2&gt;, ...]) <span class="hljs-comment"># Or: hist(&lt;data&gt;).</span>
  1814. pyplot.savefig(&lt;filename&gt;)
  1815. pyplot.show()
  1816. pyplot.clf() <span class="hljs-comment"># Clears figure.</span>
  1817. </code></pre>
  1818. <h2 id="table"><a href="#table" name="table">#</a>Table</h2>
  1819. <h4 id="printsacsvfileasanasciitable">Prints a CSV file as an ASCII table:</h4>
  1820. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tabulate</span>
  1821. <span class="hljs-keyword">from</span> tabulate <span class="hljs-keyword">import</span> tabulate
  1822. <span class="hljs-keyword">import</span> csv
  1823. <span class="hljs-keyword">with</span> open(&lt;filename&gt;, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
  1824. lines = csv.reader(file)
  1825. headers = [header.title() <span class="hljs-keyword">for</span> header <span class="hljs-keyword">in</span> next(lines)]
  1826. table = tabulate(lines, headers)
  1827. print(table)
  1828. </code></pre>
  1829. <h2 id="curses"><a href="#curses" name="curses">#</a>Curses</h2>
  1830. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> curses <span class="hljs-keyword">import</span> wrapper, ascii
  1831. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1832. wrapper(draw)
  1833. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">draw</span><span class="hljs-params">(screen)</span>:</span>
  1834. screen.clear()
  1835. screen.addstr(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-string">'Press ESC to quit.'</span>)
  1836. <span class="hljs-keyword">while</span> screen.getch() != ascii.ESC:
  1837. <span class="hljs-keyword">pass</span>
  1838. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_border</span><span class="hljs-params">(screen)</span>:</span>
  1839. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  1840. P = namedtuple(<span class="hljs-string">'P'</span>, <span class="hljs-string">'y x'</span>)
  1841. height, width = screen.getmaxyx()
  1842. <span class="hljs-keyword">return</span> P(height<span class="hljs-number">-1</span>, width<span class="hljs-number">-1</span>)
  1843. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  1844. main()
  1845. </code></pre>
  1846. <h2 id="logging"><a href="#logging" name="logging">#</a>Logging</h2>
  1847. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install loguru</span>
  1848. <span class="hljs-keyword">from</span> loguru <span class="hljs-keyword">import</span> logger
  1849. </code></pre>
  1850. <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>
  1851. 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>
  1852. logger.&lt;level&gt;(<span class="hljs-string">'A logging message.'</span>)
  1853. </code></pre>
  1854. <ul>
  1855. <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>
  1856. </ul>
  1857. <h3 id="exceptions-2">Exceptions</h3>
  1858. <p><strong>Error description, stack trace and values of variables are appended automatically.</strong></p>
  1859. <pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
  1860. ...
  1861. <span class="hljs-keyword">except</span> &lt;exception&gt;:
  1862. logger.exception(<span class="hljs-string">'An error happened.'</span>)
  1863. </code></pre>
  1864. <h3 id="rotation">Rotation</h3>
  1865. <p><strong>Argument that sets a condition when a new log file is created.</strong></p>
  1866. <pre><code class="python language-python hljs">rotation=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;datetime.time&gt;|&lt;str&gt;
  1867. </code></pre>
  1868. <ul>
  1869. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max file size in bytes.</strong></li>
  1870. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1871. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;time&gt;'</span></code> - Time of day.</strong></li>
  1872. <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>
  1873. </ul>
  1874. <h3 id="retention">Retention</h3>
  1875. <p><strong>Sets a condition which old log files are deleted.</strong></p>
  1876. <pre><code class="python language-python hljs">retention=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;str&gt;
  1877. </code></pre>
  1878. <ul>
  1879. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max number of files.</strong></li>
  1880. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1881. <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>
  1882. </ul>
  1883. <h2 id="scraping"><a href="#scraping" name="scraping">#</a>Scraping</h2>
  1884. <h4 id="scrapesandprintspythonsurlandversionnumberfromwikipedia">Scrapes and prints Python's URL and version number from Wikipedia:</h4>
  1885. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests beautifulsoup4</span>
  1886. <span class="hljs-keyword">import</span> requests
  1887. <span class="hljs-keyword">from</span> bs4 <span class="hljs-keyword">import</span> BeautifulSoup
  1888. url = <span class="hljs-string">'https://en.wikipedia.org/wiki/Python_(programming_language)'</span>
  1889. page = requests.get(url)
  1890. doc = BeautifulSoup(page.text, <span class="hljs-string">'html.parser'</span>)
  1891. table = doc.find(<span class="hljs-string">'table'</span>, class_=<span class="hljs-string">'infobox vevent'</span>)
  1892. rows = table.find_all(<span class="hljs-string">'tr'</span>)
  1893. link = rows[<span class="hljs-number">11</span>].find(<span class="hljs-string">'a'</span>)[<span class="hljs-string">'href'</span>]
  1894. ver = rows[<span class="hljs-number">6</span>].find(<span class="hljs-string">'div'</span>).text.split()[<span class="hljs-number">0</span>]
  1895. print(link, ver)
  1896. </code></pre>
  1897. <h2 id="web"><a href="#web" name="web">#</a>Web</h2>
  1898. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install bottle</span>
  1899. <span class="hljs-keyword">from</span> bottle <span class="hljs-keyword">import</span> run, route, post, template, request, response
  1900. <span class="hljs-keyword">import</span> json
  1901. </code></pre>
  1902. <h3 id="run">Run</h3>
  1903. <pre><code class="python language-python hljs">run(host=<span class="hljs-string">'localhost'</span>, port=<span class="hljs-number">8080</span>)
  1904. 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>)
  1905. </code></pre>
  1906. <h3 id="staticrequest">Static Request</h3>
  1907. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/img/&lt;image&gt;')</span>
  1908. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_image</span><span class="hljs-params">(image)</span>:</span>
  1909. <span class="hljs-keyword">return</span> static_file(image, <span class="hljs-string">'images/'</span>, mimetype=<span class="hljs-string">'image/png'</span>)
  1910. </code></pre>
  1911. <h3 id="dynamicrequest">Dynamic Request</h3>
  1912. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/&lt;sport&gt;')</span>
  1913. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_page</span><span class="hljs-params">(sport)</span>:</span>
  1914. <span class="hljs-keyword">return</span> template(<span class="hljs-string">'&lt;h1&gt;{{title}}&lt;/h1&gt;'</span>, title=sport)
  1915. </code></pre>
  1916. <h3 id="restrequest">REST Request</h3>
  1917. <pre><code class="python language-python hljs"><span class="hljs-meta">@post('/odds/&lt;sport&gt;')</span>
  1918. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">odds_handler</span><span class="hljs-params">(sport)</span>:</span>
  1919. team = request.forms.get(<span class="hljs-string">'team'</span>)
  1920. home_odds, away_odds = <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>
  1921. response.headers[<span class="hljs-string">'Content-Type'</span>] = <span class="hljs-string">'application/json'</span>
  1922. response.headers[<span class="hljs-string">'Cache-Control'</span>] = <span class="hljs-string">'no-cache'</span>
  1923. <span class="hljs-keyword">return</span> json.dumps([team, home_odds, away_odds])
  1924. </code></pre>
  1925. <h4 id="test">Test:</h4>
  1926. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests</span>
  1927. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> requests
  1928. <span class="hljs-meta">&gt;&gt;&gt; </span>url = <span class="hljs-string">'http://localhost:8080/odds/football'</span>
  1929. <span class="hljs-meta">&gt;&gt;&gt; </span>data = {<span class="hljs-string">'team'</span>: <span class="hljs-string">'arsenal f.c.'</span>}
  1930. <span class="hljs-meta">&gt;&gt;&gt; </span>response = requests.post(url, data=data)
  1931. <span class="hljs-meta">&gt;&gt;&gt; </span>response.json()
  1932. [<span class="hljs-string">'arsenal f.c.'</span>, <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>]
  1933. </code></pre>
  1934. <h2 id="profile"><a href="#profile" name="profile">#</a>Profile</h2>
  1935. <h3 id="basic">Basic</h3>
  1936. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> time
  1937. start_time = time() <span class="hljs-comment"># Seconds since Epoch.</span>
  1938. ...
  1939. duration = time() - start_time
  1940. </code></pre>
  1941. <h3 id="highperformance">High Performance</h3>
  1942. <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
  1943. start_time = pc() <span class="hljs-comment"># Seconds since restart.</span>
  1944. ...
  1945. duration = pc() - start_time
  1946. </code></pre>
  1947. <h3 id="timingasnippet">Timing a Snippet</h3>
  1948. <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
  1949. <span class="hljs-meta">&gt;&gt;&gt; </span>timeit(<span class="hljs-string">'"-".join(str(a) for a in range(100))'</span>,
  1950. <span class="hljs-meta">... </span> number=<span class="hljs-number">10000</span>, globals=globals(), setup=<span class="hljs-string">'pass'</span>)
  1951. <span class="hljs-number">0.34986</span>
  1952. </code></pre>
  1953. <h3 id="lineprofiler">Line Profiler</h3>
  1954. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install line_profiler</span>
  1955. <span class="hljs-meta">@profile</span>
  1956. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1957. a = [*range(<span class="hljs-number">10000</span>)]
  1958. b = {*range(<span class="hljs-number">10000</span>)}
  1959. main()
  1960. </code></pre>
  1961. <h4 id="usage">Usage:</h4>
  1962. <pre><code class="text language-text">$ kernprof -lv test.py
  1963. Line # Hits Time Per Hit % Time Line Contents
  1964. ==============================================================
  1965. 1 @profile
  1966. 2 def main():
  1967. 3 1 1128.0 1128.0 27.4 a = [*range(10000)]
  1968. 4 1 2994.0 2994.0 72.6 b = {*range(10000)}
  1969. </code></pre>
  1970. <h3 id="callgraph">Call Graph</h3>
  1971. <h4 id="generatesapngimageofacallgraphwithhighlightedbottlenecks">Generates a PNG image of a call graph with highlighted bottlenecks:</h4>
  1972. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pycallgraph</span>
  1973. <span class="hljs-keyword">from</span> pycallgraph <span class="hljs-keyword">import</span> output, PyCallGraph
  1974. <span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> datetime
  1975. time_str = datetime.now().strftime(<span class="hljs-string">'%Y%m%d%H%M%S'</span>)
  1976. filename = <span class="hljs-string">f'profile-<span class="hljs-subst">{time_str}</span>.png'</span>
  1977. drawer = output.GraphvizOutput(output_file=filename)
  1978. <span class="hljs-keyword">with</span> PyCallGraph(drawer):
  1979. &lt;code_to_be_profiled&gt;
  1980. </code></pre>
  1981. <h2 id="numpy"><a href="#numpy" name="numpy">#</a>NumPy</h2>
  1982. <p><strong>Array manipulation mini language. Can run up to one hundred times faster than equivalent Python code.</strong></p>
  1983. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install numpy</span>
  1984. <span class="hljs-keyword">import</span> numpy <span class="hljs-keyword">as</span> np
  1985. </code></pre>
  1986. <pre><code class="python language-python hljs">&lt;array&gt; = np.array(&lt;list&gt;)
  1987. &lt;array&gt; = np.arange(from_inclusive, to_exclusive, ±step_size)
  1988. &lt;array&gt; = np.ones(&lt;shape&gt;)
  1989. &lt;array&gt; = np.random.randint(from_inclusive, to_exclusive, &lt;shape&gt;)
  1990. </code></pre>
  1991. <pre><code class="python language-python hljs">&lt;array&gt;.shape = &lt;shape&gt;
  1992. &lt;view&gt; = &lt;array&gt;.reshape(&lt;shape&gt;)
  1993. &lt;view&gt; = np.broadcast_to(&lt;array&gt;, &lt;shape&gt;)
  1994. </code></pre>
  1995. <pre><code class="python language-python hljs">&lt;array&gt; = &lt;array&gt;.sum(axis)
  1996. indexes = &lt;array&gt;.argmin(axis)
  1997. </code></pre>
  1998. <ul>
  1999. <li><strong>Shape is a tuple of dimension sizes.</strong></li>
  2000. <li><strong>Axis is an index of dimension that gets collapsed. Leftmost dimension has index 0.</strong></li>
  2001. </ul>
  2002. <h3 id="indexing">Indexing</h3>
  2003. <pre><code class="bash language-bash hljs">&lt;el&gt; = &lt;2d_array&gt;[0, 0] <span class="hljs-comment"># First element.</span>
  2004. &lt;1d_view&gt; = &lt;2d_array&gt;[0] <span class="hljs-comment"># First row.</span>
  2005. &lt;1d_view&gt; = &lt;2d_array&gt;[:, 0] <span class="hljs-comment"># First column. Also [..., 0].</span>
  2006. &lt;3d_view&gt; = &lt;2d_array&gt;[None, :, :] <span class="hljs-comment"># Expanded by dimension of size 1.</span>
  2007. </code></pre>
  2008. <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;]
  2009. &lt;2d_array&gt; = &lt;2d_array&gt;[&lt;2d_row_indexes&gt;, &lt;2d_column_indexes&gt;]
  2010. </code></pre>
  2011. <pre><code class="bash language-bash hljs">&lt;2d_bools&gt; = &lt;2d_array&gt; &gt; 0
  2012. &lt;1d_array&gt; = &lt;2d_array&gt;[&lt;2d_bools&gt;]
  2013. </code></pre>
  2014. <ul>
  2015. <li><strong>If row and column indexes differ in shape, they are combined with broadcasting.</strong></li>
  2016. </ul>
  2017. <h3 id="broadcasting">Broadcasting</h3>
  2018. <p><strong>Broadcasting is a set of rules by which NumPy functions operate on arrays of different sizes and/or dimensions.</strong></p>
  2019. <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>
  2020. 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>
  2021. </code></pre>
  2022. <h4 id="1ifarrayshapesdifferinlengthleftpadtheshortershapewithones">1. If array shapes differ in length, left-pad the shorter shape with ones:</h4>
  2023. <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>
  2024. 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>
  2025. </code></pre>
  2026. <h4 id="2ifanydimensionsdifferinsizeexpandtheonesthathavesize1byduplicatingtheirelements">2. If any dimensions differ in size, expand the ones that have size 1 by duplicating their elements:</h4>
  2027. <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>
  2028. 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>
  2029. </code></pre>
  2030. <h4 id="3ifneithernonmatchingdimensionhassize1riseanerror">3. If neither non-matching dimension has size 1, rise an error.</h4>
  2031. <h3 id="example-1">Example</h3>
  2032. <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>
  2033. <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>])
  2034. [ <span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>]
  2035. <span class="hljs-meta">&gt;&gt;&gt; </span>wrapped_points = points.reshape(<span class="hljs-number">3</span>, <span class="hljs-number">1</span>)
  2036. [[ <span class="hljs-number">0.1</span>],
  2037. [ <span class="hljs-number">0.6</span>],
  2038. [ <span class="hljs-number">0.8</span>]]
  2039. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = wrapped_points - points
  2040. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">-0.5</span>, <span class="hljs-number">-0.7</span>],
  2041. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">-0.2</span>],
  2042. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  2043. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = np.abs(distances)
  2044. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  2045. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">0.2</span>],
  2046. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  2047. <span class="hljs-meta">&gt;&gt;&gt; </span>i = np.arange(<span class="hljs-number">3</span>)
  2048. [<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>]
  2049. <span class="hljs-meta">&gt;&gt;&gt; </span>distances[i, i] = np.inf
  2050. [[ inf, <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  2051. [ <span class="hljs-number">0.5</span>, inf, <span class="hljs-number">0.2</span>],
  2052. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, inf]]
  2053. <span class="hljs-meta">&gt;&gt;&gt; </span>distances.argmin(<span class="hljs-number">1</span>)
  2054. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">1</span>]
  2055. </code></pre>
  2056. <h2 id="image"><a href="#image" name="image">#</a>Image</h2>
  2057. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pillow</span>
  2058. <span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> Image
  2059. </code></pre>
  2060. <h4 id="createsapngimageofarainbowgradient">Creates a PNG image of a rainbow gradient:</h4>
  2061. <pre><code class="python language-python hljs">width = <span class="hljs-number">100</span>
  2062. height = <span class="hljs-number">100</span>
  2063. size = width * height
  2064. pixels = [<span class="hljs-number">255</span> * i/size <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(size)]
  2065. img = Image.new(<span class="hljs-string">'HSV'</span>, (width, height))
  2066. 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])
  2067. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  2068. </code></pre>
  2069. <h4 id="addsnoisetoapngimage">Adds noise to a PNG image:</h4>
  2070. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  2071. 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>)))
  2072. img = Image.open(<span class="hljs-string">'test.png'</span>).convert(mode=<span class="hljs-string">'HSV'</span>)
  2073. img.putdata([(add_noise(h), s, v) <span class="hljs-keyword">for</span> h, s, v <span class="hljs-keyword">in</span> img.getdata()])
  2074. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  2075. </code></pre>
  2076. <h3 id="modes-1">Modes</h3>
  2077. <ul>
  2078. <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>
  2079. <li><strong><code class="python hljs"><span class="hljs-string">'L'</span></code> - 8-bit pixels, greyscale.</strong></li>
  2080. <li><strong><code class="python hljs"><span class="hljs-string">'RGB'</span></code> - 3x8-bit pixels, true color.</strong></li>
  2081. <li><strong><code class="python hljs"><span class="hljs-string">'RGBA'</span></code> - 4x8-bit pixels, true color with transparency mask.</strong></li>
  2082. <li><strong><code class="python hljs"><span class="hljs-string">'HSV'</span></code> - 3x8-bit pixels, Hue, Saturation, Value color space.</strong></li>
  2083. </ul>
  2084. <h2 id="audio"><a href="#audio" name="audio">#</a>Audio</h2>
  2085. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> wave
  2086. <span class="hljs-keyword">from</span> struct <span class="hljs-keyword">import</span> pack, iter_unpack
  2087. </code></pre>
  2088. <h3 id="readframesfromwavfile">Read Frames from WAV File</h3>
  2089. <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>
  2090. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> wf:
  2091. frames = wf.readframes(wf.getnframes())
  2092. <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)]
  2093. </code></pre>
  2094. <h3 id="writeframestowavfile">Write Frames to WAV File</h3>
  2095. <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>
  2096. 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)
  2097. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> wf:
  2098. 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>)
  2099. wf.setsampwidth(<span class="hljs-number">2</span>)
  2100. wf.setframerate(<span class="hljs-number">44100</span>)
  2101. wf.writeframes(<span class="hljs-string">b''</span>.join(frames_short))
  2102. </code></pre>
  2103. <h3 id="examples">Examples</h3>
  2104. <h4 id="savesasinewavetoamonowavfile">Saves a sine wave to a mono WAV file:</h4>
  2105. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> pi, sin
  2106. 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>))
  2107. 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)
  2108. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  2109. </code></pre>
  2110. <h4 id="addsnoisetoamonowavfile">Adds noise to a mono WAV file:</h4>
  2111. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  2112. 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>)))
  2113. 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>))
  2114. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  2115. </code></pre>
  2116. <h3 id="synthesizer">Synthesizer</h3>
  2117. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install simpleaudio</span>
  2118. <span class="hljs-keyword">import</span> simpleaudio, math, struct
  2119. <span class="hljs-keyword">from</span> itertools <span class="hljs-keyword">import</span> chain, repeat
  2120. F = <span class="hljs-number">44100</span>
  2121. P1 = <span class="hljs-string">'71♪,69,,71♪,66,,62♪,66,,59♪,,,'</span>
  2122. P2 = <span class="hljs-string">'71♪,73,,74♪,73,,74,,71,,73♪,71,,73,,69,,71♪,69,,71,,67,,71♪,,,'</span>
  2123. get_pause = <span class="hljs-keyword">lambda</span> seconds: repeat(<span class="hljs-number">0</span>, int(seconds * F))
  2124. sin_f = <span class="hljs-keyword">lambda</span> i, hz: math.sin(i * <span class="hljs-number">2</span> * math.pi * hz / F)
  2125. 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)))
  2126. 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>)
  2127. parse_note = <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>)
  2128. get_frames = <span class="hljs-keyword">lambda</span> note: get_wave(*parse_note(note)) <span class="hljs-keyword">if</span> note <span class="hljs-keyword">else</span> get_pause(<span class="hljs-number">0.125</span>)
  2129. frames_f = chain.from_iterable(get_frames(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>))
  2130. frames_b = <span class="hljs-string">b''</span>.join(struct.pack(<span class="hljs-string">'&lt;h'</span>, int(f * <span class="hljs-number">30000</span>)) <span class="hljs-keyword">for</span> f <span class="hljs-keyword">in</span> frames_f)
  2131. simpleaudio.play_buffer(frames_b, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, F)
  2132. </code></pre>
  2133. <h2 id="basicscripttemplate"><a href="#basicscripttemplate" name="basicscripttemplate">#</a>Basic Script Template</h2>
  2134. <pre><code class="python language-python hljs"><span class="hljs-comment">#!/usr/bin/env python3</span>
  2135. <span class="hljs-comment">#</span>
  2136. <span class="hljs-comment"># Usage: .py</span>
  2137. <span class="hljs-comment">#</span>
  2138. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  2139. <span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
  2140. <span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  2141. <span class="hljs-keyword">import</span> re
  2142. <span class="hljs-keyword">import</span> sys
  2143. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  2144. <span class="hljs-keyword">pass</span>
  2145. <span class="hljs-comment">###</span>
  2146. <span class="hljs-comment">## UTIL</span>
  2147. <span class="hljs-comment">#</span>
  2148. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_file</span><span class="hljs-params">(filename)</span>:</span>
  2149. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  2150. <span class="hljs-keyword">return</span> file.readlines()
  2151. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  2152. main()
  2153. </code></pre>
  2154. <footer>
  2155. <aside>March 14, 2018</aside>
  2156. <a href="../" rel="author">Jure Šorn</a>
  2157. </footer>
  2158. <br>
  2159. <br>
  2160. <br>
  2161. <script src="web/jquery-3.4.0.min.js"></script>
  2162. <script src="web/script_2.js"></script>
  2163. </body>
  2164. </html>