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.
2951 lines
322 KiB
2951 lines
322 KiB
<!DOCTYPE html>
|
|
<html class="ocks-org do-not-copy" lang="en">
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<title>Comprehensive Python Cheatsheet</title>
|
|
<meta name="description" content="Exhaustive, simple, beautiful and concise. A truly Pythonic cheat sheet about Python programming language.">
|
|
<link rel="icon" href="web/favicon.png">
|
|
|
|
<link rel="stylesheet" href="web/default.min.css">
|
|
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css">
|
|
<link rel="stylesheet" href="web/style.css">
|
|
|
|
<script>
|
|
// Uses dark theme 3 if it's specified in query string orbrowser prefers dark mode and
|
|
// theme is not explicitly set.
|
|
if ((window.location.search.search(/[?&]theme=dark3/) !== -1) || ((window.location.search.search(/[?&]theme=/) == -1) && (window.matchMedia('(prefers-color-scheme: dark)').matches))) {
|
|
document.write("<link rel=\"stylesheet\" href=\"web/default_dark3.min.css\">");
|
|
document.write("<link rel=\"stylesheet\" href=\"web/style_dark3.css\">");
|
|
}
|
|
else if (window.location.search.search(/[?&]theme=dark2/) !== -1) {
|
|
document.write("<link rel=\"stylesheet\" href=\"web/default_dark2.min.css\">");
|
|
document.write("<link rel=\"stylesheet\" href=\"web/style_dark2.css\">");
|
|
}
|
|
else if (window.location.search.search(/[?&]theme=dark1/) !== -1) {
|
|
document.write("<link rel=\"stylesheet\" href=\"web/default_dark1.min.css\">");
|
|
document.write("<link rel=\"stylesheet\" href=\"web/style_dark1.css\">");
|
|
}
|
|
else if (window.location.search.search(/[?&]theme=dark/) !== -1) {
|
|
document.write("<link rel=\"stylesheet\" href=\"web/default_dark.min.css\">");
|
|
document.write("<link rel=\"stylesheet\" href=\"web/style_dark.css\">");
|
|
}
|
|
</script>
|
|
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:title" content="Comprehensive Python Cheatsheet">
|
|
<meta name="twitter:description" content="Exhaustive, simple, beautiful and concise. A truly Pythonic cheat sheet about Python programming language.">
|
|
<meta name="twitter:image" content="https://gto76.github.io/python-cheatsheet/web/image_social_4.png">
|
|
|
|
<meta property="og:url" content="https://gto76.github.io/python-cheatsheet/">
|
|
<meta property="og:title" content="Comprehensive Python Cheatsheet">
|
|
<meta property="og:description" content="Exhaustive, simple, beautiful and concise. A truly Pythonic cheat sheet about Python programming language.">
|
|
<meta property="og:site_name" content="gto76.github.io">
|
|
<meta property="og:image" content="https://gto76.github.io/python-cheatsheet/web/image_social_4.png">
|
|
<meta property="og:type" content="article">
|
|
|
|
<meta itemprop="url" content="https://gto76.github.io/python-cheatsheet/">
|
|
<meta itemprop="name" content="Comprehensive Python Cheatsheet">
|
|
<meta itemprop="description" content="Exhaustive, simple, beautiful and concise. A truly Pythonic cheat sheet about Python programming language.">
|
|
<meta itemprop="image" content="https://gto76.github.io/python-cheatsheet/web/image_social_4.png">
|
|
|
|
<meta name="google-site-verification" content="w3rvuG0D1kUm_w20qsJecSEZh59Am8jK4eSPVU83e_M">
|
|
<meta name="viewport" id="viewport-meta">
|
|
</head>
|
|
|
|
<body>
|
|
<header>
|
|
<aside>September 16, 2025</aside>
|
|
<a href="https://gto76.github.io" rel="author">Jure Šorn</a>
|
|
</header>
|
|
|
|
<div><h1 id="comprehensivepythoncheatsheet">Comprehensive Python Cheatsheet</h1><p class="banner"><sup><a href="https://raw.githubusercontent.com/gto76/python-cheatsheet/main/README.md">Download text file</a>, <a href="https://github.com/gto76/python-cheatsheet">Fork me on GitHub</a>, <a href="https://github.com/gto76/python-cheatsheet/wiki/Frequently-Asked-Questions">Check out FAQ</a> or <a href="index.html?theme=dark3">Switch to dark theme</a>.
|
|
</sup></p><p class="banner" style="margin-bottom: 20px; padding-bottom: 7px;"><img src="web/image_888.jpeg" alt="Monty Python"></p><script>
|
|
// Changes the banner image and link-to-theme if "theme=dark" is in query string
|
|
// or if browser prefers dark mode and theme is not explicitly set.
|
|
|
|
const theme_not_set_in_query = window.location.search.search(/[?&]theme=light/) == -1
|
|
const browser_prefers_dark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
|
|
if ((window.location.search.search(/[?&]theme=dark/) !== -1) ||
|
|
(theme_not_set_in_query && browser_prefers_dark)) {
|
|
activateDarkMode();
|
|
}
|
|
|
|
function activateDarkMode() {
|
|
var link_to_theme = document.createElement("a")
|
|
link_to_theme.href = "index.html?theme=light"
|
|
link_to_theme.text = "Switch to light theme"
|
|
document.getElementsByClassName("banner")[0].firstChild.children[3].replaceWith(link_to_theme)
|
|
|
|
var img_dark = document.createElement("img");
|
|
img_dark.src = "web/image_orig_blue6.png";
|
|
img_dark.alt = "Monthy Python";
|
|
if ((window.location.search.search(/[?&]theme=dark2/) !== -1) ||
|
|
(window.location.search.search(/[?&]theme=dark3/) !== -1) ||
|
|
(theme_not_set_in_query && browser_prefers_dark)) {
|
|
img_dark.style = "width: 910px;";
|
|
} else {
|
|
img_dark.style = "width: 960px;";
|
|
}
|
|
document.getElementsByClassName("banner")[1].firstChild.replaceWith(img_dark);
|
|
}
|
|
</script><pre style="border-left: none;padding-left: 1.9px;"><code class="hljs bash" style="line-height: 1.327em;"><strong>ToC</strong> = {
|
|
<strong><span class="hljs-string"><span class="hljs-string">'1. Collections'</span></span></strong>: [<a href="#list">List</a>, <a href="#dictionary">Dictionary</a>, <a href="#set">Set</a>, <a href="#tuple">Tuple</a>, <a href="#range">Range</a>, <a href="#enumerate">Enumerate</a>, <a href="#iterator">Iterator</a>, <a href="#generator">Generator</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'2. Types'</span></span></strong>: [<a href="#type">Type</a>, <a href="#string">String</a>, <a href="#regex">Regular_Exp</a>, <a href="#format">Format</a>, <a href="#numbers">Numbers</a>, <a href="#combinatorics">Combinatorics</a>, <a href="#datetime">Datetime</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'3. Syntax'</span></span></strong>: [<a href="#function">Function</a>, <a href="#inline">Inline</a>, <a href="#imports">Import</a>, <a href="#decorator">Decorator</a>, <a href="#class">Class</a>, <a href="#ducktypes">Duck_Type</a>, <a href="#enum">Enum</a>, <a href="#exceptions">Except</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'4. System'</span></span></strong>: [<a href="#exit">Exit</a>, <a href="#print">Print</a>, <a href="#input">Input</a>, <a href="#commandlinearguments">Command_Line_Arguments</a>, <a href="#open">Open</a>, <a href="#paths">Path</a>, <a href="#oscommands">OS_Commands</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'5. Data'</span></span></strong>: [<a href="#json">JSON</a>, <a href="#pickle">Pickle</a>, <a href="#csv">CSV</a>, <a href="#sqlite">SQLite</a>, <a href="#bytes">Bytes</a>, <a href="#struct">Struct</a>, <a href="#array">Array</a>, <a href="#memoryview">Memory_View</a>, <a href="#deque">Deque</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'6. Advanced'</span></span></strong>: [<a href="#operator">Operator</a>, <a href="#matchstatement">Match_Stmt</a>, <a href="#logging">Logging</a>, <a href="#introspection">Introspection</a>, <a href="#threading">Threading</a>, <a href="#coroutines">Coroutines</a>],
|
|
<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="#consoleapp">Console_App</a>, <a href="#guiapp">GUI</a>, <a href="#scraping">Scraping</a>, <a href="#webapp">Web</a>, <a href="#profiling">Profile</a>],
|
|
<strong><span class="hljs-string"><span class="hljs-string">'8. Multimedia'</span></span></strong>: [<a href="#numpy">NumPy</a>, <a href="#image">Image</a>, <a href="#animation">Animation</a>, <a href="#audio">Audio</a>, <a href="#synthesizer">Synthesizer</a>, <a href="#pygame">Pygame</a>, <a href="#pandas">Pandas</a>, <a href="#plotly">Plotly</a>]
|
|
}
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
<div><h2 id="main"><a href="#main" name="main">#</a>Main</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>: <span class="hljs-comment"># Skips next line if file was imported.</span>
|
|
main() <span class="hljs-comment"># Runs `def main(): ...` function.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="list"><a href="#list" name="list">#</a>List</h2><pre><code class="python language-python hljs"><list> = [<el_1>, <el_2>, ...] <span class="hljs-comment"># Creates a list object. Also list(<collection>).</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><el> = <list>[index] <span class="hljs-comment"># First index is 0. Last -1. Allows assignments.</span>
|
|
<list> = <list>[<slice>] <span class="hljs-comment"># Also <list>[from_inclusive : to_exclusive : ±step].</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list>.append(<el>) <span class="hljs-comment"># Appends element to the end. Also <list> += [<el>].</span>
|
|
<list>.extend(<collection>) <span class="hljs-comment"># Appends elements to the end. Also <list> += <coll>.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list>.sort() <span class="hljs-comment"># Sorts the elements in ascending order.</span>
|
|
<list>.reverse() <span class="hljs-comment"># Reverses the order of list's elements.</span>
|
|
<list> = sorted(<collection>) <span class="hljs-comment"># Returns a new list with sorted elements.</span>
|
|
<iter> = reversed(<list>) <span class="hljs-comment"># Returns reversed iterator of elements.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><el> = max(<collection>) <span class="hljs-comment"># Returns largest element. Also min(<el_1>, ...).</span>
|
|
<num> = sum(<collection>) <span class="hljs-comment"># Returns sum of elements. Also math.prod(<coll>).</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">elementwise_sum = [sum(pair) <span class="hljs-keyword">for</span> pair <span class="hljs-keyword">in</span> zip(list_a, list_b)]
|
|
sorted_by_second = sorted(<collection>, key=<span class="hljs-keyword">lambda</span> el: el[<span class="hljs-number">1</span>])
|
|
sorted_by_both = sorted(<collection>, key=<span class="hljs-keyword">lambda</span> el: (el[<span class="hljs-number">1</span>], el[<span class="hljs-number">0</span>]))
|
|
flatter_list = list(itertools.chain.from_iterable(<list>))
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>For details about sort(), sorted(), min() and max() see <a href="#sortable">Sortable</a>.</strong></li>
|
|
<li><strong>Module <a href="#operator">operator</a> has function itemgetter() that can replace listed <a href="#lambda">lambdas</a>.</strong></li>
|
|
<li><strong>This text uses the term collection instead of iterable. For rationale see <a href="#collection">Collection</a>.</strong></li>
|
|
</ul>
|
|
<pre><code class="python language-python hljs"><int> = len(<list>) <span class="hljs-comment"># Returns number of items. Also works on dict, set and string.</span>
|
|
<int> = <list>.count(<el>) <span class="hljs-comment"># Returns number of occurrences. Also `if <el> in <coll>: ...`.</span>
|
|
<int> = <list>.index(<el>) <span class="hljs-comment"># Returns index of the first occurrence or raises ValueError.</span>
|
|
<el> = <list>.pop() <span class="hljs-comment"># Removes and returns item from the end or at index if passed.</span>
|
|
<list>.insert(<int>, <el>) <span class="hljs-comment"># Inserts item at passed index and moves the rest to the right.</span>
|
|
<list>.remove(<el>) <span class="hljs-comment"># Removes first occurrence of the item or raises ValueError.</span>
|
|
<list>.clear() <span class="hljs-comment"># Removes all list's items. Also works on dictionary and set.</span>
|
|
</code></pre>
|
|
<div><h2 id="dictionary"><a href="#dictionary" name="dictionary">#</a>Dictionary</h2><pre><code class="python language-python hljs"><dict> = {key_1: val_1, key_2: val_2, ...} <span class="hljs-comment"># Use `<dict>[key]` to get or set the value.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><view> = <dict>.keys() <span class="hljs-comment"># Collection of keys that reflects changes.</span>
|
|
<view> = <dict>.values() <span class="hljs-comment"># Collection of values that reflects changes.</span>
|
|
<view> = <dict>.items() <span class="hljs-comment"># Coll. of key-value tuples that reflects chgs.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">value = <dict>.get(key, default=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Returns default argument if key is missing.</span>
|
|
value = <dict>.setdefault(key, default=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Returns and writes default if key is missing.</span>
|
|
<dict> = collections.defaultdict(<type>) <span class="hljs-comment"># Returns a dict with default value `<type>()`.</span>
|
|
<dict> = collections.defaultdict(<span class="hljs-keyword">lambda</span>: <span class="hljs-number">1</span>) <span class="hljs-comment"># Returns a dict with default value 1.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><dict> = dict(<collection>) <span class="hljs-comment"># Creates a dict from coll. of key-value pairs.</span>
|
|
<dict> = dict(zip(keys, values)) <span class="hljs-comment"># Creates a dict from two collections.</span>
|
|
<dict> = dict.fromkeys(keys [, value]) <span class="hljs-comment"># Creates a dict from collection of keys.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><dict>.update(<dict>) <span class="hljs-comment"># Adds items. Replaces ones with matching keys.</span>
|
|
value = <dict>.pop(key) <span class="hljs-comment"># Removes item or raises KeyError if missing.</span>
|
|
{k <span class="hljs-keyword">for</span> k, v <span class="hljs-keyword">in</span> <dict>.items() <span class="hljs-keyword">if</span> v == value} <span class="hljs-comment"># Returns set of keys that point to the value.</span>
|
|
{k: v <span class="hljs-keyword">for</span> k, v <span class="hljs-keyword">in</span> <dict>.items() <span class="hljs-keyword">if</span> k <span class="hljs-keyword">in</span> keys} <span class="hljs-comment"># Filters the dictionary by specified keys.</span>
|
|
</code></pre>
|
|
<div><h3 id="counter">Counter</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> Counter
|
|
<span class="hljs-meta">>>> </span>counter = Counter([<span class="hljs-string">'blue'</span>, <span class="hljs-string">'blue'</span>, <span class="hljs-string">'blue'</span>, <span class="hljs-string">'red'</span>, <span class="hljs-string">'red'</span>])
|
|
<span class="hljs-meta">>>> </span>counter[<span class="hljs-string">'yellow'</span>] += <span class="hljs-number">1</span>
|
|
<span class="hljs-meta">>>> </span>print(counter.most_common())
|
|
[(<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>)]
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="set"><a href="#set" name="set">#</a>Set</h2><pre><code class="python language-python hljs"><set> = {<el_1>, <el_2>, ...} <span class="hljs-comment"># Use `set()` for empty set.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><set>.add(<el>) <span class="hljs-comment"># Or: <set> |= {<el>}</span>
|
|
<set>.update(<collection> [, ...]) <span class="hljs-comment"># Or: <set> |= <set></span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><set> = <set>.union(<coll.>) <span class="hljs-comment"># Or: <set> | <set></span>
|
|
<set> = <set>.intersection(<coll.>) <span class="hljs-comment"># Or: <set> & <set></span>
|
|
<set> = <set>.difference(<coll.>) <span class="hljs-comment"># Or: <set> - <set></span>
|
|
<set> = <set>.symmetric_difference(<coll.>) <span class="hljs-comment"># Or: <set> ^ <set></span>
|
|
<bool> = <set>.issubset(<coll.>) <span class="hljs-comment"># Or: <set> <= <set></span>
|
|
<bool> = <set>.issuperset(<coll.>) <span class="hljs-comment"># Or: <set> >= <set></span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><el> = <set>.pop() <span class="hljs-comment"># Raises KeyError if empty.</span>
|
|
<set>.remove(<el>) <span class="hljs-comment"># Raises KeyError if missing.</span>
|
|
<set>.discard(<el>) <span class="hljs-comment"># Doesn't raise an error.</span>
|
|
</code></pre>
|
|
<div><h3 id="frozenset">Frozen Set</h3><ul>
|
|
<li><strong>Is immutable and hashable.</strong></li>
|
|
<li><strong>That means it can be used as a key in a dictionary or as an element in a set.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><frozenset> = frozenset(<collection>)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h2 id="tuple"><a href="#tuple" name="tuple">#</a>Tuple</h2><p><strong>Tuple is an immutable and hashable list.</strong></p><pre><code class="python language-python hljs"><tuple> = () <span class="hljs-comment"># Empty tuple.</span>
|
|
<tuple> = (<el>,) <span class="hljs-comment"># Or: <el>,</span>
|
|
<tuple> = (<el_1>, <el_2> [, ...]) <span class="hljs-comment"># Or: <el_1>, <el_2> [, ...]</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="namedtuple">Named Tuple</h3><p><strong>Tuple's subclass with named elements.</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
|
|
<span class="hljs-meta">>>> </span>Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>)
|
|
<span class="hljs-meta">>>> </span>p = Point(<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
|
|
<span class="hljs-meta">>>> </span>print(p)
|
|
Point(x=<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>)
|
|
<span class="hljs-meta">>>> </span>p.x, p[<span class="hljs-number">1</span>]
|
|
(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h2 id="range"><a href="#range" name="range">#</a>Range</h2><p><strong>Immutable and hashable sequence of integers.</strong></p><pre><code class="python language-python hljs"><range> = range(stop) <span class="hljs-comment"># I.e. range(to_exclusive).</span>
|
|
<range> = range(start, stop) <span class="hljs-comment"># I.e. range(from_inclusive, to_exclusive).</span>
|
|
<range> = range(start, stop, ±step) <span class="hljs-comment"># I.e. range(from_inclusive, to_exclusive, ±step).</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>[i <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">3</span>)]
|
|
[<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>]
|
|
</code></pre>
|
|
<div><h2 id="enumerate"><a href="#enumerate" name="enumerate">#</a>Enumerate</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">for</span> i, el <span class="hljs-keyword">in</span> enumerate(<coll>, start=<span class="hljs-number">0</span>): <span class="hljs-comment"># Returns next element and its index on each pass.</span>
|
|
...
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="iterator"><a href="#iterator" name="iterator">#</a>Iterator</h2><p><strong>Potentially endless stream of elements.</strong></p><pre><code class="python language-python hljs"><iter> = iter(<collection>) <span class="hljs-comment"># `iter(<iter>)` returns unmodified iterator.</span>
|
|
<iter> = iter(<function>, to_exclusive) <span class="hljs-comment"># A sequence of return values until 'to_exclusive'.</span>
|
|
<el> = next(<iter> [, default]) <span class="hljs-comment"># Raises StopIteration or returns 'default' on end.</span>
|
|
<list> = list(<iter>) <span class="hljs-comment"># Returns a list of iterator's remaining elements.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="itertools">Itertools</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> itertools <span class="hljs-keyword">as</span> it
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><iter> = it.count(start=<span class="hljs-number">0</span>, step=<span class="hljs-number">1</span>) <span class="hljs-comment"># Returns updated value endlessly. Accepts floats.</span>
|
|
<iter> = it.repeat(<el> [, times]) <span class="hljs-comment"># Returns element endlessly or 'times' times.</span>
|
|
<iter> = it.cycle(<collection>) <span class="hljs-comment"># Repeats the passed sequence of elements endlessly.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><iter> = it.chain(<coll>, <coll> [, ...]) <span class="hljs-comment"># Empties collections in order (only figuratively).</span>
|
|
<iter> = it.chain.from_iterable(<coll>) <span class="hljs-comment"># Empties collections inside a collection in order.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><iter> = it.islice(<coll>, to_exclusive) <span class="hljs-comment"># Only returns first 'to_exclusive' elements.</span>
|
|
<iter> = it.islice(<coll>, from_inc, …) <span class="hljs-comment"># `to_exclusive, +step_size`. Indices can be None.</span>
|
|
</code></pre>
|
|
<div><h2 id="generator"><a href="#generator" name="generator">#</a>Generator</h2><ul>
|
|
<li><strong>Any function that contains a yield statement returns a generator.</strong></li>
|
|
<li><strong>Generators and iterators are interchangeable.</strong></li>
|
|
</ul><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>
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
|
|
<span class="hljs-keyword">yield</span> start
|
|
start += step
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>counter = count(<span class="hljs-number">10</span>, <span class="hljs-number">2</span>)
|
|
<span class="hljs-meta">>>> </span>next(counter), next(counter), next(counter)
|
|
(<span class="hljs-number">10</span>, <span class="hljs-number">12</span>, <span class="hljs-number">14</span>)
|
|
</code></pre>
|
|
<div><h2 id="type"><a href="#type" name="type">#</a>Type</h2><ul>
|
|
<li><strong>Everything is an object.</strong></li>
|
|
<li><strong>Every object has a type.</strong></li>
|
|
<li><strong>Type and class are synonymous.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><type> = type(<el>) <span class="hljs-comment"># Or: <el>.__class__</span>
|
|
<bool> = isinstance(<el>, <type>) <span class="hljs-comment"># Or: issubclass(type(<el>), <type>)</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>type(<span class="hljs-string">'a'</span>), <span class="hljs-string">'a'</span>.__class__, str
|
|
(<<span class="hljs-class"><span class="hljs-title">class</span> '<span class="hljs-title">str</span>'>, <<span class="hljs-title">class</span> '<span class="hljs-title">str</span>'>, <<span class="hljs-title">class</span> '<span class="hljs-title">str</span>'>)
|
|
</span></code></pre>
|
|
<div><h4 id="sometypesdonothavebuiltinnamessotheymustbeimported">Some types do not have built-in names, so they must be imported:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> types <span class="hljs-keyword">import</span> FunctionType, MethodType, LambdaType, GeneratorType, ModuleType
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="abstractbaseclasses">Abstract Base Classes</h3><p><strong>Each abstract base class specifies a set of virtual subclasses. These classes are then recognized by isinstance() and issubclass() as subclasses of the ABC, although they are really not. ABC can also manually decide whether or not a specific class is its virtual subclass, usually based on which methods the class has implemented. For instance, Iterable ABC looks for method iter(), while Collection ABC looks for iter(), contains() and len().</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> collections.abc <span class="hljs-keyword">import</span> Iterable, Collection, Sequence
|
|
<span class="hljs-meta">>>> </span>isinstance([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], Iterable)
|
|
<span class="hljs-keyword">True</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="text language-text">┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┓
|
|
┃ │ Iterable │ Collection │ Sequence ┃
|
|
┠──────────────────┼────────────┼────────────┼────────────┨
|
|
┃ list, range, str │ ✓ │ ✓ │ ✓ ┃
|
|
┃ dict, set │ ✓ │ ✓ │ ┃
|
|
┃ iter │ ✓ │ │ ┃
|
|
┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┛
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> numbers <span class="hljs-keyword">import</span> Number, Complex, Real, Rational, Integral
|
|
<span class="hljs-meta">>>> </span>isinstance(<span class="hljs-number">123</span>, Number)
|
|
<span class="hljs-keyword">True</span>
|
|
</code></pre>
|
|
<pre><code class="text language-text">┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┯━━━━━━━━━━┓
|
|
┃ │ Number │ Complex │ Real │ Rational │ Integral ┃
|
|
┠────────────────────┼──────────┼──────────┼──────────┼──────────┼──────────┨
|
|
┃ int │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ ┃
|
|
┃ fractions.Fraction │ ✓ │ ✓ │ ✓ │ ✓ │ ┃
|
|
┃ float │ ✓ │ ✓ │ ✓ │ │ ┃
|
|
┃ complex │ ✓ │ ✓ │ │ │ ┃
|
|
┃ decimal.Decimal │ ✓ │ │ │ │ ┃
|
|
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┷━━━━━━━━━━┛
|
|
</code></pre>
|
|
<div><h2 id="string"><a href="#string" name="string">#</a>String</h2><p><strong>Immutable sequence of characters.</strong></p><pre><code class="python language-python hljs"><str> = <span class="hljs-string">'abc'</span> <span class="hljs-comment"># Also "abc". Interprets \n, \t, \x00-\xff, etc.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><str> = <str>.strip() <span class="hljs-comment"># Strips all whitespace characters from both ends.</span>
|
|
<str> = <str>.strip(<span class="hljs-string">'<chars>'</span>) <span class="hljs-comment"># Strips passed characters. Also lstrip/rstrip().</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list> = <str>.split() <span class="hljs-comment"># Splits it on one or more whitespace characters.</span>
|
|
<list> = <str>.split(sep=<span class="hljs-keyword">None</span>, maxsplit=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Splits on 'sep' string at most 'maxsplit' times.</span>
|
|
<list> = <str>.splitlines(keepends=<span class="hljs-keyword">False</span>) <span class="hljs-comment"># On [\n\r\f\v\x1c-\x1e\x85\u2028\u2029] and \r\n.</span>
|
|
<str> = <str>.join(<coll_of_strings>) <span class="hljs-comment"># Joins items by using the string as a separator.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><bool> = <sub_str> <span class="hljs-keyword">in</span> <str> <span class="hljs-comment"># Returns True if string contains the substring.</span>
|
|
<bool> = <str>.startswith(<sub_str>) <span class="hljs-comment"># Pass tuple of strings to give multiple options.</span>
|
|
<int> = <str>.find(<sub_str>) <span class="hljs-comment"># Returns start index of the first match or -1.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><str> = <str>.lower() <span class="hljs-comment"># Lowers the case. Also upper/capitalize/title().</span>
|
|
<str> = <str>.casefold() <span class="hljs-comment"># Lower() that converts ẞ/ß to ss, Σ/ς to σ, etc.</span>
|
|
<str> = <str>.replace(old, new [, count]) <span class="hljs-comment"># Replaces 'old' with 'new' at most 'count' times.</span>
|
|
<str> = <str>.translate(<table>) <span class="hljs-comment"># Use `str.maketrans(<dict>)` to generate table.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><str> = chr(<int>) <span class="hljs-comment"># Converts passed integer into Unicode character.</span>
|
|
<int> = ord(<str>) <span class="hljs-comment"># Converts passed Unicode character into integer.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'unicodedata.normalize("NFC", <str>)'</span></code> on strings like <code class="python hljs"><span class="hljs-string">'Motörhead'</span></code> before comparing them to other strings, because <code class="python hljs"><span class="hljs-string">'ö'</span></code> can be stored as one or two characters.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'NFC'</span></code> converts such characters to a single character, while <code class="python hljs"><span class="hljs-string">'NFD'</span></code> converts them to two.</strong></li>
|
|
</ul>
|
|
<pre><code class="python language-python hljs"><bool> = <str>.isdecimal() <span class="hljs-comment"># Checks all chars for [0-9]. Also [०-९], [٠-٩].</span>
|
|
<bool> = <str>.isdigit() <span class="hljs-comment"># Checks for [²³¹…] and isdecimal(). Also [፩-፱].</span>
|
|
<bool> = <str>.isnumeric() <span class="hljs-comment"># Checks for [¼½¾…] and isdigit(). Also [零〇一…].</span>
|
|
<bool> = <str>.isalnum() <span class="hljs-comment"># Checks for [ABC…] and isnumeric(). Also [ªµº…].</span>
|
|
<bool> = <str>.isprintable() <span class="hljs-comment"># Checks for [ !"#$…] and isalnum(). Also emojis.</span>
|
|
<bool> = <str>.isspace() <span class="hljs-comment"># Checks for [ \t\n\r\f\v\x1c\x1d\x1e\x1f\x85…].</span>
|
|
</code></pre>
|
|
<div><h2 id="regex"><a href="#regex" name="regex">#</a>Regex</h2><p><strong>Functions for regular expression matching.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> re
|
|
<str> = re.sub(<span class="hljs-string">r'<regex>'</span>, new, text, count=<span class="hljs-number">0</span>) <span class="hljs-comment"># Substitutes all occurrences with 'new'.</span>
|
|
<list> = re.findall(<span class="hljs-string">r'<regex>'</span>, text) <span class="hljs-comment"># Returns all occurrences of the pattern.</span>
|
|
<list> = re.split(<span class="hljs-string">r'<regex>'</span>, text, maxsplit=<span class="hljs-number">0</span>) <span class="hljs-comment"># Add brackets around regex to keep matches.</span>
|
|
<Match> = re.search(<span class="hljs-string">r'<regex>'</span>, text) <span class="hljs-comment"># First occurrence of the pattern or None.</span>
|
|
<Match> = re.match(<span class="hljs-string">r'<regex>'</span>, text) <span class="hljs-comment"># Searches only at the beginning of the text.</span>
|
|
<iter> = re.finditer(<span class="hljs-string">r'<regex>'</span>, text) <span class="hljs-comment"># Returns all occurrences as Match objects.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Raw string literals do not interpret escape sequences, thus enabling us to use regex-specific escape sequences that cause SyntaxWarning in normal string literals (since 3.12).</strong></li>
|
|
<li><strong>Argument 'new' of re.sub() can be a function that accepts Match object and returns a str.</strong></li>
|
|
<li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.IGNORECASE'</span></code> can be used with all functions that are listed above.</strong></li>
|
|
<li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.MULTILINE'</span></code> makes <code class="python hljs"><span class="hljs-string">'^'</span></code> and <code class="python hljs"><span class="hljs-string">'$'</span></code> match the start/end of each line.</strong></li>
|
|
<li><strong>Argument <code class="python hljs"><span class="hljs-string">'flags=re.DOTALL'</span></code> makes <code class="python hljs"><span class="hljs-string">'.'</span></code> also accept the <code class="python hljs"><span class="hljs-string">'\n'</span></code> (besides all other chars).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'re.compile(<regex>)'</span></code> returns a Pattern object with methods sub(), findall(), etc.</strong></li>
|
|
</ul>
|
|
<div><h3 id="matchobject">Match Object</h3><pre><code class="python language-python hljs"><str> = <Match>.group() <span class="hljs-comment"># Returns the whole match. Also group(0).</span>
|
|
<str> = <Match>.group(<span class="hljs-number">1</span>) <span class="hljs-comment"># Returns part inside the first brackets.</span>
|
|
<tuple> = <Match>.groups() <span class="hljs-comment"># Returns all bracketed parts as strings.</span>
|
|
<int> = <Match>.start() <span class="hljs-comment"># Returns start index of the whole match.</span>
|
|
<int> = <Match>.end() <span class="hljs-comment"># Returns its exclusive end index.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="specialsequences">Special Sequences</h3><pre><code class="python language-python hljs"><span class="hljs-string">'\d'</span> == <span class="hljs-string">'[0-9]'</span> <span class="hljs-comment"># Also [०-९…]. Matches a decimal character.</span>
|
|
<span class="hljs-string">'\w'</span> == <span class="hljs-string">'[a-zA-Z0-9_]'</span> <span class="hljs-comment"># Also [ª²³…]. Matches an alphanumeric or _.</span>
|
|
<span class="hljs-string">'\s'</span> == <span class="hljs-string">'[ \t\n\r\f\v]'</span> <span class="hljs-comment"># Also [\x1c-\x1f…]. Matches a whitespace.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>By default, decimal characters and alphanumerics from all alphabets are matched unless <code class="python hljs"><span class="hljs-string">'flags=re.ASCII'</span></code> is used. It restricts special sequence matches to the first 128 Unicode characters and also prevents <code class="python hljs"><span class="hljs-string">'\s'</span></code> from accepting <code class="python hljs"><span class="hljs-string">'\x1c'</span></code>, <code class="python hljs"><span class="hljs-string">'\x1d'</span></code>, <code class="python hljs"><span class="hljs-string">'\x1e'</span></code> and <code class="python hljs"><span class="hljs-string">'\x1f'</span></code> (non-printable characters that divide text into files, tables, rows and fields, respectively).</strong></li>
|
|
<li><strong>Use a capital letter for negation (all non-ASCII characters will be matched when used in combination with ASCII flag).</strong></li>
|
|
</ul>
|
|
<div><h2 id="format"><a href="#format" name="format">#</a>Format</h2><pre><code class="python hljs"><str> = <span class="hljs-string">f'<span class="hljs-subst">{<el_1>}</span>, <span class="hljs-subst">{<el_2>}</span>'</span> <span class="hljs-comment"># Curly braces can also contain expressions.</span>
|
|
<str> = <span class="hljs-string">'{}, {}'</span>.format(<el_1>, <el_2>) <span class="hljs-comment"># Same as '{0}, {a}'.format(<el_1>, a=<el_2>).</span>
|
|
<str> = <span class="hljs-string">'%s, %s'</span> % (<el_1>, <el_2>) <span class="hljs-comment"># Redundant and inferior C-style formatting.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="example">Example</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>Person = collections.namedtuple(<span class="hljs-string">'Person'</span>, <span class="hljs-string">'name height'</span>)
|
|
<span class="hljs-meta">>>> </span>person = Person(<span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>)
|
|
<span class="hljs-meta">>>> </span><span class="hljs-string">f'<span class="hljs-subst">{person.name}</span> is <span class="hljs-subst">{person.height / <span class="hljs-number">100</span>}</span> meters tall.'</span>
|
|
<span class="hljs-string">'Jean-Luc is 1.87 meters tall.'</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="generaloptions">General Options</h3><pre><code class="python language-python hljs">{<el>:<<span class="hljs-number">10</span>} <span class="hljs-comment"># '<el> '</span>
|
|
{<el>:^<span class="hljs-number">10</span>} <span class="hljs-comment"># ' <el> '</span>
|
|
{<el>:><span class="hljs-number">10</span>} <span class="hljs-comment"># ' <el>'</span>
|
|
{<el>:.<<span class="hljs-number">10</span>} <span class="hljs-comment"># '<el>......'</span>
|
|
{<el>:<span class="hljs-number">0</span>} <span class="hljs-comment"># '<el>'</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Objects are rendered by calling the <code class="python hljs"><span class="hljs-string">'format(<el>, "<options>")'</span></code> function.</strong></li>
|
|
<li><strong>Options inside curly braces can be generated dynamically: <code class="python hljs"><span class="hljs-string">f'<span class="hljs-subst">{<el>:{<str/int>}</span>[…]}'</span></code>.</strong></li>
|
|
<li><strong>Adding <code class="python hljs"><span class="hljs-string">'='</span></code> to the expression prepends it to the output: <code class="python hljs"><span class="hljs-string">f'<span class="hljs-subst">{<span class="hljs-number">1</span>+<span class="hljs-number">1</span>=}</span>'</span></code> returns <code class="python hljs"><span class="hljs-string">'1+1=2'</span></code>.</strong></li>
|
|
<li><strong>Adding <code class="python hljs"><span class="hljs-string">'!r'</span></code> to the expression converts object to string by calling its <a href="#class">repr()</a> method.</strong></li>
|
|
</ul>
|
|
<div><h3 id="strings">Strings</h3><pre><code class="python language-python hljs">{<span class="hljs-string">'abcde'</span>:<span class="hljs-number">10</span>} <span class="hljs-comment"># 'abcde '</span>
|
|
{<span class="hljs-string">'abcde'</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># 'abc '</span>
|
|
{<span class="hljs-string">'abcde'</span>:<span class="hljs-number">.3</span>} <span class="hljs-comment"># 'abc'</span>
|
|
{<span class="hljs-string">'abcde'</span>!r:<span class="hljs-number">10</span>} <span class="hljs-comment"># "'abcde' "</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="numbers-1">Numbers</h3><pre><code class="python language-python hljs">{<span class="hljs-number">123456</span>:<span class="hljs-number">10</span>} <span class="hljs-comment"># ' 123456'</span>
|
|
{<span class="hljs-number">123456</span>:<span class="hljs-number">10</span>,} <span class="hljs-comment"># ' 123,456'</span>
|
|
{<span class="hljs-number">123456</span>:<span class="hljs-number">10</span>_} <span class="hljs-comment"># ' 123_456'</span>
|
|
{<span class="hljs-number">123456</span>:+<span class="hljs-number">10</span>} <span class="hljs-comment"># ' +123456'</span>
|
|
{<span class="hljs-number">123456</span>:=+<span class="hljs-number">10</span>} <span class="hljs-comment"># '+ 123456'</span>
|
|
{<span class="hljs-number">123456</span>: } <span class="hljs-comment"># ' 123456'</span>
|
|
{<span class="hljs-number">-123456</span>: } <span class="hljs-comment"># '-123456'</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="floats">Floats</h3><pre><code class="python language-python hljs">{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>} <span class="hljs-comment"># ' 1.23'</span>
|
|
{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>f} <span class="hljs-comment"># ' 1.235'</span>
|
|
{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>e} <span class="hljs-comment"># ' 1.235e+00'</span>
|
|
{<span class="hljs-number">1.23456</span>:<span class="hljs-number">10.3</span>%} <span class="hljs-comment"># ' 123.456%'</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="comparisonofpresentationtypes">Comparison of presentation types:</h4><pre><code class="text language-text">┏━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┓
|
|
┃ │ {<float>} │ {<float>:f} │ {<float>:e} │ {<float>:%} ┃
|
|
┠──────────────┼────────────────┼────────────────┼────────────────┼────────────────┨
|
|
┃ 0.000056789 │ '5.6789e-05' │ '0.000057' │ '5.678900e-05' │ '0.005679%' ┃
|
|
┃ 0.00056789 │ '0.00056789' │ '0.000568' │ '5.678900e-04' │ '0.056789%' ┃
|
|
┃ 0.0056789 │ '0.0056789' │ '0.005679' │ '5.678900e-03' │ '0.567890%' ┃
|
|
┃ 0.056789 │ '0.056789' │ '0.056789' │ '5.678900e-02' │ '5.678900%' ┃
|
|
┃ 0.56789 │ '0.56789' │ '0.567890' │ '5.678900e-01' │ '56.789000%' ┃
|
|
┃ 5.6789 │ '5.6789' │ '5.678900' │ '5.678900e+00' │ '567.890000%' ┃
|
|
┃ 56.789 │ '56.789' │ '56.789000' │ '5.678900e+01' │ '5678.900000%' ┃
|
|
┗━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┛
|
|
|
|
┏━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┓
|
|
┃ │ {<float>:.2} │ {<float>:.2f} │ {<float>:.2e} │ {<float>:.2%} ┃
|
|
┠──────────────┼────────────────┼────────────────┼────────────────┼────────────────┨
|
|
┃ 0.000056789 │ '5.7e-05' │ '0.00' │ '5.68e-05' │ '0.01%' ┃
|
|
┃ 0.00056789 │ '0.00057' │ '0.00' │ '5.68e-04' │ '0.06%' ┃
|
|
┃ 0.0056789 │ '0.0057' │ '0.01' │ '5.68e-03' │ '0.57%' ┃
|
|
┃ 0.056789 │ '0.057' │ '0.06' │ '5.68e-02' │ '5.68%' ┃
|
|
┃ 0.56789 │ '0.57' │ '0.57' │ '5.68e-01' │ '56.79%' ┃
|
|
┃ 5.6789 │ '5.7' │ '5.68' │ '5.68e+00' │ '567.89%' ┃
|
|
┃ 56.789 │ '5.7e+01' │ '56.79' │ '5.68e+01' │ '5678.90%' ┃
|
|
┗━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'{<float>:g}'</span></code> is <code class="python hljs"><span class="hljs-string">'{<float>:.6}'</span></code> with stripped zeros, exponent starting at <code class="python hljs"><span class="hljs-string">'1e+06'</span></code>.</strong></li>
|
|
<li><strong>When both rounding up and rounding down are possible, the one that returns result with even last digit is chosen. That makes <code class="python hljs"><span class="hljs-string">'{6.5:.0f}'</span></code> a <code class="python hljs"><span class="hljs-string">'6'</span></code> and <code class="python hljs"><span class="hljs-string">'{7.5:.0f}'</span></code> an <code class="python hljs"><span class="hljs-string">'8'</span></code>.</strong></li>
|
|
<li><strong>This rule only effects numbers that can be represented exactly by a float (<code class="python hljs"><span class="hljs-number">.5</span></code>, <code class="python hljs"><span class="hljs-number">.25</span></code>, …).</strong></li>
|
|
</ul>
|
|
<div><h3 id="ints">Ints</h3><pre><code class="python language-python hljs">{<span class="hljs-number">90</span>:c} <span class="hljs-comment"># 'Z'. Unicode character with value 90.</span>
|
|
{<span class="hljs-number">90</span>:b} <span class="hljs-comment"># '1011010'. Binary representation of the int.</span>
|
|
{<span class="hljs-number">90</span>:X} <span class="hljs-comment"># '5A'. Hexadecimal with upper-case letters.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="numbers"><a href="#numbers" name="numbers">#</a>Numbers</h2><pre><code class="python language-python hljs"><int> = int(<float/str/bool>) <span class="hljs-comment"># Whole number of any size. Truncates floats.</span>
|
|
<float> = float(<int/str/bool>) <span class="hljs-comment"># 64-bit decimal number. Also <float>e±<int>.</span>
|
|
<complex> = complex(real=<span class="hljs-number">0</span>, imag=<span class="hljs-number">0</span>) <span class="hljs-comment"># A complex number. Also `<float> ± <float>j`.</span>
|
|
<Fraction> = fractions.Fraction(<int>, <int>) <span class="hljs-comment"># E.g. `Fraction(1, 2) / 3 == Fraction(1, 6)`.</span>
|
|
<Decimal> = decimal.Decimal(<str/int/tuple>) <span class="hljs-comment"># E.g. `Decimal((1, (2, 3), 4)) == -230_000`.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'int(<str>)'</span></code> and <code class="python hljs"><span class="hljs-string">'float(<str>)'</span></code> raise ValueError if passed string is malformed.</strong></li>
|
|
<li><strong>Decimal objects store numbers exactly, unlike most floats where <code class="python hljs"><span class="hljs-string">'1.1 + 2.2 != 3.3'</span></code>.</strong></li>
|
|
<li><strong>Floats can be compared with: <code class="python hljs"><span class="hljs-string">'math.isclose(<float>, <float>, rel_tol=1e-09)'</span></code>.</strong></li>
|
|
<li><strong>Precision of decimal operations is set with: <code class="python hljs"><span class="hljs-string">'decimal.getcontext().prec = <int>'</span></code>.</strong></li>
|
|
<li><strong>Bools can be used anywhere ints can, because bool is a subclass of int: <code class="python hljs"><span class="hljs-string">'True + 1 == 2'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="builtinfunctions">Built-in Functions</h3><pre><code class="python language-python hljs"><num> = pow(<num>, <num>) <span class="hljs-comment"># E.g. `pow(2, 3) == 2 ** 3 == 8`.</span>
|
|
<num> = abs(<num>) <span class="hljs-comment"># E.g. `abs(complex(3, 4)) == 5`.</span>
|
|
<num> = round(<num> [, ±ndigits]) <span class="hljs-comment"># E.g. `round(123, -1) == 120`.</span>
|
|
<num> = min(<collection>) <span class="hljs-comment"># Also max(<num>, <num> [, ...]).</span>
|
|
<num> = sum(<collection>) <span class="hljs-comment"># Also math.prod(<collection>).</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="math">Math</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> floor, ceil, trunc <span class="hljs-comment"># They convert floats into integers.</span>
|
|
<span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> pi, inf, nan, isnan <span class="hljs-comment"># `inf * 0` and `nan + 1` return nan.</span>
|
|
<span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> sqrt, factorial <span class="hljs-comment"># `sqrt(-1)` will raise ValueError.</span>
|
|
<span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> sin, cos, tan <span class="hljs-comment"># Also: asin, acos, degrees, radians.</span>
|
|
<span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> log, log10, log2 <span class="hljs-comment"># Log accepts base as second argument.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="statistics">Statistics</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> statistics <span class="hljs-keyword">import</span> mean, median, mode <span class="hljs-comment"># Mode returns the most common item.</span>
|
|
<span class="hljs-keyword">from</span> statistics <span class="hljs-keyword">import</span> variance, stdev <span class="hljs-comment"># Also: pvariance, pstdev, quantiles.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="random">Random</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> random, randint, uniform <span class="hljs-comment"># Also: gauss, choice, shuffle, seed.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><float> = random() <span class="hljs-comment"># Returns a float inside [0, 1).</span>
|
|
<num> = randint/uniform(a, b) <span class="hljs-comment"># Returns an int/float inside [a, b].</span>
|
|
<float> = gauss(mean, stdev) <span class="hljs-comment"># Also triangular(low, high, mode).</span>
|
|
<el> = choice(<sequence>) <span class="hljs-comment"># Keeps it intact. Also sample(p, n).</span>
|
|
shuffle(<list>) <span class="hljs-comment"># Works on all mutable sequences.</span>
|
|
</code></pre>
|
|
<div><h3 id="hexadecimalnumbers">Hexadecimal Numbers</h3><pre><code class="python language-python hljs"><int> = <span class="hljs-number">0x</span><hex> <span class="hljs-comment"># E.g. `0xFF == 255`. Also 0b<bin>.</span>
|
|
<int> = int(<span class="hljs-string">'±<hex>'</span>, <span class="hljs-number">16</span>) <span class="hljs-comment"># Also int('±0x<hex>/±0b<bin>', 0).</span>
|
|
<str> = hex(<int>) <span class="hljs-comment"># Returns '[-]0x<hex>'. Also bin().</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="bitwiseoperators">Bitwise Operators</h3><pre><code class="python language-python hljs"><int> = <int> & <int> <span class="hljs-comment"># E.g. `0b1100 & 0b1010 == 0b1000`.</span>
|
|
<int> = <int> | <int> <span class="hljs-comment"># E.g. `0b1100 | 0b1010 == 0b1110`.</span>
|
|
<int> = <int> ^ <int> <span class="hljs-comment"># E.g. `0b1100 ^ 0b1010 == 0b0110`.</span>
|
|
<int> = <int> << n_bits <span class="hljs-comment"># E.g. `0b1111 << 4 == 0b11110000`.</span>
|
|
<int> = ~<int> <span class="hljs-comment"># E.g. `~0b1 == -0b10 == -(0b1+1)`.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="combinatorics"><a href="#combinatorics" name="combinatorics">#</a>Combinatorics</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> itertools <span class="hljs-keyword">as</span> it
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>list(it.product(<span class="hljs-string">'abc'</span>, repeat=<span class="hljs-number">2</span>)) <span class="hljs-comment"># a b c</span>
|
|
[(<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>), <span class="hljs-comment"># a x x x</span>
|
|
(<span class="hljs-string">'b'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'b'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>), <span class="hljs-comment"># b x x x</span>
|
|
(<span class="hljs-string">'c'</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>, <span class="hljs-string">'c'</span>)] <span class="hljs-comment"># c x x x</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>list(it.permutations(<span class="hljs-string">'abc'</span>, <span class="hljs-number">2</span>)) <span class="hljs-comment"># a b c</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>), <span class="hljs-comment"># a . x x</span>
|
|
(<span class="hljs-string">'b'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>), <span class="hljs-comment"># b x . x</span>
|
|
(<span class="hljs-string">'c'</span>, <span class="hljs-string">'a'</span>), (<span class="hljs-string">'c'</span>, <span class="hljs-string">'b'</span>)] <span class="hljs-comment"># c x x .</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>list(it.combinations(<span class="hljs-string">'abc'</span>, <span class="hljs-number">2</span>)) <span class="hljs-comment"># a b c</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>), <span class="hljs-comment"># a . x x</span>
|
|
(<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>) <span class="hljs-comment"># b . . x</span>
|
|
] <span class="hljs-comment"># c . . .</span>
|
|
</code></pre>
|
|
<div><h2 id="datetime"><a href="#datetime" name="datetime">#</a>Datetime</h2><p><strong>Provides 'date', 'time', 'datetime' and 'timedelta' classes. All are immutable and hashable.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install python-dateutil</span>
|
|
<span class="hljs-keyword">from</span> datetime <span class="hljs-keyword">import</span> date, time, datetime, timedelta, timezone
|
|
<span class="hljs-keyword">import</span> zoneinfo, dateutil.tz
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python apache hljs"><D> = date(year, month, day) <span class="hljs-comment"># Only accepts valid dates from 1 to 9999 AD.</span>
|
|
<T> = time(hour=<span class="hljs-number">0</span>, minute=<span class="hljs-number">0</span>, second=<span class="hljs-number">0</span>) <span class="hljs-comment"># Also: `microsecond=0, tzinfo=None, fold=0`.</span>
|
|
<DT> = datetime(year, month, day, hour=<span class="hljs-number">0</span>) <span class="hljs-comment"># Also: `minute=0, second=0, microsecond=0, …`.</span>
|
|
<TD> = timedelta(weeks=<span class="hljs-number">0</span>, days=<span class="hljs-number">0</span>, hours=<span class="hljs-number">0</span>) <span class="hljs-comment"># Also: `minutes=0, seconds=0, microseconds=0`.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Times and datetimes that have defined timezone are called aware and ones that don't, naive. If time or datetime object is naive, it is presumed to be in the system's timezone!</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'fold=1'</span></code> means the second pass in case of time jumping back (usually for one hour).</strong></li>
|
|
<li><strong>Timedelta normalizes arguments to ±days, seconds (< 86 400) and microseconds (< 1M). Its str() method returns <code class="python hljs"><span class="hljs-string">'[±D, ]H:MM:SS[.…]'</span></code> and total_seconds() a float of all seconds.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'<D/DT>.weekday()'</span></code> to get the day of the week as an integer, with Monday being 0.</strong></li>
|
|
</ul>
|
|
<div><h3 id="now">Now</h3><pre><code class="python language-python hljs"><D/DTn> = D/DT.today() <span class="hljs-comment"># Current local date or naive DT. Also DT.now().</span>
|
|
<DTa> = DT.now(<tzinfo>) <span class="hljs-comment"># Aware DT from current time in passed timezone.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>To extract time use <code class="python hljs"><span class="hljs-string">'<DTn>.time()'</span></code>, <code class="python hljs"><span class="hljs-string">'<DTa>.time()'</span></code> or <code class="python hljs"><span class="hljs-string">'<DTa>.timetz()'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="timezones">Timezones</h3><pre><code class="python language-python apache hljs"><tzinfo> = timezone.utc <span class="hljs-comment"># Coordinated universal time (UK without DST).</span>
|
|
<tzinfo> = timezone(<timedelta>) <span class="hljs-comment"># Timezone with fixed offset from universal time.</span>
|
|
<tzinfo> = dateutil.tz.tzlocal() <span class="hljs-comment"># Local timezone with dynamic offset from UTC.</span>
|
|
<tzinfo> = zoneinfo.ZoneInfo(<span class="hljs-string">'<iana_key>'</span>) <span class="hljs-comment"># 'Continent/City_Name' zone with dynamic offset.</span>
|
|
<DTa> = <DT>.astimezone([<tzinfo>]) <span class="hljs-comment"># Converts DT to the passed or local fixed zone.</span>
|
|
<Ta/DTa> = <T/DT>.replace(tzinfo=<tzinfo>) <span class="hljs-comment"># Changes object's timezone without conversion.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Timezones returned by tzlocal(), ZoneInfo() and implicit local timezone of naive objects have offsets that vary through time due to DST and historical changes of the base offset.</strong></li>
|
|
<li><strong>To get ZoneInfo() to work on Windows run <code class="python hljs"><span class="hljs-string">'> pip3 install tzdata'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="encode">Encode</h3><pre><code class="python language-python apache hljs"><D/T/DT> = D/T/DT.fromisoformat(<str>) <span class="hljs-comment"># Object from ISO string. Raises ValueError.</span>
|
|
<DT> = DT.strptime(<str>, <span class="hljs-string">'<format>'</span>) <span class="hljs-comment"># Datetime from custom string. See Format.</span>
|
|
<D/DTn> = D/DT.fromordinal(<int>) <span class="hljs-comment"># D/DT from days since the Gregorian NYE 1.</span>
|
|
<DTn> = DT.fromtimestamp(<float>) <span class="hljs-comment"># Local naive DT from seconds since the Epoch.</span>
|
|
<DTa> = DT.fromtimestamp(<float>, <tz>) <span class="hljs-comment"># Aware datetime from seconds since the Epoch.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<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.mmmuuu[±HH:MM]'</span></code>, or both separated by an arbitrary character. All parts following the hours are optional.</strong></li>
|
|
<li><strong>Python uses the Unix Epoch: <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>
|
|
</ul>
|
|
<div><h3 id="decode">Decode</h3><pre><code class="python language-python hljs"><str> = <D/T/DT>.isoformat(sep=<span class="hljs-string">'T'</span>) <span class="hljs-comment"># Also `timespec='auto/hours/minutes/seconds…'`.</span>
|
|
<str> = <D/T/DT>.strftime(<span class="hljs-string">'<format>'</span>) <span class="hljs-comment"># Custom string representation of the object.</span>
|
|
<int> = <D/DT>.toordinal() <span class="hljs-comment"># Days since NYE 1. Ignores DT's time and zone.</span>
|
|
<float> = <DTn>.timestamp() <span class="hljs-comment"># Seconds since the Epoch, from local naive DT.</span>
|
|
<float> = <DTa>.timestamp() <span class="hljs-comment"># Seconds since the Epoch, from aware datetime.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="format-1">Format</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>dt = datetime.strptime(<span class="hljs-string">'2025-08-14 23:39:00.00 +0200'</span>, <span class="hljs-string">'%Y-%m-%d %H:%M:%S.%f %z'</span>)
|
|
<span class="hljs-meta">>>> </span>dt.strftime(<span class="hljs-string">"%dth of %B '%y (%a), %I:%M %p %Z"</span>)
|
|
<span class="hljs-string">"14th of August '25 (Thu), 11:39 PM UTC+02:00"</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'%z'</span></code> accepts <code class="python hljs"><span class="hljs-string">'±HH[:]MM'</span></code> and returns <code class="python hljs"><span class="hljs-string">'±HHMM'</span></code> or empty string if object is naive.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'%Z'</span></code> accepts <code class="python hljs"><span class="hljs-string">'UTC/GMT'</span></code> and local timezone's code and returns timezone's name, <code class="python hljs"><span class="hljs-string">'UTC[±HH:MM]'</span></code> if timezone is nameless, or an empty string if object is naive.</strong></li>
|
|
</ul>
|
|
<div><h3 id="arithmetics">Arithmetics</h3><pre><code class="python language-python apache hljs"><bool> = <D/T/DTn> > <D/T/DTn> <span class="hljs-comment"># Ignores time jumps (fold attribute). Also ==.</span>
|
|
<bool> = <DTa> > <DTa> <span class="hljs-comment"># Ignores time jumps if they share tzinfo object.</span>
|
|
<TD> = <D/DTn> - <D/DTn> <span class="hljs-comment"># Ignores jumps. Convert to UTC for actual delta.</span>
|
|
<TD> = <DTa> - <DTa> <span class="hljs-comment"># Ignores jumps if they share the tzinfo object.</span>
|
|
<D/DT> = <D/DT> ± <TD> <span class="hljs-comment"># Returned datetime can fall into missing hour.</span>
|
|
<TD> = <TD> * <float> <span class="hljs-comment"># Also `<TD> = abs(<TD>)`, `<TD> = <TD> ± <TD>`.</span>
|
|
<float> = <TD> / <TD> <span class="hljs-comment"># Also `(<int>, <TD>) = divmod(<TD>, <TD>)`.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="function"><a href="#function" name="function">#</a>Function</h2><p><strong>Independent block of code that returns a value when called.</strong></p><pre><code class="python language-python hljs"><span class="hljs-function"><span class="hljs-keyword">def</span> <<span class="hljs-title">func_name</span>><span class="hljs-params">(<nondefault_args>)</span>:</span> ... <span class="hljs-comment"># E.g. `def func(x, y): ...`.</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <<span class="hljs-title">func_name</span>><span class="hljs-params">(<default_args>)</span>:</span> ... <span class="hljs-comment"># E.g. `def func(x=0, y=0): ...`.</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <<span class="hljs-title">func_name</span>><span class="hljs-params">(<nondefault_args>, <default_args>)</span>:</span> ... <span class="hljs-comment"># E.g. `def func(x, y=0): ...`.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Function returns None if it doesn't encounter <code class="python hljs"><span class="hljs-string">'return <obj/exp>'</span></code> statement.</strong></li>
|
|
<li><strong>Run <code class="python hljs"><span class="hljs-string">'global <var_name>'</span></code> inside the function before assigning to global variable.</strong></li>
|
|
<li><strong>Default values are evaluated when function is first encountered in the scope. Any mutation of a mutable default value will persist between invocations!</strong></li>
|
|
</ul>
|
|
<div><h3 id="functioncall">Function Call</h3><pre><code class="python language-python hljs"><obj> = <function>(<positional_args>) <span class="hljs-comment"># E.g. `func(0, 0)`.</span>
|
|
<obj> = <function>(<keyword_args>) <span class="hljs-comment"># E.g. `func(x=0, y=0)`.</span>
|
|
<obj> = <function>(<positional_args>, <keyword_args>) <span class="hljs-comment"># E.g. `func(0, y=0)`.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="splatoperator"><a href="#splatoperator" name="splatoperator">#</a>Splat Operator</h2><p><strong>Splat expands a collection into positional arguments, while splatty-splat expands a dictionary into keyword arguments.</strong></p><pre><code class="python language-python hljs">args, kwargs = (<span class="hljs-number">1</span>, <span class="hljs-number">2</span>), {<span class="hljs-string">'z'</span>: <span class="hljs-number">3</span>}
|
|
func(*args, **kwargs)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h4 id="isthesameas">Is the same as:</h4><pre><code class="python language-python hljs">func(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, z=<span class="hljs-number">3</span>)
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="insidefunctiondefinition">Inside Function Definition</h3><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><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>
|
|
<span class="hljs-keyword">return</span> sum(a)
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>add(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
<span class="hljs-number">6</span>
|
|
</code></pre>
|
|
<div><h4 id="allowedcompositionsofargumentsandthewaystheycanbecalled">Allowed compositions of arguments and the ways they can be called:</h4><pre><code class="text language-text">┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━┓
|
|
┃ │ func(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>) │ func(<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>) │ func(x=<span class="hljs-number">1</span>, y=<span class="hljs-number">2</span>) ┃
|
|
┠───────────────────────────┼──────────────┼──────────────┼────────────────┨
|
|
┃ <span class="hljs-title">func</span>(x, *args, **kwargs): │ ✓ │ ✓ │ ✓ ┃
|
|
┃ <span class="hljs-title">func</span>(*args, y, **kwargs): │ │ ✓ │ ✓ ┃
|
|
┃ <span class="hljs-title">func</span>(*, x, **kwargs): │ │ │ ✓ ┃
|
|
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="otheruses">Other Uses</h3><pre><code class="python language-python hljs"><list> = [*<collection> [, ...]] <span class="hljs-comment"># Or: list(<coll>) [+ ...]</span>
|
|
<tuple> = (*<collection>, [...]) <span class="hljs-comment"># Or: tuple(<coll>) [+ ...]</span>
|
|
<set> = {*<collection> [, ...]} <span class="hljs-comment"># Or: set(<coll>) [| ...]</span>
|
|
<dict> = {**<dict> [, ...]} <span class="hljs-comment"># Or: <dict> | ...</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs">head, *body, tail = <collection> <span class="hljs-comment"># Head or tail can be omitted.</span>
|
|
</code></pre>
|
|
<div><h2 id="inline"><a href="#inline" name="inline">#</a>Inline</h2><div><h3 id="lambda">Lambda</h3><pre><code class="python language-python hljs"><func> = <span class="hljs-keyword">lambda</span>: <return_value> <span class="hljs-comment"># A single statement function.</span>
|
|
<func> = <span class="hljs-keyword">lambda</span> <arg_1>, <arg_2>: <return_value> <span class="hljs-comment"># Also allows default arguments.</span>
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h3 id="comprehensions">Comprehensions</h3><pre><code class="python language-python hljs"><list> = [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"># Returns [1, 2, ..., 10].</span>
|
|
<iter> = (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 > <span class="hljs-number">5</span>) <span class="hljs-comment"># Returns iter([6, 7, 8, 9]).</span>
|
|
<set> = {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"># Returns {5, 6, ..., 14}.</span>
|
|
<dict> = {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"># Returns {0: 0, 1: 2, ..., 9: 18}.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>[l+r <span class="hljs-keyword">for</span> l <span class="hljs-keyword">in</span> <span class="hljs-string">'abc'</span> <span class="hljs-keyword">for</span> r <span class="hljs-keyword">in</span> <span class="hljs-string">'abc'</span>] <span class="hljs-comment"># Inner loop is on the right side.</span>
|
|
[<span class="hljs-string">'aa'</span>, <span class="hljs-string">'ab'</span>, <span class="hljs-string">'ac'</span>, ..., <span class="hljs-string">'cc'</span>]
|
|
</code></pre>
|
|
<div><h3 id="mapfilterreduce">Map, Filter, Reduce</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> reduce
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><iter> = 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"># Returns iter([1, 2, ..., 10]).</span>
|
|
<iter> = filter(<span class="hljs-keyword">lambda</span> x: x > <span class="hljs-number">5</span>, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># Returns iter([6, 7, 8, 9]).</span>
|
|
<obj> = reduce(<span class="hljs-keyword">lambda</span> out, x: out + x, range(<span class="hljs-number">10</span>)) <span class="hljs-comment"># Returns 45.</span>
|
|
</code></pre>
|
|
<div><h3 id="anyall">Any, All</h3><pre><code class="python language-python hljs"><bool> = any(<collection>) <span class="hljs-comment"># Is `bool(<el>)` True for any el?</span>
|
|
<bool> = all(<collection>) <span class="hljs-comment"># True for all? Also True if empty.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="conditionalexpression">Conditional Expression</h3><pre><code class="python language-python hljs"><obj> = <exp> <span class="hljs-keyword">if</span> <condition> <span class="hljs-keyword">else</span> <exp> <span class="hljs-comment"># Only one expression is evaluated.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>[i <span class="hljs-keyword">if</span> i <span class="hljs-keyword">else</span> <span class="hljs-string">'zero'</span> <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> (<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)] <span class="hljs-comment"># `any([0, '', [], None]) == False`</span>
|
|
[<span class="hljs-string">'zero'</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
|
|
</code></pre>
|
|
<div><h3 id="andor">And, Or</h3><pre><code class="python language-python hljs"><obj> = <exp> <span class="hljs-keyword">and</span> <exp> [<span class="hljs-keyword">and</span> ...] <span class="hljs-comment"># Returns first false or last object.</span>
|
|
<obj> = <exp> <span class="hljs-keyword">or</span> <exp> [<span class="hljs-keyword">or</span> ...] <span class="hljs-comment"># Returns first true or last object.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="walrusoperator">Walrus Operator</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>[i <span class="hljs-keyword">for</span> ch <span class="hljs-keyword">in</span> <span class="hljs-string">'0123'</span> <span class="hljs-keyword">if</span> (i := int(ch)) > <span class="hljs-number">0</span>] <span class="hljs-comment"># Assigns to variable mid-sentence.</span>
|
|
[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="namedtupleenumdataclass">Named Tuple, Enum, Dataclass</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> namedtuple
|
|
Point = namedtuple(<span class="hljs-string">'Point'</span>, <span class="hljs-string">'x y'</span>) <span class="hljs-comment"># Creates tuple's subclass.</span>
|
|
point = Point(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>) <span class="hljs-comment"># Returns its instance.</span>
|
|
|
|
<span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
|
|
Direction = Enum(<span class="hljs-string">'Direction'</span>, <span class="hljs-string">'N E S W'</span>) <span class="hljs-comment"># Creates Enum's subclass.</span>
|
|
direction = Direction.N <span class="hljs-comment"># Returns its member.</span>
|
|
|
|
<span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
|
|
Player = make_dataclass(<span class="hljs-string">'Player'</span>, [<span class="hljs-string">'loc'</span>, <span class="hljs-string">'dir'</span>]) <span class="hljs-comment"># Creates a class.</span>
|
|
player = Player(point, direction) <span class="hljs-comment"># Returns its instance.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="imports"><a href="#imports" name="imports">#</a>Imports</h2><p><strong>Mechanism that makes code in one file available to another file.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> <module> <span class="hljs-comment"># Imports a built-in or '<module>.py'.</span>
|
|
<span class="hljs-keyword">import</span> <package> <span class="hljs-comment"># Imports a built-in or '<package>/__init__.py'.</span>
|
|
<span class="hljs-keyword">import</span> <package>.<module> <span class="hljs-comment"># Imports a built-in or '<package>/<module>.py'.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Package is a collection of modules, but it can also define its own functions, classes, etc.</strong></li>
|
|
<li><strong>On a filesystem this corresponds to a directory of Python files with an optional init script.</strong></li>
|
|
<li><strong>Running <code class="python hljs"><span class="hljs-string">'import <package>'</span></code> does not automatically provide access to the package's modules unless they are explicitly imported in the <code class="python hljs"><span class="hljs-string">'<package>/__init__.py'</span></code> script.</strong></li>
|
|
<li><strong>Directory of the file that is passed to python command serves as a root of local imports.</strong></li>
|
|
<li><strong>For relative imports use <code class="python hljs"><span class="hljs-string">'from .[…][<pkg/module>[.…]] import <obj>'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h2 id="closure"><a href="#closure" name="closure">#</a>Closure</h2><p><strong>We have/get a closure in Python when a nested function references a value of its enclosing function and then the enclosing function returns its nested function.</strong></p><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>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(b)</span>:</span>
|
|
<span class="hljs-keyword">return</span> a * b
|
|
<span class="hljs-keyword">return</span> out
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>multiply_by_3 = get_multiplier(<span class="hljs-number">3</span>)
|
|
<span class="hljs-meta">>>> </span>multiply_by_3(<span class="hljs-number">10</span>)
|
|
<span class="hljs-number">30</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Any value that is referenced from within multiple nested functions gets shared.</strong></li>
|
|
</ul>
|
|
<div><h3 id="partial">Partial</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
|
|
<function> = partial(<function> [, <arg_1> [, ...]])
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">multiply</span><span class="hljs-params">(a, b)</span>:</span>
|
|
<span class="hljs-meta">... </span> <span class="hljs-keyword">return</span> a * b
|
|
<span class="hljs-meta">>>> </span>multiply_by_3 = partial(multiply, <span class="hljs-number">3</span>)
|
|
<span class="hljs-meta">>>> </span>multiply_by_3(<span class="hljs-number">10</span>)
|
|
<span class="hljs-number">30</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Partial is also useful in cases when a function needs to be passed as an argument because it enables us to set its arguments beforehand (<code class="python hljs"><span class="hljs-string">'collections.defaultdict(<func>)'</span></code>, <code class="python hljs"><span class="hljs-string">'iter(<func>, to_exc)'</span></code> and <code class="python hljs"><span class="hljs-string">'dataclasses.field(default_factory=<func>)'</span></code>).</strong></li>
|
|
</ul>
|
|
<div><h3 id="nonlocal">Non-Local</h3><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><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>
|
|
i = <span class="hljs-number">0</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">()</span>:</span>
|
|
<span class="hljs-keyword">nonlocal</span> i
|
|
i += <span class="hljs-number">1</span>
|
|
<span class="hljs-keyword">return</span> i
|
|
<span class="hljs-keyword">return</span> out
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>counter = get_counter()
|
|
<span class="hljs-meta">>>> </span>counter(), counter(), counter()
|
|
(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
</code></pre>
|
|
<div class="pagebreak"></div><div><h2 id="decorator"><a href="#decorator" name="decorator">#</a>Decorator</h2><p><strong>A decorator takes a function, adds some functionality and returns it. It can be any <a href="#callable">callable</a>, but is usually implemented as a function that returns a <a href="#closure">closure</a>.</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">@decorator_name</span>
|
|
<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>
|
|
...
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="debuggerexample">Debugger Example</h3><p><strong>Decorator that prints function's name every time the function is called.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(func)</span>:</span>
|
|
<span class="hljs-meta"> @wraps(func)</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
|
|
print(func.__name__)
|
|
<span class="hljs-keyword">return</span> func(*args, **kwargs)
|
|
<span class="hljs-keyword">return</span> out
|
|
|
|
<span class="hljs-meta">@debug</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
|
|
<span class="hljs-keyword">return</span> x + y
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Wraps is a helper decorator that copies the metadata of the passed function (func) to the function it is wrapping (out). 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>
|
|
</ul>
|
|
<div><h3 id="cache">Cache</h3><p><strong>Decorator that caches function's return values. All function's arguments must be hashable.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> cache
|
|
|
|
<span class="hljs-meta">@cache</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">fib</span><span class="hljs-params">(n)</span>:</span>
|
|
<span class="hljs-keyword">return</span> n <span class="hljs-keyword">if</span> n < <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>)</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Potential problem with cache is that it can grow indefinitely. To clear stored values run <code class="python hljs"><span class="hljs-string">'<func>.cache_clear()'</span></code>, or use <code class="python hljs"><span class="hljs-string">'@lru_cache(maxsize=<int>)'</span></code> decorator instead.</strong></li>
|
|
<li><strong>CPython interpreter limits recursion depth to 3000 by default. To increase it run <code class="python hljs"><span class="hljs-string">'sys.setrecursionlimit(<int>)'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="parametrizeddecorator">Parametrized Decorator</h3><p><strong>A decorator that accepts arguments and returns a normal decorator that accepts a function.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> wraps
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">debug</span><span class="hljs-params">(print_result=<span class="hljs-keyword">False</span>)</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">decorator</span><span class="hljs-params">(func)</span>:</span>
|
|
<span class="hljs-meta"> @wraps(func)</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">out</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
|
|
result = func(*args, **kwargs)
|
|
print(func.__name__, result <span class="hljs-keyword">if</span> print_result <span class="hljs-keyword">else</span> <span class="hljs-string">''</span>)
|
|
<span class="hljs-keyword">return</span> result
|
|
<span class="hljs-keyword">return</span> out
|
|
<span class="hljs-keyword">return</span> decorator
|
|
|
|
<span class="hljs-meta">@debug(print_result=True)</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">add</span><span class="hljs-params">(x, y)</span>:</span>
|
|
<span class="hljs-keyword">return</span> x + y
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Using only <code class="python hljs"><span class="hljs-string">'@debug'</span></code> to decorate the add() function would not work here, because debug would then receive the add() function as a 'print_result' argument. Decorators can however manually check if the argument they received is a function and act accordingly.</strong></li>
|
|
</ul>
|
|
<div><h2 id="class"><a href="#class" name="class">#</a>Class</h2><p><strong>A template for creating user-defined objects.</strong></p><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__str__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> str(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
|
|
class_name = self.__class__.__name__
|
|
<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>
|
|
|
|
<span class="hljs-meta"> @classmethod</span>
|
|
<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>
|
|
<span class="hljs-keyword">return</span> cls.__name__
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>obj = MyClass(<span class="hljs-number">1</span>)
|
|
<span class="hljs-meta">>>> </span>obj.a, str(obj), repr(obj)
|
|
(<span class="hljs-number">1</span>, <span class="hljs-string">'1'</span>, <span class="hljs-string">'MyClass(1)'</span>)
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Methods whose names start and end with two underscores are called special methods. They are executed when object is passed to a built-in function or used as an operand, for example, <code class="python hljs"><span class="hljs-string">'print(a)'</span></code> calls <code class="python hljs"><span class="hljs-string">'a.__str__()'</span></code> and <code class="python hljs"><span class="hljs-string">'a + b'</span></code> calls <code class="python hljs"><span class="hljs-string">'a.__add__(b)'</span></code>.</strong></li>
|
|
<li><strong>Methods decorated with <code class="python hljs"><span class="hljs-string">'@staticmethod'</span></code> receive neither 'self' nor 'cls' argument.</strong></li>
|
|
<li><strong>Return value of str() special method should be readable and of repr() unambiguous. If only repr() is defined, it will also be used for str().</strong></li>
|
|
</ul>
|
|
<div><h4 id="expressionsthatcallthestrmethod">Expressions that call the str() method:</h4><pre><code class="python language-python hljs">print(<obj>)
|
|
<span class="hljs-string">f'<span class="hljs-subst">{<obj>}</span>'</span>
|
|
logging.warning(<obj>)
|
|
csv.writer(<file>).writerow([<obj>])
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="expressionsthatcallthereprmethod">Expressions that call the repr() method:</h4><pre><code class="python language-python hljs">print/str/repr([<obj>])
|
|
print/str/repr({<obj>: <obj>})
|
|
<span class="hljs-string">f'<span class="hljs-subst">{<obj>!r}</span>'</span>
|
|
Z = make_dataclass(<span class="hljs-string">'Z'</span>, [<span class="hljs-string">'a'</span>]); print/str/repr(Z(<obj>))
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="subclass">Subclass</h3><ul>
|
|
<li><strong>Inheritance is a mechanism that enables a class to extend some other class (that is, subclass to extend its parent), and by doing so inherit all of its methods and attributes.</strong></li>
|
|
<li><strong>Subclass can then add its own methods and attributes or override inherited ones by reusing their names.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, name)</span>:</span>
|
|
self.name = name
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> <span class="hljs-string">f'Person(<span class="hljs-subst">{self.name!r}</span>)'</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__lt__</span><span class="hljs-params">(self, other)</span>:</span>
|
|
<span class="hljs-keyword">return</span> self.name < other.name
|
|
|
|
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Employee</span><span class="hljs-params">(Person)</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, name, staff_num)</span>:</span>
|
|
super().__init__(name)
|
|
self.staff_num = staff_num
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__repr__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> <span class="hljs-string">f'Employee(<span class="hljs-subst">{self.name!r}</span>, <span class="hljs-subst">{self.staff_num}</span>)'</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>people = {Person(<span class="hljs-string">'Ann'</span>), Employee(<span class="hljs-string">'Bob'</span>, <span class="hljs-number">0</span>)}
|
|
<span class="hljs-meta">>>> </span>sorted(people)
|
|
[Person(<span class="hljs-string">'Ann'</span>), Employee(<span class="hljs-string">'Bob'</span>, <span class="hljs-number">0</span>)]
|
|
</code></pre>
|
|
<div><h3 id="typeannotations">Type Annotations</h3><ul>
|
|
<li><strong>They add type hints to variables, arguments and functions (<code class="python hljs"><span class="hljs-string">'def f() -> <type>:'</span></code>).</strong></li>
|
|
<li><strong>Hints are used by type checkers like <a href="https://pypi.org/project/mypy/">mypy</a>, data validation libraries such as <a href="https://pypi.org/project/pydantic/">Pydantic</a> and lately also by <a href="https://pypi.org/project/Cython/">Cython</a> compiler. However, they are not enforced by CPython interpreter.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> abc
|
|
|
|
<name>: <type> [| ...] [= <obj>]
|
|
<name>: list/set/abc.Iterable/abc.Sequence[<type>] [= <obj>]
|
|
<name>: tuple/dict[<type>, ...] [= <obj>]
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="dataclass">Dataclass</h3><p><strong>Decorator that uses class variables to generate init(), repr() and eq() special methods.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> dataclass, field, make_dataclass
|
|
|
|
<span class="hljs-meta">@dataclass(order=False, frozen=False)</span>
|
|
<span class="hljs-class"><span class="hljs-keyword">class</span> <<span class="hljs-title">class_name</span>>:</span>
|
|
<attr_name>: <type>
|
|
<attr_name>: <type> = <default_value>
|
|
<attr_name>: list/dict/set = field(default_factory=list/dict/set)
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong>Objects can be made <a href="#sortable">sortable</a> with <code class="python hljs"><span class="hljs-string">'order=True'</span></code> and immutable with <code class="python hljs"><span class="hljs-string">'frozen=True'</span></code>.</strong></li>
|
|
<li><strong>For object to be <a href="#hashable">hashable</a>, all attributes must be hashable and 'frozen' must be True.</strong></li>
|
|
<li><strong>Function field() is needed because <code class="python hljs"><span class="hljs-string">'<attr_name>: list = []'</span></code> would make a list that is shared among all instances. Its 'default_factory' argument accepts any <a href="#callable">callable</a> object.</strong></li>
|
|
<li><strong>For attributes of arbitrary type use <code class="python hljs"><span class="hljs-string">'typing.Any'</span></code>.</strong></li>
|
|
</ul>
|
|
<pre><code class="python language-python hljs">P = make_dataclass(<span class="hljs-string">'P'</span>, [<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>])
|
|
P = make_dataclass(<span class="hljs-string">'P'</span>, [(<span class="hljs-string">'x'</span>, float), (<span class="hljs-string">'y'</span>, float)])
|
|
P = make_dataclass(<span class="hljs-string">'P'</span>, [(<span class="hljs-string">'x'</span>, float, <span class="hljs-number">0</span>), (<span class="hljs-string">'y'</span>, float, <span class="hljs-number">0</span>)])
|
|
</code></pre>
|
|
<div><h3 id="property">Property</h3><p><strong>Pythonic way of implementing getters and setters.</strong></p><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span>:</span>
|
|
<span class="hljs-meta"> @property</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">name</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> <span class="hljs-string">' '</span>.join(self._name)
|
|
|
|
<span class="hljs-meta"> @name.setter</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">name</span><span class="hljs-params">(self, value)</span>:</span>
|
|
self._name = value.split()
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>person = Person()
|
|
<span class="hljs-meta">>>> </span>person.name = <span class="hljs-string">'\t Guido van Rossum \n'</span>
|
|
<span class="hljs-meta">>>> </span>person.name
|
|
<span class="hljs-string">'Guido van Rossum'</span>
|
|
</code></pre>
|
|
<div><h3 id="slots">Slots</h3><p><strong>Mechanism that restricts objects to attributes listed in 'slots'.</strong></p><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClassWithSlots</span>:</span>
|
|
__slots__ = [<span class="hljs-string">'a'</span>]
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.a = <span class="hljs-number">1</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="copy">Copy</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> copy <span class="hljs-keyword">import</span> copy, deepcopy
|
|
<object> = copy/deepcopy(<object>)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="ducktypes"><a href="#ducktypes" name="ducktypes">#</a>Duck Types</h2><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><div><h3 id="comparable">Comparable</h3><ul>
|
|
<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>. That means all user-defined objects compare not equal by default (because id() returns object's memory address that is guaranteed to be unique).</strong></li>
|
|
<li><strong>Only the left side object has eq() method called, unless it returns NotImplemented, in which case the right object is consulted. Result is False if both return NotImplemented.</strong></li>
|
|
<li><strong>Ne() automatically works on any object that has eq() defined.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyComparable</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
|
|
<span class="hljs-keyword">if</span> isinstance(other, type(self)):
|
|
<span class="hljs-keyword">return</span> self.a == other.a
|
|
<span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
|
|
</code></pre></div></div>
|
|
|
|
|
|
|
|
|
|
<div><h3 id="hashable">Hashable</h3><ul>
|
|
<li><strong>Hashable object needs both hash() and eq() methods and its hash value must not change.</strong></li>
|
|
<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. That is why Python automatically makes classes unhashable if you only implement eq().</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyHashable</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self._a = a
|
|
<span class="hljs-meta"> @property</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">a</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> self._a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
|
|
<span class="hljs-keyword">if</span> isinstance(other, type(self)):
|
|
<span class="hljs-keyword">return</span> self.a == other.a
|
|
<span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__hash__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> hash(self.a)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="sortable">Sortable</h3><ul>
|
|
<li><strong>With 'total_ordering' decorator, you only need to provide eq() and one of lt(), gt(), le() or ge() special methods (used by <, >, <=, >=) and the rest will be automatically generated.</strong></li>
|
|
<li><strong>Functions sorted() and min() only require lt() method, while max() only requires gt(). However, it is best to define them all so that confusion doesn't arise in other contexts.</strong></li>
|
|
<li><strong>When two lists, strings or dataclasses are compared, their values get compared in order until a pair of unequal values is found. The comparison of this two values is then returned. The shorter sequence is considered smaller in case of all values being equal.</strong></li>
|
|
<li><strong>To sort collection of strings in proper alphabetical order pass <code class="python hljs"><span class="hljs-string">'key=locale.strxfrm'</span></code> to sorted() after running <code class="python hljs"><span class="hljs-string">'locale.setlocale(locale.LC_COLLATE, "en_US.UTF-8")'</span></code>.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> total_ordering
|
|
|
|
<span class="hljs-meta">@total_ordering</span>
|
|
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySortable</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__eq__</span><span class="hljs-params">(self, other)</span>:</span>
|
|
<span class="hljs-keyword">if</span> isinstance(other, type(self)):
|
|
<span class="hljs-keyword">return</span> self.a == other.a
|
|
<span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__lt__</span><span class="hljs-params">(self, other)</span>:</span>
|
|
<span class="hljs-keyword">if</span> isinstance(other, type(self)):
|
|
<span class="hljs-keyword">return</span> self.a < other.a
|
|
<span class="hljs-keyword">return</span> <span class="hljs-built_in">NotImplemented</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="iterator-1">Iterator</h3><ul>
|
|
<li><strong>Any object that has methods next() and iter() is an iterator.</strong></li>
|
|
<li><strong>Next() should return next item or raise StopIteration exception.</strong></li>
|
|
<li><strong>Iter() should return an iterator of remaining items, i.e. 'self'.</strong></li>
|
|
<li><strong>Any object that has iter() method can be used in a for loop.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.i = <span class="hljs-number">0</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__next__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.i += <span class="hljs-number">1</span>
|
|
<span class="hljs-keyword">return</span> self.i
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> self
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>counter = Counter()
|
|
<span class="hljs-meta">>>> </span>next(counter), next(counter), next(counter)
|
|
(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
</code></pre>
|
|
<div><h4 id="pythonhasmanydifferentiteratorobjects">Python has many different iterator objects:</h4><ul>
|
|
<li><strong>Sequence iterators returned by the <a href="#iterator">iter()</a> function, such as list_iterator, etc.</strong></li>
|
|
<li><strong>Objects returned by the <a href="#itertools">itertools</a> module, such as count, repeat and cycle.</strong></li>
|
|
<li><strong>Generators returned by the <a href="#generator">generator functions</a> and <a href="#comprehensions">generator expressions</a>.</strong></li>
|
|
<li><strong>File objects returned by the <a href="#open">open()</a> function, etc.</strong></li>
|
|
</ul><div><h3 id="callable">Callable</h3><ul>
|
|
<li><strong>All functions and classes have a call() method that is executed when they are called.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'callable(<obj>)'</span></code> or <code class="python hljs"><span class="hljs-string">'isinstance(<obj>, collections.abc.Callable)'</span></code> to check if object is callable. You can also call the object and check if it raised TypeError.</strong></li>
|
|
<li><strong>When this cheatsheet uses <code class="python hljs"><span class="hljs-string">'<function>'</span></code> as an argument, it means <code class="python hljs"><span class="hljs-string">'<callable>'</span></code>.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Counter</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.i = <span class="hljs-number">0</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__call__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.i += <span class="hljs-number">1</span>
|
|
<span class="hljs-keyword">return</span> self.i
|
|
</code></pre></div></div>
|
|
|
|
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>counter = Counter()
|
|
<span class="hljs-meta">>>> </span>counter(), counter(), counter()
|
|
(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
</code></pre>
|
|
<div><h3 id="contextmanager">Context Manager</h3><ul>
|
|
<li><strong>With statements only work on objects that have enter() and exit() special methods.</strong></li>
|
|
<li><strong>Enter() should lock the resources and optionally return an object (file, lock, etc.).</strong></li>
|
|
<li><strong>Exit() should release the resources (for example close a file, release a lock, etc.).</strong></li>
|
|
<li><strong>Any exception that happens inside the with block is passed to the exit() method.</strong></li>
|
|
<li><strong>The exit() method can suppress the exception by returning a true value.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyOpen</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, filename)</span>:</span>
|
|
self.filename = filename
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__enter__</span><span class="hljs-params">(self)</span>:</span>
|
|
self.file = open(self.filename)
|
|
<span class="hljs-keyword">return</span> self.file
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__exit__</span><span class="hljs-params">(self, exc_type, exception, traceback)</span>:</span>
|
|
self.file.close()
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </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:
|
|
<span class="hljs-meta">... </span> file.write(<span class="hljs-string">'Hello World!'</span>)
|
|
<span class="hljs-meta">>>> </span><span class="hljs-keyword">with</span> MyOpen(<span class="hljs-string">'test.txt'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-meta">... </span> print(file.read())
|
|
Hello World!
|
|
</code></pre>
|
|
<div><h2 id="iterableducktypes"><a href="#iterableducktypes" name="iterableducktypes">#</a>Iterable Duck Types</h2><div><h3 id="iterable">Iterable</h3><ul>
|
|
<li><strong>Only required method is iter(). It should return an iterator of object's items.</strong></li>
|
|
<li><strong>Contains() automatically works on any object that has iter() defined.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyIterable</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> iter(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
|
|
<span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
|
|
</code></pre></div></div>
|
|
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>obj = MyIterable([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
|
|
<span class="hljs-meta">>>> </span>[el <span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> obj]
|
|
[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]
|
|
<span class="hljs-meta">>>> </span><span class="hljs-number">1</span> <span class="hljs-keyword">in</span> obj
|
|
<span class="hljs-keyword">True</span>
|
|
</code></pre>
|
|
<div><h3 id="collection">Collection</h3><ul>
|
|
<li><strong>Only required methods are iter() and len(). Len() should return the number of items.</strong></li>
|
|
<li><strong>This cheatsheet actually means <code class="python hljs"><span class="hljs-string">'<iterable>'</span></code> when it uses the <code class="python hljs"><span class="hljs-string">'<collection>'</span></code>.</strong></li>
|
|
<li><strong>I chose not to use the name 'iterable' because it sounds scarier and more vague than 'collection'. The main drawback of this decision is that the reader could think a certain function doesn't accept iterators when it does, since iterators are the only built-in objects that are iterable but are not collections.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyCollection</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> iter(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
|
|
<span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> len(self.a)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="sequence">Sequence</h3><ul>
|
|
<li><strong>Only required methods are getitem() and len(). Getitem() should return the item at the passed index or raise IndexError (it may also support negative indices and/or slices).</strong></li>
|
|
<li><strong>Iter() and contains() automatically work on any object that has getitem() defined.</strong></li>
|
|
<li><strong>Reversed() automatically works on any object that has getitem() and len() defined. It returns reversed iterator of object's items.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySequence</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__iter__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> iter(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__contains__</span><span class="hljs-params">(self, el)</span>:</span>
|
|
<span class="hljs-keyword">return</span> el <span class="hljs-keyword">in</span> self.a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> len(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
|
|
<span class="hljs-keyword">return</span> self.a[i]
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__reversed__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> reversed(self.a)
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h4 id="discrepanciesbetweenglossarydefinitionsandabstractbaseclasses">Discrepancies between glossary definitions and abstract base classes:</h4><ul>
|
|
<li><strong>Python's glossary defines iterable as any object with special methods iter() and/or getitem() and sequence as any object with getitem() and len(). It doesn't define collection.</strong></li>
|
|
<li><strong>Passing ABC Iterable to isinstance() or issubclass() only checks whether object/class has special method iter(), while ABC Collection checks for iter(), contains() and len().</strong></li>
|
|
</ul></div>
|
|
|
|
|
|
|
|
|
|
<div><h3 id="abcsequence">ABC Sequence</h3><ul>
|
|
<li><strong>It's a richer interface than the basic sequence that also requires just getitem() and len().</strong></li>
|
|
<li><strong>Extending it generates iter(), contains(), reversed(), index() and count() special methods.</strong></li>
|
|
<li><strong>Unlike <code class="python hljs"><span class="hljs-string">'abc.Iterable'</span></code> and <code class="python hljs"><span class="hljs-string">'abc.Collection'</span></code>, it is not a duck type. That is why <code class="python hljs"><span class="hljs-string">'issubclass(MySequence, abc.Sequence)'</span></code> would return False even if MySequence had all the methods defined. It however recognizes list, tuple, range, str, bytes, bytearray, array, memoryview and deque, since they are registered as Sequence's virtual subclasses.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> abc
|
|
|
|
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyAbcSequence</span><span class="hljs-params">(abc.Sequence)</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, a)</span>:</span>
|
|
self.a = a
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__len__</span><span class="hljs-params">(self)</span>:</span>
|
|
<span class="hljs-keyword">return</span> len(self.a)
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__getitem__</span><span class="hljs-params">(self, i)</span>:</span>
|
|
<span class="hljs-keyword">return</span> self.a[i]
|
|
</code></pre></div><div><h4 id="tableofrequiredandautomaticallyavailablespecialmethods">Table of required and automatically available special methods:</h4><pre><code class="text language-text">┏━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━┓
|
|
┃ │ Iterable │ Collection │ Sequence │ abc.Sequence ┃
|
|
┠────────────┼────────────┼────────────┼────────────┼──────────────┨
|
|
┃ iter() │ ! │ ! │ ✓ │ ✓ ┃
|
|
┃ contains() │ ✓ │ ✓ │ ✓ │ ✓ ┃
|
|
┃ len() │ │ ! │ ! │ ! ┃
|
|
┃ getitem() │ │ │ ! │ ! ┃
|
|
┃ reversed() │ │ │ ✓ │ ✓ ┃
|
|
┃ index() │ │ │ │ ✓ ┃
|
|
┃ count() │ │ │ │ ✓ ┃
|
|
┗━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Method iter() is required for <code class="python hljs"><span class="hljs-string">'isinstance(<obj>, abc.Iterable)'</span></code> to return True, however any object with getitem() will work with any code expecting an iterable.</strong></li>
|
|
<li><strong>MutableSequence, Set, MutableSet, Mapping and MutableMapping ABCs are also extendable. Use <code class="python hljs"><span class="hljs-string">'<abc>.__abstractmethods__'</span></code> to get names of required methods.</strong></li>
|
|
</ul>
|
|
<div><h2 id="enum"><a href="#enum" name="enum">#</a>Enum</h2><p><strong>Class of named constants called members.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum, auto
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <<span class="hljs-title">enum_name</span>><span class="hljs-params">(Enum)</span>:</span>
|
|
<member_name> = auto() <span class="hljs-comment"># Increment of the last numeric value or 1.</span>
|
|
<member_name> = <value> <span class="hljs-comment"># Values don't have to be hashable or unique.</span>
|
|
<member_name> = <el_1>, <el_2> <span class="hljs-comment"># Values can be collections. This is a tuple.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Methods receive the member they were called on as the 'self' argument.</strong></li>
|
|
<li><strong>Accessing a member named after a reserved keyword causes SyntaxError.</strong></li>
|
|
</ul>
|
|
<pre><code class="python language-python hljs"><member> = <enum>.<member_name> <span class="hljs-comment"># Returns a member. Raises AttributeError.</span>
|
|
<member> = <enum>[<span class="hljs-string">'<member_name>'</span>] <span class="hljs-comment"># Returns a member. Raises KeyError.</span>
|
|
<member> = <enum>(<value>) <span class="hljs-comment"># Returns a member. Raises ValueError.</span>
|
|
<str> = <member>.name <span class="hljs-comment"># Returns the member's name.</span>
|
|
<obj> = <member>.value <span class="hljs-comment"># Returns the member's value.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list> = list(<enum>) <span class="hljs-comment"># Returns a list of enum's members.</span>
|
|
<list> = <enum>._member_names_ <span class="hljs-comment"># Returns a list of member names.</span>
|
|
<list> = [m.value <span class="hljs-keyword">for</span> m <span class="hljs-keyword">in</span> <enum>] <span class="hljs-comment"># Returns a list of member values.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><enum> = type(<member>) <span class="hljs-comment"># Returns an enum. Also <memb>.__class__.</span>
|
|
<iter> = itertools.cycle(<enum>) <span class="hljs-comment"># Returns an endless iterator of members.</span>
|
|
<member> = random.choice(list(<enum>)) <span class="hljs-comment"># Randomly selects one of the members.</span>
|
|
</code></pre>
|
|
<div><h3 id="inline-1">Inline</h3><pre><code class="python language-python hljs">Cutlery = Enum(<span class="hljs-string">'Cutlery'</span>, <span class="hljs-string">'FORK KNIFE SPOON'</span>)
|
|
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>])
|
|
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>})
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="userdefinedfunctionscannotbevaluessotheymustbewrapped">User-defined functions cannot be values, so they must be wrapped:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> functools <span class="hljs-keyword">import</span> partial
|
|
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),
|
|
<span class="hljs-string">'OR'</span>: partial(<span class="hljs-keyword">lambda</span> l, r: l <span class="hljs-keyword">or</span> r)})
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="exceptions"><a href="#exceptions" name="exceptions">#</a>Exceptions</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
|
|
<code>
|
|
<span class="hljs-keyword">except</span> <exception>:
|
|
<code>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="complexexample">Complex Example</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">try</span>:
|
|
<code_1>
|
|
<span class="hljs-keyword">except</span> <exception_a>:
|
|
<code_2_a>
|
|
<span class="hljs-keyword">except</span> <exception_b>:
|
|
<code_2_b>
|
|
<span class="hljs-keyword">else</span>:
|
|
<code_2_c>
|
|
<span class="hljs-keyword">finally</span>:
|
|
<code_3>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Code inside the <code class="python hljs"><span class="hljs-string">'else'</span></code> block will only be executed if <code class="python hljs"><span class="hljs-string">'try'</span></code> block had no exceptions.</strong></li>
|
|
<li><strong>Code inside the <code class="python hljs"><span class="hljs-string">'finally'</span></code> block will always be executed (unless a signal is received).</strong></li>
|
|
<li><strong>All variables that are initialized in executed blocks are also visible in all subsequent blocks, as well as outside the try statement (only the function block delimits scope).</strong></li>
|
|
<li><strong>To catch signals use <code class="python hljs"><span class="hljs-string">'signal.signal(signal_number, handler_function)'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="catchingexceptions">Catching Exceptions</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">except</span> <exception>: ...
|
|
<span class="hljs-keyword">except</span> <exception> <span class="hljs-keyword">as</span> <name>: ...
|
|
<span class="hljs-keyword">except</span> (<exception>, [...]): ...
|
|
<span class="hljs-keyword">except</span> (<exception>, [...]) <span class="hljs-keyword">as</span> <name>: ...
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Also catches subclasses, e.g. <code class="python hljs"><span class="hljs-string">'IndexError'</span></code> is caught by <code class="python hljs"><span class="hljs-string">'except LookupError:'</span></code>.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'traceback.print_exc()'</span></code> to print the full error message to standard error stream.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'print(<name>)'</span></code> to print just the cause of the exception (that is, its arguments).</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'logging.exception(<str>)'</span></code> to log the passed message, followed by the full error message of the caught exception. For details about setting up the logger see <a href="#logging">Logging</a>.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'sys.exc_info()'</span></code> to get exception type, object, and traceback of caught exception.</strong></li>
|
|
</ul>
|
|
<div><h3 id="raisingexceptions">Raising Exceptions</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> <exception>
|
|
<span class="hljs-keyword">raise</span> <exception>()
|
|
<span class="hljs-keyword">raise</span> <exception>(<obj> [, ...])
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="reraisingcaughtexception">Re-raising caught exception:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">except</span> <exception> [<span class="hljs-keyword">as</span> <name>]:
|
|
...
|
|
<span class="hljs-keyword">raise</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="exceptionobject">Exception Object</h3><pre><code class="python language-python hljs">arguments = <name>.args
|
|
exc_type = <name>.__class__
|
|
filename = <name>.__traceback__.tb_frame.f_code.co_filename
|
|
func_name = <name>.__traceback__.tb_frame.f_code.co_name
|
|
line_str = linecache.getline(filename, <name>.__traceback__.tb_lineno)
|
|
trace_str = <span class="hljs-string">''</span>.join(traceback.format_tb(<name>.__traceback__))
|
|
error_msg = <span class="hljs-string">''</span>.join(traceback.format_exception(type(<name>), <name>, <name>.__traceback__))
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="builtinexceptions">Built-in Exceptions</h3><pre><code class="text language-text">BaseException
|
|
├── SystemExit <span class="hljs-comment"># Raised by the sys.exit() function (see #Exit for details).</span>
|
|
├── KeyboardInterrupt <span class="hljs-comment"># Raised when the user hits the interrupt key (control-c).</span>
|
|
└── Exception <span class="hljs-comment"># User-defined exceptions should be derived from this class.</span>
|
|
├── ArithmeticError <span class="hljs-comment"># Base class for arithmetic errors such as ZeroDivisionError.</span>
|
|
├── AssertionError <span class="hljs-comment"># Raised by `assert <exp>` if expression returns false value.</span>
|
|
├── AttributeError <span class="hljs-comment"># Raised when object doesn't have requested attribute/method.</span>
|
|
├── EOFError <span class="hljs-comment"># Raised by input() when it hits an end-of-file condition.</span>
|
|
├── LookupError <span class="hljs-comment"># Base class for errors when a collection can't find an item.</span>
|
|
│ ├── IndexError <span class="hljs-comment"># Raised when index of a sequence (list/str) is out of range.</span>
|
|
│ └── KeyError <span class="hljs-comment"># Raised when a dictionary key or set element is missing.</span>
|
|
├── MemoryError <span class="hljs-comment"># Out of memory. May be too late to start deleting variables.</span>
|
|
├── NameError <span class="hljs-comment"># Raised when nonexistent name (variable/func/class) is used.</span>
|
|
│ └── UnboundLocalError <span class="hljs-comment"># Raised when local name is used before it's being defined.</span>
|
|
├── OSError <span class="hljs-comment"># Errors such as FileExistsError, TimeoutError (see #Open).</span>
|
|
│ └── ConnectionError <span class="hljs-comment"># Errors such as BrokenPipeError and ConnectionAbortedError.</span>
|
|
├── RuntimeError <span class="hljs-comment"># Raised by errors that don't fall into other categories.</span>
|
|
│ ├── NotImplementedEr… <span class="hljs-comment"># Can be raised by abstract methods or by unfinished code.</span>
|
|
│ └── RecursionError <span class="hljs-comment"># Raised if max recursion depth is exceeded (3k by default).</span>
|
|
├── StopIteration <span class="hljs-comment"># Raised when exhausted (empty) iterator is passed to next().</span>
|
|
├── TypeError <span class="hljs-comment"># When an argument of the wrong type is passed to function.</span>
|
|
└── ValueError <span class="hljs-comment"># When argument has the right type but inappropriate value.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="collectionsandtheirexceptions">Collections and their exceptions:</h4><pre><code class="text language-text">┏━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┓
|
|
┃ │ List │ Set │ Dict ┃
|
|
┠───────────┼────────────┼────────────┼────────────┨
|
|
┃ getitem() │ IndexError │ │ KeyError ┃
|
|
┃ pop() │ IndexError │ KeyError │ KeyError ┃
|
|
┃ remove() │ ValueError │ KeyError │ ┃
|
|
┃ index() │ ValueError │ │ ┃
|
|
┗━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="usefulbuiltinexceptions">Useful built-in exceptions:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">raise</span> TypeError(<span class="hljs-string">'Argument is of the wrong type!'</span>)
|
|
<span class="hljs-keyword">raise</span> ValueError(<span class="hljs-string">'Argument has the right type but an inappropriate value!'</span>)
|
|
<span class="hljs-keyword">raise</span> RuntimeError(<span class="hljs-string">'I am too lazy to define my own exception!'</span>)
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="userdefinedexceptions">User-defined Exceptions</h3><pre><code class="python language-python hljs"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyError</span><span class="hljs-params">(Exception)</span>:</span> <span class="hljs-keyword">pass</span>
|
|
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyInputError</span><span class="hljs-params">(MyError)</span>:</span> <span class="hljs-keyword">pass</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="exit"><a href="#exit" name="exit">#</a>Exit</h2><p><strong>Exits the interpreter by raising SystemExit exception.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sys
|
|
sys.exit() <span class="hljs-comment"># Exits with exit code 0 (success).</span>
|
|
sys.exit(<int>) <span class="hljs-comment"># Exits with the passed exit code.</span>
|
|
sys.exit(<obj>) <span class="hljs-comment"># Prints to stderr and exits with 1.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h2 id="print"><a href="#print" name="print">#</a>Print</h2><pre><code class="python language-python hljs">print(<el_1>, ..., sep=<span class="hljs-string">' '</span>, end=<span class="hljs-string">'\n'</span>, file=sys.stdout, flush=<span class="hljs-keyword">False</span>)
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'file=sys.stderr'</span></code> for messages about errors so they can be processed separately.</strong></li>
|
|
<li><strong>Stdout and stderr streams hold output in a buffer until they receive a string containing '\n' or '\r', buffer reaches 4096 characters, <code class="python hljs"><span class="hljs-string">'flush=True'</span></code> is used, or program exits.</strong></li>
|
|
</ul>
|
|
<div><h3 id="prettyprint">Pretty Print</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pprint <span class="hljs-keyword">import</span> pprint
|
|
pprint(<collection>, width=<span class="hljs-number">80</span>, depth=<span class="hljs-keyword">None</span>, compact=<span class="hljs-keyword">False</span>, sort_dicts=<span class="hljs-keyword">True</span>)
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Each item is printed on its own line if collection exceeds 'width' characters.</strong></li>
|
|
<li><strong>Nested collections that are 'depth' levels deep get printed as '…'.</strong></li>
|
|
</ul>
|
|
<div><h2 id="input"><a href="#input" name="input">#</a>Input</h2><pre><code class="python language-python hljs"><str> = input()
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Reads a line from the user input or pipe if present (trailing newline gets stripped).</strong></li>
|
|
<li><strong>If argument is passed, it gets printed to the standard output before input is read.</strong></li>
|
|
<li><strong>EOFError is raised if user hits EOF (ctrl-d/ctrl-z⏎) or if stream is already exhausted.</strong></li>
|
|
</ul>
|
|
<div><h2 id="commandlinearguments"><a href="#commandlinearguments" name="commandlinearguments">#</a>Command Line Arguments</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sys
|
|
scripts_path = sys.argv[<span class="hljs-number">0</span>]
|
|
arguments = sys.argv[<span class="hljs-number">1</span>:]
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="argumentparser">Argument Parser</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> argparse <span class="hljs-keyword">import</span> ArgumentParser, FileType
|
|
p = ArgumentParser(description=<str>) <span class="hljs-comment"># Returns a parser object.</span>
|
|
p.add_argument(<span class="hljs-string">'-<short_name>'</span>, <span class="hljs-string">'--<name>'</span>, action=<span class="hljs-string">'store_true'</span>) <span class="hljs-comment"># Flag (defaults to False).</span>
|
|
p.add_argument(<span class="hljs-string">'-<short_name>'</span>, <span class="hljs-string">'--<name>'</span>, type=<type>) <span class="hljs-comment"># Option (defaults to None).</span>
|
|
p.add_argument(<span class="hljs-string">'<name>'</span>, type=<type>, nargs=<span class="hljs-number">1</span>) <span class="hljs-comment"># Mandatory first argument.</span>
|
|
p.add_argument(<span class="hljs-string">'<name>'</span>, type=<type>, nargs=<span class="hljs-string">'+'</span>) <span class="hljs-comment"># Mandatory remaining args.</span>
|
|
p.add_argument(<span class="hljs-string">'<name>'</span>, type=<type>, nargs=<span class="hljs-string">'?/*'</span>) <span class="hljs-comment"># Optional argument/s.</span>
|
|
args = p.parse_args() <span class="hljs-comment"># Exits on parsing error.</span>
|
|
<obj> = args.<name> <span class="hljs-comment"># Returns `<type>(<arg>)`.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'help=<str>'</span></code> to set argument description that will be displayed in help message.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'default=<obj>'</span></code> to override None as option's or optional argument's default value.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'type=FileType(<mode>)'</span></code> for files. It accepts 'encoding', but 'newline' is None.</strong></li>
|
|
</ul>
|
|
<div><h2 id="open"><a href="#open" name="open">#</a>Open</h2><p><strong>Opens a file and returns the corresponding file object.</strong></p><pre><code class="python language-python hljs"><file> = open(<path>, mode=<span class="hljs-string">'r'</span>, encoding=<span class="hljs-keyword">None</span>, newline=<span class="hljs-keyword">None</span>)
|
|
</code></pre></div>
|
|
|
|
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'encoding=None'</span></code> means that the default encoding is used, which is platform dependent. Best practice is to use <code class="python hljs"><span class="hljs-string">'encoding="utf-8"'</span></code> until it becomes the default (Python 3.15).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'newline=None'</span></code> means all different end of line combinations are converted to '\n' on read, while on write all '\n' characters are converted to system's default line separator.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'newline=""'</span></code> means no conversions take place, but input is still broken into chunks by readline() and readlines() on every '\n', '\r' and '\r\n'.</strong></li>
|
|
</ul>
|
|
<div><h3 id="modes">Modes</h3><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'r'</span></code> - Read. Used by default.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'w'</span></code> - Write. Deletes existing contents.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'x'</span></code> - Write or fail if the file already exists.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'a'</span></code> - Append. Creates new file if it doesn't exist.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'w+'</span></code> - Read and write. Deletes existing contents.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'r+'</span></code> - Read and write from the start.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'a+'</span></code> - Read and write from the end.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - Binary mode (<code class="python hljs"><span class="hljs-string">'rb'</span></code>, <code class="python hljs"><span class="hljs-string">'wb'</span></code>, <code class="python hljs"><span class="hljs-string">'xb'</span></code>, …).</strong></li>
|
|
</ul><div><h3 id="exceptions-1">Exceptions</h3><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'FileNotFoundError'</span></code> can be raised when reading with <code class="python hljs"><span class="hljs-string">'r'</span></code> or <code class="python hljs"><span class="hljs-string">'r+'</span></code>.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'FileExistsError'</span></code> can be raised when writing with <code class="python hljs"><span class="hljs-string">'x'</span></code>.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'IsADirectoryError'</span></code> and <code class="python hljs"><span class="hljs-string">'PermissionError'</span></code> can be raised by any.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'OSError'</span></code> is the parent class of all listed exceptions.</strong></li>
|
|
</ul><div><h3 id="fileobject">File Object</h3><pre><code class="python language-python hljs"><file>.seek(<span class="hljs-number">0</span>) <span class="hljs-comment"># Moves current position to the start of file.</span>
|
|
<file>.seek(offset) <span class="hljs-comment"># Moves 'offset' chars/bytes from the start.</span>
|
|
<file>.seek(<span class="hljs-number">0</span>, <span class="hljs-number">2</span>) <span class="hljs-comment"># Moves current position to the end of file.</span>
|
|
<bin_file>.seek(±offset, origin) <span class="hljs-comment"># Origin: 0 start, 1 current position, 2 end.</span>
|
|
</code></pre></div></div></div>
|
|
|
|
|
|
|
|
|
|
|
|
<pre><code class="python language-python hljs"><str/bytes> = <file>.read(size=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Reads 'size' chars/bytes or until the EOF.</span>
|
|
<str/bytes> = <file>.readline() <span class="hljs-comment"># Returns a line or empty string/bytes on EOF.</span>
|
|
<list> = <file>.readlines() <span class="hljs-comment"># Returns remaining lines. Also list(<file>).</span>
|
|
<str/bytes> = next(<file>) <span class="hljs-comment"># Returns a line using a read-ahead buffer.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><file>.write(<str/bytes>) <span class="hljs-comment"># Writes a str or bytes object to write buffer.</span>
|
|
<file>.writelines(<collection>) <span class="hljs-comment"># Writes a coll. of strings or bytes objects.</span>
|
|
<file>.flush() <span class="hljs-comment"># Flushes write buffer. Runs every 4096/8192 B.</span>
|
|
<file>.close() <span class="hljs-comment"># Closes the file after flushing write buffer.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Methods do not add or strip trailing newlines, not even writelines().</strong></li>
|
|
</ul>
|
|
<div><h3 id="readtextfromfile">Read Text from File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> file.readlines()
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writetexttofile">Write Text to File</h3><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>
|
|
<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:
|
|
file.write(text)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="paths"><a href="#paths" name="paths">#</a>Paths</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os, glob
|
|
<span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><str> = os.getcwd() <span class="hljs-comment"># Returns working dir. Starts as shell's $PWD.</span>
|
|
<str> = os.path.join(<path>, ...) <span class="hljs-comment"># Uses os.sep to join strings or Path objects.</span>
|
|
<str> = os.path.realpath(<path>) <span class="hljs-comment"># Resolves symlinks and calls path.abspath().</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><str> = os.path.basename(<path>) <span class="hljs-comment"># Returns final component of the path.</span>
|
|
<str> = os.path.dirname(<path>) <span class="hljs-comment"># Returns path without the final component.</span>
|
|
<tup.> = os.path.splitext(<path>) <span class="hljs-comment"># Splits on last period of the final component.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list> = os.listdir(path=<span class="hljs-string">'.'</span>) <span class="hljs-comment"># Returns all filenames located at the path.</span>
|
|
<list> = glob.glob(<span class="hljs-string">'<pattern>'</span>) <span class="hljs-comment"># Returns paths matching the wildcard pattern.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><bool> = os.path.exists(<path>) <span class="hljs-comment"># Checks if path exists. Also <Path>.exists().</span>
|
|
<bool> = os.path.isfile(<path>) <span class="hljs-comment"># Also <Path>.is_file() and <DirEntry>.is_file().</span>
|
|
<bool> = os.path.isdir(<path>) <span class="hljs-comment"># Also <Path>.is_dir() and <DirEntry>.is_dir().</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><stat> = os.stat(<path>) <span class="hljs-comment"># File's status. Also <Path/DirEntry>.stat().</span>
|
|
<num> = <stat>.st_mtime/st_size/… <span class="hljs-comment"># Returns modification time, size in bytes, etc.</span>
|
|
</code></pre>
|
|
<div><h3 id="direntry">DirEntry</h3><p><strong>Unlike listdir(), scandir() returns DirEntry objects that cache isfile, isdir, and on Windows also stat information, thus significantly increasing the performance of code that requires it.</strong></p><pre><code class="python language-python hljs"><iter> = os.scandir(path=<span class="hljs-string">'.'</span>) <span class="hljs-comment"># Returns DirEntry objects located at the path.</span>
|
|
<str> = <DirEntry>.path <span class="hljs-comment"># Is absolute if 'path' argument was absolute.</span>
|
|
<str> = <DirEntry>.name <span class="hljs-comment"># Returns path's final component as a string.</span>
|
|
<file> = open(<DirEntry>) <span class="hljs-comment"># Opens the file and returns its file object.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="pathobject">Path Object</h3><pre><code class="python language-python hljs"><Path> = Path(<path> [, ...]) <span class="hljs-comment"># Accepts strings, Paths, and DirEntry objects.</span>
|
|
<Path> = <path> / <path> [/ ...] <span class="hljs-comment"># First or second path must be a Path object.</span>
|
|
<Path> = <Path>.resolve() <span class="hljs-comment"># Returns absolute path with resolved symlinks.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><Path> = Path() <span class="hljs-comment"># Returns current working dir. Also Path('.').</span>
|
|
<Path> = Path.cwd() <span class="hljs-comment"># Returns absolute CWD. Also Path().resolve().</span>
|
|
<Path> = Path.home() <span class="hljs-comment"># Returns user's home directory (absolute).</span>
|
|
<Path> = Path(__file__).resolve() <span class="hljs-comment"># Returns module's path if CWD wasn't changed.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Path> = <Path>.parent <span class="hljs-comment"># Returns Path without the final component.</span>
|
|
<str> = <Path>.name <span class="hljs-comment"># Returns path's final component as a string.</span>
|
|
<str> = <Path>.suffix <span class="hljs-comment"># Returns name's last extension, e.g. '.gz'.</span>
|
|
<str> = <Path>.stem <span class="hljs-comment"># Returns name without the last extension.</span>
|
|
<tup.> = <Path>.parts <span class="hljs-comment"># Returns all path's components as strings.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><iter> = <Path>.iterdir() <span class="hljs-comment"># Returns directory contents as Path objects.</span>
|
|
<iter> = <Path>.glob(<span class="hljs-string">'<pattern>'</span>) <span class="hljs-comment"># Returns Paths matching the wildcard pattern.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><str> = str(<Path>) <span class="hljs-comment"># Returns path as string. Also <Path>.as_uri().</span>
|
|
<file> = open(<Path>) <span class="hljs-comment"># Also <Path>.read_text/write_bytes(<args>).</span>
|
|
</code></pre>
|
|
<div><h2 id="oscommands"><a href="#oscommands" name="oscommands">#</a>OS Commands</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> os, shutil, subprocess
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs">os.chdir(<path>) <span class="hljs-comment"># Changes the current working directory (CWD).</span>
|
|
os.mkdir(<path>, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates a directory. Permissions are in octal.</span>
|
|
os.makedirs(<path>, mode=<span class="hljs-number">0o777</span>) <span class="hljs-comment"># Creates all path's dirs. Also `exist_ok=False`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">shutil.copy(from, to) <span class="hljs-comment"># Copies the file. 'to' can exist or be a dir.</span>
|
|
shutil.copy2(from, to) <span class="hljs-comment"># Also copies creation and modification time.</span>
|
|
shutil.copytree(from, to) <span class="hljs-comment"># Copies the directory. 'to' must not exist.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">os.rename(from, to) <span class="hljs-comment"># Renames or moves the file or directory 'from'.</span>
|
|
os.replace(from, to) <span class="hljs-comment"># Same, but overwrites file 'to' even on Windows.</span>
|
|
shutil.move(from, to) <span class="hljs-comment"># Rename() that moves into 'to' if it's a dir.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">os.remove(<path>) <span class="hljs-comment"># Deletes the file. Or `pip3 install send2trash`.</span>
|
|
os.rmdir(<path>) <span class="hljs-comment"># Deletes the empty directory or raises OSError.</span>
|
|
shutil.rmtree(<path>) <span class="hljs-comment"># Deletes the directory and all of its contents.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Paths can be either strings, Path objects, or DirEntry objects.</strong></li>
|
|
<li><strong>Functions report OS related errors by raising OSError or one of its <a href="#exceptions-1">subclasses</a>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="shellcommands">Shell Commands</h3><pre><code class="python language-python hljs"><pipe> = os.popen(<span class="hljs-string">'<commands>'</span>) <span class="hljs-comment"># Executes commands in sh/cmd. Returns combined stdout.</span>
|
|
<str> = <pipe>.read(size=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Reads 'size' chars or until EOF. Also readline/s().</span>
|
|
<int> = <pipe>.close() <span class="hljs-comment"># Returns None if last command exited with returncode 0.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="sends11tothebasiccalculatorandcapturesitsoutput">Sends "1 + 1" to the basic calculator and captures its output:</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>subprocess.run(<span class="hljs-string">'bc'</span>, input=<span class="hljs-string">'1 + 1\n'</span>, capture_output=<span class="hljs-keyword">True</span>, text=<span class="hljs-keyword">True</span>)
|
|
CompletedProcess(args=<span class="hljs-string">'bc'</span>, returncode=<span class="hljs-number">0</span>, stdout=<span class="hljs-string">'2\n'</span>, stderr=<span class="hljs-string">''</span>)
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="sendstestintothebasiccalculatorrunninginstandardmodeandsavesitsoutputtotestout">Sends test.in to the basic calculator running in standard mode and saves its output to test.out:</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> shlex <span class="hljs-keyword">import</span> split
|
|
<span class="hljs-meta">>>> </span>os.popen(<span class="hljs-string">'echo 1 + 1 > test.in'</span>)
|
|
<span class="hljs-meta">>>> </span>subprocess.run(split(<span class="hljs-string">'bc -s'</span>), stdin=open(<span class="hljs-string">'test.in'</span>), stdout=open(<span class="hljs-string">'test.out'</span>, <span class="hljs-string">'w'</span>))
|
|
CompletedProcess(args=[<span class="hljs-string">'bc'</span>, <span class="hljs-string">'-s'</span>], returncode=<span class="hljs-number">0</span>)
|
|
<span class="hljs-meta">>>> </span>open(<span class="hljs-string">'test.out'</span>).read()
|
|
<span class="hljs-string">'2\n'</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="json"><a href="#json" name="json">#</a>JSON</h2><p><strong>Text file format for storing collections of strings and numbers.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> json
|
|
<str> = json.dumps(<list/dict>) <span class="hljs-comment"># Converts collection to JSON string.</span>
|
|
<coll> = json.loads(<str>) <span class="hljs-comment"># Converts JSON string to collection.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="readcollectionfromjsonfile">Read Collection from JSON File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> json.load(file)
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writecollectiontojsonfile">Write Collection to JSON File</h3><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, collection)</span>:</span>
|
|
<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:
|
|
json.dump(collection, file, ensure_ascii=<span class="hljs-keyword">False</span>, indent=<span class="hljs-number">2</span>)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="pickle"><a href="#pickle" name="pickle">#</a>Pickle</h2><p><strong>Binary file format for storing Python objects.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> pickle
|
|
<bytes> = pickle.dumps(<object>) <span class="hljs-comment"># Converts object to bytes object.</span>
|
|
<object> = pickle.loads(<bytes>) <span class="hljs-comment"># Converts bytes object to object.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="readobjectfrompicklefile">Read Object from Pickle File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> pickle.load(file)
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writeobjecttopicklefile">Write Object to Pickle File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
|
|
pickle.dump(an_object, file)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="csv"><a href="#csv" name="csv">#</a>CSV</h2><p><strong>Text file format for storing spreadsheets.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> csv
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><file> = open(<path>, newline=<span class="hljs-string">''</span>) <span class="hljs-comment"># Opens the CSV (text) file for reading.</span>
|
|
<reader> = csv.reader(<file>) <span class="hljs-comment"># Also: `dialect='excel', delimiter=','`.</span>
|
|
<list> = next(<reader>) <span class="hljs-comment"># Returns next row as a list of strings.</span>
|
|
<list> = list(<reader>) <span class="hljs-comment"># Returns a list of all remaining rows.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Without the <code class="python hljs"><span class="hljs-string">'newline=""'</span></code> argument, every '\r\n' sequence that is embedded inside a quoted field will get converted to '\n'! For details about newline argument see <a href="#open">Open</a>.</strong></li>
|
|
<li><strong>To print the spreadsheet to the console use <a href="#table">Tabulate</a> or PrettyTable library.</strong></li>
|
|
<li><strong>For XML and binary Excel files (xlsx, xlsm and xlsb) use <a href="#fileformats">Pandas</a> library.</strong></li>
|
|
<li><strong>Reader accepts any iterator (or collection) of strings, not just files.</strong></li>
|
|
</ul>
|
|
<div><h3 id="write">Write</h3><pre><code class="python language-python hljs"><file> = open(<path>, <span class="hljs-string">'w'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-comment"># Opens the CSV (text) file for writing.</span>
|
|
<writer> = csv.writer(<file>) <span class="hljs-comment"># Also: `dialect='excel', delimiter=','`.</span>
|
|
<writer>.writerow(<collection>) <span class="hljs-comment"># Encodes each object using `str(<el>)`.</span>
|
|
<writer>.writerows(<coll_of_coll>) <span class="hljs-comment"># Appends multiple rows to the file.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>If file is opened without the <code class="python hljs"><span class="hljs-string">'newline=""'</span></code> argument, '\r' will be added in front of every '\n' on platforms that use '\r\n' line endings (i.e., newlines may get doubled on Windows)!</strong></li>
|
|
<li><strong>Open existing file with <code class="python hljs"><span class="hljs-string">'mode="a"'</span></code> to append to it or <code class="python hljs"><span class="hljs-string">'mode="w"'</span></code> to overwrite it.</strong></li>
|
|
</ul>
|
|
<div><h3 id="parameters">Parameters</h3><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'dialect'</span></code> - Master parameter that sets the default values. String or a 'csv.Dialect' object.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'delimiter'</span></code> - A one-character string that separates fields (comma, tab, semicolon, etc.).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'lineterminator'</span></code> - How writer terminates rows. Reader looks for '\n', '\r' and '\r\n'.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'quotechar'</span></code> - Character for quoting fields containing delimiters, quotechars, '\n' or '\r'.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'escapechar'</span></code> - Character for escaping quotechars (not needed if doublequote is True).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'doublequote'</span></code> - Whether quotechars inside fields are/get doubled instead of escaped.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'quoting'</span></code> - 0: As necessary, 1: All, 2: All but numbers which are read as floats, 3: None.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'skipinitialspace'</span></code> - Is space character at the start of the field stripped by the reader.</strong></li>
|
|
</ul><div><h3 id="dialects">Dialects</h3><pre><code class="text language-text">┏━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┓
|
|
┃ │ excel │ excel-tab │ unix ┃
|
|
┠──────────────────┼──────────────┼──────────────┼──────────────┨
|
|
┃ delimiter │ ',' │ '\t' │ ',' ┃
|
|
┃ lineterminator │ '\r\n' │ '\r\n' │ '\n' ┃
|
|
┃ quotechar │ '"' │ '"' │ '"' ┃
|
|
┃ escapechar │ None │ None │ None ┃
|
|
┃ doublequote │ True │ True │ True ┃
|
|
┃ quoting │ 0 │ 0 │ 1 ┃
|
|
┃ skipinitialspace │ False │ False │ False ┃
|
|
┗━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┛
|
|
</code></pre></div></div>
|
|
|
|
|
|
|
|
<div><h3 id="readrowsfromcsvfile">Read Rows from CSV File</h3><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, **csv_params)</span>:</span>
|
|
<span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> list(csv.reader(file, **csv_params))
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writerowstocsvfile">Write Rows to CSV File</h3><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, mode=<span class="hljs-string">'w'</span>, **csv_params)</span>:</span>
|
|
<span class="hljs-keyword">with</span> open(filename, mode, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
|
|
writer = csv.writer(file, **csv_params)
|
|
writer.writerows(rows)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="sqlite"><a href="#sqlite" name="sqlite">#</a>SQLite</h2><p><strong>A server-less database engine that stores each database into its own file.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> sqlite3
|
|
<conn> = sqlite3.connect(<path>) <span class="hljs-comment"># Opens existing or new file. Also ':memory:'.</span>
|
|
<conn>.close() <span class="hljs-comment"># Closes connection. Discards uncommitted data.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="read">Read</h3><pre><code class="python language-python hljs"><cursor> = <conn>.execute(<span class="hljs-string">'<query>'</span>) <span class="hljs-comment"># Can raise a subclass of sqlite3.Error.</span>
|
|
<tuple> = <cursor>.fetchone() <span class="hljs-comment"># Returns the next row. Also next(<cursor>).</span>
|
|
<list> = <cursor>.fetchall() <span class="hljs-comment"># Returns remaining rows. Also list(<cursor>).</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="write-1">Write</h3><pre><code class="python language-python hljs"><conn>.execute(<span class="hljs-string">'<query>'</span>) <span class="hljs-comment"># Can raise a subclass of sqlite3.Error.</span>
|
|
<conn>.commit() <span class="hljs-comment"># Saves all changes since the last commit.</span>
|
|
<conn>.rollback() <span class="hljs-comment"># Discards all changes since the last commit.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="or">Or:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">with</span> <conn>: <span class="hljs-comment"># Exits the block with commit() or rollback(),</span>
|
|
<conn>.execute(<span class="hljs-string">'<query>'</span>) <span class="hljs-comment"># depending on whether any exception occurred.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="placeholders">Placeholders</h3><pre><code class="python language-python hljs"><conn>.execute(<span class="hljs-string">'<query>'</span>, <list/tuple>) <span class="hljs-comment"># Replaces every question mark with an item.</span>
|
|
<conn>.execute(<span class="hljs-string">'<query>'</span>, <dict/namedtuple>) <span class="hljs-comment"># Replaces every :<key> with a matching value.</span>
|
|
<conn>.executemany(<span class="hljs-string">'<query>'</span>, <coll_of_coll>) <span class="hljs-comment"># Runs execute() once for each collection.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Passed values can be of type str, int, float, bytes, None, or bool (stored as 1 or 0).</strong></li>
|
|
<li><strong>SQLite does not restrict columns to any type unless table is declared as strict.</strong></li>
|
|
</ul>
|
|
<div><h3 id="example-1">Example</h3><p><strong>Values are not actually saved in this example because <code class="python hljs"><span class="hljs-string">'conn.commit()'</span></code> is omitted!</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>conn = sqlite3.connect(<span class="hljs-string">'test.db'</span>)
|
|
<span class="hljs-meta">>>> </span>conn.execute(<span class="hljs-string">'CREATE TABLE person (name TEXT, height INTEGER) STRICT'</span>)
|
|
<span class="hljs-meta">>>> </span>conn.execute(<span class="hljs-string">'INSERT INTO person VALUES (?, ?)'</span>, (<span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>))
|
|
<span class="hljs-meta">>>> </span>conn.execute(<span class="hljs-string">'SELECT rowid, * FROM person'</span>).fetchall()
|
|
[(<span class="hljs-number">1</span>, <span class="hljs-string">'Jean-Luc'</span>, <span class="hljs-number">187</span>)]
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="sqlalchemy">SQLAlchemy</h3><p><strong>Library for interacting with various DB systems via SQL, method chaining, or ORM.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install sqlalchemy</span>
|
|
<span class="hljs-keyword">from</span> sqlalchemy <span class="hljs-keyword">import</span> create_engine, text
|
|
<engine> = create_engine(<span class="hljs-string">'<url>'</span>) <span class="hljs-comment"># Url: 'dialect://user:password@host/dbname'.</span>
|
|
<conn> = <engine>.connect() <span class="hljs-comment"># Creates a connection. Also <conn>.close().</span>
|
|
<cursor> = <conn>.execute(text(<span class="hljs-string">'<query>'</span>), …) <span class="hljs-comment"># `<dict>`. Replaces every :<key> with value.</span>
|
|
<span class="hljs-keyword">with</span> <conn>.begin(): ... <span class="hljs-comment"># Exits the block with commit or rollback.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="text language-text">┏━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
┃ Dialect │ pip3 install │ Dependencies ┃
|
|
┠─────────────────┼──────────────┼──────────────────────────────────┨
|
|
┃ mysql │ mysqlclient │ www.pypi.org/project/mysqlclient ┃
|
|
┃ postgresql │ psycopg2 │ www.pypi.org/project/psycopg2 ┃
|
|
┃ mssql │ pyodbc │ www.pypi.org/project/pyodbc ┃
|
|
┃ oracle+oracledb │ oracledb │ www.pypi.org/project/oracledb ┃
|
|
┗━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
|
</code></pre>
|
|
<div><h2 id="bytes"><a href="#bytes" name="bytes">#</a>Bytes</h2><p><strong>A bytes object is an immutable sequence of single bytes. Mutable version is called bytearray.</strong></p><pre><code class="python language-python hljs"><bytes> = <span class="hljs-string">b'<str>'</span> <span class="hljs-comment"># Only accepts ASCII characters and \x00-\xff.</span>
|
|
<int> = <bytes>[index] <span class="hljs-comment"># Returns an integer in range from 0 to 255.</span>
|
|
<bytes> = <bytes>[<slice>] <span class="hljs-comment"># Returns bytes even if it has only one element.</span>
|
|
<bytes> = <bytes>.join(<coll_of_bytes>) <span class="hljs-comment"># Joins elements by using bytes as a separator.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="encode-1">Encode</h3><pre><code class="python language-python hljs"><bytes> = bytes(<coll_of_ints>) <span class="hljs-comment"># Integers must be in range from 0 to 255.</span>
|
|
<bytes> = bytes(<str>, <span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Encodes the string. Also <str>.encode().</span>
|
|
<bytes> = bytes.fromhex(<span class="hljs-string">'<hex>'</span>) <span class="hljs-comment"># Hex pairs can be separated by whitespaces.</span>
|
|
<bytes> = <int>.to_bytes(n_bytes, …) <span class="hljs-comment"># `byteorder='big/little', signed=False`.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="decode-1">Decode</h3><pre><code class="python language-python hljs"><list> = list(<bytes>) <span class="hljs-comment"># Returns integers in range from 0 to 255.</span>
|
|
<str> = str(<bytes>, <span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Returns a string. Also <bytes>.decode().</span>
|
|
<str> = <bytes>.hex() <span class="hljs-comment"># Returns hex pairs. Accepts `sep=<str>`.</span>
|
|
<int> = int.from_bytes(<bytes>, …) <span class="hljs-comment"># `byteorder='big/little', signed=False`.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="readbytesfromfile">Read Bytes from File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'rb'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> file.read()
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writebytestofile">Write Bytes to File</h3><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>
|
|
<span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
|
|
file.write(bytes_obj)
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="struct"><a href="#struct" name="struct">#</a>Struct</h2><ul>
|
|
<li><strong>Module that performs conversions between a sequence of numbers and a bytes object.</strong></li>
|
|
<li><strong>System’s type sizes, byte order, and alignment rules are used by default.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> struct <span class="hljs-keyword">import</span> pack, unpack
|
|
|
|
<bytes> = pack(<span class="hljs-string">'<format>'</span>, <el_1> [, ...]) <span class="hljs-comment"># Packs numbers according to format string.</span>
|
|
<tuple> = unpack(<span class="hljs-string">'<format>'</span>, <bytes>) <span class="hljs-comment"># Use iter_unpack() to get iterator of tuples.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>pack(<span class="hljs-string">'>hhl'</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
<span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>
|
|
<span class="hljs-meta">>>> </span>unpack(<span class="hljs-string">'>hhl'</span>, <span class="hljs-string">b'\x00\x01\x00\x02\x00\x00\x00\x03'</span>)
|
|
(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>)
|
|
</code></pre>
|
|
<h3 id="format-2">Format</h3><div><h4 id="forstandardtypesizesandmanualalignmentpaddingstartformatstringwith">For standard type sizes and manual alignment (padding) start format string with:</h4><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'='</span></code> - System's byte order (usually little-endian).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'<'</span></code> - Little-endian (i.e. least significant byte first).</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'>'</span></code> - Big-endian (also <code class="python hljs"><span class="hljs-string">'!'</span></code>).</strong></li>
|
|
</ul><div><h4 id="besidesnumberspackandunpackalsosupportbytesobjectsasapartofthesequence">Besides numbers, pack() and unpack() also support bytes objects as a part of the sequence:</h4><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'c'</span></code> - A bytes object with a single element. For pad byte use <code class="python hljs"><span class="hljs-string">'x'</span></code>.</strong></li>
|
|
<li><strong><code class="apache hljs"><span class="hljs-section">'<n>s'</span><span class="hljs-attribute"></span></code> - A bytes object with n elements (not effected by byte order).</strong></li>
|
|
</ul></div></div><div><div><h4 id="integertypesuseacapitalletterforunsignedtypeminimumandstandardsizesareinbrackets">Integer types. Use a capital letter for unsigned type. Minimum and standard sizes are in brackets:</h4><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'b'</span></code> - char (1/1)</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'h'</span></code> - short (2/2)</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'i'</span></code> - int (2/4)</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'l'</span></code> - long (4/4)</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'q'</span></code> - long long (8/8)</strong></li>
|
|
</ul></div><div><h4 id="floatingpointtypesstructalwaysusesstandardsizes">Floating point types (struct always uses standard sizes):</h4><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'f'</span></code> - float (4/4)</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'d'</span></code> - double (8/8)</strong></li>
|
|
</ul></div></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div><h2 id="array"><a href="#array" name="array">#</a>Array</h2><p><strong>List that can only hold numbers of a predefined type. Available types and their minimum sizes in bytes are listed above. Type sizes and byte order are always determined by the system, however bytes of each element can be reversed (by calling the byteswap() method).</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> array <span class="hljs-keyword">import</span> array
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><array> = array(<span class="hljs-string">'<typecode>'</span>, <coll_of_nums>) <span class="hljs-comment"># Creates an array from collection of numbers.</span>
|
|
<array> = array(<span class="hljs-string">'<typecode>'</span>, <bytes>) <span class="hljs-comment"># Writes passed bytes to the array's memory.</span>
|
|
<array> = array(<span class="hljs-string">'<typecode>'</span>, <array>) <span class="hljs-comment"># Treats passed array as a sequence of numbers.</span>
|
|
<array>.fromfile(<file>, n_items) <span class="hljs-comment"># Appends file contents to the array's memory.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><bytes> = bytes(<array>) <span class="hljs-comment"># Returns a copy of array's memory as bytes.</span>
|
|
<file>.write(<array>) <span class="hljs-comment"># Writes array's memory to the binary file.</span>
|
|
</code></pre>
|
|
<div><h2 id="memoryview"><a href="#memoryview" name="memoryview">#</a>Memory View</h2><p><strong>A sequence object that points to the memory of another bytes-like object. Each element can reference a single or multiple consecutive bytes, depending on format. Order and number of elements can be changed with slicing.</strong></p><pre><code class="python language-python hljs"><mview> = memoryview(<bytes/bytearray/array>) <span class="hljs-comment"># Immutable if bytes is passed, else mutable.</span>
|
|
<obj> = <mview>[index] <span class="hljs-comment"># Returns ints/floats. Bytes if format is 'c'.</span>
|
|
<mview> = <mview>[<slice>] <span class="hljs-comment"># Returns memoryview with rearranged elements.</span>
|
|
<mview> = <mview>.cast(<span class="hljs-string">'<typecode>'</span>) <span class="hljs-comment"># Only works between B/b/c and other types.</span>
|
|
<mview>.release() <span class="hljs-comment"># Releases memory buffer of the base object.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><bytes> = bytes(<mview>) <span class="hljs-comment"># Returns a new bytes object. Also bytearray().</span>
|
|
<bytes> = <bytes>.join(<coll_of_mviews>) <span class="hljs-comment"># Joins memoryviews using bytes as a separator.</span>
|
|
<array> = array(<span class="hljs-string">'<typecode>'</span>, <mview>) <span class="hljs-comment"># Treats memoryview as a sequence of numbers.</span>
|
|
<file>.write(<mview>) <span class="hljs-comment"># Writes `bytes(<mview>)` to the binary file.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><list> = list(<mview>) <span class="hljs-comment"># Returns a list of ints, floats or bytes.</span>
|
|
<str> = str(<mview>, <span class="hljs-string">'utf-8'</span>) <span class="hljs-comment"># Treats passed memoryview as a bytes object.</span>
|
|
<str> = <mview>.hex() <span class="hljs-comment"># Returns hex pairs. Accepts `sep=<str>`.</span>
|
|
</code></pre>
|
|
<div><h2 id="deque"><a href="#deque" name="deque">#</a>Deque</h2><p><strong>List with efficient appends and pops from either side.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> deque
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><deque> = deque(<collection>) <span class="hljs-comment"># Use `maxlen=<int>` to set size limit.</span>
|
|
<deque>.appendleft(<el>) <span class="hljs-comment"># Opposite element is dropped if full.</span>
|
|
<deque>.extendleft(<collection>) <span class="hljs-comment"># Prepends reversed coll. to the deque.</span>
|
|
<deque>.rotate(n=<span class="hljs-number">1</span>) <span class="hljs-comment"># Last element becomes the first one.</span>
|
|
<el> = <deque>.popleft() <span class="hljs-comment"># Raises IndexError if deque is empty.</span>
|
|
</code></pre>
|
|
<div><h2 id="operator"><a href="#operator" name="operator">#</a>Operator</h2><p><strong>Module of functions that provide the functionality of operators. Functions are grouped by operator precedence, from least to most binding. Functions and operators in first, third and fifth line are also ordered by precedence within a group.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> operator <span class="hljs-keyword">as</span> op
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><bool> = op.not_(<obj>) <span class="hljs-comment"># or, and, not (or/and missing)</span>
|
|
<bool> = op.eq/ne/lt/ge/is_/is_not/contains(<obj>, <obj>) <span class="hljs-comment"># ==, !=, <, >=, is, is not, in</span>
|
|
<obj> = op.or_/xor/and_(<int/set>, <int/set>) <span class="hljs-comment"># |, ^, & (sorted by precedence)</span>
|
|
<int> = op.lshift/rshift(<int>, <int>) <span class="hljs-comment"># <<, >> (i.e. <int> << n_bits)</span>
|
|
<obj> = op.add/sub/mul/truediv/floordiv/mod(<obj>, <obj>) <span class="hljs-comment"># +, -, *, /, //, % (two groups)</span>
|
|
<num> = op.neg/invert(<num>) <span class="hljs-comment"># -, ~ (negate and bitwise not)</span>
|
|
<num> = op.pow(<num>, <num>) <span class="hljs-comment"># ** (pow() accepts 3 arguments)</span>
|
|
<func> = op.itemgetter/attrgetter/methodcaller(<obj> [, ...]) <span class="hljs-comment"># [index/key], .name, .name([…])</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs">elementwise_sum = map(op.add, list_a, list_b)
|
|
sorted_by_second = sorted(<coll>, key=op.itemgetter(<span class="hljs-number">1</span>))
|
|
sorted_by_both = sorted(<coll>, key=op.itemgetter(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>))
|
|
first_element = op.methodcaller(<span class="hljs-string">'pop'</span>, <span class="hljs-number">0</span>)(<list>)
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Most operators call the object's special method that is named after them (second object is passed as an argument), while logical operators call their own code that relies on bool().</strong></li>
|
|
<li><strong>Comparisons can be chained: <code class="python hljs"><span class="hljs-string">'x < y < z'</span></code> gets converted to <code class="python hljs"><span class="hljs-string">'(x < y) and (y < z)</span></code>'.</strong></li>
|
|
</ul>
|
|
<div><h2 id="matchstatement"><a href="#matchstatement" name="matchstatement">#</a>Match Statement</h2><p><strong>Executes the first block with matching pattern.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">match</span> <object/expression>:
|
|
<span class="hljs-keyword">case</span> <pattern> [<span class="hljs-keyword">if</span> <condition>]:
|
|
<code>
|
|
...
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="patterns">Patterns</h3><pre><code class="python language-python hljs"><value_pattern> = <span class="hljs-number">1</span>/<span class="hljs-string">'abc'</span>/<span class="hljs-keyword">True</span>/<span class="hljs-keyword">None</span>/math.pi <span class="hljs-comment"># Matches the literal or a dotted name.</span>
|
|
<class_pattern> = <type>() <span class="hljs-comment"># Matches any object of that type (or ABC).</span>
|
|
<wildcard_patt> = _ <span class="hljs-comment"># Matches any object. Useful in last case.</span>
|
|
<capture_patt> = <name> <span class="hljs-comment"># Matches any object and binds it to name.</span>
|
|
<as_pattern> = <pattern> <span class="hljs-keyword">as</span> <name> <span class="hljs-comment"># Binds match to name. Also <type>(<name>).</span>
|
|
<or_pattern> = <pattern> | <pattern> [| ...] <span class="hljs-comment"># Matches if any of listed patterns match.</span>
|
|
<sequence_patt> = [<pattern>, ...] <span class="hljs-comment"># Matches a sequence. All items must match.</span>
|
|
<mapping_patt> = {<value_pattern>: <patt>, ...} <span class="hljs-comment"># Matches a dict that has matching items.</span>
|
|
<class_pattern> = <type>(<attr_name>=<patt>, ...) <span class="hljs-comment"># Matches an object if attributes match.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Sequence pattern can also be written as a tuple, either with or without the brackets.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'*<name>'</span></code> and <code class="python hljs"><span class="hljs-string">'**<name>'</span></code> in sequence/mapping patterns to bind remaining items.</strong></li>
|
|
<li><strong>Sequence pattern must match all items of the collection, while mapping pattern does not.</strong></li>
|
|
<li><strong>Patterns can be surrounded with brackets to override their precedence: <code class="python hljs"><span class="hljs-string">'|'</span></code> > <code class="python hljs"><span class="hljs-string">'as'</span></code> > <code class="python hljs"><span class="hljs-string">','</span></code>. For example, <code class="python hljs"><span class="hljs-string">'[1, 2]'</span></code> is matched by the <code class="python hljs"><span class="hljs-string">'case 1|2, 2|3 as x if x == 2:'</span></code> block.</strong></li>
|
|
<li><strong>All names that are bound in the matching case, as well as variables initialized in its body, are visible after the match statement (only function block delimits scope).</strong></li>
|
|
</ul>
|
|
<div><h3 id="example-2">Example</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> pathlib <span class="hljs-keyword">import</span> Path
|
|
<span class="hljs-meta">>>> </span><span class="hljs-keyword">match</span> Path(<span class="hljs-string">'/home/gto/python-cheatsheet/README.md'</span>):
|
|
<span class="hljs-meta">... </span> <span class="hljs-keyword">case</span> Path(
|
|
<span class="hljs-meta">... </span> parts=[<span class="hljs-string">'/'</span>, <span class="hljs-string">'home'</span>, user, *_]
|
|
<span class="hljs-meta">... </span> ) <span class="hljs-keyword">as</span> p <span class="hljs-keyword">if</span> p.name.lower().startswith(<span class="hljs-string">'readme'</span>) <span class="hljs-keyword">and</span> p.is_file():
|
|
<span class="hljs-meta">... </span> print(<span class="hljs-string">f'<span class="hljs-subst">{p.name}</span> is a readme file that belongs to user <span class="hljs-subst">{user}</span>.'</span>)
|
|
README.md is a readme file that belongs to user gto.
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="logging"><a href="#logging" name="logging">#</a>Logging</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> logging <span class="hljs-keyword">as</span> log
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs">log.basicConfig(filename=<path>, level=<span class="hljs-string">'DEBUG'</span>) <span class="hljs-comment"># Configures the root logger (see Setup).</span>
|
|
log.debug/info/warning/error/critical(<str>) <span class="hljs-comment"># Sends passed message to the root logger.</span>
|
|
<Logger> = log.getLogger(__name__) <span class="hljs-comment"># Returns a logger named after the module.</span>
|
|
<Logger>.<level>(<str>) <span class="hljs-comment"># Sends the message. Same levels as above.</span>
|
|
<Logger>.exception(<str>) <span class="hljs-comment"># Error() that appends caught exception.</span>
|
|
</code></pre>
|
|
<div><h3 id="setup">Setup</h3><pre><code class="python language-python hljs">log.basicConfig(
|
|
filename=<span class="hljs-keyword">None</span>, <span class="hljs-comment"># Logs to stderr or appends to file.</span>
|
|
format=<span class="hljs-string">'%(levelname)s:%(name)s:%(message)s'</span>, <span class="hljs-comment"># Add '%(asctime)s' for local datetime.</span>
|
|
level=log.WARNING, <span class="hljs-comment"># Drops messages with lower priority.</span>
|
|
handlers=[log.StreamHandler(sys.stderr)] <span class="hljs-comment"># Uses FileHandler if filename is set.</span>
|
|
)
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><Formatter> = log.Formatter(<span class="hljs-string">'<format>'</span>) <span class="hljs-comment"># Formats messages according to format str.</span>
|
|
<Handler> = log.FileHandler(<path>, mode=<span class="hljs-string">'a'</span>) <span class="hljs-comment"># Appends to file. Also `encoding=None`.</span>
|
|
<Handler>.setFormatter(<Formatter>) <span class="hljs-comment"># Only outputs bare messages by default.</span>
|
|
<Handler>.setLevel(<int/str>) <span class="hljs-comment"># Prints or saves every message by default.</span>
|
|
<Logger>.addHandler(<Handler>) <span class="hljs-comment"># Logger can have more than one handler.</span>
|
|
<Logger>.setLevel(<int/str>) <span class="hljs-comment"># What is sent to its/ancestors' handlers.</span>
|
|
<Logger>.propagate = <bool> <span class="hljs-comment"># Cuts off ancestors' handlers if False.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Parent logger can be specified by naming the child logger <code class="python hljs"><span class="hljs-string">'<parent>.<name>'</span></code>.</strong></li>
|
|
<li><strong>If logger doesn't have a set level, it inherits it from the first ancestor that does.</strong></li>
|
|
<li><strong>Formatter also accepts: pathname, filename, funcName, lineno, thread and process.</strong></li>
|
|
<li><strong>RotatingFileHandler creates and deletes files based on 'maxBytes', 'backupCount' args.</strong></li>
|
|
<li><strong>An object with <code class="python hljs"><span class="hljs-string">'filter(<LogRecord>)'</span></code> method (or the method itself) can be added to loggers and handlers via addFilter(). Message is dropped if filter() returns a false value.</strong></li>
|
|
</ul>
|
|
<div><h4 id="createsaloggerthatwritesallmessagestoafileandsendsthemtotherootshandlerthatprintswarningsorhigher">Creates a logger that writes all messages to a file and sends them to the root's handler that prints warnings or higher:</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>logger = log.getLogger(<span class="hljs-string">'my_module'</span>)
|
|
<span class="hljs-meta">>>> </span>handler = log.FileHandler(<span class="hljs-string">'test.log'</span>, encoding=<span class="hljs-string">'utf-8'</span>)
|
|
<span class="hljs-meta">>>> </span>handler.setFormatter(log.Formatter(<span class="hljs-string">'%(asctime)s %(levelname)s:%(name)s:%(message)s'</span>))
|
|
<span class="hljs-meta">>>> </span>logger.addHandler(handler)
|
|
<span class="hljs-meta">>>> </span>logger.setLevel(<span class="hljs-string">'DEBUG'</span>)
|
|
<span class="hljs-meta">>>> </span>log.basicConfig()
|
|
<span class="hljs-meta">>>> </span>log.root.handlers[<span class="hljs-number">0</span>].setLevel(<span class="hljs-string">'WARNING'</span>)
|
|
<span class="hljs-meta">>>> </span>logger.critical(<span class="hljs-string">'Running out of disk space.'</span>)
|
|
CRITICAL:my_module:Running out of disk space.
|
|
<span class="hljs-meta">>>> </span>print(open(<span class="hljs-string">'test.log'</span>).read())
|
|
2023-02-07 23:21:01,430 CRITICAL:my_module:Running out of disk space.
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="introspection"><a href="#introspection" name="introspection">#</a>Introspection</h2><pre><code class="python language-python hljs"><list> = dir() <span class="hljs-comment"># Local names of variables, functions, classes and modules.</span>
|
|
<dict> = vars() <span class="hljs-comment"># Dict of local names and their objects. Same as locals().</span>
|
|
<dict> = globals() <span class="hljs-comment"># Dict of global names and their objects, e.g. __builtin__.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><list> = dir(<obj>) <span class="hljs-comment"># Returns names of object's attributes (including methods).</span>
|
|
<dict> = vars(<obj>) <span class="hljs-comment"># Returns dict of writable attributes. Also <obj>.__dict__.</span>
|
|
<bool> = hasattr(<obj>, <span class="hljs-string">'<name>'</span>) <span class="hljs-comment"># Checks if object possesses attribute with passed name.</span>
|
|
value = getattr(<obj>, <span class="hljs-string">'<name>'</span>) <span class="hljs-comment"># Returns the object's attribute or raises AttributeError.</span>
|
|
setattr(<obj>, <span class="hljs-string">'<name>'</span>, value) <span class="hljs-comment"># Sets attribute. Only works on objects with __dict__ attr.</span>
|
|
delattr(<obj>, <span class="hljs-string">'<name>'</span>) <span class="hljs-comment"># Deletes attribute from __dict__. Also `del <obj>.<name>`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Sig> = inspect.signature(<func>) <span class="hljs-comment"># Returns Signature object of the passed function or class.</span>
|
|
<dict> = <Sig>.parameters <span class="hljs-comment"># Returns dict of Parameters. Also <Sig>.return_annotation.</span>
|
|
<memb> = <Param>.kind <span class="hljs-comment"># Returns ParameterKind member (Parameter.KEYWORD_ONLY, …).</span>
|
|
<type> = <Param>.annotation <span class="hljs-comment"># Returns Parameter.empty if missing. Also <Param>.default.</span>
|
|
</code></pre>
|
|
<div><h2 id="threading"><a href="#threading" name="threading">#</a>Threading</h2><p><strong>CPython interpreter can only run a single thread at a time. Using multiple threads won't result in a faster execution, unless at least one of the threads contains an I/O operation.</strong></p><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> threading <span class="hljs-keyword">import</span> Thread, Lock, RLock, Semaphore, Event, Barrier
|
|
<span class="hljs-keyword">from</span> concurrent.futures <span class="hljs-keyword">import</span> ThreadPoolExecutor, as_completed
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="thread">Thread</h3><pre><code class="python language-python hljs"><Thread> = Thread(target=<function>) <span class="hljs-comment"># Use `args=<collection>` to set the arguments.</span>
|
|
<Thread>.start() <span class="hljs-comment"># Starts the thread. Also <Thread>.is_alive().</span>
|
|
<Thread>.join() <span class="hljs-comment"># Waits for the thread to finish executing.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'kwargs=<dict>'</span></code> to pass keyword arguments to the function.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'daemon=True'</span></code>, or the program won't be able to exit while the thread is alive.</strong></li>
|
|
</ul>
|
|
<div><h3 id="lock">Lock</h3><pre><code class="python language-python hljs"><lock> = Lock/RLock() <span class="hljs-comment"># RLock can only be released by acquirer thread.</span>
|
|
<lock>.acquire() <span class="hljs-comment"># Blocks (waits) until lock becomes available.</span>
|
|
<lock>.release() <span class="hljs-comment"># Releases the lock so it can be acquired again.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="or-1">Or:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">with</span> <lock>: <span class="hljs-comment"># Enters the block by calling method acquire().</span>
|
|
... <span class="hljs-comment"># Exits it by calling release(), even on error.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="semaphoreeventbarrier">Semaphore, Event, Barrier</h3><pre><code class="python language-python hljs"><Semaphore> = Semaphore(value=<span class="hljs-number">1</span>) <span class="hljs-comment"># Lock that can be acquired by 'value' threads.</span>
|
|
<Event> = Event() <span class="hljs-comment"># Method wait() blocks until set() is called.</span>
|
|
<Barrier> = Barrier(<int>) <span class="hljs-comment"># Wait() blocks until it's called int times.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="queue">Queue</h3><pre><code class="python language-python hljs"><Queue> = queue.Queue(maxsize=<span class="hljs-number">0</span>) <span class="hljs-comment"># A first-in-first-out queue. It's thread safe.</span>
|
|
<Queue>.put(<obj>) <span class="hljs-comment"># Call blocks until queue stops being full.</span>
|
|
<Queue>.put_nowait(<obj>) <span class="hljs-comment"># Raises queue.Full exception if queue is full.</span>
|
|
<obj> = <Queue>.get() <span class="hljs-comment"># Call blocks until queue stops being empty.</span>
|
|
<obj> = <Queue>.get_nowait() <span class="hljs-comment"># Raises queue.Empty exception if it's empty.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="threadpoolexecutor">Thread Pool Executor</h3><pre><code class="python language-python hljs"><Exec> = ThreadPoolExecutor(max_workers=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Also `with ThreadPoolExecutor() as <name>: …`.</span>
|
|
<iter> = <Exec>.map(<func>, <args_1>, ...) <span class="hljs-comment"># Multithreaded and non-lazy map(). Keeps order.</span>
|
|
<Futr> = <Exec>.submit(<func>, <arg_1>, ...) <span class="hljs-comment"># Creates a thread and returns its Future obj.</span>
|
|
<Exec>.shutdown() <span class="hljs-comment"># Waits for all threads to finish executing.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><bool> = <Future>.done() <span class="hljs-comment"># Checks if the thread has finished executing.</span>
|
|
<obj> = <Future>.result(timeout=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Raises TimeoutError after 'timeout' seconds.</span>
|
|
<bool> = <Future>.cancel() <span class="hljs-comment"># Cancels or returns False if running/finished.</span>
|
|
<iter> = as_completed(<coll_of_Futures>) <span class="hljs-comment"># `next(<iter>)` returns next completed Future.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Map() and as_completed() also accept 'timeout'. It causes futures.TimeoutError when next() is called/blocking. Map() times from original call and as_completed() from first call to next(). As_completed() fails if next() is called too late, even if all threads are done.</strong></li>
|
|
<li><strong>Exceptions that happen inside threads are raised when map iterator's next() or Future's result() are called. Future's exception() method returns an exception object or None.</strong></li>
|
|
<li><strong>ProcessPoolExecutor provides true parallelism but: everything sent to/from workers must be <a href="#pickle">pickable</a>, queues must be sent using executor's 'initargs' and 'initializer' parameters, and executor should only be reachable via <code class="python hljs"><span class="hljs-string">'if __name__ == "__main__": ...'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h2 id="coroutines"><a href="#coroutines" name="coroutines">#</a>Coroutines</h2><ul>
|
|
<li><strong>Coroutines have a lot in common with threads, but unlike threads, they only give up control when they call another coroutine and they don’t consume as much memory.</strong></li>
|
|
<li><strong>Coroutine definition starts with <code class="python hljs"><span class="hljs-string">'async'</span></code> keyword and its call with <code class="python hljs"><span class="hljs-string">'await'</span></code>.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'asyncio.run(<coroutine>)'</span></code> to start the first/main coroutine.</strong></li>
|
|
</ul><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> asyncio <span class="hljs-keyword">as</span> aio
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><coro> = <async_function>(<args>) <span class="hljs-comment"># Creates a coroutine by calling async def function.</span>
|
|
<obj> = <span class="hljs-keyword">await</span> <coroutine> <span class="hljs-comment"># Starts the coroutine. Returns its result or None.</span>
|
|
<task> = aio.create_task(<coroutine>) <span class="hljs-comment"># Schedules it for execution. Always keep the task.</span>
|
|
<obj> = <span class="hljs-keyword">await</span> <task> <span class="hljs-comment"># Returns coroutine's result. Also <task>.cancel().</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><coro> = aio.gather(<coro/task>, ...) <span class="hljs-comment"># Schedules coros. Returns list of results on await.</span>
|
|
<coro> = aio.wait(<tasks>, return_when=…) <span class="hljs-comment"># `'ALL/FIRST_COMPLETED'`. Returns (done, pending).</span>
|
|
<iter> = aio.as_completed(<coros/tasks>) <span class="hljs-comment"># Iter of coros that return next result on await.</span>
|
|
</code></pre>
|
|
<div><h4 id="runsaterminalgamewhereyoucontrolanasteriskthatmustavoidnumbers">Runs a terminal game where you control an asterisk that must avoid numbers:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> asyncio, collections, curses, curses.textpad, enum, random
|
|
|
|
P = collections.namedtuple(<span class="hljs-string">'P'</span>, <span class="hljs-string">'x y'</span>) <span class="hljs-comment"># Position (x and y coordinates).</span>
|
|
D = enum.Enum(<span class="hljs-string">'D'</span>, <span class="hljs-string">'n e s w'</span>) <span class="hljs-comment"># Direction (north, east, etc.).</span>
|
|
W, H = <span class="hljs-number">15</span>, <span class="hljs-number">7</span> <span class="hljs-comment"># Width and height of the field.</span>
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">(screen)</span>:</span>
|
|
curses.curs_set(<span class="hljs-number">0</span>) <span class="hljs-comment"># Makes the cursor invisible.</span>
|
|
screen.nodelay(<span class="hljs-keyword">True</span>) <span class="hljs-comment"># Makes getch() non-blocking.</span>
|
|
asyncio.run(main_coroutine(screen)) <span class="hljs-comment"># Starts running asyncio code.</span>
|
|
|
|
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main_coroutine</span><span class="hljs-params">(screen)</span>:</span>
|
|
moves = asyncio.Queue()
|
|
state = {<span class="hljs-string">'*'</span>: P(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>)} | {id_: P(W//<span class="hljs-number">2</span>, H//<span class="hljs-number">2</span>) <span class="hljs-keyword">for</span> id_ <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)}
|
|
ai = [random_controller(id_, moves) <span class="hljs-keyword">for</span> id_ <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)]
|
|
mvc = [controller(screen, moves), model(moves, state), view(state, screen)]
|
|
tasks = [asyncio.create_task(coro) <span class="hljs-keyword">for</span> coro <span class="hljs-keyword">in</span> ai + mvc]
|
|
<span class="hljs-keyword">await</span> asyncio.wait(tasks, return_when=asyncio.FIRST_COMPLETED)
|
|
|
|
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">random_controller</span><span class="hljs-params">(id_, moves)</span>:</span>
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
|
|
d = random.choice(list(D))
|
|
moves.put_nowait((id_, d))
|
|
<span class="hljs-keyword">await</span> asyncio.sleep(random.triangular(<span class="hljs-number">0.01</span>, <span class="hljs-number">0.65</span>))
|
|
|
|
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">controller</span><span class="hljs-params">(screen, moves)</span>:</span>
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
|
|
key_mappings = {<span class="hljs-number">258</span>: D.s, <span class="hljs-number">259</span>: D.n, <span class="hljs-number">260</span>: D.w, <span class="hljs-number">261</span>: D.e}
|
|
<span class="hljs-keyword">if</span> d := key_mappings.get(screen.getch()):
|
|
moves.put_nowait((<span class="hljs-string">'*'</span>, d))
|
|
<span class="hljs-keyword">await</span> asyncio.sleep(<span class="hljs-number">0.005</span>)
|
|
|
|
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">model</span><span class="hljs-params">(moves, state)</span>:</span>
|
|
<span class="hljs-keyword">while</span> state[<span class="hljs-string">'*'</span>] <span class="hljs-keyword">not</span> <span class="hljs-keyword">in</span> (state[id_] <span class="hljs-keyword">for</span> id_ <span class="hljs-keyword">in</span> range(<span class="hljs-number">10</span>)):
|
|
id_, d = <span class="hljs-keyword">await</span> moves.get()
|
|
deltas = {D.n: P(<span class="hljs-number">0</span>, <span class="hljs-number">-1</span>), D.e: P(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>), D.s: P(<span class="hljs-number">0</span>, <span class="hljs-number">1</span>), D.w: P(<span class="hljs-number">-1</span>, <span class="hljs-number">0</span>)}
|
|
state[id_] = P((state[id_].x + deltas[d].x) % W, (state[id_].y + deltas[d].y) % H)
|
|
|
|
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">view</span><span class="hljs-params">(state, screen)</span>:</span>
|
|
offset = P(curses.COLS//<span class="hljs-number">2</span> - W//<span class="hljs-number">2</span>, curses.LINES//<span class="hljs-number">2</span> - H//<span class="hljs-number">2</span>)
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
|
|
screen.erase()
|
|
curses.textpad.rectangle(screen, offset.y-<span class="hljs-number">1</span>, offset.x-<span class="hljs-number">1</span>, offset.y+H, offset.x+W)
|
|
<span class="hljs-keyword">for</span> id_, p <span class="hljs-keyword">in</span> state.items():
|
|
screen.addstr(offset.y + (p.y - state[<span class="hljs-string">'*'</span>].y + H//<span class="hljs-number">2</span>) % H,
|
|
offset.x + (p.x - state[<span class="hljs-string">'*'</span>].x + W//<span class="hljs-number">2</span>) % W, str(id_))
|
|
screen.refresh()
|
|
<span class="hljs-keyword">await</span> asyncio.sleep(<span class="hljs-number">0.005</span>)
|
|
|
|
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
|
|
curses.wrapper(main)
|
|
</code></pre></div>
|
|
|
|
<p><br></p>
|
|
<div><h1 id="libraries">Libraries</h1><div><h2 id="progressbar"><a href="#progressbar" name="progressbar">#</a>Progress Bar</h2><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tqdm</span>
|
|
<span class="hljs-meta">>>> </span><span class="hljs-keyword">import</span> tqdm, time
|
|
<span class="hljs-meta">>>> </span><span class="hljs-keyword">for</span> el <span class="hljs-keyword">in</span> tqdm.tqdm([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], desc=<span class="hljs-string">'Processing'</span>):
|
|
<span class="hljs-meta">... </span> time.sleep(<span class="hljs-number">1</span>)
|
|
Processing: 100%|████████████████████| 3/3 [00:03<00:00, 1.00s/it]
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="plot"><a href="#plot" name="plot">#</a>Plot</h2><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install matplotlib</span>
|
|
<span class="hljs-keyword">import</span> matplotlib.pyplot <span class="hljs-keyword">as</span> plt
|
|
|
|
plt.plot/bar/scatter(x_data, y_data [, label=<str>]) <span class="hljs-comment"># Also plt.plot(y_data).</span>
|
|
plt.legend() <span class="hljs-comment"># Adds a legend of labels.</span>
|
|
plt.title/xlabel/ylabel(<str>) <span class="hljs-comment"># Adds title or axis label.</span>
|
|
plt.show() <span class="hljs-comment"># Also plt.savefig(<path>).</span>
|
|
plt.clf() <span class="hljs-comment"># Clears the plot (figure).</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="table"><a href="#table" name="table">#</a>Table</h2><div><h4 id="printsacsvspreadsheettotheconsole">Prints a CSV spreadsheet to the console:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install tabulate</span>
|
|
<span class="hljs-keyword">import</span> csv, tabulate
|
|
<span class="hljs-keyword">with</span> open(<span class="hljs-string">'test.csv'</span>, encoding=<span class="hljs-string">'utf-8'</span>, newline=<span class="hljs-string">''</span>) <span class="hljs-keyword">as</span> file:
|
|
rows = list(csv.reader(file))
|
|
print(tabulate.tabulate(rows, headers=<span class="hljs-string">'firstrow'</span>))
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="consoleapp"><a href="#consoleapp" name="consoleapp">#</a>Console App</h2><div><h4 id="runsabasicfileexplorerintheconsole">Runs a basic file explorer in the console:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install windows-curses</span>
|
|
<span class="hljs-keyword">import</span> curses, os
|
|
<span class="hljs-keyword">from</span> curses <span class="hljs-keyword">import</span> A_REVERSE, KEY_UP, KEY_DOWN, KEY_LEFT, KEY_RIGHT
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">(screen)</span>:</span>
|
|
ch, first, selected, paths = <span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>, os.listdir()
|
|
<span class="hljs-keyword">while</span> ch != ord(<span class="hljs-string">'q'</span>):
|
|
height, width = screen.getmaxyx()
|
|
screen.erase()
|
|
<span class="hljs-keyword">for</span> y, filename <span class="hljs-keyword">in</span> enumerate(paths[first : first+height]):
|
|
color = A_REVERSE <span class="hljs-keyword">if</span> filename == paths[selected] <span class="hljs-keyword">else</span> <span class="hljs-number">0</span>
|
|
screen.addnstr(y, <span class="hljs-number">0</span>, filename, width-<span class="hljs-number">1</span>, color)
|
|
ch = screen.getch()
|
|
selected -= (ch == KEY_UP) <span class="hljs-keyword">and</span> (selected > <span class="hljs-number">0</span>)
|
|
selected += (ch == KEY_DOWN) <span class="hljs-keyword">and</span> (selected < len(paths)-<span class="hljs-number">1</span>)
|
|
first -= (first > selected)
|
|
first += (first < selected-(height-<span class="hljs-number">1</span>))
|
|
<span class="hljs-keyword">if</span> ch <span class="hljs-keyword">in</span> [KEY_LEFT, KEY_RIGHT, ord(<span class="hljs-string">'\n'</span>)]:
|
|
new_dir = <span class="hljs-string">'..'</span> <span class="hljs-keyword">if</span> ch == KEY_LEFT <span class="hljs-keyword">else</span> paths[selected]
|
|
<span class="hljs-keyword">if</span> os.path.isdir(new_dir):
|
|
os.chdir(new_dir)
|
|
first, selected, paths = <span class="hljs-number">0</span>, <span class="hljs-number">0</span>, os.listdir()
|
|
|
|
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
|
|
curses.wrapper(main)
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="guiapp"><a href="#guiapp" name="guiapp">#</a>GUI App</h2><div><h4 id="runsadesktopappforconvertingweightsfrommetricunitsintopounds">Runs a desktop app for converting weights from metric units into pounds:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install PySimpleGUI</span>
|
|
<span class="hljs-keyword">import</span> PySimpleGUI <span class="hljs-keyword">as</span> sg
|
|
|
|
text_box = sg.Input(default_text=<span class="hljs-string">'100'</span>, enable_events=<span class="hljs-keyword">True</span>, key=<span class="hljs-string">'QUANTITY'</span>)
|
|
dropdown = sg.InputCombo([<span class="hljs-string">'g'</span>, <span class="hljs-string">'kg'</span>, <span class="hljs-string">'t'</span>], <span class="hljs-string">'kg'</span>, readonly=<span class="hljs-keyword">True</span>, enable_events=<span class="hljs-keyword">True</span>, k=<span class="hljs-string">'UNIT'</span>)
|
|
label = sg.Text(<span class="hljs-string">'100 kg is 220.462 lbs.'</span>, key=<span class="hljs-string">'OUTPUT'</span>)
|
|
window = sg.Window(<span class="hljs-string">'Weight Converter'</span>, [[text_box, dropdown], [label], [sg.Button(<span class="hljs-string">'Close'</span>)]])
|
|
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">True</span>:
|
|
event, values = window.read()
|
|
<span class="hljs-keyword">if</span> event <span class="hljs-keyword">in</span> [sg.WIN_CLOSED, <span class="hljs-string">'Close'</span>]:
|
|
<span class="hljs-keyword">break</span>
|
|
<span class="hljs-keyword">try</span>:
|
|
quantity = float(values[<span class="hljs-string">'QUANTITY'</span>])
|
|
<span class="hljs-keyword">except</span> ValueError:
|
|
<span class="hljs-keyword">continue</span>
|
|
unit = values[<span class="hljs-string">'UNIT'</span>]
|
|
lbs = quantity * {<span class="hljs-string">'g'</span>: <span class="hljs-number">0.001</span>, <span class="hljs-string">'kg'</span>: <span class="hljs-number">1</span>, <span class="hljs-string">'t'</span>: <span class="hljs-number">1000</span>}[unit] / <span class="hljs-number">0.45359237</span>
|
|
window[<span class="hljs-string">'OUTPUT'</span>].update(value=<span class="hljs-string">f'<span class="hljs-subst">{quantity}</span> <span class="hljs-subst">{unit}</span> is <span class="hljs-subst">{lbs:g}</span> lbs.'</span>)
|
|
window.close()
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="scraping"><a href="#scraping" name="scraping">#</a>Scraping</h2><div><h4 id="scrapespythonsurlandlogofromitswikipediapage">Scrapes Python's URL and logo from its Wikipedia page:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests beautifulsoup4</span>
|
|
<span class="hljs-keyword">import</span> requests, bs4, os
|
|
|
|
get = <span class="hljs-keyword">lambda</span> url: requests.get(url, headers={<span class="hljs-string">'User-Agent'</span>: <span class="hljs-string">'cpc-bot'</span>})
|
|
response = get(<span class="hljs-string">'https://en.wikipedia.org/wiki/Python_(programming_language)'</span>)
|
|
document = bs4.BeautifulSoup(response.text, <span class="hljs-string">'html.parser'</span>)
|
|
table = document.find(<span class="hljs-string">'table'</span>, class_=<span class="hljs-string">'infobox vevent'</span>)
|
|
python_url = table.find(<span class="hljs-string">'th'</span>, text=<span class="hljs-string">'Website'</span>).next_sibling.a[<span class="hljs-string">'href'</span>]
|
|
logo_url = table.find(<span class="hljs-string">'img'</span>)[<span class="hljs-string">'src'</span>]
|
|
filename = os.path.basename(logo_url)
|
|
<span class="hljs-keyword">with</span> open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
|
|
file.write(get(<span class="hljs-string">f'https:<span class="hljs-subst">{logo_url}</span>'</span>).content)
|
|
print(<span class="hljs-string">f'URL: <span class="hljs-subst">{python_url}</span>, logo: file://<span class="hljs-subst">{os.path.abspath(filename)}</span>'</span>)
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h3 id="selenium">Selenium</h3><p><strong>Library for scraping websites with dynamic content.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install selenium</span>
|
|
<span class="hljs-keyword">from</span> selenium <span class="hljs-keyword">import</span> webdriver
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><Drv> = webdriver.Chrome/Firefox/Safari/Edge() <span class="hljs-comment"># Opens the browser. Also <Driver>.quit().</span>
|
|
<Drv>.implicitly_wait(seconds) <span class="hljs-comment"># Sets timeout for find_element/s() methods.</span>
|
|
<Drv>.get(<span class="hljs-string">'<url>'</span>) <span class="hljs-comment"># Blocks until browser fires the load event.</span>
|
|
<str> = <Drv>.page_source <span class="hljs-comment"># Returns HTML of the page's current state.</span>
|
|
<El> = <Drv/El>.find_element(<span class="hljs-string">'xpath'</span>, <str>) <span class="hljs-comment"># Accepts '//<tag>[@<attr_name>="<val>"]…'.</span>
|
|
<str> = <El>.get_attribute(<span class="hljs-string">'<name>'</span>) <span class="hljs-comment"># Returns attribute or property if exists.</span>
|
|
<El>.click/clear() <span class="hljs-comment"># Also <El>.text and <El>.send_keys(<str>).</span>
|
|
</code></pre>
|
|
<div><h4 id="xpathalsoavailableinlxmlscrapyandbrowsersconsoleviadxxpath">XPath — also available in lxml, Scrapy, and browser's console via <code class="python hljs"><span class="hljs-string">'$x("<xpath>")'</span></code>:</h4><pre><code class="python language-python hljs"><xpath> = //<element>[/ <span class="hljs-keyword">or</span> // <element>] <span class="hljs-comment"># E.g. …/child, …//descendant, …/../sibling.</span>
|
|
<xpath> = //<element>/following::<element> <span class="hljs-comment"># Next element. Also preceding::, parent::.</span>
|
|
<element> = <tag><conditions><index> <span class="hljs-comment"># Tag accepts */a/…. Use [1/2/…] for index.</span>
|
|
<condition> = [<sub_cond> [<span class="hljs-keyword">and</span>/<span class="hljs-keyword">or</span> <sub_cond>]] <span class="hljs-comment"># Use not(<sub_cond>) to negate condition.</span>
|
|
<sub_cond> = @<attr>[=<span class="hljs-string">"<val>"</span>] <span class="hljs-comment"># `text()=` and `.=` match (complete) text.</span>
|
|
<sub_cond> = contains(@<attr>, <span class="hljs-string">"<val>"</span>) <span class="hljs-comment"># Is <val> a substring of attribute's value?</span>
|
|
<sub_cond> = [//]<element> <span class="hljs-comment"># Has matching child? Descendant if //<el>.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="webapp"><a href="#webapp" name="webapp">#</a>Web App</h2><p><strong>Flask is a micro web framework/server. If you just want to open a html file in a web browser use <code class="python hljs"><span class="hljs-string">'webbrowser.open(<path>)'</span></code> instead.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install flask</span>
|
|
<span class="hljs-keyword">import</span> flask <span class="hljs-keyword">as</span> fl
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs">app = fl.Flask(__name__) <span class="hljs-comment"># Returns the app object. Put at the top.</span>
|
|
app.run(host=<span class="hljs-keyword">None</span>, port=<span class="hljs-keyword">None</span>, debug=<span class="hljs-keyword">None</span>) <span class="hljs-comment"># Or: $ flask --app FILE run [--ARG[=VAL]]…</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Starts the app at <code class="python hljs"><span class="hljs-string">'http://localhost:5000'</span></code>. Use <code class="python hljs"><span class="hljs-string">'host="0.0.0.0"'</span></code> to run externally.</strong></li>
|
|
<li><strong>Install a WSGI server like <a href="https://flask.palletsprojects.com/en/latest/deploying/waitress/">Waitress</a> and a HTTP server such as <a href="https://flask.palletsprojects.com/en/latest/deploying/nginx/">Nginx</a> for better security.</strong></li>
|
|
<li><strong>Debug mode restarts the app whenever script changes and displays errors in the browser.</strong></li>
|
|
</ul>
|
|
<div><h3 id="servingfiles">Serving Files</h3><pre><code class="python language-python hljs"><span class="hljs-meta">@app.route('/img/<path:filename>')</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">serve_file</span><span class="hljs-params">(filename)</span>:</span>
|
|
<span class="hljs-keyword">return</span> fl.send_from_directory(<span class="hljs-string">'DIRNAME'</span>, filename)
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="servinghtml">Serving HTML</h3><pre><code class="python language-python hljs"><span class="hljs-meta">@app.route('/<sport>')</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">serve_html</span><span class="hljs-params">(sport)</span>:</span>
|
|
<span class="hljs-keyword">return</span> fl.render_template_string(<span class="hljs-string">'<h1>{{title}}</h1>'</span>, title=sport)
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'fl.render_template(filename, <kwargs>)'</span></code> renders a file located in 'templates' dir.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'fl.abort(<int>)'</span></code> returns error code and <code class="python hljs"><span class="hljs-string">'return fl.redirect(<url>)'</span></code> redirects.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'fl.request.args[<str>]'</span></code> returns parameter from query string (URL part right of '?').</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'fl.session[<str>] = <obj>'</span></code> stores session data. It requires secret key to be set at the startup with <code class="python hljs"><span class="hljs-string">'app.secret_key = <str>'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="servingjson">Serving JSON</h3><pre><code class="python language-python hljs"><span class="hljs-meta">@app.post('/<sport>/odds')</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">serve_json</span><span class="hljs-params">(sport)</span>:</span>
|
|
team = fl.request.form[<span class="hljs-string">'team'</span>]
|
|
<span class="hljs-keyword">return</span> {<span class="hljs-string">'team'</span>: team, <span class="hljs-string">'odds'</span>: [<span class="hljs-number">2.09</span>, <span class="hljs-number">3.74</span>, <span class="hljs-number">3.68</span>]}
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="startstheappinitsownthreadandqueriesitsrestapi">Starts the app in its own thread and queries its REST API:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install requests</span>
|
|
<span class="hljs-meta">>>> </span><span class="hljs-keyword">import</span> threading, requests
|
|
<span class="hljs-meta">>>> </span>threading.Thread(target=app.run, daemon=<span class="hljs-keyword">True</span>).start()
|
|
<span class="hljs-meta">>>> </span>url = <span class="hljs-string">'http://localhost:5000/football/odds'</span>
|
|
<span class="hljs-meta">>>> </span>response = requests.post(url, data={<span class="hljs-string">'team'</span>: <span class="hljs-string">'arsenal f.c.'</span>})
|
|
<span class="hljs-meta">>>> </span>response.json()
|
|
{<span class="hljs-string">'team'</span>: <span class="hljs-string">'arsenal f.c.'</span>, <span class="hljs-string">'odds'</span>: [<span class="hljs-number">2.09</span>, <span class="hljs-number">3.74</span>, <span class="hljs-number">3.68</span>]}
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="profiling"><a href="#profiling" name="profiling">#</a>Profiling</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> time <span class="hljs-keyword">import</span> perf_counter
|
|
start_time = perf_counter()
|
|
...
|
|
duration_in_seconds = perf_counter() - start_time
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="timingasnippet">Timing a Snippet</h3><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span><span class="hljs-keyword">from</span> timeit <span class="hljs-keyword">import</span> timeit
|
|
<span class="hljs-meta">>>> </span>timeit(<span class="hljs-string">'list(range(10000))'</span>, number=<span class="hljs-number">1000</span>, globals=globals(), setup=<span class="hljs-string">'pass'</span>)
|
|
<span class="hljs-number">0.19373</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="profilingbyline">Profiling by Line</h3><pre><code class="text language-text">$ pip3 install line_profiler
|
|
$ echo '@profile
|
|
def main():
|
|
a = list(range(10000))
|
|
b = set(range(10000))
|
|
main()' > test.py
|
|
$ kernprof -lv test.py
|
|
Line # Hits Time Per Hit % Time Line Contents
|
|
==============================================================
|
|
1 @profile
|
|
2 def main():
|
|
3 1 253.4 253.4 32.2 a = list(range(10000))
|
|
4 1 534.1 534.1 67.8 b = set(range(10000))
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="callandflamegraphs">Call and Flame Graphs</h3><pre><code class="bash language-bash hljs">$ apt/brew install graphviz && pip3 install gprof2dot snakeviz <span class="hljs-comment"># Or download installer.</span>
|
|
$ tail --lines=+2 test.py > test.py <span class="hljs-comment"># Removes first line.</span>
|
|
$ python3 -m cProfile -o test.prof test.py <span class="hljs-comment"># Runs built-in profiler.</span>
|
|
$ gprof2dot --format=pstats test.prof | dot -T png -o test.png <span class="hljs-comment"># Generates call graph.</span>
|
|
$ xdg-open/open test.png <span class="hljs-comment"># Displays call graph.</span>
|
|
$ snakeviz test.prof <span class="hljs-comment"># Displays flame graph.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="samplingandmemoryprofilers">Sampling and Memory Profilers</h3><pre><code class="text language-text">┏━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━┯━━━━━━┓
|
|
┃ pip3 install │ Target │ How to run │ Lines │ Live ┃
|
|
┠──────────────┼────────────┼───────────────────────────────┼───────┼──────┨
|
|
┃ pyinstrument │ CPU │ pyinstrument test.py │ × │ × ┃
|
|
┃ py-spy │ CPU │ py-spy top -- python3 test.py │ × │ ✓ ┃
|
|
┃ scalene │ CPU+Memory │ scalene test.py │ ✓ │ × ┃
|
|
┃ memray │ Memory │ memray run --live test.py │ ✓ │ ✓ ┃
|
|
┗━━━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━┷━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="numpy"><a href="#numpy" name="numpy">#</a>NumPy</h2><p><strong>Array manipulation mini-language. It can run up to one hundred times faster than the equivalent Python code. An even faster alternative that runs on a GPU is called CuPy.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install numpy</span>
|
|
<span class="hljs-keyword">import</span> numpy <span class="hljs-keyword">as</span> np
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><array> = np.array(<list/list_of_lists/…>) <span class="hljs-comment"># Returns a 1d/2d/… NumPy array.</span>
|
|
<array> = np.zeros/ones/empty(<shape>) <span class="hljs-comment"># Also np.full(<shape>, <el>).</span>
|
|
<array> = np.arange(from_inc, to_exc, ±step) <span class="hljs-comment"># Also np.linspace(start, stop, len).</span>
|
|
<array> = np.random.randint(from_inc, to_exc, <shape>) <span class="hljs-comment"># Also np.random.random(<shape>).</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><view> = <array>.reshape(<shape>) <span class="hljs-comment"># Also `<array>.shape = <shape>`.</span>
|
|
<array> = <array>.flatten() <span class="hljs-comment"># Also `<view> = <array>.ravel()`.</span>
|
|
<view> = <array>.transpose() <span class="hljs-comment"># Flips the table over its diagonal.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><array> = np.copy/abs/sqrt/log/int64(<array>) <span class="hljs-comment"># Returns new array of the same shape.</span>
|
|
<array> = <array>.sum/max/mean/argmax/all(axis) <span class="hljs-comment"># Aggregates specified dimension.</span>
|
|
<array> = np.apply_along_axis(<func>, axis, <array>) <span class="hljs-comment"># Func can return a scalar or array.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><array> = np.concatenate(<list_of_arrays>, axis=<span class="hljs-number">0</span>) <span class="hljs-comment"># Links arrays along first axis (rows).</span>
|
|
<array> = np.vstack/column_stack(<list_of_arrays>) <span class="hljs-comment"># Treats 1d arrays as rows or columns.</span>
|
|
<array> = np.tile/repeat(<array>, <int/list> [, axis]) <span class="hljs-comment"># Tiles array or repeats its elements.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Shape is a tuple of dimension sizes. A 100x50 RGB image has shape (50, 100, 3).</strong></li>
|
|
<li><strong>Axis is an index of a dimension. Leftmost dimension has index 0. Summing the RGB image along axis 2 will return a greyscale image with shape (50, 100).</strong></li>
|
|
</ul>
|
|
<div><h3 id="indexing">Indexing</h3><pre><code class="bash hljs"><el> = <2d>[row_index, col_index] <span class="hljs-comment"># Or: <3d>[<int>, <int>, <int>]</span>
|
|
<1d_view> = <2d>[row_index] <span class="hljs-comment"># Or: <3d>[<int>, <int>, <slice>]</span>
|
|
<1d_view> = <2d>[:, col_index] <span class="hljs-comment"># Or: <3d>[<int>, <slice>, <int>]</span>
|
|
<2d_view> = <2d>[from:to_row_i, from:to_col_i] <span class="hljs-comment"># Or: <3d>[<int>, <slice>, <slice>]</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="bash hljs"><1d_array> = <2d>[row_indices, col_indices] <span class="hljs-comment"># Or: <3d>[<int/1d>, <1d>, <1d>]</span>
|
|
<2d_array> = <2d>[row_indices] <span class="hljs-comment"># Or: <3d>[<int/1d>, <1d>, <slice>]</span>
|
|
<2d_array> = <2d>[:, col_indices] <span class="hljs-comment"># Or: <3d>[<int/1d>, <slice>, <1d>]</span>
|
|
<2d_array> = <2d>[np.ix_(row_indices, col_indices)] <span class="hljs-comment"># Or: <3d>[<int/1d/2d>, <2d>, <2d>]</span>
|
|
</code></pre>
|
|
<pre><code class="bash hljs"><2d_bools> = <2d> > <el/1d/2d> <span class="hljs-comment"># 1d object must have size of a row.</span>
|
|
<1/2d_arr> = <2d>[<2d/1d_bools>] <span class="hljs-comment"># 1d_bools must have size of a column.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">':'</span></code> returns a slice of all dimension's indices. Omitted dimensions default to <code class="python hljs"><span class="hljs-string">':'</span></code>.</strong></li>
|
|
<li><strong>Python converts <code class="python hljs"><span class="hljs-string">'obj[i, j]'</span></code> to <code class="python hljs"><span class="hljs-string">'obj[(i, j)]'</span></code>. This makes <code class="python hljs"><span class="hljs-string">'<2d>[row_i, col_i]'</span></code> and <code class="python hljs"><span class="hljs-string">'<2d>[row_indices]'</span></code> indistinguishable to NumPy if tuple of two indices is passed!</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'ix_([1, 2], [3, 4])'</span></code> returns <code class="python hljs"><span class="hljs-string">'[[1], [2]]'</span></code> and <code class="python hljs"><span class="hljs-string">'[[3, 4]]'</span></code>. Due to broadcasting rules, this is the same as using <code class="python hljs"><span class="hljs-string">'[[1, 1], [2, 2]]'</span></code> and <code class="python hljs"><span class="hljs-string">'[[3, 4], [3, 4]]'</span></code>.</strong></li>
|
|
<li><strong>Any value that is broadcastable to the indexed shape can be assigned to the selection.</strong></li>
|
|
</ul>
|
|
<div><h3 id="broadcasting">Broadcasting</h3><p><strong>A set of rules by which NumPy functions operate on arrays of different shapes.</strong></p><pre><code class="python language-python hljs">left = np.array([<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"># `left.shape == (3,)`</span>
|
|
right = np.array([[<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"># `right.shape == (3, 1)`</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h4 id="1ifarrayshapesdifferinlengthleftpadtheshortershapewithones">1. If array shapes differ in length, left-pad the shorter shape with ones:</h4><pre><code class="python language-python hljs">left = np.array([[<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"># `left.shape == (1, 3)`</span>
|
|
right = np.array([[<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"># `right.shape == (3, 1)`</span>
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="2ifanydimensionsdifferinsizeexpandtheonesthathavesize1byduplicatingtheirelements">2. If any dimensions differ in size, expand the ones that have size 1 by duplicating their elements:</h4><pre><code class="python language-python hljs">left = np.array([[<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"># `left.shape == (3, 3)`</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>]])
|
|
|
|
right = np.array([[<span class="hljs-number">0.1</span>, <span class="hljs-number">0.1</span>, <span class="hljs-number">0.1</span>], <span class="hljs-comment"># `right.shape == (3, 3)`</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>]])
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="example-3">Example</h3><div><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>] => [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">1</span>]</code>):</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>print(points := np.array([<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-meta">>>> </span>print(wrapped_points := points.reshape(<span class="hljs-number">3</span>, <span class="hljs-number">1</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-meta">>>> </span>print(deltas := points - wrapped_points)
|
|
[[ <span class="hljs-number">0.</span> <span class="hljs-number">0.5</span> <span class="hljs-number">0.7</span>]
|
|
[<span class="hljs-number">-0.5</span> <span class="hljs-number">0.</span> <span class="hljs-number">0.2</span>]
|
|
[<span class="hljs-number">-0.7</span> <span class="hljs-number">-0.2</span> <span class="hljs-number">0.</span> ]]
|
|
<span class="hljs-meta">>>> </span>deltas[range(<span class="hljs-number">3</span>), range(<span class="hljs-number">3</span>)] = np.inf
|
|
<span class="hljs-meta">>>> </span>print(distances := np.abs(deltas))
|
|
[[inf <span class="hljs-number">0.5</span> <span class="hljs-number">0.7</span>]
|
|
[<span class="hljs-number">0.5</span> inf <span class="hljs-number">0.2</span>]
|
|
[<span class="hljs-number">0.7</span> <span class="hljs-number">0.2</span> inf]]
|
|
<span class="hljs-meta">>>> </span>print(distances.argmin(axis=<span class="hljs-number">1</span>))
|
|
[<span class="hljs-number">1</span> <span class="hljs-number">2</span> <span class="hljs-number">1</span>]
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="image"><a href="#image" name="image">#</a>Image</h2><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pillow</span>
|
|
<span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> Image
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><Image> = Image.new(<span class="hljs-string">'<mode>'</span>, (width, height)) <span class="hljs-comment"># Creates new image. Also `color=<int/tuple>`.</span>
|
|
<Image> = Image.open(<path>) <span class="hljs-comment"># Identifies format based on file's contents.</span>
|
|
<Image> = <Image>.convert(<span class="hljs-string">'<mode>'</span>) <span class="hljs-comment"># Converts image to the new mode (see Modes).</span>
|
|
<Image>.save(<path>) <span class="hljs-comment"># Accepts `quality=<int>` if extension is jpg.</span>
|
|
<Image>.show() <span class="hljs-comment"># Displays image in default preview app.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><int/tup> = <Image>.getpixel((x, y)) <span class="hljs-comment"># Returns pixel's value (its color).</span>
|
|
<ImgCore> = <Image>.getdata() <span class="hljs-comment"># Returns a flattened view of pixel values.</span>
|
|
<Image>.putpixel((x, y), <int/tuple>) <span class="hljs-comment"># Updates pixel's value. Clips passed int/s.</span>
|
|
<Image>.putdata(<list/ImgCore>) <span class="hljs-comment"># Updates pixels with a copy of the sequence.</span>
|
|
<Image>.paste(<Image>, (x, y)) <span class="hljs-comment"># Draws passed image at the specified location.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Image> = <Image>.filter(<Filter>) <span class="hljs-comment"># Use ImageFilter.<name>(<args>) for Filter.</span>
|
|
<Image> = <Enhance>.enhance(<float>) <span class="hljs-comment"># Use ImageEnhance.<name>(<Image>) for Enhance.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><array> = np.array(<Image>) <span class="hljs-comment"># Creates a 2d/3d NumPy array from the image.</span>
|
|
<Image> = Image.fromarray(np.uint8(<array>)) <span class="hljs-comment"># Use <array>.clip(0, 255) to clip the values.</span>
|
|
</code></pre>
|
|
<div><h3 id="modes-1">Modes</h3><ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'L'</span></code> - Lightness (greyscale image). Each pixel is an integer between 0 and 255.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'RGB'</span></code> - Red, green, blue (true color image). Each pixel is a tuple of three integers.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'RGBA'</span></code> - RGB with alpha. Low alpha (i.e. fourth int) makes pixel more transparent.</strong></li>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'HSV'</span></code> - Hue, saturation, value. Three ints representing color in HSV color space.</strong></li>
|
|
</ul><div><h3 id="examples">Examples</h3><div><h4 id="createsapngimageofarainbowgradient">Creates a PNG image of a rainbow gradient:</h4><pre><code class="python language-python hljs">WIDTH, HEIGHT = <span class="hljs-number">100</span>, <span class="hljs-number">100</span>
|
|
n_pixels = WIDTH * HEIGHT
|
|
hues = (<span class="hljs-number">255</span> * i/n_pixels <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n_pixels))
|
|
img = Image.new(<span class="hljs-string">'HSV'</span>, (WIDTH, HEIGHT))
|
|
img.putdata([(int(h), <span class="hljs-number">255</span>, <span class="hljs-number">255</span>) <span class="hljs-keyword">for</span> h <span class="hljs-keyword">in</span> hues])
|
|
img.convert(<span class="hljs-string">'RGB'</span>).save(<span class="hljs-string">'test.png'</span>)
|
|
</code></pre></div></div></div>
|
|
|
|
|
|
|
|
|
|
<div><h4 id="addsnoisetothepngimageanddisplaysit">Adds noise to the PNG image and displays it:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
|
|
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>)))
|
|
img = Image.open(<span class="hljs-string">'test.png'</span>).convert(<span class="hljs-string">'HSV'</span>)
|
|
img.putdata([(add_noise(h), s, v) <span class="hljs-keyword">for</span> h, s, v <span class="hljs-keyword">in</span> img.getdata()])
|
|
img.show()
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="imagedraw">Image Draw</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> ImageDraw
|
|
<Draw> = ImageDraw.Draw(<Image>) <span class="hljs-comment"># Object for adding 2D graphics to the image.</span>
|
|
<Draw>.point((x, y)) <span class="hljs-comment"># Draws a point. Also `fill=<int/tuple/str>`.</span>
|
|
<Draw>.line((x1, y1, x2, y2 [, ...])) <span class="hljs-comment"># For anti-aliasing use <Image>.resize((w, h)).</span>
|
|
<Draw>.arc((x1, y1, x2, y2), deg1, deg2) <span class="hljs-comment"># Draws in clockwise dir. Also pieslice().</span>
|
|
<Draw>.rectangle((x1, y1, x2, y2)) <span class="hljs-comment"># Also rounded_rectangle(), regular_polygon().</span>
|
|
<Draw>.polygon((x1, y1, x2, y2, ...)) <span class="hljs-comment"># Last point gets connected to the first one.</span>
|
|
<Draw>.ellipse((x1, y1, x2, y2)) <span class="hljs-comment"># To rotate use <Image>.rotate(anticlock_deg).</span>
|
|
<Draw>.text((x, y), <str>, font=<Font>) <span class="hljs-comment"># `<Font> = ImageFont.truetype(<path>, size)`.</span>
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'fill=<color>'</span></code> to set the primary color.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'width=<int>'</span></code> to set the width of lines or contours.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'outline=<color>'</span></code> to set the color of the contours.</strong></li>
|
|
<li><strong>Color can be an int, tuple, <code class="python hljs"><span class="hljs-string">'#rrggbb[aa]'</span></code> string or a color name.</strong></li>
|
|
</ul>
|
|
<div><h2 id="animation"><a href="#animation" name="animation">#</a>Animation</h2><div><h4 id="createsagifofabouncingball">Creates a GIF of a bouncing ball:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install imageio</span>
|
|
<span class="hljs-keyword">from</span> PIL <span class="hljs-keyword">import</span> Image, ImageDraw
|
|
<span class="hljs-keyword">import</span> imageio
|
|
|
|
WIDTH, HEIGHT, R = <span class="hljs-number">126</span>, <span class="hljs-number">126</span>, <span class="hljs-number">10</span>
|
|
frames = []
|
|
<span class="hljs-keyword">for</span> velocity <span class="hljs-keyword">in</span> range(<span class="hljs-number">1</span>, <span class="hljs-number">16</span>):
|
|
y = sum(range(velocity))
|
|
frame = Image.new(<span class="hljs-string">'L'</span>, (WIDTH, HEIGHT))
|
|
draw = ImageDraw.Draw(frame)
|
|
draw.ellipse((WIDTH/<span class="hljs-number">2</span>-R, y, WIDTH/<span class="hljs-number">2</span>+R, y+R*<span class="hljs-number">2</span>), fill=<span class="hljs-string">'white'</span>)
|
|
frames.append(frame)
|
|
frames += reversed(frames[<span class="hljs-number">1</span>:<span class="hljs-number">-1</span>])
|
|
imageio.mimsave(<span class="hljs-string">'test.gif'</span>, frames, duration=<span class="hljs-number">0.03</span>)
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="audio"><a href="#audio" name="audio">#</a>Audio</h2><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> wave
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><Wave> = wave.open(<span class="hljs-string">'<path>'</span>) <span class="hljs-comment"># Opens the WAV file for reading.</span>
|
|
<int> = <Wave>.getframerate() <span class="hljs-comment"># Returns number of frames per second.</span>
|
|
<int> = <Wave>.getnchannels() <span class="hljs-comment"># Returns number of samples per frame.</span>
|
|
<int> = <Wave>.getsampwidth() <span class="hljs-comment"># Returns number of bytes per sample.</span>
|
|
<tuple> = <Wave>.getparams() <span class="hljs-comment"># Returns namedtuple of all parameters.</span>
|
|
<bytes> = <Wave>.readframes(nframes) <span class="hljs-comment"># Returns all frames if -1 is passed.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Wave> = wave.open(<span class="hljs-string">'<path>'</span>, <span class="hljs-string">'wb'</span>) <span class="hljs-comment"># Creates/truncates a file for writing.</span>
|
|
<Wave>.setframerate(<int>) <span class="hljs-comment"># Pass 44100 for CD, 48000 for video.</span>
|
|
<Wave>.setnchannels(<int>) <span class="hljs-comment"># Pass 1 for mono, 2 for stereo.</span>
|
|
<Wave>.setsampwidth(<int>) <span class="hljs-comment"># Pass 2 for CD, 3 for hi-res sound.</span>
|
|
<Wave>.setparams(<tuple>) <span class="hljs-comment"># Tuple must contain all parameters.</span>
|
|
<Wave>.writeframes(<bytes>) <span class="hljs-comment"># Appends frames to the file.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Bytes object contains a sequence of frames, each consisting of one or more samples.</strong></li>
|
|
<li><strong>In a stereo signal, the first sample of a frame belongs to the left channel.</strong></li>
|
|
<li><strong>Each sample consists of one or more bytes that, when converted to an integer, indicate the displacement of a speaker membrane at a given moment.</strong></li>
|
|
<li><strong>If sample width is one byte, then the integer should be encoded unsigned. For all other sizes, the integer should be encoded signed with little-endian byte order.</strong></li>
|
|
</ul>
|
|
<div><h3 id="samplevalues">Sample Values</h3><pre><code class="python hljs">┏━━━━━━━━━━━┯━━━━━━━━━━━┯━━━━━━┯━━━━━━━━━━━┓
|
|
┃ sampwidth │ min │ zero │ max ┃
|
|
┠───────────┼───────────┼──────┼───────────┨
|
|
┃ <span class="hljs-number">1</span> │ <span class="hljs-number">0</span> │ <span class="hljs-number">128</span> │ <span class="hljs-number">255</span> ┃
|
|
┃ <span class="hljs-number">2</span> │ <span class="hljs-number">-32768</span> │ <span class="hljs-number">0</span> │ <span class="hljs-number">32767</span> ┃
|
|
┃ <span class="hljs-number">3</span> │ <span class="hljs-number">-8388608</span> │ <span class="hljs-number">0</span> │ <span class="hljs-number">8388607</span> ┃
|
|
┗━━━━━━━━━━━┷━━━━━━━━━━━┷━━━━━━┷━━━━━━━━━━━┛
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="readfloatsamplesfromwavfile">Read Float Samples from WAV File</h3><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>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_int</span><span class="hljs-params">(bytes_obj)</span>:</span>
|
|
an_int = int.from_bytes(bytes_obj, <span class="hljs-string">'little'</span>, signed=(p.sampwidth != <span class="hljs-number">1</span>))
|
|
<span class="hljs-keyword">return</span> an_int - <span class="hljs-number">128</span> * (p.sampwidth == <span class="hljs-number">1</span>)
|
|
<span class="hljs-keyword">with</span> wave.open(filename) <span class="hljs-keyword">as</span> file:
|
|
p = file.getparams()
|
|
frames = file.readframes(<span class="hljs-number">-1</span>)
|
|
bytes_samples = (frames[i : i + p.sampwidth] <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">0</span>, len(frames), p.sampwidth))
|
|
<span class="hljs-keyword">return</span> [get_int(b) / pow(<span class="hljs-number">2</span>, (p.sampwidth * <span class="hljs-number">8</span>) - <span class="hljs-number">1</span>) <span class="hljs-keyword">for</span> b <span class="hljs-keyword">in</span> bytes_samples], p
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="writefloatsamplestowavfile">Write Float Samples to WAV File</h3><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, samples_f, p=<span class="hljs-keyword">None</span>, nchannels=<span class="hljs-number">1</span>, sampwidth=<span class="hljs-number">2</span>, framerate=<span class="hljs-number">44100</span>)</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_bytes</span><span class="hljs-params">(a_float)</span>:</span>
|
|
a_float = max(<span class="hljs-number">-1</span>, min(<span class="hljs-number">1</span> - <span class="hljs-number">2e-16</span>, a_float))
|
|
a_float += (p.sampwidth == <span class="hljs-number">1</span>)
|
|
a_float *= pow(<span class="hljs-number">2</span>, (p.sampwidth * <span class="hljs-number">8</span>) - <span class="hljs-number">1</span>)
|
|
<span class="hljs-keyword">return</span> int(a_float).to_bytes(p.sampwidth, <span class="hljs-string">'little'</span>, signed=(p.sampwidth != <span class="hljs-number">1</span>))
|
|
<span class="hljs-keyword">if</span> p <span class="hljs-keyword">is</span> <span class="hljs-keyword">None</span>:
|
|
p = wave._wave_params(nchannels, sampwidth, framerate, <span class="hljs-number">0</span>, <span class="hljs-string">'NONE'</span>, <span class="hljs-string">'not compressed'</span>)
|
|
<span class="hljs-keyword">with</span> wave.open(filename, <span class="hljs-string">'wb'</span>) <span class="hljs-keyword">as</span> file:
|
|
file.setparams(p)
|
|
file.writeframes(<span class="hljs-string">b''</span>.join(get_bytes(f) <span class="hljs-keyword">for</span> f <span class="hljs-keyword">in</span> samples_f))
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="examples-1">Examples</h3><div><h4 id="savesa440hzsinewavetoamonowavfile">Saves a 440 Hz sine wave to a mono WAV file:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> math <span class="hljs-keyword">import</span> pi, sin
|
|
samples_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">100_000</span>))
|
|
write_to_wav_file(<span class="hljs-string">'test.wav'</span>, samples_f)
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h4 id="addsnoisetothewavfile">Adds noise to the WAV file:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> uniform
|
|
samples_f, params = read_wav_file(<span class="hljs-string">'test.wav'</span>)
|
|
samples_f = (f + uniform(<span class="hljs-number">-0.05</span>, <span class="hljs-number">0.05</span>) <span class="hljs-keyword">for</span> f <span class="hljs-keyword">in</span> samples_f)
|
|
write_to_wav_file(<span class="hljs-string">'test.wav'</span>, samples_f, p=params)
|
|
</code></pre></div>
|
|
|
|
<div><h4 id="playsthewavfile">Plays the WAV file:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install simpleaudio</span>
|
|
<span class="hljs-keyword">from</span> simpleaudio <span class="hljs-keyword">import</span> play_buffer
|
|
<span class="hljs-keyword">with</span> wave.open(<span class="hljs-string">'test.wav'</span>) <span class="hljs-keyword">as</span> file:
|
|
frames, p = file.readframes(<span class="hljs-number">-1</span>), file.getparams()
|
|
play_buffer(frames, p.nchannels, p.sampwidth, p.framerate).wait_done()
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="texttospeech">Text to Speech</h3><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pyttsx3</span>
|
|
<span class="hljs-keyword">import</span> pyttsx3
|
|
engine = pyttsx3.init()
|
|
engine.say(<span class="hljs-string">'Sally sells seashells by the seashore.'</span>)
|
|
engine.runAndWait()
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="synthesizer"><a href="#synthesizer" name="synthesizer">#</a>Synthesizer</h2><div><h4 id="playspopcornbygershonkingsley">Plays Popcorn by Gershon Kingsley:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install simpleaudio</span>
|
|
<span class="hljs-keyword">import</span> itertools <span class="hljs-keyword">as</span> it, math, array, simpleaudio
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">play_notes</span><span class="hljs-params">(notes, bpm=<span class="hljs-number">132</span>, f=<span class="hljs-number">44100</span>)</span>:</span>
|
|
get_pause = <span class="hljs-keyword">lambda</span> n_beats: it.repeat(<span class="hljs-number">0</span>, int(n_beats * <span class="hljs-number">60</span>/bpm * f))
|
|
sin_f = <span class="hljs-keyword">lambda</span> i, hz: math.sin(i * <span class="hljs-number">2</span> * math.pi * hz / f)
|
|
get_wave = <span class="hljs-keyword">lambda</span> hz, n_beats: (sin_f(i, hz) <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(int(n_beats * <span class="hljs-number">60</span>/bpm * f)))
|
|
get_hz = <span class="hljs-keyword">lambda</span> note: <span class="hljs-number">440</span> * <span class="hljs-number">2</span> ** ((int(note[:<span class="hljs-number">2</span>]) - <span class="hljs-number">69</span>) / <span class="hljs-number">12</span>)
|
|
get_nbeats = <span class="hljs-keyword">lambda</span> note: <span class="hljs-number">1</span>/<span class="hljs-number">2</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">1</span>/<span class="hljs-number">4</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">1</span>
|
|
get_samples = <span class="hljs-keyword">lambda</span> n: get_wave(get_hz(n), get_nbeats(n)) <span class="hljs-keyword">if</span> n <span class="hljs-keyword">else</span> get_pause(<span class="hljs-number">1</span>/<span class="hljs-number">4</span>)
|
|
samples_f = it.chain.from_iterable(get_samples(n) <span class="hljs-keyword">for</span> n <span class="hljs-keyword">in</span> notes.split(<span class="hljs-string">','</span>))
|
|
samples_i = array.array(<span class="hljs-string">'h'</span>, (int(fl * <span class="hljs-number">5000</span>) <span class="hljs-keyword">for</span> fl <span class="hljs-keyword">in</span> samples_f))
|
|
simpleaudio.play_buffer(samples_i, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, f).wait_done()
|
|
|
|
play_notes(<span class="hljs-string">'83♩,81♪,,83♪,,78♪,,74♪,,78♪,,71♪,,,,83♪,,81♪,,83♪,,78♪,,74♪,,78♪,,71♪,,,,'</span>
|
|
<span class="hljs-string">'83♩,85♪,,86♪,,85♪,,86♪,,83♪,,85♩,83♪,,85♪,,81♪,,83♪,,81♪,,83♪,,79♪,,83♪,,,,'</span>)
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h2 id="pygame"><a href="#pygame" name="pygame">#</a>Pygame</h2><div><h4 id="opesawindowanddrawsasquarethatcanbemovedwitharrowkeys">Opes a window and draws a square that can be moved with arrow keys:</h4><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pygame</span>
|
|
<span class="hljs-keyword">import</span> pygame <span class="hljs-keyword">as</span> pg
|
|
|
|
pg.init()
|
|
screen = pg.display.set_mode((<span class="hljs-number">500</span>, <span class="hljs-number">500</span>))
|
|
rect = pg.Rect(<span class="hljs-number">240</span>, <span class="hljs-number">240</span>, <span class="hljs-number">20</span>, <span class="hljs-number">20</span>)
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">not</span> pg.event.get(pg.QUIT):
|
|
<span class="hljs-keyword">for</span> event <span class="hljs-keyword">in</span> pg.event.get(pg.KEYDOWN):
|
|
dx = (event.key == pg.K_RIGHT) - (event.key == pg.K_LEFT)
|
|
dy = (event.key == pg.K_DOWN) - (event.key == pg.K_UP)
|
|
rect = rect.move((dx * <span class="hljs-number">20</span>, dy * <span class="hljs-number">20</span>))
|
|
screen.fill(pg.Color(<span class="hljs-string">'black'</span>))
|
|
pg.draw.rect(screen, pg.Color(<span class="hljs-string">'white'</span>), rect)
|
|
pg.display.flip()
|
|
pg.quit()
|
|
</code></pre></div></div>
|
|
|
|
|
|
<div><h3 id="rect">Rect</h3><p><strong>Object for storing rectangular coordinates.</strong></p><pre><code class="python language-python hljs"><Rect> = pg.Rect(x, y, width, height) <span class="hljs-comment"># Creates Rect object. Truncates passed floats.</span>
|
|
<int> = <Rect>.x/y/centerx/centery/… <span class="hljs-comment"># `top/right/bottom/left`. Allows assignments.</span>
|
|
<tup.> = <Rect>.topleft/center/… <span class="hljs-comment"># `topright/bottomright/bottomleft/size`. Same.</span>
|
|
<Rect> = <Rect>.move((delta_x, delta_y)) <span class="hljs-comment"># Use move_ip() to move the rectangle in-place.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><bool> = <Rect>.collidepoint((x, y)) <span class="hljs-comment"># Checks whether rectangle contains the point.</span>
|
|
<bool> = <Rect>.colliderect(<Rect>) <span class="hljs-comment"># Checks whether the two rectangles overlap.</span>
|
|
<int> = <Rect>.collidelist(<list_of_Rect>) <span class="hljs-comment"># Returns index of first colliding Rect or -1.</span>
|
|
<list> = <Rect>.collidelistall(<list_of_Rect>) <span class="hljs-comment"># Returns indices of all colliding rectangles.</span>
|
|
</code></pre>
|
|
<div><h3 id="surface">Surface</h3><p><strong>Object for representing images.</strong></p><pre><code class="python language-python hljs"><Surf> = pg.display.set_mode((width, height)) <span class="hljs-comment"># Opens a new window and returns its surface.</span>
|
|
<Surf> = pg.Surface((width, height)) <span class="hljs-comment"># New RGB surface. RGBA if `flags=pg.SRCALPHA`.</span>
|
|
<Surf> = pg.image.load(<path/file>) <span class="hljs-comment"># Loads the image. Format depends on source.</span>
|
|
<Surf> = pg.surfarray.make_surface(<np_array>) <span class="hljs-comment"># Also `<np_arr> = surfarray.pixels3d(<Surf>)`.</span>
|
|
<Surf> = <Surf>.subsurface(<Rect>) <span class="hljs-comment"># Creates a new surface from the cutout.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><Surf>.fill(color) <span class="hljs-comment"># Pass tuple of ints or pg.Color('<name/hex>').</span>
|
|
<Surf>.set_at((x, y), color) <span class="hljs-comment"># Updates pixel. Also <Surf>.get_at((x, y)).</span>
|
|
<Surf>.blit(<Surf>, (x, y)) <span class="hljs-comment"># Draws passed surface at specified location.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pygame.transform <span class="hljs-keyword">import</span> scale, rotate <span class="hljs-comment"># Also: flip, smoothscale, scale_by.</span>
|
|
<Surf> = scale(<Surf>, (width, height)) <span class="hljs-comment"># Scales the surface. `smoothscale()` blurs it.</span>
|
|
<Surf> = rotate(<Surf>, angle) <span class="hljs-comment"># Rotates the surface for counterclock degrees.</span>
|
|
<Surf> = flip(<Surf>, flip_x=<span class="hljs-keyword">False</span>) <span class="hljs-comment"># Mirrors the surface. Also `flip_y=False`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-keyword">from</span> pygame.draw <span class="hljs-keyword">import</span> line, arc, rect <span class="hljs-comment"># Also: ellipse, polygon, circle, aaline.</span>
|
|
line(<Surf>, color, (x1, y1), (x2, y2)) <span class="hljs-comment"># Draws a line to the surface. Also `width=1`.</span>
|
|
arc(<Surf>, color, <Rect>, from_rad, to_rad) <span class="hljs-comment"># Also ellipse(<Surf>, color, <Rect>, width=0).</span>
|
|
rect(<Surf>, color, <Rect>, width=<span class="hljs-number">0</span>) <span class="hljs-comment"># Also polygon(<Surf>, color, points, width=0).</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Font> = pg.font.Font(<path/file>, size) <span class="hljs-comment"># Loads TTF file. Pass None for default font.</span>
|
|
<Surf> = <Font>.render(text, antialias, color) <span class="hljs-comment"># Accepts background color as fourth argument.</span>
|
|
</code></pre>
|
|
<div><h3 id="sound">Sound</h3><pre><code class="python language-python hljs"><Sound> = pg.mixer.Sound(<path/file/bytes>) <span class="hljs-comment"># WAV file or bytes/array of signed shorts.</span>
|
|
<Sound>.play/stop() <span class="hljs-comment"># Also set_volume(<float>) and fadeout(msec).</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="basicmariobrothersexample">Basic Mario Brothers Example</h3><pre><code class="python language-python hljs"><span class="hljs-keyword">import</span> collections, dataclasses, enum, io, itertools <span class="hljs-keyword">as</span> it, pygame <span class="hljs-keyword">as</span> pg, urllib.request
|
|
<span class="hljs-keyword">from</span> random <span class="hljs-keyword">import</span> randint
|
|
|
|
P = collections.namedtuple(<span class="hljs-string">'P'</span>, <span class="hljs-string">'x y'</span>) <span class="hljs-comment"># Position</span>
|
|
D = enum.Enum(<span class="hljs-string">'D'</span>, <span class="hljs-string">'n e s w'</span>) <span class="hljs-comment"># Direction</span>
|
|
W, H, MAX_S = <span class="hljs-number">50</span>, <span class="hljs-number">50</span>, P(<span class="hljs-number">5</span>, <span class="hljs-number">10</span>) <span class="hljs-comment"># Width, Height, Max speed</span>
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_screen</span><span class="hljs-params">()</span>:</span>
|
|
pg.init()
|
|
<span class="hljs-keyword">return</span> pg.display.set_mode((W*<span class="hljs-number">16</span>, H*<span class="hljs-number">16</span>))
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_images</span><span class="hljs-params">()</span>:</span>
|
|
url = <span class="hljs-string">'https://gto76.github.io/python-cheatsheet/web/mario_bros.png'</span>
|
|
img = pg.image.load(io.BytesIO(urllib.request.urlopen(url).read()))
|
|
<span class="hljs-keyword">return</span> [img.subsurface(get_rect(x, <span class="hljs-number">0</span>)) <span class="hljs-keyword">for</span> x <span class="hljs-keyword">in</span> range(img.get_width() // <span class="hljs-number">16</span>)]
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_mario</span><span class="hljs-params">()</span>:</span>
|
|
Mario = dataclasses.make_dataclass(<span class="hljs-string">'Mario'</span>, <span class="hljs-string">'rect spd facing_left frame_cycle'</span>.split())
|
|
<span class="hljs-keyword">return</span> Mario(get_rect(<span class="hljs-number">1</span>, <span class="hljs-number">1</span>), P(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>), <span class="hljs-keyword">False</span>, it.cycle(range(<span class="hljs-number">3</span>)))
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_tiles</span><span class="hljs-params">()</span>:</span>
|
|
border = [(x, y) <span class="hljs-keyword">for</span> x <span class="hljs-keyword">in</span> range(W) <span class="hljs-keyword">for</span> y <span class="hljs-keyword">in</span> range(H) <span class="hljs-keyword">if</span> x <span class="hljs-keyword">in</span> [<span class="hljs-number">0</span>, W-<span class="hljs-number">1</span>] <span class="hljs-keyword">or</span> y <span class="hljs-keyword">in</span> [<span class="hljs-number">0</span>, H-<span class="hljs-number">1</span>]]
|
|
platforms = [(randint(<span class="hljs-number">1</span>, W-<span class="hljs-number">2</span>), randint(<span class="hljs-number">2</span>, H-<span class="hljs-number">2</span>)) <span class="hljs-keyword">for</span> _ <span class="hljs-keyword">in</span> range(W*H // <span class="hljs-number">10</span>)]
|
|
<span class="hljs-keyword">return</span> [get_rect(x, y) <span class="hljs-keyword">for</span> x, y <span class="hljs-keyword">in</span> border + platforms]
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_rect</span><span class="hljs-params">(x, y)</span>:</span>
|
|
<span class="hljs-keyword">return</span> pg.Rect(x*<span class="hljs-number">16</span>, y*<span class="hljs-number">16</span>, <span class="hljs-number">16</span>, <span class="hljs-number">16</span>)
|
|
run(get_screen(), get_images(), get_mario(), get_tiles())
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">run</span><span class="hljs-params">(screen, images, mario, tiles)</span>:</span>
|
|
clock = pg.time.Clock()
|
|
pressed = set()
|
|
<span class="hljs-keyword">while</span> <span class="hljs-keyword">not</span> pg.event.get(pg.QUIT):
|
|
clock.tick(<span class="hljs-number">28</span>)
|
|
pressed |= {e.key <span class="hljs-keyword">for</span> e <span class="hljs-keyword">in</span> pg.event.get(pg.KEYDOWN)}
|
|
pressed -= {e.key <span class="hljs-keyword">for</span> e <span class="hljs-keyword">in</span> pg.event.get(pg.KEYUP)}
|
|
update_speed(mario, tiles, pressed)
|
|
update_position(mario, tiles)
|
|
draw(screen, images, mario, tiles)
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">update_speed</span><span class="hljs-params">(mario, tiles, pressed)</span>:</span>
|
|
x, y = mario.spd
|
|
x += <span class="hljs-number">2</span> * ((pg.K_RIGHT <span class="hljs-keyword">in</span> pressed) - (pg.K_LEFT <span class="hljs-keyword">in</span> pressed))
|
|
x += (x < <span class="hljs-number">0</span>) - (x > <span class="hljs-number">0</span>)
|
|
y += <span class="hljs-number">1</span> <span class="hljs-keyword">if</span> D.s <span class="hljs-keyword">not</span> <span class="hljs-keyword">in</span> get_boundaries(mario.rect, tiles) <span class="hljs-keyword">else</span> (pg.K_UP <span class="hljs-keyword">in</span> pressed) * <span class="hljs-number">-10</span>
|
|
mario.spd = P(x=max(-MAX_S.x, min(MAX_S.x, x)), y=max(-MAX_S.y, min(MAX_S.y, y)))
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">update_position</span><span class="hljs-params">(mario, tiles)</span>:</span>
|
|
x, y = mario.rect.topleft
|
|
n_steps = max(abs(s) <span class="hljs-keyword">for</span> s <span class="hljs-keyword">in</span> mario.spd)
|
|
<span class="hljs-keyword">for</span> _ <span class="hljs-keyword">in</span> range(n_steps):
|
|
mario.spd = stop_on_collision(mario.spd, get_boundaries(mario.rect, tiles))
|
|
x, y = x + (mario.spd.x / n_steps), y + (mario.spd.y / n_steps)
|
|
mario.rect.topleft = x, y
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_boundaries</span><span class="hljs-params">(rect, tiles)</span>:</span>
|
|
deltas = {D.n: P(<span class="hljs-number">0</span>, <span class="hljs-number">-1</span>), D.e: P(<span class="hljs-number">1</span>, <span class="hljs-number">0</span>), D.s: P(<span class="hljs-number">0</span>, <span class="hljs-number">1</span>), D.w: P(<span class="hljs-number">-1</span>, <span class="hljs-number">0</span>)}
|
|
<span class="hljs-keyword">return</span> {d <span class="hljs-keyword">for</span> d, delta <span class="hljs-keyword">in</span> deltas.items() <span class="hljs-keyword">if</span> rect.move(delta).collidelist(tiles) != <span class="hljs-number">-1</span>}
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">stop_on_collision</span><span class="hljs-params">(spd, bounds)</span>:</span>
|
|
<span class="hljs-keyword">return</span> P(x=<span class="hljs-number">0</span> <span class="hljs-keyword">if</span> (D.w <span class="hljs-keyword">in</span> bounds <span class="hljs-keyword">and</span> spd.x < <span class="hljs-number">0</span>) <span class="hljs-keyword">or</span> (D.e <span class="hljs-keyword">in</span> bounds <span class="hljs-keyword">and</span> spd.x > <span class="hljs-number">0</span>) <span class="hljs-keyword">else</span> spd.x,
|
|
y=<span class="hljs-number">0</span> <span class="hljs-keyword">if</span> (D.n <span class="hljs-keyword">in</span> bounds <span class="hljs-keyword">and</span> spd.y < <span class="hljs-number">0</span>) <span class="hljs-keyword">or</span> (D.s <span class="hljs-keyword">in</span> bounds <span class="hljs-keyword">and</span> spd.y > <span class="hljs-number">0</span>) <span class="hljs-keyword">else</span> spd.y)
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">draw</span><span class="hljs-params">(screen, images, mario, tiles)</span>:</span>
|
|
screen.fill((<span class="hljs-number">85</span>, <span class="hljs-number">168</span>, <span class="hljs-number">255</span>))
|
|
mario.facing_left = mario.spd.x < <span class="hljs-number">0</span> <span class="hljs-keyword">if</span> mario.spd.x <span class="hljs-keyword">else</span> mario.facing_left
|
|
is_airborne = D.s <span class="hljs-keyword">not</span> <span class="hljs-keyword">in</span> get_boundaries(mario.rect, tiles)
|
|
image_index = <span class="hljs-number">4</span> <span class="hljs-keyword">if</span> is_airborne <span class="hljs-keyword">else</span> next(mario.frame_cycle) <span class="hljs-keyword">if</span> mario.spd.x <span class="hljs-keyword">else</span> <span class="hljs-number">6</span>
|
|
screen.blit(images[image_index + (mario.facing_left * <span class="hljs-number">9</span>)], mario.rect)
|
|
<span class="hljs-keyword">for</span> t <span class="hljs-keyword">in</span> tiles:
|
|
is_border = t.x <span class="hljs-keyword">in</span> [<span class="hljs-number">0</span>, (W-<span class="hljs-number">1</span>)*<span class="hljs-number">16</span>] <span class="hljs-keyword">or</span> t.y <span class="hljs-keyword">in</span> [<span class="hljs-number">0</span>, (H-<span class="hljs-number">1</span>)*<span class="hljs-number">16</span>]
|
|
screen.blit(images[<span class="hljs-number">18</span> <span class="hljs-keyword">if</span> is_border <span class="hljs-keyword">else</span> <span class="hljs-number">19</span>], t)
|
|
pg.display.flip()
|
|
|
|
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
|
|
main()
|
|
</code></pre></div>
|
|
|
|
<div><h2 id="pandas"><a href="#pandas" name="pandas">#</a>Pandas</h2><p><strong>Data analysis library. For examples see <a href="#plotly">Plotly</a>.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pandas matplotlib</span>
|
|
<span class="hljs-keyword">import</span> pandas <span class="hljs-keyword">as</span> pd, matplotlib.pyplot <span class="hljs-keyword">as</span> plt
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="series">Series</h3><p><strong>Ordered dictionary with a name.</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>s = pd.Series([<span class="hljs-number">1</span>, <span class="hljs-number">2</span>], index=[<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>], name=<span class="hljs-string">'a'</span>); s
|
|
x <span class="hljs-number">1</span>
|
|
y <span class="hljs-number">2</span>
|
|
Name: a, dtype: int64
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><S> = pd.Series(<list>) <span class="hljs-comment"># Uses list's indices for 'index'.</span>
|
|
<S> = pd.Series(<dict>) <span class="hljs-comment"># Uses dictionary's keys for 'index'.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><el> = <S>.loc[key] <span class="hljs-comment"># Or: <S>.iloc[i]</span>
|
|
<S> = <S>.loc[coll_of_keys] <span class="hljs-comment"># Or: <S>.iloc[coll_of_i]</span>
|
|
<S> = <S>.loc[from_key : to_key_inc] <span class="hljs-comment"># Or: <S>.iloc[from_i : to_i_exc]</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><el> = <S>[key/i] <span class="hljs-comment"># Or: <S>.<key></span>
|
|
<S> = <S>[coll_of_keys/coll_of_i] <span class="hljs-comment"># Or: <S>[key/i : key/i]</span>
|
|
<S> = <S>[<S_of_bools>] <span class="hljs-comment"># Or: <S>.loc/iloc[<S_of_bools>]</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><S> = <S> > <el/S> <span class="hljs-comment"># Returns S of bools. For logic use &, |, ~.</span>
|
|
<S> = <S> + <el/S> <span class="hljs-comment"># Items with non-matching keys get value NaN.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><S> = <S>.head/describe/sort_values() <span class="hljs-comment"># Also <S>.unique/value_counts/round/dropna().</span>
|
|
<S> = <S>.str.strip/lower/contains/replace() <span class="hljs-comment"># Also split().str[i] or split(expand=True).</span>
|
|
<S> = <S>.dt.year/month/day/hour <span class="hljs-comment"># Use pd.to_datetime(<S>) to get S of datetimes.</span>
|
|
<S> = <S>.dt.to_period(<span class="hljs-string">'y/m/d/h'</span>) <span class="hljs-comment"># Quantizes datetimes into Period objects.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><S>.plot.line/area/bar/pie/hist() <span class="hljs-comment"># Generates a plot. Accepts `title=<str>`.</span>
|
|
plt.show() <span class="hljs-comment"># Displays the plot. Also plt.savefig(<path>).</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'print(<S>.to_string())'</span></code> to print a Series that has more than sixty items.</strong></li>
|
|
<li><strong>Use <code class="python hljs"><span class="hljs-string">'<S>.index'</span></code> to get collection of keys and <code class="python hljs"><span class="hljs-string">'<S>.index = <coll>'</span></code> to update them.</strong></li>
|
|
<li><strong>Only pass a list or Series to loc/iloc because <code class="python hljs"><span class="hljs-string">'obj[x, y]'</span></code> is converted to <code class="python hljs"><span class="hljs-string">'obj[(x, y)]'</span></code> and <code class="python hljs"><span class="hljs-string">'<S>.loc[key_1, key_2]'</span></code> is how you retrieve a value from a multi-indexed Series.</strong></li>
|
|
<li><strong>Pandas uses NumPy types like <code class="python hljs"><span class="hljs-string">'np.int64'</span></code>. Series is converted to <code class="python hljs"><span class="hljs-string">'float64'</span></code> if np.nan is assigned to any item. Use <code class="python hljs"><span class="hljs-string">'<S>.astype(<str/type>)'</span></code> to get converted Series.</strong></li>
|
|
</ul>
|
|
<div><h4 id="seriesaggregatetransformmap">Series — Aggregate, Transform, Map:</h4><pre><code class="python language-python hljs"><el> = <S>.sum/max/mean/std/idxmax/count() <span class="hljs-comment"># Or: <S>.agg(lambda <S>: <el>)</span>
|
|
<S> = <S>.rank/diff/cumsum/ffill/interpol…() <span class="hljs-comment"># Or: <S>.agg/transform(lambda <S>: <S>)</span>
|
|
<S> = <S>.isna/fillna/isin([<el/coll>]) <span class="hljs-comment"># Or: <S>.agg/transform/map(lambda <el>: <el>)</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python hljs">┏━━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓
|
|
┃ │ <span class="hljs-string">'sum'</span> │ [<span class="hljs-string">'sum'</span>] │ {<span class="hljs-string">'s'</span>: <span class="hljs-string">'sum'</span>} ┃
|
|
┠──────────────┼─────────────┼─────────────┼───────────────┨
|
|
┃ s.apply(…) │ <span class="hljs-number">3</span> │ sum <span class="hljs-number">3</span> │ s <span class="hljs-number">3</span> ┃
|
|
┃ s.agg(…) │ │ │ ┃
|
|
┗━━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛
|
|
|
|
┏━━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓
|
|
┃ │ <span class="hljs-string">'rank'</span> │ [<span class="hljs-string">'rank'</span>] │ {<span class="hljs-string">'r'</span>: <span class="hljs-string">'rank'</span>} ┃
|
|
┠──────────────┼─────────────┼─────────────┼───────────────┨
|
|
┃ s.apply(…) │ │ rank │ ┃
|
|
┃ s.agg(…) │ x <span class="hljs-number">1.0</span> │ x <span class="hljs-number">1.0</span> │ r x <span class="hljs-number">1.0</span> ┃
|
|
┃ │ y <span class="hljs-number">2.0</span> │ y <span class="hljs-number">2.0</span> │ y <span class="hljs-number">2.0</span> ┃
|
|
┗━━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛
|
|
</code></pre>
|
|
|
|
<div><h3 id="dataframe">DataFrame</h3><p><strong>Table with labeled rows and columns.</strong></p><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>df = pd.DataFrame([[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>], [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>]], index=[<span class="hljs-string">'a'</span>, <span class="hljs-string">'b'</span>], columns=[<span class="hljs-string">'x'</span>, <span class="hljs-string">'y'</span>]); df
|
|
x y
|
|
a <span class="hljs-number">1</span> <span class="hljs-number">2</span>
|
|
b <span class="hljs-number">3</span> <span class="hljs-number">4</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><DF> = pd.DataFrame(<list_of_rows>) <span class="hljs-comment"># Rows can be either lists, dicts or series.</span>
|
|
<DF> = pd.DataFrame(<dict_of_columns>) <span class="hljs-comment"># Columns can be either lists, dicts or series.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><el> = <DF>.loc[row_key, col_key] <span class="hljs-comment"># Or: <DF>.iloc[row_i, col_i]</span>
|
|
<S/DF> = <DF>.loc[row_key/s] <span class="hljs-comment"># Or: <DF>.iloc[row_i/s]</span>
|
|
<S/DF> = <DF>.loc[:, col_key/s] <span class="hljs-comment"># Or: <DF>.iloc[:, col_i/s]</span>
|
|
<DF> = <DF>.loc[row_bools, col_bools] <span class="hljs-comment"># Or: <DF>.iloc[row_bools, col_bools]</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><S/DF> = <DF>[col_key/s] <span class="hljs-comment"># Or: <DF>.<col_key></span>
|
|
<DF> = <DF>[<S_of_bools>] <span class="hljs-comment"># Filters rows. For example `df[df.x > 1]`.</span>
|
|
<DF> = <DF>[<DF_of_bools>] <span class="hljs-comment"># Assigns NaN to items that are False in bools.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><DF> = <DF> > <el/S/DF> <span class="hljs-comment"># Returns DF of bools. Treats series as a row.</span>
|
|
<DF> = <DF> + <el/S/DF> <span class="hljs-comment"># Items with non-matching keys get value NaN.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><DF> = <DF>.set_index(col_key) <span class="hljs-comment"># Replaces row keys with column's values.</span>
|
|
<DF> = <DF>.reset_index(drop=<span class="hljs-keyword">False</span>) <span class="hljs-comment"># Drops or moves row keys to column named index.</span>
|
|
<DF> = <DF>.sort_index(ascending=<span class="hljs-keyword">True</span>) <span class="hljs-comment"># Sorts rows by row keys. Use `axis=1` for cols.</span>
|
|
<DF> = <DF>.sort_values(col_key/s) <span class="hljs-comment"># Sorts rows by passed column/s. Also `axis=1`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><DF> = <DF>.head/tail/sample(<int>) <span class="hljs-comment"># Returns first, last, or random n rows.</span>
|
|
<DF> = <DF>.describe() <span class="hljs-comment"># Describes columns. Also info(), corr(), shape.</span>
|
|
<DF> = <DF>.query(<span class="hljs-string">'<query>'</span>) <span class="hljs-comment"># Filters rows. For example `df.query('x > 1')`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><DF>.plot.line/area/bar/scatter(x=col_key, …) <span class="hljs-comment"># `y=col_key/s`. Also hist/box(column/by=col_k).</span>
|
|
plt.show() <span class="hljs-comment"># Displays the plot. Also plt.savefig(<path>).</span>
|
|
</code></pre>
|
|
<div><h4 id="dataframemergejoinconcat">DataFrame — Merge, Join, Concat:</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>df_2 = pd.DataFrame([[<span class="hljs-number">4</span>, <span class="hljs-number">5</span>], [<span class="hljs-number">6</span>, <span class="hljs-number">7</span>]], index=[<span class="hljs-string">'b'</span>, <span class="hljs-string">'c'</span>], columns=[<span class="hljs-string">'y'</span>, <span class="hljs-string">'z'</span>]); df_2
|
|
y z
|
|
b <span class="hljs-number">4</span> <span class="hljs-number">5</span>
|
|
c <span class="hljs-number">6</span> <span class="hljs-number">7</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python hljs">┏━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
|
┃ │ <span class="hljs-string">'outer'</span> │ <span class="hljs-string">'inner'</span> │ <span class="hljs-string">'left'</span> │ Description ┃
|
|
┠───────────────────────┼───────────────┼────────────┼────────────┼───────────────────────────┨
|
|
┃ df.merge(df_2, │ x y z │ x y z │ x y z │ Merges on column if 'on' ┃
|
|
┃ on=<span class="hljs-string">'y'</span>, │ <span class="hljs-number">0</span> <span class="hljs-number">1</span> <span class="hljs-number">2</span> . │ <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ <span class="hljs-number">1</span> <span class="hljs-number">2</span> . │ or 'left_on/right_on' are ┃
|
|
┃ how=…) │ <span class="hljs-number">1</span> <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ │ <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ set, else on shared cols. ┃
|
|
┃ │ <span class="hljs-number">2</span> . <span class="hljs-number">6</span> <span class="hljs-number">7</span> │ │ │ Uses <span class="hljs-string">'inner'</span> by default. ┃
|
|
┠───────────────────────┼───────────────┼────────────┼────────────┼───────────────────────────┨
|
|
┃ df.join(df_2, │ x yl yr z │ │ x yl yr z │ Merges on row keys. ┃
|
|
┃ lsuffix=<span class="hljs-string">'l'</span>, │ a <span class="hljs-number">1</span> <span class="hljs-number">2</span> . . │ x yl yr z │ <span class="hljs-number">1</span> <span class="hljs-number">2</span> . . │ Uses <span class="hljs-string">'left'</span> by default. ┃
|
|
┃ rsuffix=<span class="hljs-string">'r'</span>, │ b <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ If Series is passed, it ┃
|
|
┃ how=…) │ c . . <span class="hljs-number">6</span> <span class="hljs-number">7</span> │ │ │ is treated as a column. ┃
|
|
┠───────────────────────┼───────────────┼────────────┼────────────┼───────────────────────────┨
|
|
┃ pd.concat([df, df_2], │ x y z │ y │ │ Adds rows at the bottom. ┃
|
|
┃ axis=<span class="hljs-number">0</span>, │ a <span class="hljs-number">1</span> <span class="hljs-number">2</span> . │ <span class="hljs-number">2</span> │ │ Uses <span class="hljs-string">'outer'</span> by default. ┃
|
|
┃ join=…) │ b <span class="hljs-number">3</span> <span class="hljs-number">4</span> . │ <span class="hljs-number">4</span> │ │ A Series is treated as a ┃
|
|
┃ │ b . <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ <span class="hljs-number">4</span> │ │ column. To add a row use ┃
|
|
┃ │ c . <span class="hljs-number">6</span> <span class="hljs-number">7</span> │ <span class="hljs-number">6</span> │ │ pd.concat([df, DF([s])]). ┃
|
|
┠───────────────────────┼───────────────┼────────────┼────────────┼───────────────────────────┨
|
|
┃ pd.concat([df, df_2], │ x y y z │ │ │ Adds columns at the ┃
|
|
┃ axis=<span class="hljs-number">1</span>, │ a <span class="hljs-number">1</span> <span class="hljs-number">2</span> . . │ x y y z │ │ right end. Uses <span class="hljs-string">'outer'</span> ┃
|
|
┃ join=…) │ b <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ <span class="hljs-number">3</span> <span class="hljs-number">4</span> <span class="hljs-number">4</span> <span class="hljs-number">5</span> │ │ by default. A Series is ┃
|
|
┃ │ c . . <span class="hljs-number">6</span> <span class="hljs-number">7</span> │ │ │ treated as a column. ┃
|
|
┗━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
|
</code></pre>
|
|
<div><h4 id="dataframeaggregatetransformmap">DataFrame — Aggregate, Transform, Map:</h4><pre><code class="python language-python hljs"><S> = <DF>.sum/max/mean/std/idxmax/count() <span class="hljs-comment"># Or: <DF>.apply/agg(lambda <S>: <el>)</span>
|
|
<DF> = <DF>.rank/diff/cumsum/ffill/interpo…() <span class="hljs-comment"># Or: <DF>.apply/agg/transform(lambda <S>: <S>)</span>
|
|
<DF> = <DF>.isna/fillna/isin([<el/coll>]) <span class="hljs-comment"># Or: <DF>.applymap(lambda <el>: <el>)</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python hljs">┏━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓
|
|
┃ │ <span class="hljs-string">'sum'</span> │ [<span class="hljs-string">'sum'</span>] │ {<span class="hljs-string">'x'</span>: <span class="hljs-string">'sum'</span>} ┃
|
|
┠─────────────────┼───────────────┼───────────────┼───────────────┨
|
|
┃ df.apply(…) │ x <span class="hljs-number">4</span> │ x y │ x <span class="hljs-number">4</span> ┃
|
|
┃ df.agg(…) │ y <span class="hljs-number">6</span> │ sum <span class="hljs-number">4</span> <span class="hljs-number">6</span> │ ┃
|
|
┗━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛
|
|
|
|
┏━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━┓
|
|
┃ │ <span class="hljs-string">'rank'</span> │ [<span class="hljs-string">'rank'</span>] │ {<span class="hljs-string">'x'</span>: <span class="hljs-string">'rank'</span>} ┃
|
|
┠─────────────────┼───────────────┼───────────────┼───────────────┨
|
|
┃ df.apply(…) │ │ x y │ ┃
|
|
┃ df.agg(…) │ x y │ rank rank │ x ┃
|
|
┃ df.transform(…) │ a <span class="hljs-number">1.0</span> <span class="hljs-number">1.0</span> │ a <span class="hljs-number">1.0</span> <span class="hljs-number">1.0</span> │ a <span class="hljs-number">1.0</span> ┃
|
|
┃ │ b <span class="hljs-number">2.0</span> <span class="hljs-number">2.0</span> │ b <span class="hljs-number">2.0</span> <span class="hljs-number">2.0</span> │ b <span class="hljs-number">2.0</span> ┃
|
|
┗━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━┛
|
|
</code></pre>
|
|
|
|
<ul>
|
|
<li><strong>Listed methods process the columns unless they receive <code class="python hljs"><span class="hljs-string">'axis=1'</span></code>. Exceptions to this rule are <code class="python hljs"><span class="hljs-string">'<DF>.dropna()'</span></code>, <code class="python hljs"><span class="hljs-string">'<DF>.drop(row_key/s)'</span></code> and <code class="python hljs"><span class="hljs-string">'<DF>.rename(<dict/func>)'</span></code>.</strong></li>
|
|
<li><strong>Fifth result's columns are indexed with a multi-index. This means we need a tuple of column keys to specify a column: <code class="python hljs"><span class="hljs-string">'<DF>.loc[row_key, (col_key_1, col_key_2)]'</span></code>.</strong></li>
|
|
</ul>
|
|
<div><h3 id="multiindex">Multi-Index</h3><pre><code class="python language-python hljs"><DF> = <DF>.loc[row_key_1] <span class="hljs-comment"># Or: <DF>.xs(row_key_1)</span>
|
|
<DF> = <DF>.loc[:, (slice(<span class="hljs-keyword">None</span>), col_key_2)] <span class="hljs-comment"># Or: <DF>.xs(col_key_2, axis=1, level=1)</span>
|
|
<DF> = <DF>.set_index(col_keys) <span class="hljs-comment"># Creates index from cols. Also `append=False`.</span>
|
|
<DF> = <DF>.pivot_table(index=col_key/s) <span class="hljs-comment"># `columns=key/s, values=key/s, aggfunc='mean'`.</span>
|
|
<S> = <DF>.stack/unstack(level=<span class="hljs-number">-1</span>) <span class="hljs-comment"># Combines col keys with row keys or vice versa.</span>
|
|
</code></pre></div>
|
|
|
|
<div><h3 id="fileformats">File Formats</h3><pre><code class="python language-python hljs"><S/DF> = pd.read_json/pickle(<path/url/file>) <span class="hljs-comment"># Also io.StringIO(<str>), io.BytesIO(<bytes>).</span>
|
|
<DF> = pd.read_csv/excel(<path/url/file>) <span class="hljs-comment"># Also `header/index_col/dtype/usecols/…=<obj>`.</span>
|
|
<list> = pd.read_html(<path/url/file>) <span class="hljs-comment"># Raises ImportError if webpage has zero tables.</span>
|
|
<S/DF> = pd.read_parquet/feather/hdf(<path…>) <span class="hljs-comment"># Function read_hdf() accepts `key=<s/df_name>`.</span>
|
|
<DF> = pd.read_sql(<span class="hljs-string">'<table/query>'</span>, <conn>) <span class="hljs-comment"># Pass SQLite3/Alchemy connection. See #SQLite.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><DF>.to_json/csv/html/latex/parquet(<path>) <span class="hljs-comment"># Returns a string/bytes if path is omitted.</span>
|
|
<DF>.to_pickle/excel/feather/hdf(<path>) <span class="hljs-comment"># Method to_hdf() requires `key=<s/df_name>`.</span>
|
|
<DF>.to_sql(<span class="hljs-string">'<table_name>'</span>, <connection>) <span class="hljs-comment"># Also `if_exists='fail/replace/append'`.</span>
|
|
</code></pre>
|
|
<ul>
|
|
<li><strong><code class="python hljs"><span class="hljs-string">'$ pip3 install "pandas[excel]" odfpy lxml pyarrow'</span></code> installs dependencies.</strong></li>
|
|
<li><strong>Csv functions use the same dialect as standard library's csv module (e.g. <code class="python hljs"><span class="hljs-string">'sep=","'</span></code>).</strong></li>
|
|
<li><strong>Read_csv() only parses dates of columns that are listed in 'parse_dates'. It automatically tries to detect the format, but it can be helped with 'date_format' or 'dayfirst' arguments.</strong></li>
|
|
<li><strong>We get a dataframe with DatetimeIndex if 'parse_dates' argument includes 'index_col'. Its <code class="python hljs"><span class="hljs-string">'resample("y/m/d/h")'</span></code> method returns Resampler object that is similar to GroupBy.</strong></li>
|
|
</ul>
|
|
<div><h3 id="groupby">GroupBy</h3><p><strong>Object that groups together rows of a dataframe based on the value of the passed column.</strong></p><pre><code class="python language-python hljs"><GB> = <DF>.groupby(col_key/s) <span class="hljs-comment"># Splits DF into groups based on passed column.</span>
|
|
<DF> = <GB>.apply/filter(<func>) <span class="hljs-comment"># Filter drops a group if func returns False.</span>
|
|
<DF> = <GB>.get_group(<el>) <span class="hljs-comment"># Selects a group by grouping column's value.</span>
|
|
<S> = <GB>.size() <span class="hljs-comment"># S of group sizes. Same keys as get_group().</span>
|
|
<GB> = <GB>[col_key] <span class="hljs-comment"># Single column GB. All operations return S.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<pre><code class="python language-python hljs"><DF> = <GB>.sum/max/mean/std/idxmax/count() <span class="hljs-comment"># Or: <GB>.agg(lambda <S>: <el>)</span>
|
|
<DF> = <GB>.rank/diff/cumsum/ffill() <span class="hljs-comment"># Or: <GB>.transform(lambda <S>: <S>)</span>
|
|
<DF> = <GB>.fillna(<el>) <span class="hljs-comment"># Or: <GB>.transform(lambda <S>: <S>)</span>
|
|
</code></pre>
|
|
<div><h4 id="dividesrowsintogroupsandsumstheircolumnsresulthasanamedindexthatcreatescolumnzonreset_index">Divides rows into groups and sums their columns. Result has a named index that creates column <code class="python hljs"><span class="hljs-string">'z'</span></code> on reset_index():</h4><pre><code class="python language-python hljs"><span class="hljs-meta">>>> </span>df = pd.DataFrame([[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], [<span class="hljs-number">4</span>, <span class="hljs-number">5</span>, <span class="hljs-number">6</span>], [<span class="hljs-number">7</span>, <span class="hljs-number">8</span>, <span class="hljs-number">6</span>]], list(<span class="hljs-string">'abc'</span>), list(<span class="hljs-string">'xyz'</span>))
|
|
<span class="hljs-meta">>>> </span>gb = df.groupby(<span class="hljs-string">'z'</span>); gb.apply(print)
|
|
x y z
|
|
a <span class="hljs-number">1</span> <span class="hljs-number">2</span> <span class="hljs-number">3</span>
|
|
x y z
|
|
b <span class="hljs-number">4</span> <span class="hljs-number">5</span> <span class="hljs-number">6</span>
|
|
c <span class="hljs-number">7</span> <span class="hljs-number">8</span> <span class="hljs-number">6</span>
|
|
<span class="hljs-meta">>>> </span>gb.sum()
|
|
x y
|
|
z
|
|
<span class="hljs-number">3</span> <span class="hljs-number">1</span> <span class="hljs-number">2</span>
|
|
<span class="hljs-number">6</span> <span class="hljs-number">11</span> <span class="hljs-number">13</span></code></pre></div>
|
|
|
|
<div><h3 id="rolling">Rolling</h3><p><strong>Object for rolling window calculations.</strong></p><pre><code class="python language-python hljs"><RS/RDF/RGB> = <S/DF/GB>.rolling(win_size) <span class="hljs-comment"># Also: `min_periods=None, center=False`.</span>
|
|
<RS/RDF/RGB> = <RDF/RGB>[col_key/s] <span class="hljs-comment"># Or: <RDF/RGB>.<col_key></span>
|
|
<S/DF> = <R>.mean/sum/max() <span class="hljs-comment"># Or: <R>.apply/agg(<agg_func/str>)</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h2 id="plotly"><a href="#plotly" name="plotly">#</a>Plotly</h2><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install plotly kaleido pandas</span>
|
|
<span class="hljs-keyword">import</span> plotly.express <span class="hljs-keyword">as</span> px, pandas <span class="hljs-keyword">as</span> pd
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><Fig> = px.line(<DF> [, y=col_key/s [, x=col_key]]) <span class="hljs-comment"># Also px.line(y=<list> [, x=<list>]).</span>
|
|
<Fig>.update_layout(paper_bgcolor=<span class="hljs-string">'#rrggbb'</span>) <span class="hljs-comment"># Also `margin=dict(t=0, r=0, b=0, l=0)`.</span>
|
|
<Fig>.write_html/json/image(<span class="hljs-string">'<path>'</span>) <span class="hljs-comment"># Use <Fig>.show() to display the plot.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><Fig> = px.area/bar/box(<DF>, x=col_key, y=col_keys) <span class="hljs-comment"># Also `color=col_key`. All are optional.</span>
|
|
<Fig> = px.scatter(<DF>, x=col_key, y=col_keys) <span class="hljs-comment"># Also `color/size/symbol=col_key`. Same.</span>
|
|
<Fig> = px.scatter_3d(<DF>, x=col_key, y=col_key, …) <span class="hljs-comment"># `z=col_key`. Also color, size, symbol.</span>
|
|
<Fig> = px.histogram(<DF>, x=col_keys, y=col_key) <span class="hljs-comment"># Also color, nbins. All are optional.</span>
|
|
</code></pre>
|
|
<div><h4 id="displaysalinechartoftotalcovid19deathspermilliongroupedbycontinent">Displays a line chart of total COVID-19 deaths per million grouped by continent:</h4><p></p><div id="2a950764-39fc-416d-97fe-0a6226a3095f" class="plotly-graph-div" style="height:312px; width:914px;"></div><pre><code class="python language-python hljs">covid = pd.read_csv(<span class="hljs-string">'https://raw.githubusercontent.com/owid/covid-19-data/8dde8ca49b'</span>
|
|
<span class="hljs-string">'6e648c17dd420b2726ca0779402651/public/data/owid-covid-data.csv'</span>,
|
|
usecols=[<span class="hljs-string">'iso_code'</span>, <span class="hljs-string">'date'</span>, <span class="hljs-string">'population'</span>, <span class="hljs-string">'total_deaths'</span>])
|
|
continents = pd.read_csv(<span class="hljs-string">'https://gto76.github.io/python-cheatsheet/web/continents.csv'</span>,
|
|
usecols=[<span class="hljs-string">'Three_Letter_Country_Code'</span>, <span class="hljs-string">'Continent_Name'</span>])
|
|
df = pd.merge(covid, continents, left_on=<span class="hljs-string">'iso_code'</span>, right_on=<span class="hljs-string">'Three_Letter_Country_Code'</span>)
|
|
df = df.groupby([<span class="hljs-string">'Continent_Name'</span>, <span class="hljs-string">'date'</span>]).sum().reset_index()
|
|
df[<span class="hljs-string">'Total Deaths per Million'</span>] = df.total_deaths * <span class="hljs-number">1e6</span> / df.population
|
|
df = df[df.date > <span class="hljs-string">'2020-03-14'</span>]
|
|
df = df.rename({<span class="hljs-string">'date'</span>: <span class="hljs-string">'Date'</span>, <span class="hljs-string">'Continent_Name'</span>: <span class="hljs-string">'Continent'</span>}, axis=<span class="hljs-string">'columns'</span>)
|
|
px.line(df, x=<span class="hljs-string">'Date'</span>, y=<span class="hljs-string">'Total Deaths per Million'</span>, color=<span class="hljs-string">'Continent'</span>)
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
<div><h4 id="displaysamultiaxislinechartoftotalcovid19casesandchangesinpricesofbitcoindowjonesandgold">Displays a multi-axis line chart of total COVID-19 cases and changes in prices of Bitcoin, Dow Jones and gold:</h4><p></p><div id="e23ccacc-a456-478b-b467-7282a2165921" class="plotly-graph-div" style="height:285px; width:935px;"></div><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install pandas lxml selenium plotly</span>
|
|
<span class="hljs-keyword">import</span> pandas <span class="hljs-keyword">as</span> pd, selenium.webdriver, io, plotly.graph_objects <span class="hljs-keyword">as</span> go
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
|
|
covid, (bitcoin, gold, dow) = get_covid_cases(), get_tickers()
|
|
df = wrangle_data(covid, bitcoin, gold, dow)
|
|
display_data(df)
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_covid_cases</span><span class="hljs-params">()</span>:</span>
|
|
url = <span class="hljs-string">'https://catalog.ourworldindata.org/garden/covid/latest/compact/compact.csv'</span>
|
|
df = pd.read_csv(url, parse_dates=[<span class="hljs-string">'date'</span>])
|
|
df = df[df.country == <span class="hljs-string">'World'</span>]
|
|
s = df.set_index(<span class="hljs-string">'date'</span>).total_cases
|
|
<span class="hljs-keyword">return</span> s.rename(<span class="hljs-string">'Total Cases'</span>)
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_tickers</span><span class="hljs-params">()</span>:</span>
|
|
<span class="hljs-keyword">with</span> selenium.webdriver.Chrome() <span class="hljs-keyword">as</span> driver:
|
|
driver.implicitly_wait(<span class="hljs-number">10</span>)
|
|
symbols = {<span class="hljs-string">'Bitcoin'</span>: <span class="hljs-string">'BTC-USD'</span>, <span class="hljs-string">'Gold'</span>: <span class="hljs-string">'GC=F'</span>, <span class="hljs-string">'Dow Jones'</span>: <span class="hljs-string">'%5EDJI'</span>}
|
|
<span class="hljs-keyword">return</span> [get_ticker(driver, name, symbol) <span class="hljs-keyword">for</span> name, symbol <span class="hljs-keyword">in</span> symbols.items()]
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get_ticker</span><span class="hljs-params">(driver, name, symbol)</span>:</span>
|
|
url = <span class="hljs-string">f'https://finance.yahoo.com/quote/<span class="hljs-subst">{symbol}</span>/history/'</span>
|
|
driver.get(url + <span class="hljs-string">'?period1=1579651200&period2=9999999999'</span>)
|
|
<span class="hljs-keyword">if</span> buttons := driver.find_elements(<span class="hljs-string">'xpath'</span>, <span class="hljs-string">'//button[@name="reject"]'</span>):
|
|
buttons[<span class="hljs-number">0</span>].click()
|
|
html = io.StringIO(driver.page_source)
|
|
dataframes = pd.read_html(html, parse_dates=[<span class="hljs-string">'Date'</span>])
|
|
s = dataframes[<span class="hljs-number">0</span>].set_index(<span class="hljs-string">'Date'</span>).Open
|
|
<span class="hljs-keyword">return</span> s.rename(name)
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">wrangle_data</span><span class="hljs-params">(covid, bitcoin, gold, dow)</span>:</span>
|
|
df = pd.concat([bitcoin, gold, dow], axis=<span class="hljs-number">1</span>) <span class="hljs-comment"># Creates table by joining columns on dates.</span>
|
|
df = df.sort_index().interpolate() <span class="hljs-comment"># Sorts rows by date and interpolates NaN-s.</span>
|
|
df = df.loc[<span class="hljs-string">'2020-02-23'</span>:<span class="hljs-string">'2021-12-20'</span>] <span class="hljs-comment"># Keeps rows between specified dates.</span>
|
|
df = (df / df.iloc[<span class="hljs-number">0</span>]) * <span class="hljs-number">100</span> <span class="hljs-comment"># Calculates percentages relative to day 1.</span>
|
|
df = df.join(covid) <span class="hljs-comment"># Adds column with covid cases.</span>
|
|
<span class="hljs-keyword">return</span> df.sort_values(df.index[<span class="hljs-number">-1</span>], axis=<span class="hljs-number">1</span>) <span class="hljs-comment"># Sorts columns by last day's value.</span>
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">display_data</span><span class="hljs-params">(df)</span>:</span>
|
|
figure = go.Figure()
|
|
<span class="hljs-keyword">for</span> col_name <span class="hljs-keyword">in</span> reversed(df.columns):
|
|
yaxis = <span class="hljs-string">'y1'</span> <span class="hljs-keyword">if</span> col_name == <span class="hljs-string">'Total Cases'</span> <span class="hljs-keyword">else</span> <span class="hljs-string">'y2'</span>
|
|
trace = go.Scatter(x=df.index, y=df[col_name], yaxis=yaxis, name=col_name)
|
|
figure.add_trace(trace)
|
|
figure.update_layout(
|
|
width=<span class="hljs-number">944</span>,
|
|
height=<span class="hljs-number">423</span>,
|
|
yaxis1=dict(title=<span class="hljs-string">'Total Cases'</span>, rangemode=<span class="hljs-string">'tozero'</span>),
|
|
yaxis2=dict(title=<span class="hljs-string">'%'</span>, rangemode=<span class="hljs-string">'tozero'</span>, overlaying=<span class="hljs-string">'y'</span>, side=<span class="hljs-string">'right'</span>),
|
|
colorway=[<span class="hljs-string">'#EF553B'</span>, <span class="hljs-string">'#636EFA'</span>, <span class="hljs-string">'#00CC96'</span>, <span class="hljs-string">'#FFA152'</span>],
|
|
legend=dict(x=<span class="hljs-number">1.08</span>)
|
|
)
|
|
figure.show()
|
|
|
|
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
|
|
main()
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
<div><h2 id="appendix"><a href="#appendix" name="appendix">#</a>Appendix</h2><div><h3 id="cython">Cython</h3><p><strong>Library that compiles Python-like code into C.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment"># $ pip3 install cython</span>
|
|
<span class="hljs-keyword">import</span> pyximport; pyximport.install() <span class="hljs-comment"># Module that runs Cython scripts.</span>
|
|
<span class="hljs-keyword">import</span> <cython_script> <span class="hljs-comment"># Script must have '.pyx' extension.</span>
|
|
</code></pre></div></div>
|
|
|
|
|
|
|
|
<div><h4 id="allcdefdefinitionsareoptionalbuttheycontributetothespeedup">All <code class="python hljs"><span class="hljs-string">'cdef'</span></code> definitions are optional, but they contribute to the speed-up:</h4><pre><code class="python language-python hljs"><span class="hljs-keyword">cdef</span> <type> <var_name> [= <obj/var>] <span class="hljs-comment"># Either Python or C type variable.</span>
|
|
<span class="hljs-keyword">cdef</span> <ctype> *<pointer_name> [= &<var>] <span class="hljs-comment"># Use <pointer>[0] to get the value.</span>
|
|
<span class="hljs-keyword">cdef</span> <ctype>[size] <array_name> [= <coll/array>] <span class="hljs-comment"># Also `<ctype>[:] <mview> = <array>`.</span>
|
|
<span class="hljs-keyword">cdef</span> <ctype> *<array_name> [= <coll/array/pointer>] <span class="hljs-comment"># E.g. `<<ctype> *> malloc(n_bytes)`.</span>
|
|
</code></pre></div>
|
|
|
|
<pre><code class="python language-python hljs"><span class="hljs-keyword">cdef</span> <type> <func_name>(<type> [*]<arg_name>): ... <span class="hljs-comment"># Omitted types default to `object`.</span>
|
|
</code></pre>
|
|
<pre><code class="python language-python hljs"><span class="hljs-keyword">cdef</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <<span class="hljs-title">class_name</span>>:</span> <span class="hljs-comment"># Also `cdef struct <struct_name>:`.</span>
|
|
<span class="hljs-keyword">cdef</span> <span class="hljs-keyword">public</span> <type> [*]<attr_name> <span class="hljs-comment"># Also `... <ctype> [*]<field_name>`.</span>
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, <type> <arg_name>)</span>:</span> <span class="hljs-comment"># Also `cdef __dealloc__(self):`.</span>
|
|
self.<attr_name> = <arg_name> <span class="hljs-comment"># Also `... free(<array/pointer>)`.</span>
|
|
</code></pre>
|
|
<div><h3 id="virtualenvironments">Virtual Environments</h3><p><strong>System for installing libraries directly into project's directory.</strong></p><pre><code class="python hljs">$ python3 -m venv NAME <span class="hljs-comment"># Creates virtual environment in current directory.</span>
|
|
$ source NAME/bin/activate <span class="hljs-comment"># Activates it. On Windows run `NAME\Scripts\activate`.</span>
|
|
$ pip3 install LIBRARY <span class="hljs-comment"># Installs the library into active environment.</span>
|
|
$ python3 FILE <span class="hljs-comment"># Runs the script in active environment. Also `./FILE`.</span>
|
|
$ deactivate <span class="hljs-comment"># Deactivates the active virtual environment.</span>
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h3 id="basicscripttemplate">Basic Script Template</h3><p><strong>Run the script with <code class="python hljs"><span class="hljs-string">'$ python3 FILE'</span></code> or <code class="python hljs"><span class="hljs-string">'$ chmod u+x FILE; ./FILE'</span></code>. To automatically start the debugger when uncaught exception occurs run <code class="python hljs"><span class="hljs-string">'$ python3 -m pdb -cc FILE'</span></code>.</strong></p><pre><code class="python language-python hljs"><span class="hljs-comment">#!/usr/bin/env python3</span>
|
|
<span class="hljs-comment">#</span>
|
|
<span class="hljs-comment"># Usage: .py</span>
|
|
<span class="hljs-comment">#</span>
|
|
|
|
<span class="hljs-keyword">from</span> sys <span class="hljs-keyword">import</span> argv, exit
|
|
<span class="hljs-keyword">from</span> collections <span class="hljs-keyword">import</span> defaultdict, namedtuple
|
|
<span class="hljs-keyword">from</span> dataclasses <span class="hljs-keyword">import</span> make_dataclass
|
|
<span class="hljs-keyword">from</span> enum <span class="hljs-keyword">import</span> Enum
|
|
<span class="hljs-keyword">import</span> functools <span class="hljs-keyword">as</span> ft, itertools <span class="hljs-keyword">as</span> it, operator <span class="hljs-keyword">as</span> op, re
|
|
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">main</span><span class="hljs-params">()</span>:</span>
|
|
<span class="hljs-keyword">pass</span>
|
|
|
|
|
|
<span class="hljs-comment">###</span>
|
|
<span class="hljs-comment">## UTIL</span>
|
|
<span class="hljs-comment">#</span>
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">read_file</span><span class="hljs-params">(filename)</span>:</span>
|
|
<span class="hljs-keyword">with</span> open(filename, encoding=<span class="hljs-string">'utf-8'</span>) <span class="hljs-keyword">as</span> file:
|
|
<span class="hljs-keyword">return</span> file.readlines()
|
|
|
|
|
|
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">'__main__'</span>:
|
|
main()
|
|
</code></pre></div>
|
|
|
|
|
|
<div><h2 id="index"><a href="#index" name="index">#</a>Index</h2><ul><li><strong>Ctrl+F / ⌘F is usually sufficient.</strong></li>
|
|
<li><strong>Searching <code class="python hljs"><span class="hljs-string">'#<title>'</span></code> will limit the search to the titles.</strong></li>
|
|
<li><strong>Click on the title's <code class="python hljs"><span class="hljs-string">'#'</span></code> to get a link to its section.</strong></li>
|
|
</ul></div>
|
|
|
|
|
|
<footer>
|
|
<aside>September 16, 2025</aside>
|
|
<a href="https://gto76.github.io" rel="author">Jure Šorn</a>
|
|
</footer>
|
|
|
|
<a href="javascript:" id="return-to-top"><i class="icon-chevron-up"></i></a>
|
|
|
|
<script src="web/jquery-3.4.0.min.js"></script>
|
|
<script src="web/script_2.js"></script>
|
|
<script type="text/javascript" src="https://transactions.sendowl.com/assets/sendowl.js" ></script>
|
|
<script src="web/plotly.min.js"></script>
|
|
<script src="web/covid_deaths.js"></script>
|
|
<script src="web/covid_cases.js"></script>
|
|
</body>
|
|
|
|
</html>
|