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.

1875 lines
151 KiB

6 years ago
6 years ago
6 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
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 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">Dict</a>, <a href="#set">Set</a>, <a href="#range">Range</a>, <a href="#enumerate">Enumerate</a>, <a href="#namedtuple">Namedtuple</a>, <a href="#iterator">Iterator</a>, <a href="#generator">Generator</a>],
  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">Regex</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 first index of item 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">Frozenset</h3>
  255. <h4 id="ishashablemeaningitcanbeusedasakeyinadictionaryorasanelementinaset">Is hashable, meaning it can be used as a key in a dictionary or as an element in a set.</h4>
  256. <pre><code class="python language-python hljs">&lt;frozenset&gt; = frozenset(&lt;collection&gt;)
  257. </code></pre>
  258. <h2 id="range"><a href="#range" name="range">#</a>Range</h2>
  259. <pre><code class="python language-python hljs">&lt;range&gt; = range(to_exclusive)
  260. &lt;range&gt; = range(from_inclusive, to_exclusive)
  261. &lt;range&gt; = range(from_inclusive, to_exclusive, ±step_size)
  262. </code></pre>
  263. <pre><code class="python language-python hljs">from_inclusive = &lt;range&gt;.start
  264. to_exclusive = &lt;range&gt;.stop
  265. </code></pre>
  266. <h2 id="enumerate"><a href="#enumerate" name="enumerate">#</a>Enumerate</h2>
  267. <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]):
  268. ...
  269. </code></pre>
  270. <h2 id="namedtuple"><a href="#namedtuple" name="namedtuple">#</a>Named Tuple</h2>
  271. <ul>
  272. <li><strong>Tuple is an immutable and hashable list.</strong></li>
  273. <li><strong>Named tuple is its subclass with named elements.</strong></li>
  274. </ul>
  275. <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
  276. <span class="hljs-meta">&gt;&gt;&gt; </span>Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  277. <span class="hljs-meta">&gt;&gt;&gt; </span>p = Point(<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  278. Point(x=<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
  279. <span class="hljs-meta">&gt;&gt;&gt; </span>p[<span class="hljs-number">0</span>]
  280. <span class="hljs-number">1</span>
  281. <span class="hljs-meta">&gt;&gt;&gt; </span>p.x
  282. <span class="hljs-number">1</span>
  283. <span class="hljs-meta">&gt;&gt;&gt; </span>getattr(p, <span class="hljs-string">'y'</span>)
  284. <span class="hljs-number">2</span>
  285. <span class="hljs-meta">&gt;&gt;&gt; </span>p._fields <span class="hljs-comment"># Or: Point._fields</span>
  286. (<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>)
  287. </code></pre>
  288. <h2 id="iterator"><a href="#iterator" name="iterator">#</a>Iterator</h2>
  289. <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
  290. </code></pre>
  291. <pre><code class="python language-python hljs">&lt;iter&gt; = iter(&lt;collection&gt;)
  292. &lt;iter&gt; = iter(&lt;function&gt;, to_exclusive) <span class="hljs-comment"># Sequence of return values until 'to_exclusive'.</span>
  293. &lt;el&gt; = next(&lt;iter&gt; [, default]) <span class="hljs-comment"># Raises StopIteration or returns 'default' on end.</span>
  294. </code></pre>
  295. <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>
  296. &lt;iter&gt; = repeat(&lt;el&gt; [, times]) <span class="hljs-comment"># Returns element endlessly or 'times' times.</span>
  297. &lt;iter&gt; = cycle(&lt;collection&gt;) <span class="hljs-comment"># Repeats the sequence indefinitely.</span>
  298. </code></pre>
  299. <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>
  300. &lt;iter&gt; = chain.from_iterable(&lt;collection&gt;) <span class="hljs-comment"># Empties collections inside a collection in order.</span>
  301. </code></pre>
  302. <pre><code class="python language-python hljs">&lt;iter&gt; = islice(&lt;collection&gt;, to_exclusive)
  303. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive)
  304. &lt;iter&gt; = islice(&lt;collection&gt;, from_inclusive, to_exclusive, step_size)
  305. </code></pre>
  306. <h2 id="generator"><a href="#generator" name="generator">#</a>Generator</h2>
  307. <p><strong>Convenient way to implement the iterator protocol.</strong></p>
  308. <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>
  309. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  310. <span class="hljs-keyword">yield</span> start
  311. start += step
  312. </code></pre>
  313. <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>)
  314. <span class="hljs-meta">&gt;&gt;&gt; </span>next(counter), next(counter), next(counter)
  315. (<span class="hljs-number">10</span>, <span class="hljs-number">12</span>, <span class="hljs-number">14</span>)
  316. </code></pre>
  317. <h2 id="type"><a href="#type" name="type">#</a>Type</h2>
  318. <ul>
  319. <li><strong>Everything is an object.</strong></li>
  320. <li><strong>Every object has a type.</strong></li>
  321. <li><strong>Type and class are synonymous.</strong></li>
  322. </ul>
  323. <pre><code class="python language-python hljs">&lt;type&gt; = type(&lt;el&gt;) <span class="hljs-comment"># Or: &lt;el&gt;.__class__</span>
  324. &lt;bool&gt; = isinstance(&lt;el&gt;, &lt;type&gt;) <span class="hljs-comment"># Or: issubclass(type(&lt;el&gt;), &lt;type&gt;)</span>
  325. </code></pre>
  326. <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
  327. (&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;)
  328. </span></code></pre>
  329. <h4 id="sometypesdonothavebuiltinnamessotheymustbeimported">Some types do not have builtin names, so they must be imported:</h4>
  330. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> types <span class="hljs-keyword">import</span> FunctionType, MethodType, LambdaType, GeneratorType
  331. </code></pre>
  332. <h3 id="abc">ABC</h3>
  333. <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>
  334. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> numbers <span class="hljs-keyword">import</span> Integral, Rational, Real, Complex, Number
  335. <span class="hljs-keyword">from</span> collections.abc <span class="hljs-keyword">import</span> Sequence, Collection, Iterable
  336. </code></pre>
  337. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>isinstance(<span class="hljs-number">123</span>, Number)
  338. <span class="hljs-keyword">True</span>
  339. <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)
  340. <span class="hljs-keyword">True</span>
  341. </code></pre>
  342. <h2 id="string"><a href="#string" name="string">#</a>String</h2>
  343. <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>
  344. &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>
  345. </code></pre>
  346. <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>
  347. &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>
  348. &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>
  349. &lt;str&gt; = &lt;str&gt;.join(&lt;collection&gt;) <span class="hljs-comment"># Joins elements using string as separator.</span>
  350. </code></pre>
  351. <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>
  352. &lt;bool&gt; = &lt;str&gt;.startswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  353. &lt;bool&gt; = &lt;str&gt;.endswith(&lt;sub_str&gt;) <span class="hljs-comment"># Pass tuple of strings for multiple options.</span>
  354. &lt;int&gt; = &lt;str&gt;.find(&lt;sub_str&gt;) <span class="hljs-comment"># Returns start index of first match or -1.</span>
  355. &lt;int&gt; = &lt;str&gt;.index(&lt;sub_str&gt;) <span class="hljs-comment"># Same but raises ValueError.</span>
  356. </code></pre>
  357. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;str&gt;.isnumeric() <span class="hljs-comment"># True if str contains only numeric characters.</span>
  358. &lt;list&gt; = textwrap.wrap(&lt;str&gt;, width) <span class="hljs-comment"># Nicely breaks string into lines.</span>
  359. </code></pre>
  360. <ul>
  361. <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>
  362. <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>
  363. </ul>
  364. <h3 id="char">Char</h3>
  365. <pre><code class="python language-python hljs">&lt;str&gt; = chr(&lt;int&gt;) <span class="hljs-comment"># Converts int to unicode char.</span>
  366. &lt;int&gt; = ord(&lt;str&gt;) <span class="hljs-comment"># Converts unicode char to int.</span>
  367. </code></pre>
  368. <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>)
  369. (<span class="hljs-number">48</span>, <span class="hljs-number">57</span>)
  370. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'A'</span>), ord(<span class="hljs-string">'Z'</span>)
  371. (<span class="hljs-number">65</span>, <span class="hljs-number">90</span>)
  372. <span class="hljs-meta">&gt;&gt;&gt; </span>ord(<span class="hljs-string">'a'</span>), ord(<span class="hljs-string">'z'</span>)
  373. (<span class="hljs-number">97</span>, <span class="hljs-number">122</span>)
  374. </code></pre>
  375. <h2 id="regex"><a href="#regex" name="regex">#</a>Regex</h2>
  376. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> re
  377. &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>
  378. &lt;list&gt; = re.findall(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences.</span>
  379. &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>
  380. &lt;Match&gt; = re.search(&lt;regex&gt;, text) <span class="hljs-comment"># Searches for first occurrence of pattern.</span>
  381. &lt;Match&gt; = re.match(&lt;regex&gt;, text) <span class="hljs-comment"># Searches only at the beginning of the text.</span>
  382. &lt;iter&gt; = re.finditer(&lt;regex&gt;, text) <span class="hljs-comment"># Returns all occurrences as match objects.</span>
  383. </code></pre>
  384. <ul>
  385. <li><strong>Parameter <code class="python hljs"><span class="hljs-string">'flags=re.IGNORECASE'</span></code> can be used with all functions.</strong></li>
  386. <li><strong>Parameter <code class="python hljs"><span class="hljs-string">'flags=re.DOTALL'</span></code> makes dot also accept newline.</strong></li>
  387. <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>
  388. <li><strong>Use <code class="python hljs"><span class="hljs-string">'?'</span></code> to make an operator non-greedy.</strong></li>
  389. </ul>
  390. <h3 id="matchobject">Match Object</h3>
  391. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Match&gt;.group() <span class="hljs-comment"># Whole match.</span>
  392. &lt;str&gt; = &lt;Match&gt;.group(<span class="hljs-number">1</span>) <span class="hljs-comment"># Part in first bracket.</span>
  393. &lt;tuple&gt; = &lt;Match&gt;.groups() <span class="hljs-comment"># All bracketed parts.</span>
  394. &lt;int&gt; = &lt;Match&gt;.start() <span class="hljs-comment"># Start index of a match.</span>
  395. &lt;int&gt; = &lt;Match&gt;.end() <span class="hljs-comment"># Exclusive end index of a match.</span>
  396. </code></pre>
  397. <h3 id="specialsequences">Special Sequences</h3>
  398. <p><strong>Expressions below hold true for strings that contain only ASCII characters. Use capital letters for negation.</strong></p>
  399. <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>
  400. <span class="hljs-string">'\s'</span> == <span class="hljs-string">'[ \t\n\r\f\v]'</span> <span class="hljs-comment"># Whitespace</span>
  401. <span class="hljs-string">'\w'</span> == <span class="hljs-string">'[a-zA-Z0-9_]'</span> <span class="hljs-comment"># Alphanumeric</span>
  402. </code></pre>
  403. <h2 id="format"><a href="#format" name="format">#</a>Format</h2>
  404. <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>
  405. &lt;str&gt; = <span class="hljs-string">'{}, {}'</span>.format(&lt;el_1&gt;, &lt;el_2&gt;)
  406. </code></pre>
  407. <h3 id="attributes">Attributes</h3>
  408. <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
  409. <span class="hljs-meta">&gt;&gt;&gt; </span>Person = namedtuple(<span class="hljs-string">'Person'</span>, <span class="hljs-string">'name height'</span>)
  410. <span class="hljs-meta">&gt;&gt;&gt; </span>person = Person(<span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>)
  411. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">f'<span class="hljs-subst">{person.height}</span>'</span>
  412. <span class="hljs-string">'187'</span>
  413. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-string">'{p.height}'</span>.format(p=person)
  414. <span class="hljs-string">'187'</span>
  415. </code></pre>
  416. <h3 id="generaloptions">General Options</h3>
  417. <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>
  418. {&lt;el&gt;:^<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt; '</span>
  419. {&lt;el&gt;:&gt;<span class="hljs-number">10</span>} <span class="hljs-comment"># ' &lt;el&gt;'</span>
  420. </code></pre>
  421. <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>
  422. {&lt;el&gt;:&gt;<span class="hljs-number">0</span>} <span class="hljs-comment"># '&lt;el&gt;'</span>
  423. </code></pre>
  424. <h3 id="stringoptions">String Options</h3>
  425. <p><strong><code class="python hljs"><span class="hljs-string">'!r'</span></code> calls object's repr() method, instead of format(), to get a string.</strong></p>
  426. <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>
  427. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">.3</span>} <span class="hljs-comment"># 'abc'</span>
  428. {<span class="hljs-string">'abcde'</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># 'abc '</span>
  429. </code></pre>
  430. <h3 id="numberoptions">Number Options</h3>
  431. <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>
  432. { <span class="hljs-number">123456</span>:<span class="hljs-number">10</span>_} <span class="hljs-comment"># ' 123_456'</span>
  433. { <span class="hljs-number">123456</span>:+<span class="hljs-number">10</span>} <span class="hljs-comment"># ' +123456'</span>
  434. {<span class="hljs-number">-123456</span>:=<span class="hljs-number">10</span>} <span class="hljs-comment"># '- 123456'</span>
  435. { <span class="hljs-number">123456</span>: } <span class="hljs-comment"># ' 123456'</span>
  436. {<span class="hljs-number">-123456</span>: } <span class="hljs-comment"># '-123456'</span>
  437. </code></pre>
  438. <h4 id="floattypes">Float types:</h4>
  439. <pre><code class="python language-python hljs">{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>f} <span class="hljs-comment"># ' 1.235'</span>
  440. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>e} <span class="hljs-comment"># ' 1.235e+00'</span>
  441. {<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>%} <span class="hljs-comment"># ' 123.456%'</span>
  442. </code></pre>
  443. <h4 id="inttypes">Int types:</h4>
  444. <pre><code class="python language-python hljs">{<span class="hljs-number">90</span>:c} <span class="hljs-comment"># 'Z'</span>
  445. {<span class="hljs-number">90</span>:X} <span class="hljs-comment"># '5A'</span>
  446. {<span class="hljs-number">90</span>:b} <span class="hljs-comment"># '1011010'</span>
  447. </code></pre>
  448. <h2 id="numbers"><a href="#numbers" name="numbers">#</a>Numbers</h2>
  449. <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>
  450. &lt;float&gt; = float(&lt;int/str/bool&gt;)
  451. &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>
  452. </code></pre>
  453. <ul>
  454. <li><strong><code class="python hljs"><span class="hljs-string">'int()'</span></code> and <code class="python hljs"><span class="hljs-string">'float()'</span></code> raise ValueError on malformed string.</strong></li>
  455. </ul>
  456. <h3 id="basicfunctions">Basic Functions</h3>
  457. <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>
  458. &lt;real&gt; = abs(&lt;num&gt;)
  459. &lt;int&gt; = round(&lt;real&gt;)
  460. &lt;real&gt; = round(&lt;real&gt;, ±ndigits)
  461. </code></pre>
  462. <h3 id="math">Math</h3>
  463. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> e, pi, inf, nan
  464. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> cos, acos, sin, asin, tan, atan, degrees, radians
  465. <span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> log, log10, log2
  466. </code></pre>
  467. <h3 id="statistics">Statistics</h3>
  468. <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
  469. </code></pre>
  470. <h3 id="random">Random</h3>
  471. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> random, randint, choice, shuffle
  472. &lt;float&gt; = random()
  473. &lt;int&gt; = randint(from_inclusive, to_inclusive)
  474. &lt;el&gt; = choice(&lt;list&gt;)
  475. shuffle(&lt;list&gt;)
  476. </code></pre>
  477. <h3 id="binhex">Bin, Hex</h3>
  478. <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>
  479. &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>
  480. &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>
  481. <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>
  482. </code></pre>
  483. <h3 id="bitwiseoperators">Bitwise Operators</h3>
  484. <pre><code class="python language-python hljs">&lt;int&gt; = &lt;int&gt; &amp; &lt;int&gt; <span class="hljs-comment"># And</span>
  485. &lt;int&gt; = &lt;int&gt; | &lt;int&gt; <span class="hljs-comment"># Or</span>
  486. &lt;int&gt; = &lt;int&gt; ^ &lt;int&gt; <span class="hljs-comment"># Xor (0 if both bits equal)</span>
  487. &lt;int&gt; = &lt;int&gt; &lt;&lt; n_bits <span class="hljs-comment"># Shift left</span>
  488. &lt;int&gt; = &lt;int&gt; &gt;&gt; n_bits <span class="hljs-comment"># Shift right</span>
  489. &lt;int&gt; = ~&lt;int&gt; <span class="hljs-comment"># Compliment (flips bits)</span>
  490. </code></pre>
  491. <h2 id="combinatorics"><a href="#combinatorics" name="combinatorics">#</a>Combinatorics</h2>
  492. <ul>
  493. <li><strong>Every function returns an iterator.</strong></li>
  494. <li><strong>If you want to print the iterator, you need to pass it to the list() function!</strong></li>
  495. </ul>
  496. <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
  497. </code></pre>
  498. <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>)
  499. [(<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>),
  500. (<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>)]
  501. </code></pre>
  502. <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>)
  503. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'2'</span>),
  504. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'1'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'2'</span>)]
  505. </code></pre>
  506. <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>)
  507. [(<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>)]
  508. </code></pre>
  509. <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>)
  510. [(<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>),
  511. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  512. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'c'</span>)]
  513. </code></pre>
  514. <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>)
  515. [(<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'a'</span>, <span class="hljs-string">'c'</span>),
  516. (<span class="hljs-string">'b'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>),
  517. (<span class="hljs-string">'c'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'c'</span>, <span class="hljs-string">'b'</span>)]
  518. </code></pre>
  519. <h2 id="datetime"><a href="#datetime" name="datetime">#</a>Datetime</h2>
  520. <ul>
  521. <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>
  522. <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>
  523. <li><strong>If object is naive it is presumed to be in system's timezone.</strong></li>
  524. </ul>
  525. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> date, time, datetime, timedelta
  526. <span class="hljs-keyword">from</span> dateutil.tz <span class="hljs-keyword">import</span> UTC, tzlocal, gettz
  527. </code></pre>
  528. <h3 id="constructors">Constructors</h3>
  529. <pre><code class="python language-python apache hljs">&lt;D&gt; = date(year, month, day)
  530. &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>)
  531. &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>, ...)
  532. &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>,
  533. minutes=<span class="hljs-number">0</span>, hours=<span class="hljs-number">0</span>, weeks=<span class="hljs-number">0</span>)
  534. </code></pre>
  535. <ul>
  536. <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>
  537. <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>
  538. </ul>
  539. <h3 id="now">Now</h3>
  540. <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>
  541. &lt;DTn&gt; = DT.utcnow() <span class="hljs-comment"># Naive datetime from current UTC time.</span>
  542. &lt;DTa&gt; = DT.now(&lt;tz&gt;) <span class="hljs-comment"># Aware datetime from current tz time.</span>
  543. </code></pre>
  544. <h3 id="timezone">Timezone</h3>
  545. <pre><code class="python language-python hljs">&lt;tz&gt; = UTC <span class="hljs-comment"># UTC timezone. London without DST.</span>
  546. &lt;tz&gt; = tzlocal() <span class="hljs-comment"># Local timezone.</span>
  547. &lt;tz&gt; = gettz(<span class="hljs-string">'&lt;Cont.&gt;/&lt;City&gt;'</span>) <span class="hljs-comment"># Timezone from 'Continent/City_Name' str.</span>
  548. </code></pre>
  549. <pre><code class="python language-python apache hljs">&lt;DTa&gt; = &lt;DT&gt;.astimezone(&lt;tz&gt;) <span class="hljs-comment"># Datetime, converted to passed timezone.</span>
  550. &lt;Ta/DTa&gt; = &lt;T/DT&gt;.replace(tzinfo=&lt;tz&gt;) <span class="hljs-comment"># Unconverted object with new timezone.</span>
  551. </code></pre>
  552. <h3 id="encode">Encode</h3>
  553. <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>
  554. &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>
  555. &lt;D/DTn&gt; = D/DT.fromordinal(&lt;int&gt;) <span class="hljs-comment"># D/DTn from days since Christ.</span>
  556. &lt;DTa&gt; = DT.fromtimestamp(&lt;real&gt;, &lt;tz&gt;) <span class="hljs-comment"># DTa from seconds since Epoch in tz time.</span>
  557. </code></pre>
  558. <ul>
  559. <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>
  560. <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>
  561. </ul>
  562. <h3 id="decode">Decode</h3>
  563. <pre><code class="python language-python apache hljs">&lt;str&gt; = &lt;D/T/DT&gt;.isoformat() <span class="hljs-comment"># ISO string representation.</span>
  564. &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>
  565. &lt;int&gt; = &lt;D/DT&gt;.toordinal() <span class="hljs-comment"># Days since Christ, ignoring time and tz.</span>
  566. &lt;float&gt; = &lt;DT&gt;.timestamp() <span class="hljs-comment"># Seconds since Epoch in local time or tz.</span>
  567. </code></pre>
  568. <h3 id="format-1">Format</h3>
  569. <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
  570. <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>)
  571. <span class="hljs-meta">&gt;&gt;&gt; </span>dt.strftime(<span class="hljs-string">"%A, %dth of %B '%y, %I:%M%p %Z"</span>)
  572. <span class="hljs-string">"Thursday, 14th of May '15, 11:39PM UTC+02:00"</span>
  573. </code></pre>
  574. <h4 id="restofthecodes">Rest of the codes:</h4>
  575. <ul>
  576. <li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Weekday, abbreviated name.</strong></li>
  577. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Month, abbreviated name.</strong></li>
  578. </ul>
  579. <h2 id="arguments"><a href="#arguments" name="arguments">#</a>Arguments</h2>
  580. <h3 id="insidefunctioncall">Inside Function Call</h3>
  581. <pre><code class="python language-python hljs">&lt;function&gt;(&lt;positional_args&gt;) <span class="hljs-comment"># f(0, 0)</span>
  582. &lt;function&gt;(&lt;keyword_args&gt;) <span class="hljs-comment"># f(x=0, y=0)</span>
  583. &lt;function&gt;(&lt;positional_args&gt;, &lt;keyword_args&gt;) <span class="hljs-comment"># f(0, y=0)</span>
  584. </code></pre>
  585. <h3 id="insidefunctiondefinition">Inside Function Definition</h3>
  586. <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>
  587. <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>
  588. <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>
  589. </code></pre>
  590. <h2 id="splatoperator"><a href="#splatoperator" name="splatoperator">#</a>Splat Operator</h2>
  591. <h3 id="insidefunctioncall-1">Inside Function Call</h3>
  592. <p><strong>Splat expands a collection into positional arguments, while splatty-splat expands a dictionary into keyword arguments.</strong></p>
  593. <pre><code class="python language-python hljs">args = (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>)
  594. 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>}
  595. func(*args, **kwargs)
  596. </code></pre>
  597. <h4 id="isthesameas">Is the same as:</h4>
  598. <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>)
  599. </code></pre>
  600. <h3 id="insidefunctiondefinition-1">Inside Function Definition</h3>
  601. <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>
  602. <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>
  603. <span class="hljs-keyword">return</span> sum(a)
  604. </code></pre>
  605. <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>)
  606. <span class="hljs-number">6</span>
  607. </code></pre>
  608. <h4 id="legalargumentcombinations">Legal argument combinations:</h4>
  609. <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>
  610. <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>
  611. <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>
  612. <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>
  613. </code></pre>
  614. <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>
  615. <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>
  616. <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>
  617. <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>
  618. </code></pre>
  619. <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>
  620. <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>
  621. <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>
  622. </code></pre>
  623. <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>
  624. <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>
  625. <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>
  626. <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>
  627. </code></pre>
  628. <h3 id="otheruses">Other Uses</h3>
  629. <pre><code class="python language-python hljs">&lt;list&gt; = [*&lt;collection&gt; [, ...]]
  630. &lt;set&gt; = {*&lt;collection&gt; [, ...]}
  631. &lt;tuple&gt; = (*&lt;collection&gt;, [...])
  632. &lt;dict&gt; = {**&lt;dict&gt; [, ...]}
  633. </code></pre>
  634. <pre><code class="python language-python hljs">head, *body, tail = &lt;collection&gt;
  635. </code></pre>
  636. <h2 id="inline"><a href="#inline" name="inline">#</a>Inline</h2>
  637. <h3 id="lambda">Lambda</h3>
  638. <pre><code class="python language-python hljs">&lt;function&gt; = <span class="hljs-keyword">lambda</span>: &lt;return_value&gt;
  639. &lt;function&gt; = <span class="hljs-keyword">lambda</span> &lt;argument_1&gt;, &lt;argument_2&gt;: &lt;return_value&gt;
  640. </code></pre>
  641. <h3 id="comprehension">Comprehension</h3>
  642. <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>
  643. &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>
  644. &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>
  645. &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>
  646. </code></pre>
  647. <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>)]
  648. </code></pre>
  649. <h4 id="isthesameas-1">Is the same as:</h4>
  650. <pre><code class="python language-python hljs">out = []
  651. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  652. <span class="hljs-keyword">for</span> j <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  653. out.append(i+j)
  654. </code></pre>
  655. <h3 id="mapfilterreduce">Map, Filter, Reduce</h3>
  656. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> reduce
  657. &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>
  658. &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>
  659. &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>
  660. </code></pre>
  661. <h3 id="anyall">Any, All</h3>
  662. <pre><code class="python language-python hljs">&lt;bool&gt; = any(&lt;collection&gt;) <span class="hljs-comment"># False if empty.</span>
  663. &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>
  664. </code></pre>
  665. <h3 id="ifelse">If - Else</h3>
  666. <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;
  667. </code></pre>
  668. <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>)]
  669. [<span class="hljs-string">'zero'</span>, <span class="hljs-number">1</span>, <span class="hljs-string">'zero'</span>, <span class="hljs-number">3</span>]
  670. </code></pre>
  671. <h3 id="namedtupleenumdataclass">Namedtuple, Enum, Dataclass</h3>
  672. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  673. Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
  674. point = Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>)
  675. </code></pre>
  676. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  677. Direction = Enum(<span class="hljs-string">'Direction'</span>, <span class="hljs-string">'n e s w'</span>)
  678. direction = Direction.n
  679. </code></pre>
  680. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
  681. Creature = make_dataclass(<span class="hljs-string">'Creature'</span>, [<span class="hljs-string">'location'</span>, <span class="hljs-string">'direction'</span>])
  682. creature = Creature(Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>), Direction.n)
  683. </code></pre>
  684. <h2 id="closure"><a href="#closure" name="closure">#</a>Closure</h2>
  685. <p><strong>We have a closure in Python when:</strong></p>
  686. <ul>
  687. <li><strong>A nested function references a value of its enclosing function and then</strong></li>
  688. <li><strong>the enclosing function returns the nested function.</strong></li>
  689. </ul>
  690. <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>
  691. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(b)</span>:</span>
  692. <span class="hljs-keyword">return</span> a * b
  693. <span class="hljs-keyword">return</span> out
  694. </code></pre>
  695. <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>)
  696. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  697. <span class="hljs-number">30</span>
  698. </code></pre>
  699. <ul>
  700. <li><strong>If multiple nested functions within enclosing function reference the same value, that value gets shared.</strong></li>
  701. <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>
  702. </ul>
  703. <h3 id="partial">Partial</h3>
  704. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  705. &lt;function&gt; = partial(&lt;function&gt; [, &lt;arg_1&gt;, &lt;arg_2&gt;, ...])
  706. </code></pre>
  707. <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
  708. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3 = partial(op.mul, <span class="hljs-number">3</span>)
  709. <span class="hljs-meta">&gt;&gt;&gt; </span>multiply_by_3(<span class="hljs-number">10</span>)
  710. <span class="hljs-number">30</span>
  711. </code></pre>
  712. <h3 id="nonlocal">Nonlocal</h3>
  713. <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>
  714. <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>
  715. i = <span class="hljs-number">0</span>
  716. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">()</span>:</span>
  717. <span class="hljs-keyword">nonlocal</span> i
  718. i += <span class="hljs-number">1</span>
  719. <span class="hljs-keyword">return</span> i
  720. <span class="hljs-keyword">return</span> out
  721. </code></pre>
  722. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = get_counter()
  723. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  724. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  725. </code></pre>
  726. <h2 id="decorator"><a href="#decorator" name="decorator">#</a>Decorator</h2>
  727. <p><strong>A decorator takes a function, adds some functionality and returns it.</strong></p>
  728. <pre><code class="python language-python hljs"><span class="hljs-meta">@decorator_name</span>
  729. <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>
  730. ...
  731. </code></pre>
  732. <h3 id="debuggerexample">Debugger Example</h3>
  733. <p><strong>Decorator that prints function's name every time it gets called.</strong></p>
  734. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  735. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(func)</span>:</span>
  736. <span class="hljs-meta"> @wraps(func)</span>
  737. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  738. print(func.__name__)
  739. <span class="hljs-keyword">return</span> func(*args, **kwargs)
  740. <span class="hljs-keyword">return</span> out
  741. <span class="hljs-meta">@debug</span>
  742. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  743. <span class="hljs-keyword">return</span> x + y
  744. </code></pre>
  745. <ul>
  746. <li><strong>Wraps is a helper decorator that copies metadata of function add() to function out().</strong></li>
  747. <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>
  748. </ul>
  749. <h3 id="lrucache">LRU Cache</h3>
  750. <p><strong>Decorator that caches function's return values. All function's arguments must be hashable.</strong></p>
  751. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> lru_cache
  752. <span class="hljs-meta">@lru_cache(maxsize=None)</span>
  753. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">fib</span><span class="hljs-params">(n)</span>:</span>
  754. <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>)
  755. </code></pre>
  756. <ul>
  757. <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>
  758. </ul>
  759. <h3 id="parametrizeddecorator">Parametrized Decorator</h3>
  760. <p><strong>A decorator that accepts arguments and returns a normal decorator that accepts a function.</strong></p>
  761. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
  762. <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>
  763. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">decorator</span><span class="hljs-params">(func)</span>:</span>
  764. <span class="hljs-meta"> @wraps(func)</span>
  765. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  766. result = func(*args, **kwargs)
  767. print(func.__name__, result <span class="hljs-keyword">if</span> print_result <span class="hljs-keyword">else</span> <span class="hljs-string">''</span>)
  768. <span class="hljs-keyword">return</span> result
  769. <span class="hljs-keyword">return</span> out
  770. <span class="hljs-keyword">return</span> decorator
  771. <span class="hljs-meta">@debug(print_result=True)</span>
  772. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
  773. <span class="hljs-keyword">return</span> x + y
  774. </code></pre>
  775. <h2 id="class"><a href="#class" name="class">#</a>Class</h2>
  776. <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>
  777. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  778. self.a = a
  779. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
  780. class_name = self.__class__.__name__
  781. <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>
  782. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__str__</span><span class="hljs-params">(self)</span>:</span>
  783. <span class="hljs-keyword">return</span> str(self.a)
  784. <span class="hljs-meta"> @classmethod</span>
  785. <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>
  786. <span class="hljs-keyword">return</span> cls.__name__
  787. </code></pre>
  788. <ul>
  789. <li><strong>Return value of repr() should be unambiguous and of str() readable.</strong></li>
  790. <li><strong>If only repr() is defined, it will also be used for str().</strong></li>
  791. </ul>
  792. <h3 id="constructoroverloading">Constructor Overloading</h3>
  793. <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>
  794. <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>
  795. self.a = a
  796. </code></pre>
  797. <h3 id="inheritance">Inheritance</h3>
  798. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span>:</span>
  799. <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>
  800. self.name = name
  801. self.age = age
  802. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Employee</span><span class="hljs-params">(Person)</span>:</span>
  803. <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>
  804. super().__init__(name, age)
  805. self.staff_num = staff_num
  806. </code></pre>
  807. <h3 id="multipleinheritance">Multiple Inheritance</h3>
  808. <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>
  809. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">B</span>:</span> <span class="hljs-keyword">pass</span>
  810. <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>
  811. </code></pre>
  812. <p><strong>MRO determines the order in which parent classes are traversed when searching for a method:</strong></p>
  813. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>C.mro()
  814. [&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;]
  815. </span></code></pre>
  816. <h3 id="property">Property</h3>
  817. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span>:</span>
  818. <span class="hljs-meta"> @property</span>
  819. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
  820. <span class="hljs-keyword">return</span> self._a
  821. <span class="hljs-meta"> @a.setter</span>
  822. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self, value)</span>:</span>
  823. self._a = value
  824. </code></pre>
  825. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>el = MyClass()
  826. <span class="hljs-meta">&gt;&gt;&gt; </span>el.a = <span class="hljs-number">123</span>
  827. <span class="hljs-meta">&gt;&gt;&gt; </span>el.a
  828. <span class="hljs-number">123</span>
  829. </code></pre>
  830. <h3 id="dataclass">Dataclass</h3>
  831. <p><strong>Decorator that automatically generates init(), repr() and eq() special methods.</strong></p>
  832. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> dataclass, field
  833. <span class="hljs-meta">@dataclass(order=False, frozen=False)</span>
  834. <span class="hljs-class"><span class="hljs-keyword">class</span> &lt;<span class="hljs-title">class_name</span>&gt;:</span>
  835. &lt;attr_name_1&gt;: &lt;type&gt;
  836. &lt;attr_name_2&gt;: &lt;type&gt; = &lt;default_value&gt;
  837. &lt;attr_name_3&gt;: list/dict/set = field(default_factory=list/dict/set)
  838. </code></pre>
  839. <ul>
  840. <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>
  841. <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>
  842. <li><strong>Default_factory can be any callable.</strong></li>
  843. </ul>
  844. <h3 id="copy">Copy</h3>
  845. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> copy <span class="hljs-keyword">import</span> copy, deepcopy
  846. &lt;object&gt; = copy(&lt;object&gt;)
  847. &lt;object&gt; = deepcopy(&lt;object&gt;)
  848. </code></pre>
  849. <h2 id="ducktypes"><a href="#ducktypes" name="ducktypes">#</a>Duck Types</h2>
  850. <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>
  851. <h3 id="comparable">Comparable</h3>
  852. <ul>
  853. <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>
  854. <li><strong>That means all objects compare not equal by default.</strong></li>
  855. <li><strong>Only left side object has eq() method called, unless it returns 'NotImplemented', in which case the right object is consulted.</strong></li>
  856. </ul>
  857. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyComparable</span>:</span>
  858. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  859. self.a = a
  860. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  861. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  862. <span class="hljs-keyword">return</span> self.a == other.a
  863. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  864. </code></pre>
  865. <h3 id="hashable">Hashable</h3>
  866. <ul>
  867. <li><strong>Hashable object needs both hash() and eq() methods and its hash value should never change.</strong></li>
  868. <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>
  869. <li><strong>That is why Python automatically makes classes unhashable if you only implement eq().</strong></li>
  870. </ul>
  871. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyHashable</span>:</span>
  872. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  873. self._a = copy.deepcopy(a)
  874. <span class="hljs-meta"> @property</span>
  875. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
  876. <span class="hljs-keyword">return</span> self._a
  877. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  878. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  879. <span class="hljs-keyword">return</span> self.a == other.a
  880. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  881. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__hash__</span><span class="hljs-params">(self)</span>:</span>
  882. <span class="hljs-keyword">return</span> hash(self.a)
  883. </code></pre>
  884. <h3 id="sortable">Sortable</h3>
  885. <ul>
  886. <li><strong>With 'total_ordering' decorator you only need to provide one of lt(), gt(), le() or ge() special methods.</strong></li>
  887. </ul>
  888. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> total_ordering
  889. <span class="hljs-meta">@total_ordering</span>
  890. <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySortable</span>:</span>
  891. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  892. self.a = a
  893. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
  894. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  895. <span class="hljs-keyword">return</span> self.a == other.a
  896. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  897. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__lt__</span><span class="hljs-params">(self, other)</span>:</span>
  898. <span class="hljs-keyword">if</span> isinstance(other, type(self)):
  899. <span class="hljs-keyword">return</span> self.a &lt; other.a
  900. <span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
  901. </code></pre>
  902. <h3 id="collection">Collection</h3>
  903. <ul>
  904. <li><strong>Methods do not depend on each other, so they can be skipped if not needed.</strong></li>
  905. <li><strong>Any object with defined getitem() is considered iterable, even if it lacks iter().</strong></li>
  906. </ul>
  907. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyCollection</span>:</span>
  908. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
  909. self.a = a
  910. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
  911. <span class="hljs-keyword">return</span> len(self.a)
  912. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
  913. <span class="hljs-keyword">return</span> self.a[i]
  914. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__setitem__</span><span class="hljs-params">(self, i, el)</span>:</span>
  915. self.a[i] = el
  916. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
  917. <span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
  918. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
  919. <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> self.a:
  920. <span class="hljs-keyword">yield</span> el
  921. </code></pre>
  922. <h3 id="callable">Callable</h3>
  923. <pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
  924. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
  925. self.i = <span class="hljs-number">0</span>
  926. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__call__</span><span class="hljs-params">(self)</span>:</span>
  927. self.i += <span class="hljs-number">1</span>
  928. <span class="hljs-keyword">return</span> self.i
  929. </code></pre>
  930. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>counter = Counter()
  931. <span class="hljs-meta">&gt;&gt;&gt; </span>counter(), counter(), counter()
  932. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  933. </code></pre>
  934. <h3 id="contextmanager">Context Manager</h3>
  935. <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>
  936. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, filename)</span>:</span>
  937. self.filename = filename
  938. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__enter__</span><span class="hljs-params">(self)</span>:</span>
  939. self.file = open(self.filename)
  940. <span class="hljs-keyword">return</span> self.file
  941. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__exit__</span><span class="hljs-params">(self, *args)</span>:</span>
  942. self.file.close()
  943. </code></pre>
  944. <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:
  945. <span class="hljs-meta">... </span> file.write(<span class="hljs-string">'Hello World!'</span>)
  946. <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:
  947. <span class="hljs-meta">... </span> print(file.read())
  948. Hello World!
  949. </code></pre>
  950. <h2 id="enum"><a href="#enum" name="enum">#</a>Enum</h2>
  951. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum, auto
  952. <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>
  953. &lt;member_name_1&gt; = &lt;value_1&gt;
  954. &lt;member_name_2&gt; = &lt;value_2_a&gt;, &lt;value_2_b&gt;
  955. &lt;member_name_3&gt; = auto()
  956. <span class="hljs-meta"> @classmethod</span>
  957. <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>
  958. <span class="hljs-keyword">return</span> [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> cls.__members__.values()]
  959. </code></pre>
  960. <pre><code class="python language-python hljs">&lt;member&gt; = &lt;enum&gt;.&lt;member_name&gt;
  961. &lt;member&gt; = &lt;enum&gt;[<span class="hljs-string">'&lt;member_name&gt;'</span>]
  962. &lt;member&gt; = &lt;enum&gt;(&lt;value&gt;)
  963. name = &lt;member&gt;.name
  964. value = &lt;member&gt;.value
  965. </code></pre>
  966. <pre><code class="python language-python hljs">list_of_members = list(&lt;enum&gt;)
  967. member_names = [a.name <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  968. member_values = [a.value <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> &lt;enum&gt;]
  969. random_member = random.choice(list(&lt;enum&gt;))
  970. </code></pre>
  971. <h3 id="inline-1">Inline</h3>
  972. <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>])
  973. Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, <span class="hljs-string">'fork knife spoon'</span>)
  974. 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>})
  975. </code></pre>
  976. <h4 id="functionscannotbevaluessotheymustbewrapped">Functions can not be values, so they must be wrapped:</h4>
  977. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
  978. 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),
  979. <span class="hljs-string">'OR'</span> : partial(<span class="hljs-keyword">lambda</span> l, r: l <span class="hljs-keyword">or</span> r)})
  980. </code></pre>
  981. <h2 id="exceptions"><a href="#exceptions" name="exceptions">#</a>Exceptions</h2>
  982. <pre><code class="python language-python hljs"><span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  983. <span class="hljs-keyword">try</span>:
  984. x = int(input(<span class="hljs-string">'Please enter a number: '</span>))
  985. <span class="hljs-keyword">except</span> ValueError:
  986. print(<span class="hljs-string">'Oops! That was no valid number. Try again...'</span>)
  987. <span class="hljs-keyword">else</span>:
  988. print(<span class="hljs-string">'Thank you.'</span>)
  989. <span class="hljs-keyword">break</span>
  990. </code></pre>
  991. <h3 id="raisingexception">Raising Exception</h3>
  992. <pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> ValueError(<span class="hljs-string">'A very specific message!'</span>)
  993. </code></pre>
  994. <h3 id="finally">Finally</h3>
  995. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">try</span>:
  996. <span class="hljs-meta">... </span> <span class="hljs-keyword">raise</span> KeyboardInterrupt
  997. <span class="hljs-meta">... </span><span class="hljs-keyword">finally</span>:
  998. <span class="hljs-meta">... </span> print(<span class="hljs-string">'Goodbye, world!'</span>)
  999. Goodbye, world!
  1000. Traceback (most recent call last):
  1001. File <span class="hljs-string">"&lt;stdin&gt;"</span>, line <span class="hljs-number">2</span>, <span class="hljs-keyword">in</span> &lt;module&gt;
  1002. KeyboardInterrupt
  1003. </code></pre>
  1004. <h2 id="print"><a href="#print" name="print">#</a>Print</h2>
  1005. <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>)
  1006. </code></pre>
  1007. <ul>
  1008. <li><strong>Use <code class="python hljs"><span class="hljs-string">'file=sys.stderr'</span></code> for errors.</strong></li>
  1009. </ul>
  1010. <h3 id="prettyprint">Pretty Print</h3>
  1011. <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
  1012. <span class="hljs-meta">&gt;&gt;&gt; </span>pprint(dir())
  1013. [<span class="hljs-string">'__annotations__'</span>,
  1014. <span class="hljs-string">'__builtins__'</span>,
  1015. <span class="hljs-string">'__doc__'</span>, ...]
  1016. </code></pre>
  1017. <h2 id="input"><a href="#input" name="input">#</a>Input</h2>
  1018. <ul>
  1019. <li><strong>Reads a line from user input or pipe if present.</strong></li>
  1020. <li><strong>Trailing newline gets stripped.</strong></li>
  1021. <li><strong>Prompt string is printed to the standard output before reading input.</strong></li>
  1022. </ul>
  1023. <pre><code class="python language-python hljs">&lt;str&gt; = input(prompt=<span class="hljs-keyword">None</span>)
  1024. </code></pre>
  1025. <h4 id="printslinesuntileof">Prints lines until EOF:</h4>
  1026. <pre><code class="python language-python hljs"><span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1027. <span class="hljs-keyword">try</span>:
  1028. print(input())
  1029. <span class="hljs-keyword">except</span> EOFError:
  1030. <span class="hljs-keyword">break</span>
  1031. </code></pre>
  1032. <h2 id="commandlinearguments"><a href="#commandlinearguments" name="commandlinearguments">#</a>Command Line Arguments</h2>
  1033. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sys
  1034. script_name = sys.argv[<span class="hljs-number">0</span>]
  1035. arguments = sys.argv[<span class="hljs-number">1</span>:]
  1036. </code></pre>
  1037. <h3 id="argparse">Argparse</h3>
  1038. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> argparse <span class="hljs-keyword">import</span> ArgumentParser, FileType
  1039. p = ArgumentParser(description=&lt;str&gt;)
  1040. 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>
  1041. 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>
  1042. 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>
  1043. 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>
  1044. args = p.parse_args()
  1045. value = args.&lt;name&gt;
  1046. </code></pre>
  1047. <ul>
  1048. <li><strong>Use <code class="python hljs"><span class="hljs-string">'help=&lt;str&gt;'</span></code> for argument description.</strong></li>
  1049. <li><strong>Use <code class="python hljs"><span class="hljs-string">'type=FileType(&lt;mode&gt;)'</span></code> for files.</strong></li>
  1050. </ul>
  1051. <h2 id="open"><a href="#open" name="open">#</a>Open</h2>
  1052. <p><strong>Opens a file and returns a corresponding file object.</strong></p>
  1053. <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>)
  1054. </code></pre>
  1055. <h3 id="modes">Modes</h3>
  1056. <ul>
  1057. <li><strong><code class="python hljs"><span class="hljs-string">'r'</span></code> - Read (default).</strong></li>
  1058. <li><strong><code class="python hljs"><span class="hljs-string">'w'</span></code> - Write (truncate).</strong></li>
  1059. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - Write or fail if the file already exists.</strong></li>
  1060. <li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Append.</strong></li>
  1061. <li><strong><code class="python hljs"><span class="hljs-string">'w+'</span></code> - Read and write (truncate).</strong></li>
  1062. <li><strong><code class="python hljs"><span class="hljs-string">'r+'</span></code> - Read and write from the start.</strong></li>
  1063. <li><strong><code class="python hljs"><span class="hljs-string">'a+'</span></code> - Read and write from the end.</strong></li>
  1064. <li><strong><code class="python hljs"><span class="hljs-string">'t'</span></code> - Text mode (default).</strong></li>
  1065. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Binary mode.</strong></li>
  1066. </ul>
  1067. <h3 id="file">File</h3>
  1068. <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>
  1069. &lt;file&gt;.seek(offset) <span class="hljs-comment"># Moves 'offset' chars/bytes from the start.</span>
  1070. &lt;file&gt;.seek(offset, &lt;anchor&gt;) <span class="hljs-comment"># Anchor: 0 start, 1 current pos., 2 end.</span>
  1071. </code></pre>
  1072. <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>
  1073. &lt;str/bytes&gt; = &lt;file&gt;.readline() <span class="hljs-comment"># Returns a line.</span>
  1074. &lt;list&gt; = &lt;file&gt;.readlines() <span class="hljs-comment"># Returns a list of lines.</span>
  1075. &lt;str/bytes&gt; = next(&lt;file&gt;) <span class="hljs-comment"># Returns a line using buffer. Do not mix.</span>
  1076. </code></pre>
  1077. <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>
  1078. &lt;file&gt;.writelines(&lt;list&gt;) <span class="hljs-comment"># Writes a list of strings or bytes objects.</span>
  1079. &lt;file&gt;.flush() <span class="hljs-comment"># Flushes write buffer.</span>
  1080. </code></pre>
  1081. <ul>
  1082. <li><strong>Methods do not add or strip trailing newlines.</strong></li>
  1083. </ul>
  1084. <h3 id="readtextfromfile">Read Text from File</h3>
  1085. <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>
  1086. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1087. <span class="hljs-keyword">return</span> file.readlines()
  1088. </code></pre>
  1089. <h3 id="writetexttofile">Write Text to File</h3>
  1090. <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>
  1091. <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:
  1092. file.write(text)
  1093. </code></pre>
  1094. <h2 id="path"><a href="#path" name="path">#</a>Path</h2>
  1095. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> os <span class="hljs-keyword">import</span> path, listdir
  1096. &lt;bool&gt; = path.exists(<span class="hljs-string">'&lt;path&gt;'</span>)
  1097. &lt;bool&gt; = path.isfile(<span class="hljs-string">'&lt;path&gt;'</span>)
  1098. &lt;bool&gt; = path.isdir(<span class="hljs-string">'&lt;path&gt;'</span>)
  1099. &lt;list&gt; = listdir(<span class="hljs-string">'&lt;path&gt;'</span>)
  1100. </code></pre>
  1101. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> glob <span class="hljs-keyword">import</span> glob
  1102. <span class="hljs-meta">&gt;&gt;&gt; </span>glob(<span class="hljs-string">'../*.gif'</span>)
  1103. [<span class="hljs-string">'1.gif'</span>, <span class="hljs-string">'card.gif'</span>]
  1104. </code></pre>
  1105. <h3 id="pathlib">Pathlib</h3>
  1106. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
  1107. cwd = Path()
  1108. &lt;Path&gt; = Path(<span class="hljs-string">'&lt;path&gt;'</span> [, <span class="hljs-string">'&lt;path&gt;'</span>, &lt;Path&gt;, ...])
  1109. &lt;Path&gt; = &lt;Path&gt; / <span class="hljs-string">'&lt;dir&gt;'</span> / <span class="hljs-string">'&lt;file&gt;'</span>
  1110. </code></pre>
  1111. <pre><code class="python language-python hljs">&lt;bool&gt; = &lt;Path&gt;.exists()
  1112. &lt;bool&gt; = &lt;Path&gt;.is_file()
  1113. &lt;bool&gt; = &lt;Path&gt;.is_dir()
  1114. &lt;iter&gt; = &lt;Path&gt;.iterdir()
  1115. </code></pre>
  1116. <pre><code class="python language-python hljs">&lt;iter&gt; = &lt;Path&gt;.glob(<span class="hljs-string">'&lt;pattern&gt;'</span>)
  1117. </code></pre>
  1118. <pre><code class="python language-python hljs">&lt;str&gt; = str(&lt;Path&gt;) <span class="hljs-comment"># Returns path as a string.</span>
  1119. &lt;tup.&gt; = &lt;Path&gt;.parts <span class="hljs-comment"># Returns all components as strings.</span>
  1120. &lt;Path&gt; = &lt;Path&gt;.resolve() <span class="hljs-comment"># Returns absolute Path without symlinks.</span>
  1121. </code></pre>
  1122. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;Path&gt;.name <span class="hljs-comment"># Final component.</span>
  1123. &lt;str&gt; = &lt;Path&gt;.stem <span class="hljs-comment"># Final component without extension.</span>
  1124. &lt;str&gt; = &lt;Path&gt;.suffix <span class="hljs-comment"># Final component's extension.</span>
  1125. &lt;Path&gt; = &lt;Path&gt;.parent <span class="hljs-comment"># Path without final component.</span>
  1126. </code></pre>
  1127. <h2 id="commandexecution"><a href="#commandexecution" name="commandexecution">#</a>Command Execution</h2>
  1128. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os
  1129. &lt;str&gt; = os.popen(&lt;command&gt;).read()
  1130. </code></pre>
  1131. <h3 id="subprocess">Subprocess</h3>
  1132. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> subprocess, shlex
  1133. <span class="hljs-meta">&gt;&gt;&gt; </span>a = subprocess.run(shlex.split(<span class="hljs-string">'ls -a'</span>), stdout=subprocess.PIPE)
  1134. <span class="hljs-meta">&gt;&gt;&gt; </span>a.stdout
  1135. <span class="hljs-string">b'.\n..\nfile1.txt\nfile2.txt\n'</span>
  1136. <span class="hljs-meta">&gt;&gt;&gt; </span>a.returncode
  1137. <span class="hljs-number">0</span>
  1138. </code></pre>
  1139. <h2 id="csv"><a href="#csv" name="csv">#</a>CSV</h2>
  1140. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> csv
  1141. </code></pre>
  1142. <h3 id="readrowsfromcsvfile">Read Rows from CSV File</h3>
  1143. <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>
  1144. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1145. <span class="hljs-keyword">return</span> csv.reader(file, delimiter=<span class="hljs-string">';'</span>)
  1146. </code></pre>
  1147. <h3 id="writerowstocsvfile">Write Rows to CSV File</h3>
  1148. <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>
  1149. <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:
  1150. writer = csv.writer(file, delimiter=<span class="hljs-string">';'</span>)
  1151. writer.writerows(rows)
  1152. </code></pre>
  1153. <h2 id="json"><a href="#json" name="json">#</a>JSON</h2>
  1154. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> json
  1155. &lt;str&gt; = json.dumps(&lt;object&gt;, ensure_ascii=<span class="hljs-keyword">True</span>, indent=<span class="hljs-keyword">None</span>)
  1156. &lt;object&gt; = json.loads(&lt;str&gt;)
  1157. </code></pre>
  1158. <h3 id="readobjectfromjsonfile">Read Object from JSON File</h3>
  1159. <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>
  1160. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1161. <span class="hljs-keyword">return</span> json.load(file)
  1162. </code></pre>
  1163. <h3 id="writeobjecttojsonfile">Write Object to JSON File</h3>
  1164. <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>
  1165. <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:
  1166. json.dump(an_object, file, ensure_ascii=<span class="hljs-keyword">False</span>, indent=<span class="hljs-number">2</span>)
  1167. </code></pre>
  1168. <h2 id="pickle"><a href="#pickle" name="pickle">#</a>Pickle</h2>
  1169. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> pickle
  1170. &lt;bytes&gt; = pickle.dumps(&lt;object&gt;)
  1171. &lt;object&gt; = pickle.loads(&lt;bytes&gt;)
  1172. </code></pre>
  1173. <h3 id="readobjectfromfile">Read Object from File</h3>
  1174. <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>
  1175. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1176. <span class="hljs-keyword">return</span> pickle.load(file)
  1177. </code></pre>
  1178. <h3 id="writeobjecttofile">Write Object to File</h3>
  1179. <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>
  1180. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1181. pickle.dump(an_object, file)
  1182. </code></pre>
  1183. <h2 id="sqlite"><a href="#sqlite" name="sqlite">#</a>SQLite</h2>
  1184. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sqlite3
  1185. db = sqlite3.connect(<span class="hljs-string">'&lt;path&gt;'</span>)
  1186. ...
  1187. db.close()
  1188. </code></pre>
  1189. <h3 id="read">Read</h3>
  1190. <pre><code class="python language-python hljs">cursor = db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1191. <span class="hljs-keyword">if</span> cursor:
  1192. &lt;tuple&gt; = cursor.fetchone() <span class="hljs-comment"># First row.</span>
  1193. &lt;list&gt; = cursor.fetchall() <span class="hljs-comment"># Remaining rows.</span>
  1194. </code></pre>
  1195. <h3 id="write">Write</h3>
  1196. <pre><code class="python language-python hljs">db.execute(<span class="hljs-string">'&lt;query&gt;'</span>)
  1197. db.commit()
  1198. </code></pre>
  1199. <h2 id="bytes"><a href="#bytes" name="bytes">#</a>Bytes</h2>
  1200. <p><strong>Bytes object is an immutable sequence of single bytes. Mutable version is called 'bytearray'.</strong></p>
  1201. <pre><code class="python language-python hljs">&lt;bytes&gt; = <span class="hljs-string">b'&lt;str&gt;'</span>
  1202. &lt;int&gt; = &lt;bytes&gt;[&lt;index&gt;]
  1203. &lt;bytes&gt; = &lt;bytes&gt;[&lt;slice&gt;]
  1204. &lt;ints&gt; = list(&lt;bytes&gt;)
  1205. &lt;bytes&gt; = <span class="hljs-string">b''</span>.join(&lt;coll_of_bytes&gt;)
  1206. </code></pre>
  1207. <h3 id="encode-1">Encode</h3>
  1208. <pre><code class="python language-python hljs">&lt;bytes&gt; = &lt;str&gt;.encode(encoding=<span class="hljs-string">'utf-8'</span>)
  1209. &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>)
  1210. &lt;bytes&gt; = bytes.fromhex(<span class="hljs-string">'&lt;hex&gt;'</span>)
  1211. </code></pre>
  1212. <h3 id="decode-1">Decode</h3>
  1213. <pre><code class="python language-python hljs">&lt;str&gt; = &lt;bytes&gt;.decode(encoding=<span class="hljs-string">'utf-8'</span>)
  1214. &lt;int&gt; = int.from_bytes(&lt;bytes&gt;, byteorder=<span class="hljs-string">'big|little'</span>, signed=<span class="hljs-keyword">False</span>)
  1215. <span class="hljs-string">'&lt;hex&gt;'</span> = &lt;bytes&gt;.hex()
  1216. </code></pre>
  1217. <h3 id="readbytesfromfile">Read Bytes from File</h3>
  1218. <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>
  1219. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
  1220. <span class="hljs-keyword">return</span> file.read()
  1221. </code></pre>
  1222. <h3 id="writebytestofile">Write Bytes to File</h3>
  1223. <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>
  1224. <span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
  1225. file.write(bytes_obj)
  1226. </code></pre>
  1227. <h2 id="struct"><a href="#struct" name="struct">#</a>Struct</h2>
  1228. <ul>
  1229. <li><strong>Module that performs conversions between Python values and a C struct, represented as a Python bytes object.</strong></li>
  1230. <li><strong>Machine’s native type sizes and byte order are used by default.</strong></li>
  1231. </ul>
  1232. <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
  1233. &lt;bytes&gt; = pack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;value_1&gt; [, &lt;value_2&gt;, ...])
  1234. &lt;tuple&gt; = unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1235. &lt;tuples&gt; = iter_unpack(<span class="hljs-string">'&lt;format&gt;'</span>, &lt;bytes&gt;)
  1236. </code></pre>
  1237. <h3 id="example">Example</h3>
  1238. <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>)
  1239. <span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>
  1240. <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>)
  1241. (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
  1242. <span class="hljs-meta">&gt;&gt;&gt; </span>calcsize(<span class="hljs-string">'&gt;hhl'</span>)
  1243. <span class="hljs-number">8</span>
  1244. </code></pre>
  1245. <h3 id="format-2">Format</h3>
  1246. <h4 id="forstandardsizesstartformatstringwith">For standard sizes start format string with:</h4>
  1247. <ul>
  1248. <li><strong><code class="python hljs"><span class="hljs-string">'='</span></code> - native byte order</strong></li>
  1249. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;'</span></code> - little-endian</strong></li>
  1250. <li><strong><code class="python hljs"><span class="hljs-string">'&gt;'</span></code> - big-endian</strong></li>
  1251. </ul>
  1252. <h4 id="usecapitalletterforunsignedtypestandardsizesareinbrackets">Use capital letter for unsigned type. Standard sizes are in brackets:</h4>
  1253. <ul>
  1254. <li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - pad byte</strong></li>
  1255. <li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - char (1)</strong></li>
  1256. <li><strong><code class="python hljs"><span class="hljs-string">'h'</span></code> - short (2)</strong></li>
  1257. <li><strong><code class="python hljs"><span class="hljs-string">'i'</span></code> - int (4)</strong></li>
  1258. <li><strong><code class="python hljs"><span class="hljs-string">'l'</span></code> - long (4)</strong></li>
  1259. <li><strong><code class="python hljs"><span class="hljs-string">'q'</span></code> - long long (8)</strong></li>
  1260. <li><strong><code class="python hljs"><span class="hljs-string">'f'</span></code> - float (4)</strong></li>
  1261. <li><strong><code class="python hljs"><span class="hljs-string">'d'</span></code> - double (8)</strong></li>
  1262. </ul>
  1263. <h2 id="array"><a href="#array" name="array">#</a>Array</h2>
  1264. <p><strong>List that can hold only elements of predefined type. Available types and their sizes are listed above.</strong></p>
  1265. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> array <span class="hljs-keyword">import</span> array
  1266. &lt;array&gt; = array(<span class="hljs-string">'&lt;typecode&gt;'</span> [, &lt;collection&gt;])
  1267. </code></pre>
  1268. <h2 id="memoryview"><a href="#memoryview" name="memoryview">#</a>Memory View</h2>
  1269. <p><strong>Used for accessing the internal data of an object that supports the buffer protocol.</strong></p>
  1270. <pre><code class="python language-python hljs">&lt;memoryview&gt; = memoryview(&lt;bytes&gt; / &lt;bytearray&gt; / &lt;array&gt;)
  1271. &lt;memoryview&gt;.release()
  1272. </code></pre>
  1273. <h2 id="deque"><a href="#deque" name="deque">#</a>Deque</h2>
  1274. <p><strong>Thread-safe list with efficient appends and pops from either side. Pronounced "deck".</strong></p>
  1275. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> deque
  1276. &lt;deque&gt; = deque(&lt;collection&gt;, maxlen=<span class="hljs-keyword">None</span>)
  1277. </code></pre>
  1278. <pre><code class="python language-python hljs">&lt;deque&gt;.appendleft(&lt;el&gt;)
  1279. &lt;el&gt; = &lt;deque&gt;.popleft()
  1280. </code></pre>
  1281. <pre><code class="python language-python hljs">&lt;deque&gt;.extendleft(&lt;collection&gt;) <span class="hljs-comment"># Collection gets reversed.</span>
  1282. &lt;deque&gt;.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Rotates elements to the right.</span>
  1283. </code></pre>
  1284. <h2 id="threading"><a href="#threading" name="threading">#</a>Threading</h2>
  1285. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> threading <span class="hljs-keyword">import</span> Thread, RLock
  1286. </code></pre>
  1287. <h3 id="thread">Thread</h3>
  1288. <pre><code class="python language-python hljs">thread = Thread(target=&lt;function&gt;, args=(&lt;first_arg&gt;, ))
  1289. thread.start()
  1290. ...
  1291. thread.join()
  1292. </code></pre>
  1293. <h3 id="lock">Lock</h3>
  1294. <pre><code class="python language-python hljs">lock = RLock()
  1295. lock.acquire()
  1296. ...
  1297. lock.release()
  1298. </code></pre>
  1299. <h4 id="or">Or:</h4>
  1300. <pre><code class="python language-python hljs"><span class="hljs-keyword">with</span> lock:
  1301. ...
  1302. </code></pre>
  1303. <h2 id="introspection"><a href="#introspection" name="introspection">#</a>Introspection</h2>
  1304. <p><strong>Inspecting code at runtime.</strong></p>
  1305. <h3 id="variables">Variables</h3>
  1306. <pre><code class="python language-python hljs">&lt;list&gt; = dir() <span class="hljs-comment"># Names of variables in current scope.</span>
  1307. &lt;dict&gt; = locals() <span class="hljs-comment"># Dict of local variables. Also vars().</span>
  1308. &lt;dict&gt; = globals() <span class="hljs-comment"># Dict of global variables.</span>
  1309. </code></pre>
  1310. <h3 id="attributes-1">Attributes</h3>
  1311. <pre><code class="python language-python hljs">&lt;dict&gt; = vars(&lt;object&gt;)
  1312. &lt;bool&gt; = hasattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1313. value = getattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>)
  1314. setattr(&lt;object&gt;, <span class="hljs-string">'&lt;attr_name&gt;'</span>, value)
  1315. </code></pre>
  1316. <h3 id="parameters">Parameters</h3>
  1317. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> inspect <span class="hljs-keyword">import</span> signature
  1318. &lt;sig&gt; = signature(&lt;function&gt;)
  1319. no_of_params = len(&lt;sig&gt;.parameters)
  1320. param_names = list(&lt;sig&gt;.parameters.keys())
  1321. </code></pre>
  1322. <h2 id="metaprograming"><a href="#metaprograming" name="metaprograming">#</a>Metaprograming</h2>
  1323. <p><strong>Code that generates code.</strong></p>
  1324. <h3 id="type-1">Type</h3>
  1325. <p><strong>Type is the root class. If only passed the object it returns its type (class). Otherwise it creates a new class.</strong></p>
  1326. <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>
  1327. </span></code></pre>
  1328. <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>})
  1329. <span class="hljs-meta">&gt;&gt;&gt; </span>z = Z()
  1330. </code></pre>
  1331. <h3 id="metaclass">Meta Class</h3>
  1332. <p><strong>Class that creates class.</strong></p>
  1333. <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>
  1334. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1335. <span class="hljs-keyword">return</span> type(name, parents, attrs)
  1336. </code></pre>
  1337. <h4 id="or-1">Or:</h4>
  1338. <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>
  1339. <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>
  1340. attrs[<span class="hljs-string">'a'</span>] = <span class="hljs-string">'abcde'</span>
  1341. <span class="hljs-keyword">return</span> type.__new__(cls, name, parents, attrs)
  1342. </code></pre>
  1343. <ul>
  1344. <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>
  1345. <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>
  1346. <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>
  1347. </ul>
  1348. <h3 id="metaclassattribute">Metaclass Attribute</h3>
  1349. <p><strong>When class is created it checks if it has metaclass defined. If not, it recursively checks if any of his parents has it defined and eventually comes to type().</strong></p>
  1350. <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>
  1351. b = <span class="hljs-number">12345</span>
  1352. </code></pre>
  1353. <pre><code class="python language-python hljs"><span class="hljs-meta">&gt;&gt;&gt; </span>MyClass.a, MyClass.b
  1354. (<span class="hljs-string">'abcde'</span>, <span class="hljs-number">12345</span>)
  1355. </code></pre>
  1356. <h4 id="typediagramstrisaninstanceoftype">Type diagram (str is an instance of type, …):</h4>
  1357. <pre><code class="text language-text">┏━━━━━━━━━┯━━━━━━━━━━━━━┓
  1358. ┃ Classes │ Metaclasses ┃
  1359. ┠─────────┼─────────────┨
  1360. ┃ MyClass → MyMetaClass ┃
  1361. ┃ │ ↓ ┃
  1362. ┃ object ───→ type ←╮ ┃
  1363. ┃ │ ↑ ╰───╯ ┃
  1364. ┃ str ───────╯ ┃
  1365. ┗━━━━━━━━━┷━━━━━━━━━━━━━┛
  1366. </code></pre>
  1367. <h4 id="inheritancediagramstrisasubclassofobject">Inheritance diagram (str is a subclass of object, …):</h4>
  1368. <pre><code class="text language-text">┏━━━━━━━━━┯━━━━━━━━━━━━━┓
  1369. ┃ Classes │ Metaclasses ┃
  1370. ┠─────────┼─────────────┨
  1371. ┃ MyClass │ MyMetaClass ┃
  1372. ┃ ↓ │ ↓ ┃
  1373. ┃ object ←─── type ┃
  1374. ┃ ↑ │ ┃
  1375. ┃ str │ ┃
  1376. ┗━━━━━━━━━┷━━━━━━━━━━━━━┛
  1377. </code></pre>
  1378. <h2 id="operator"><a href="#operator" name="operator">#</a>Operator</h2>
  1379. <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
  1380. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> eq, ne, lt, le, gt, ge
  1381. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> not_, and_, or_
  1382. <span class="hljs-keyword">from</span> operator <span class="hljs-keyword">import</span> itemgetter, attrgetter, methodcaller
  1383. </code></pre>
  1384. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
  1385. product_of_elems = functools.reduce(op.mul, &lt;collection&gt;)
  1386. sorted_by_second = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>))
  1387. sorted_by_both = sorted(&lt;collection&gt;, key=op.itemgetter(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>))
  1388. 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_})
  1389. last_el = op.methodcaller(<span class="hljs-string">'pop'</span>)(&lt;list&gt;)
  1390. </code></pre>
  1391. <h2 id="eval"><a href="#eval" name="eval">#</a>Eval</h2>
  1392. <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
  1393. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'1 + 2'</span>)
  1394. <span class="hljs-number">3</span>
  1395. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'[1, 2, 3]'</span>)
  1396. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
  1397. <span class="hljs-meta">&gt;&gt;&gt; </span>literal_eval(<span class="hljs-string">'abs(1)'</span>)
  1398. ValueError: malformed node <span class="hljs-keyword">or</span> string
  1399. </code></pre>
  1400. <h2 id="coroutine"><a href="#coroutine" name="coroutine">#</a>Coroutine</h2>
  1401. <ul>
  1402. <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>
  1403. <li><strong>Coroutines provide more powerful data routing possibilities than iterators.</strong></li>
  1404. <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>
  1405. </ul>
  1406. <h3 id="helperdecorator">Helper Decorator</h3>
  1407. <ul>
  1408. <li><strong>All coroutines must be "primed" by first calling next().</strong></li>
  1409. <li><strong>Remembering to call next() is easy to forget.</strong></li>
  1410. <li><strong>Solved by wrapping coroutines with a decorator:</strong></li>
  1411. </ul>
  1412. <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>
  1413. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
  1414. cr = func(*args, **kwargs)
  1415. next(cr)
  1416. <span class="hljs-keyword">return</span> cr
  1417. <span class="hljs-keyword">return</span> out
  1418. </code></pre>
  1419. <h3 id="pipelineexample">Pipeline Example</h3>
  1420. <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>
  1421. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>):
  1422. target.send(i)
  1423. target.close()
  1424. <span class="hljs-meta">@coroutine</span>
  1425. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">adder</span><span class="hljs-params">(target)</span>:</span>
  1426. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1427. value = (<span class="hljs-keyword">yield</span>)
  1428. target.send(value + <span class="hljs-number">100</span>)
  1429. <span class="hljs-meta">@coroutine</span>
  1430. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">printer</span><span class="hljs-params">()</span>:</span>
  1431. <span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
  1432. value = (<span class="hljs-keyword">yield</span>)
  1433. print(value)
  1434. reader(adder(printer())) <span class="hljs-comment"># 100, 101, ..., 109</span>
  1435. </code></pre>
  1436. <p><br><br></p>
  1437. <h1 id="libraries">Libraries</h1>
  1438. <h2 id="progressbar"><a href="#progressbar" name="progressbar">#</a>Progress Bar</h2>
  1439. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tqdm</span>
  1440. <span class="hljs-keyword">from</span> tqdm <span class="hljs-keyword">import</span> tqdm
  1441. <span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> sleep
  1442. <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>]):
  1443. sleep(<span class="hljs-number">0.2</span>)
  1444. <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> tqdm(range(<span class="hljs-number">100</span>)):
  1445. sleep(<span class="hljs-number">0.02</span>)
  1446. </code></pre>
  1447. <h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2>
  1448. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span>
  1449. <span class="hljs-keyword">from</span> matplotlib <span class="hljs-keyword">import</span> pyplot
  1450. pyplot.plot(&lt;data_1&gt; [, &lt;data_2&gt;, ...])
  1451. pyplot.savefig(&lt;filename&gt;)
  1452. pyplot.show()
  1453. </code></pre>
  1454. <h2 id="table"><a href="#table" name="table">#</a>Table</h2>
  1455. <h4 id="printsacsvfileasanasciitable">Prints a CSV file as an ASCII table:</h4>
  1456. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tabulate</span>
  1457. <span class="hljs-keyword">from</span> tabulate <span class="hljs-keyword">import</span> tabulate
  1458. <span class="hljs-keyword">import</span> csv
  1459. <span class="hljs-keyword">with</span> open(&lt;filename&gt;, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1460. lines = csv.reader(file, delimiter=<span class="hljs-string">';'</span>)
  1461. headers = [header.title() <span class="hljs-keyword">for</span> header <span class="hljs-keyword">in</span> next(lines)]
  1462. table = tabulate(lines, headers)
  1463. print(table)
  1464. </code></pre>
  1465. <h2 id="curses"><a href="#curses" name="curses">#</a>Curses</h2>
  1466. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> curses <span class="hljs-keyword">import</span> wrapper, ascii
  1467. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1468. wrapper(draw)
  1469. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">draw</span><span class="hljs-params">(screen)</span>:</span>
  1470. screen.clear()
  1471. screen.addstr(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-string">'Press ESC to quit.'</span>)
  1472. <span class="hljs-keyword">while</span> screen.getch() != ascii.ESC:
  1473. <span class="hljs-keyword">pass</span>
  1474. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_border</span><span class="hljs-params">(screen)</span>:</span>
  1475. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  1476. P = namedtuple(<span class="hljs-string">'P'</span>, <span class="hljs-string">'y x'</span>)
  1477. height, width = screen.getmaxyx()
  1478. <span class="hljs-keyword">return</span> P(height<span class="hljs-number">-1</span>, width<span class="hljs-number">-1</span>)
  1479. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  1480. main()
  1481. </code></pre>
  1482. <h2 id="logging"><a href="#logging" name="logging">#</a>Logging</h2>
  1483. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install loguru</span>
  1484. <span class="hljs-keyword">from</span> loguru <span class="hljs-keyword">import</span> logger
  1485. </code></pre>
  1486. <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>
  1487. 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>
  1488. logger.&lt;level&gt;(<span class="hljs-string">'A logging message.'</span>)
  1489. </code></pre>
  1490. <ul>
  1491. <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>
  1492. </ul>
  1493. <h3 id="exceptions-1">Exceptions</h3>
  1494. <p><strong>Error description, stack trace and values of variables are appended automatically.</strong></p>
  1495. <pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
  1496. ...
  1497. <span class="hljs-keyword">except</span> &lt;exception&gt;:
  1498. logger.exception(<span class="hljs-string">'An error happened.'</span>)
  1499. </code></pre>
  1500. <h3 id="rotation">Rotation</h3>
  1501. <p><strong>Parameter that sets a condition when a new log file is created.</strong></p>
  1502. <pre><code class="python language-python hljs">rotation=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;datetime.time&gt;|&lt;str&gt;
  1503. </code></pre>
  1504. <ul>
  1505. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max file size in bytes.</strong></li>
  1506. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1507. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;time&gt;'</span></code> - Time of day.</strong></li>
  1508. <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>
  1509. </ul>
  1510. <h3 id="retention">Retention</h3>
  1511. <p><strong>Sets a condition which old log files are deleted.</strong></p>
  1512. <pre><code class="python language-python hljs">retention=&lt;int&gt;|&lt;datetime.timedelta&gt;|&lt;str&gt;
  1513. </code></pre>
  1514. <ul>
  1515. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;int&gt;'</span></code> - Max number of files.</strong></li>
  1516. <li><strong><code class="python hljs"><span class="hljs-string">'&lt;timedelta&gt;'</span></code> - Max age of a file.</strong></li>
  1517. <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>
  1518. </ul>
  1519. <h2 id="scraping"><a href="#scraping" name="scraping">#</a>Scraping</h2>
  1520. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests beautifulsoup4</span>
  1521. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> requests
  1522. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> bs4 <span class="hljs-keyword">import</span> BeautifulSoup
  1523. <span class="hljs-meta">&gt;&gt;&gt; </span>url = <span class="hljs-string">'https://en.wikipedia.org/wiki/Python_(programming_language)'</span>
  1524. <span class="hljs-meta">&gt;&gt;&gt; </span>page = requests.get(url)
  1525. <span class="hljs-meta">&gt;&gt;&gt; </span>doc = BeautifulSoup(page.text, <span class="hljs-string">'html.parser'</span>)
  1526. <span class="hljs-meta">&gt;&gt;&gt; </span>table = doc.find(<span class="hljs-string">'table'</span>, class_=<span class="hljs-string">'infobox vevent'</span>)
  1527. <span class="hljs-meta">&gt;&gt;&gt; </span>rows = table.find_all(<span class="hljs-string">'tr'</span>)
  1528. <span class="hljs-meta">&gt;&gt;&gt; </span>link = rows[<span class="hljs-number">11</span>].find(<span class="hljs-string">'a'</span>)[<span class="hljs-string">'href'</span>]
  1529. <span class="hljs-meta">&gt;&gt;&gt; </span>ver = rows[<span class="hljs-number">6</span>].find(<span class="hljs-string">'div'</span>).text.split()[<span class="hljs-number">0</span>]
  1530. <span class="hljs-meta">&gt;&gt;&gt; </span>link, ver
  1531. (<span class="hljs-string">'https://www.python.org/'</span>, <span class="hljs-string">'3.7.2'</span>)
  1532. </code></pre>
  1533. <h3 id="selenium">Selenium</h3>
  1534. <p><strong>Library for scraping dynamically generated web content.</strong></p>
  1535. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ brew cask install chromedriver</span>
  1536. <span class="hljs-comment"># $ pip3 install selenium</span>
  1537. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">from</span> selenium <span class="hljs-keyword">import</span> webdriver
  1538. <span class="hljs-meta">&gt;&gt;&gt; </span>driver = webdriver.Chrome()
  1539. <span class="hljs-meta">&gt;&gt;&gt; </span>driver.get(url)
  1540. <span class="hljs-meta">&gt;&gt;&gt; </span>xpath = <span class="hljs-string">'//*[@id="mw-content-text"]/div/table[1]/tbody/tr[7]/td/div'</span>
  1541. <span class="hljs-meta">&gt;&gt;&gt; </span>driver.find_element_by_xpath(xpath).text.split()[<span class="hljs-number">0</span>]
  1542. <span class="hljs-string">'3.7.2'</span>
  1543. </code></pre>
  1544. <h2 id="web"><a href="#web" name="web">#</a>Web</h2>
  1545. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install bottle</span>
  1546. <span class="hljs-keyword">from</span> bottle <span class="hljs-keyword">import</span> run, route, post, template, request, response
  1547. <span class="hljs-keyword">import</span> json
  1548. </code></pre>
  1549. <h3 id="run">Run</h3>
  1550. <pre><code class="python language-python hljs">run(host=<span class="hljs-string">'localhost'</span>, port=<span class="hljs-number">8080</span>)
  1551. 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>)
  1552. </code></pre>
  1553. <h3 id="staticrequest">Static Request</h3>
  1554. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/img/&lt;image&gt;')</span>
  1555. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_image</span><span class="hljs-params">(image)</span>:</span>
  1556. <span class="hljs-keyword">return</span> static_file(image, <span class="hljs-string">'images/'</span>, mimetype=<span class="hljs-string">'image/png'</span>)
  1557. </code></pre>
  1558. <h3 id="dynamicrequest">Dynamic Request</h3>
  1559. <pre><code class="python language-python hljs"><span class="hljs-meta">@route('/&lt;sport&gt;')</span>
  1560. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">send_page</span><span class="hljs-params">(sport)</span>:</span>
  1561. <span class="hljs-keyword">return</span> template(<span class="hljs-string">'&lt;h1&gt;{{title}}&lt;/h1&gt;'</span>, title=sport)
  1562. </code></pre>
  1563. <h3 id="restrequest">REST Request</h3>
  1564. <pre><code class="python language-python hljs"><span class="hljs-meta">@post('/odds/&lt;sport&gt;')</span>
  1565. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">odds_handler</span><span class="hljs-params">(sport)</span>:</span>
  1566. team = request.forms.get(<span class="hljs-string">'team'</span>)
  1567. home_odds, away_odds = <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>
  1568. response.headers[<span class="hljs-string">'Content-Type'</span>] = <span class="hljs-string">'application/json'</span>
  1569. response.headers[<span class="hljs-string">'Cache-Control'</span>] = <span class="hljs-string">'no-cache'</span>
  1570. <span class="hljs-keyword">return</span> json.dumps([team, home_odds, away_odds])
  1571. </code></pre>
  1572. <h4 id="test">Test:</h4>
  1573. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests</span>
  1574. <span class="hljs-meta">&gt;&gt;&gt; </span><span class="hljs-keyword">import</span> requests
  1575. <span class="hljs-meta">&gt;&gt;&gt; </span>url = <span class="hljs-string">'http://localhost:8080/odds/football'</span>
  1576. <span class="hljs-meta">&gt;&gt;&gt; </span>data = {<span class="hljs-string">'team'</span>: <span class="hljs-string">'arsenal f.c.'</span>}
  1577. <span class="hljs-meta">&gt;&gt;&gt; </span>response = requests.post(url, data=data)
  1578. <span class="hljs-meta">&gt;&gt;&gt; </span>response.json()
  1579. [<span class="hljs-string">'arsenal f.c.'</span>, <span class="hljs-number">2.44</span>, <span class="hljs-number">3.29</span>]
  1580. </code></pre>
  1581. <h2 id="profile"><a href="#profile" name="profile">#</a>Profile</h2>
  1582. <h3 id="basic">Basic</h3>
  1583. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> time
  1584. start_time = time() <span class="hljs-comment"># Seconds since Epoch.</span>
  1585. ...
  1586. duration = time() - start_time
  1587. </code></pre>
  1588. <h3 id="highperformance">High Performance</h3>
  1589. <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
  1590. start_time = pc() <span class="hljs-comment"># Seconds since restart.</span>
  1591. ...
  1592. duration = pc() - start_time
  1593. </code></pre>
  1594. <h3 id="timingasnippet">Timing a Snippet</h3>
  1595. <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
  1596. <span class="hljs-meta">&gt;&gt;&gt; </span>timeit(<span class="hljs-string">'"-".join(str(a) for a in range(100))'</span>,
  1597. <span class="hljs-meta">... </span> number=<span class="hljs-number">10000</span>, globals=globals(), setup=<span class="hljs-string">'pass'</span>)
  1598. <span class="hljs-number">0.34986</span>
  1599. </code></pre>
  1600. <h3 id="lineprofiler">Line Profiler</h3>
  1601. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install line_profiler</span>
  1602. <span class="hljs-meta">@profile</span>
  1603. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1604. a = [*range(<span class="hljs-number">10000</span>)]
  1605. b = {*range(<span class="hljs-number">10000</span>)}
  1606. main()
  1607. </code></pre>
  1608. <h4 id="usage">Usage:</h4>
  1609. <pre><code class="text language-text">$ kernprof -lv test.py
  1610. Line # Hits Time Per Hit % Time Line Contents
  1611. ==============================================================
  1612. 1 @profile
  1613. 2 def main():
  1614. 3 1 1128.0 1128.0 27.4 a = [*range(10000)]
  1615. 4 1 2994.0 2994.0 72.6 b = {*range(10000)}
  1616. </code></pre>
  1617. <h3 id="callgraph">Call Graph</h3>
  1618. <h4 id="generatesapngimageofacallgraphwithhighlightedbottlenecks">Generates a PNG image of a call graph with highlighted bottlenecks:</h4>
  1619. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pycallgraph</span>
  1620. <span class="hljs-keyword">from</span> pycallgraph <span class="hljs-keyword">import</span> output, PyCallGraph
  1621. <span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> datetime
  1622. time_str = datetime.now().strftime(<span class="hljs-string">'%Y%m%d%H%M%S'</span>)
  1623. filename = <span class="hljs-string">f'profile-<span class="hljs-subst">{time_str}</span>.png'</span>
  1624. drawer = output.GraphvizOutput(output_file=filename)
  1625. <span class="hljs-keyword">with</span> PyCallGraph(output=drawer):
  1626. &lt;code_to_be_profiled&gt;
  1627. </code></pre>
  1628. <h2 id="numpy"><a href="#numpy" name="numpy">#</a>NumPy</h2>
  1629. <p><strong>Array manipulation mini language. Can run up to one hundred times faster than equivalent Python code.</strong></p>
  1630. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install numpy</span>
  1631. <span class="hljs-keyword">import</span> numpy <span class="hljs-keyword">as</span> np
  1632. </code></pre>
  1633. <pre><code class="python language-python hljs">&lt;array&gt; = np.array(&lt;list&gt;)
  1634. &lt;array&gt; = np.arange(from_inclusive, to_exclusive, ±step_size)
  1635. &lt;array&gt; = np.ones(&lt;shape&gt;)
  1636. &lt;array&gt; = np.random.randint(from_inclusive, to_exclusive, &lt;shape&gt;)
  1637. </code></pre>
  1638. <pre><code class="python language-python hljs">&lt;array&gt;.shape = &lt;shape&gt;
  1639. &lt;view&gt; = &lt;array&gt;.reshape(&lt;shape&gt;)
  1640. &lt;view&gt; = np.broadcast_to(&lt;array&gt;, &lt;shape&gt;)
  1641. </code></pre>
  1642. <pre><code class="python language-python hljs">&lt;array&gt; = &lt;array&gt;.sum(axis)
  1643. indexes = &lt;array&gt;.argmin(axis)
  1644. </code></pre>
  1645. <ul>
  1646. <li><strong>Shape is a tuple of dimension sizes.</strong></li>
  1647. <li><strong>Axis is an index of dimension that gets collapsed. Leftmost dimension has index 0.</strong></li>
  1648. </ul>
  1649. <h3 id="indexing">Indexing</h3>
  1650. <pre><code class="bash language-bash hljs">&lt;el&gt; = &lt;2d_array&gt;[0, 0] <span class="hljs-comment"># First element.</span>
  1651. &lt;1d_view&gt; = &lt;2d_array&gt;[0] <span class="hljs-comment"># First row.</span>
  1652. &lt;1d_view&gt; = &lt;2d_array&gt;[:, 0] <span class="hljs-comment"># First column. Also [..., 0].</span>
  1653. &lt;3d_view&gt; = &lt;2d_array&gt;[None, :, :] <span class="hljs-comment"># Expanded by dimension of size 1.</span>
  1654. </code></pre>
  1655. <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;]
  1656. &lt;2d_array&gt; = &lt;2d_array&gt;[&lt;2d_row_indexes&gt;, &lt;2d_column_indexes&gt;]
  1657. </code></pre>
  1658. <pre><code class="bash language-bash hljs">&lt;2d_bools&gt; = &lt;2d_array&gt; &gt; 0
  1659. &lt;1d_array&gt; = &lt;2d_array&gt;[&lt;2d_bools&gt;]
  1660. </code></pre>
  1661. <ul>
  1662. <li><strong>If row and column indexes differ in shape, they are combined with broadcasting.</strong></li>
  1663. </ul>
  1664. <h3 id="broadcasting">Broadcasting</h3>
  1665. <p><strong>Broadcasting is a set of rules by which NumPy functions operate on arrays of different sizes and/or dimensions.</strong></p>
  1666. <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>
  1667. 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>
  1668. </code></pre>
  1669. <h4 id="1ifarrayshapesdifferinlengthleftpadtheshortershapewithones">1. If array shapes differ in length, left-pad the shorter shape with ones:</h4>
  1670. <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>
  1671. 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>
  1672. </code></pre>
  1673. <h4 id="2ifanydimensionsdifferinsizeexpandtheonesthathavesize1byduplicatingtheirelements">2. If any dimensions differ in size, expand the ones that have size 1 by duplicating their elements:</h4>
  1674. <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>
  1675. 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>
  1676. </code></pre>
  1677. <h4 id="3ifneithernonmatchingdimensionhassize1riseanerror">3. If neither non-matching dimension has size 1, rise an error.</h4>
  1678. <h3 id="example-1">Example</h3>
  1679. <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>
  1680. <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>])
  1681. [ <span class="hljs-number">0.1</span>, <span class="hljs-number">0.6</span>, <span class="hljs-number">0.8</span>]
  1682. <span class="hljs-meta">&gt;&gt;&gt; </span>wrapped_points = points.reshape(<span class="hljs-number">3</span>, <span class="hljs-number">1</span>)
  1683. [[ <span class="hljs-number">0.1</span>],
  1684. [ <span class="hljs-number">0.6</span>],
  1685. [ <span class="hljs-number">0.8</span>]]
  1686. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = wrapped_points - points
  1687. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">-0.5</span>, <span class="hljs-number">-0.7</span>],
  1688. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">-0.2</span>],
  1689. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  1690. <span class="hljs-meta">&gt;&gt;&gt; </span>distances = np.abs(distances)
  1691. [[ <span class="hljs-number">0.</span> , <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  1692. [ <span class="hljs-number">0.5</span>, <span class="hljs-number">0.</span> , <span class="hljs-number">0.2</span>],
  1693. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, <span class="hljs-number">0.</span> ]]
  1694. <span class="hljs-meta">&gt;&gt;&gt; </span>i = np.arange(<span class="hljs-number">3</span>)
  1695. [<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>]
  1696. <span class="hljs-meta">&gt;&gt;&gt; </span>distances[i, i] = np.inf
  1697. [[ inf, <span class="hljs-number">0.5</span>, <span class="hljs-number">0.7</span>],
  1698. [ <span class="hljs-number">0.5</span>, inf, <span class="hljs-number">0.2</span>],
  1699. [ <span class="hljs-number">0.7</span>, <span class="hljs-number">0.2</span>, inf]]
  1700. <span class="hljs-meta">&gt;&gt;&gt; </span>distances.argmin(<span class="hljs-number">1</span>)
  1701. [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">1</span>]
  1702. </code></pre>
  1703. <h2 id="image"><a href="#image" name="image">#</a>Image</h2>
  1704. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pillow</span>
  1705. <span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> Image
  1706. </code></pre>
  1707. <h4 id="createsapngimageofarainbowgradient">Creates a PNG image of a rainbow gradient:</h4>
  1708. <pre><code class="python language-python hljs">width = <span class="hljs-number">100</span>
  1709. height = <span class="hljs-number">100</span>
  1710. size = width * height
  1711. pixels = [<span class="hljs-number">255</span> * i/size <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(size)]
  1712. img = Image.new(<span class="hljs-string">'HSV'</span>, (width, height))
  1713. 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])
  1714. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  1715. </code></pre>
  1716. <h4 id="addsnoisetoapngimage">Adds noise to a PNG image:</h4>
  1717. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  1718. 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>)))
  1719. img = Image.open(<span class="hljs-string">'test.png'</span>).convert(mode=<span class="hljs-string">'HSV'</span>)
  1720. img.putdata([(add_noise(h), s, v) <span class="hljs-keyword">for</span> h, s, v <span class="hljs-keyword">in</span> img.getdata()])
  1721. img.convert(mode=<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
  1722. </code></pre>
  1723. <h3 id="modes-1">Modes</h3>
  1724. <ul>
  1725. <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>
  1726. <li><strong><code class="python hljs"><span class="hljs-string">'L'</span></code> - 8-bit pixels, greyscale.</strong></li>
  1727. <li><strong><code class="python hljs"><span class="hljs-string">'RGB'</span></code> - 3x8-bit pixels, true color.</strong></li>
  1728. <li><strong><code class="python hljs"><span class="hljs-string">'RGBA'</span></code> - 4x8-bit pixels, true color with transparency mask.</strong></li>
  1729. <li><strong><code class="python hljs"><span class="hljs-string">'HSV'</span></code> - 3x8-bit pixels, Hue, Saturation, Value color space.</strong></li>
  1730. </ul>
  1731. <h2 id="audio"><a href="#audio" name="audio">#</a>Audio</h2>
  1732. <pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> wave
  1733. <span class="hljs-keyword">from</span> struct <span class="hljs-keyword">import</span> pack, iter_unpack
  1734. </code></pre>
  1735. <h3 id="readframesfromwavfile">Read Frames from WAV File</h3>
  1736. <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>
  1737. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> wf:
  1738. frames = wf.readframes(wf.getnframes())
  1739. <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)]
  1740. </code></pre>
  1741. <h3 id="writeframestowavfile">Write Frames to WAV File</h3>
  1742. <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>
  1743. 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)
  1744. <span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> wf:
  1745. 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>)
  1746. wf.setsampwidth(<span class="hljs-number">2</span>)
  1747. wf.setframerate(<span class="hljs-number">44100</span>)
  1748. wf.writeframes(<span class="hljs-string">b''</span>.join(frames_short))
  1749. </code></pre>
  1750. <h3 id="examples">Examples</h3>
  1751. <h4 id="savesasinewavetoamonowavfile">Saves a sine wave to a mono WAV file:</h4>
  1752. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> pi, sin
  1753. 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>))
  1754. 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)
  1755. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  1756. </code></pre>
  1757. <h4 id="addsnoisetoamonowavfile">Adds noise to a mono WAV file:</h4>
  1758. <pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
  1759. 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>)))
  1760. 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>))
  1761. write_to_wav_file(<span class="hljs-string">'test.wav'</span>, frames_i)
  1762. </code></pre>
  1763. <h3 id="synthesizer">Synthesizer</h3>
  1764. <pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install simpleaudio</span>
  1765. <span class="hljs-keyword">import</span> simpleaudio, math, struct
  1766. <span class="hljs-keyword">from</span> itertools <span class="hljs-keyword">import</span> chain, repeat
  1767. F = <span class="hljs-number">44100</span>
  1768. P1 = <span class="hljs-string">'71♪,69,,71♪,66,,62♪,66,,59♪,,,'</span>
  1769. P2 = <span class="hljs-string">'71♪,73,,74♪,73,,74,,71,,73♪,71,,73,,69,,71♪,69,,71,,67,,71♪,,,'</span>
  1770. get_pause = <span class="hljs-keyword">lambda</span> seconds: repeat(<span class="hljs-number">0</span>, int(seconds * F))
  1771. sin_f = <span class="hljs-keyword">lambda</span> i, hz: math.sin(i * <span class="hljs-number">2</span> * math.pi * hz / F)
  1772. 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)))
  1773. 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>)
  1774. parse_n = <span class="hljs-keyword">lambda</span> note: (get_hz(note[:<span class="hljs-number">2</span>]), <span class="hljs-number">0.25</span> <span class="hljs-keyword">if</span> <span class="hljs-string">'♪'</span> <span class="hljs-keyword">in</span> note <span class="hljs-keyword">else</span> <span class="hljs-number">0.125</span>)
  1775. get_note = <span class="hljs-keyword">lambda</span> note: get_wave(*parse_n(note)) <span class="hljs-keyword">if</span> note <span class="hljs-keyword">else</span> get_pause(<span class="hljs-number">0.125</span>)
  1776. frames_i = chain.from_iterable(get_note(n) <span class="hljs-keyword">for</span> n <span class="hljs-keyword">in</span> <span class="hljs-string">f'<span class="hljs-subst">{P1}</span><span class="hljs-subst">{P1}</span><span class="hljs-subst">{P2}</span>'</span>.split(<span class="hljs-string">','</span>))
  1777. frames_b = <span class="hljs-string">b''</span>.join(struct.pack(<span class="hljs-string">'&lt;h'</span>, int(a * <span class="hljs-number">30000</span>)) <span class="hljs-keyword">for</span> a <span class="hljs-keyword">in</span> frames_i)
  1778. simpleaudio.play_buffer(frames_b, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, F)
  1779. </code></pre>
  1780. <h2 id="basicscripttemplate"><a href="#basicscripttemplate" name="basicscripttemplate">#</a>Basic Script Template</h2>
  1781. <pre><code class="python language-python hljs"><span class="hljs-comment">#!/usr/bin/env python3</span>
  1782. <span class="hljs-comment">#</span>
  1783. <span class="hljs-comment"># Usage: .py</span>
  1784. <span class="hljs-comment">#</span>
  1785. <span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
  1786. <span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
  1787. <span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
  1788. <span class="hljs-keyword">import</span> re
  1789. <span class="hljs-keyword">import</span> sys
  1790. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
  1791. <span class="hljs-keyword">pass</span>
  1792. <span class="hljs-comment">###</span>
  1793. <span class="hljs-comment">## UTIL</span>
  1794. <span class="hljs-comment">#</span>
  1795. <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_file</span><span class="hljs-params">(filename)</span>:</span>
  1796. <span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
  1797. <span class="hljs-keyword">return</span> file.readlines()
  1798. <span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
  1799. main()
  1800. </code></pre>
  1801. <footer>
  1802. <aside>March 14, 2018</aside>
  1803. <a href="../" rel="author">Jure Šorn</a>
  1804. </footer>
  1805. <br>
  1806. <br>
  1807. <br>
  1808. <script src="web/jquery-3.4.0.min.js"></script>
  1809. <script src="web/script_2.js"></script>
  1810. </body>
  1811. </html>