"Python, being a beautifully designed high-level and interpreter-based programming language, provides us with many features for the programmer's comfort. But sometimes, the outcomes of a Python snippet may not seem obvious at first sight.\n",
"\n",
"Here's a fun project attempting to explain what exactly is happening under the hood for some counter-intuitive snippets and lesser-known features in Python.\n",
"\n",
"While some of the examples you see below may not be WTFs in the truest sense, but they'll reveal some of the interesting parts of Python that you might be unaware of. I find it a nice way to learn the internals of a programming language, and I believe that you'll find it interesting too!\n",
"\n",
"If you're an experienced Python programmer, you can take it as a challenge to get most of them right in the first attempt. You may have already experienced some of them before, and I might be able to revive sweet old memories of yours! :sweat_smile:\n",
"PS: If you're a returning reader, you can learn about the new modifications [here](https://github.com/satwikkansal/wtfpython/releases/) (the examples marked with asterisk are the ones added in the latest major revision). \n",
"> (Optional): One line describing the unexpected output.\n",
">\n",
">\n",
"> #### \ud83d\udca1 Explanation:\n",
">\n",
"> * Brief explanation of what's happening and why is it happening.\n",
"> ```py\n",
"> # Set up code\n",
"> # More examples for further clarification (if necessary)\n",
"> ```\n",
"> **Output (Python version(s)):**\n",
">\n",
"> ```py\n",
"> >>> trigger # some example that makes it easy to unveil the magic\n",
"> # some justified output\n",
"> ```\n",
"\n",
"**Note:** All the examples are tested on Python 3.5.2 interactive interpreter, and they should work for all the Python versions unless explicitly specified before the output.\n",
"\n",
"# Usage\n",
"\n",
"A nice way to get the most out of these examples, in my opinion, is to read them chronologically, and for every example:\n",
"- Carefully read the initial code for setting up the example. If you're an experienced Python programmer, you'll successfully anticipate what's going to happen next most of the time.\n",
"- Read the output snippets and,\n",
" + Check if the outputs are the same as you'd expect.\n",
" + Make sure if you know the exact reason behind the output being the way it is.\n",
" - If the answer is no (which is perfectly okay), take a deep breath, and read the explanation (and if you still don't understand, shout out! and create an issue [here](https://github.com/satwikkansal/wtfpython/issues/new)).\n",
" - If yes, give a gentle pat on your back, and you may skip to the next example.\n",
"\n",
"\n\n## Hosted notebook instructions\n\nThis is just an experimental attempt of browsing wtfpython through jupyter notebooks. Some examples are read-only because, \n- they either require a version of Python that's not supported in the hosted runtime.\n- or they can't be reproduced in the notebook envrinonment.\n\nThe expected outputs are already present in collapsed cells following the code cells. The Google colab provides Python2 (2.7) and Python3 (3.6, default) runtimes. You can switch among these for Python2 specific examples. For examples specific to other minor versions, you can simply refer to collapsed outputs (it's not possible to control the minor version in hosted notebooks as of now). You can check the active version using\n\n```py\n>>> import sys\n>>> sys.version\n# Prints out Python version here.\n```\n\nThat being said, most of the examples do work as expected. If you face any trouble, feel free to consult the original content on wtfpython and create an issue in the repo. Have fun!\n\n---\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Strings can be tricky sometimes\n",
"1\\.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"140420665652016\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = \"some_string\"\n",
"id(a)\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"140420665652016\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"id(\"some\" + \"_\" + \"string\") # Notice that both the ids are same.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"2\\.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"True\n",
"\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = \"wtf\"\n",
"b = \"wtf\"\n",
"a is b\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"False\n",
"\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = \"wtf!\"\n",
"b = \"wtf!\"\n",
"a is b\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"3\\.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"True\n",
"\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a, b = \"wtf!\", \"wtf!\"\n",
"a is b # All versions except 3.7.x\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"False\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = \"wtf!\"; b = \"wtf!\"\n",
"a is b # This will print True or False depending on where you're invoking it (python shell / ipython / as a script)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "code",
"metadata": {
"collapsed": true
},
"execution_count": null,
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": []
}
],
"source": [
"# This time in file some_file.py\n",
"a = \"wtf!\"\n",
"b = \"wtf!\"\n",
"print(a is b)\n",
"\n",
"# prints True when the module is invoked!\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"4\\.\n",
"\n",
"**Output (< Python3.7 )**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"True\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"'a' * 20 is 'aaaaaaaaaaaaaaaaaaaa'\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"False\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"'a' * 21 is 'aaaaaaaaaaaaaaaaaaaaa'\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"Makes sense, right?\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"+ The behavior in first and second snippets is due to a CPython optimization (called string interning) that tries to use existing immutable objects in some cases rather than creating a new object every time.\n",
"+ After being \"interned,\" many variables may reference the same string object in memory (saving memory thereby).\n",
"+ In the snippets above, strings are implicitly interned. The decision of when to implicitly intern a string is implementation-dependent. There are some rules that can be used to guess if a string will be interned or not:\n",
" * All length 0 and length 1 strings are interned.\n",
" * Strings that are not composed of ASCII letters, digits or underscores, are not interned. This explains why `'wtf!'` was not interned due to `!`. CPython implementation of this rule can be found [here](https://github.com/python/cpython/blob/3.6/Objects/codeobject.c#L19)\n",
"+ When `a` and `b` are set to `\"wtf!\"` in the same line, the Python interpreter creates a new object, then references the second variable at the same time. If you do it on separate lines, it doesn't \"know\" that there's already `\"wtf!\"` as an object (because `\"wtf!\"` is not implicitly interned as per the facts mentioned above). It's a compile-time optimization. This optimization doesn't apply to 3.7.x versions of CPython (check this [issue](https://github.com/satwikkansal/wtfpython/issues/100) for more discussion).\n",
"+ A compile unit in an interactive environment like IPython consists of a single statement, whereas it consists of the entire module in case of modules. `a, b = \"wtf!\", \"wtf!\"` is single statement, whereas `a = \"wtf!\"; b = \"wtf!\"` are two statements in a single line. This explains why the identities are different in `a = \"wtf!\"; b = \"wtf!\"`, and also explain why they are same when invoked in `some_file.py`\n",
"+ The abrupt change in the output of the fourth snippet is due to a [peephole optimization](https://en.wikipedia.org/wiki/Peephole_optimization) technique known as Constant folding. This means the expression `'a'*20` is replaced by `'aaaaaaaaaaaaaaaaaaaa'` during compilation to save a few clock cycles during runtime. Constant folding only occurs for strings having a length of less than 21. (Why? Imagine the size of `.pyc` file generated as a result of the expression `'a'*10**10`). [Here's](https://github.com/python/cpython/blob/3.6/Python/peephole.c#L288) the implementation source for the same.\n",
"+ Note: In Python 3.7, Constant folding was moved out from peephole optimizer to the new AST optimizer with some change in logic as well, so the fourth snippet doesn't work for Python 3.7. You can read more about the change [here](https://bugs.python.org/issue11549). \n",
"As per https://docs.python.org/3/reference/expressions.html#membership-test-operations\n",
"\n",
"> Formally, if a, b, c, ..., y, z are expressions and op1, op2, ..., opN are comparison operators, then a op1 b op2 c ... y opN z is equivalent to a op1 b and b op2 c and ... y opN z, except that each expression is evaluated at most once.\n",
"\n",
"While such behavior might seem silly to you in the above examples, it's fantastic with stuff like `a == b == c` and `0 <= x <= 100`.\n",
"* `False is False is False` is equivalent to `(False is False) and (False is False)`\n",
"* `True is False == False` is equivalent to `True is False and False == False` and since the first part of the statement (`True is False`) evaluates to `False`, the overall expression evaluates to `False`.\n",
"* `1 > 0 < 1` is equivalent to `1 > 0 and 0 < 1` which evaluates to `True`.\n",
"* The expression `(1 > 0) < 1` is equivalent to `True < 1` and\n"
"**`256` is an existing object but `257` isn't**\n",
"\n",
"When you start up python the numbers from `-5` to `256` will be allocated. These numbers are used a lot, so it makes sense just to have them ready.\n",
"\n",
"Quoting from https://docs.python.org/3/c-api/long.html\n",
"> The current implementation keeps an array of integer objects for all integers between -5 and 256, when you create an int in that range you just get back a reference to the existing object. So it should be possible to change the value of 1. I suspect the behavior of Python, in this case, is undefined. :-)\n",
"Here the interpreter isn't smart enough while executing `y = 257` to recognize that we've already created an integer of the value `257,` and so it goes on to create another object in the memory.\n",
"\n",
"Similar optimization applies to other **immutable** objects like empty tuples as well. Since lists are mutable, that's why `[] is []` will return `False` and `() is ()` will return `True`. This explains our second snippet. Let's move on to the third one, \n",
"\n",
"**Both `a` and `b` refer to the same object when initialized with same value in the same line.**\n",
"* When a and b are set to `257` in the same line, the Python interpreter creates a new object, then references the second variable at the same time. If you do it on separate lines, it doesn't \"know\" that there's already `257` as an object.\n",
"\n",
"* It's a compiler optimization and specifically applies to the interactive environment. When you enter two lines in a live interpreter, they're compiled separately, therefore optimized separately. If you were to try this example in a `.py` file, you would not see the same behavior, because the file is compiled all at once. This optimization is not limited to integers, it works for other immutable data types like strings (check the \"Strings are tricky example\") and floats as well,\n",
"* Why didn't this work for Python 3.7? The abstract reason is because such compiler optimizations are implementation specific (i.e. may change with version, OS, etc). I'm still figuring out what exact implementation change cause the issue, you can check out this [issue](https://github.com/satwikkansal/wtfpython/issues/100) for updates.\n",
"* Uniqueness of keys in a Python dictionary is by *equivalence*, not identity. So even though `5`, `5.0`, and `5 + 0j` are distinct objects of different types, since they're equal, they can't both be in the same `dict` (or `set`). As soon as you insert any one of them, attempting to look up any distinct but equivalent key will succeed with the original mapped value (rather than failing with a `KeyError`):\n"
"* This applies when setting an item as well. So when you do `some_dict[5] = \"Python\"`, Python finds the existing item with equivalent key `5.0 -> \"Ruby\"`, overwrites its value in place, and leaves the original key alone.\n"
"* So how can we update the key to `5` (instead of `5.0`)? We can't actually do this update in place, but what we can do is first delete the key (`del some_dict[5.0]`), and then set it (`some_dict[5]`) to get the integer `5` as the key instead of floating `5.0`, though this should be needed in rare cases.\n",
"* How did Python find `5` in a dictionary containing `5.0`? Python does this in constant time without having to scan through every item by using hash functions. When Python looks up a key `foo` in a dict, it first computes `hash(foo)` (which runs in constant-time). Since in Python it is required that objects that compare equal also have the same hash value ([docs](https://docs.python.org/3/reference/datamodel.html#object.__hash__) here), `5`, `5.0`, and `5 + 0j` have the same hash value.\n"
" **Note:** The inverse is not necessarily true: Objects with equal hash values may themselves be unequal. (This causes what's known as a [hash collision](https://en.wikipedia.org/wiki/Collision_(computer_science)), and degrades the constant-time performance that hashing usually provides.)\n",
"* When `id` was called, Python created a `WTF` class object and passed it to the `id` function. The `id` function takes its `id` (its memory location), and throws away the object. The object is destroyed.\n",
"* When we do this twice in succession, Python allocates the same memory location to this second object as well. Since (in CPython) `id` uses the memory location as the object id, the id of the two objects is the same.\n",
"* So, the object's id is unique only for the lifetime of the object. After the object is destroyed, or before it is created, something else can have the same id.\n",
"* But why did the `is` operator evaluated to `False`? Let's see with this snippet.\n"
"- The reason why intransitive equality didn't hold among `dictionary`, `ordered_dict` and `another_ordered_dict` is because of the way `__eq__` method is implemented in `OrderedDict` class. From the [docs](https://docs.python.org/3/library/collections.html#ordereddict-objects)\n",
" \n",
" > Equality tests between OrderedDict objects are order-sensitive and are implemented as `list(od1.items())==list(od2.items())`. Equality tests between `OrderedDict` objects and other Mapping objects are order-insensitive like regular dictionaries.\n",
"- The reason for this equality in behavior is that it allows `OrderedDict` objects to be directly substituted anywhere a regular dictionary is used.\n",
"- Okay, so why did changing the order affect the length of the generated `set` object? The answer is the lack of intransitive equality only. Since sets are \"unordered\" collections of unique elements, the order in which elements are inserted shouldn't matter. But in this case, it does matter. Let's break it down a bit,\n"
" So the inconsistency is due to `another_ordered_dict in another_set` being `False` because `ordered_dict` was already present in `another_set` and as observed before, `ordered_dict == another_ordered_dict` is `False`.\n",
"- When a `return`, `break` or `continue` statement is executed in the `try` suite of a \"try\u2026finally\" statement, the `finally` clause is also executed on the way out.\n",
"- The return value of a function is determined by the last `return` statement executed. Since the `finally` clause always executes, a `return` statement executed in the `finally` clause will always be the last one executed.\n",
"- The caveat here is, if the finally clause executes a `return` or `break` statement, the temporarily saved exception is discarded.\n",
" Where `exprlist` is the assignment target. This means that the equivalent of `{exprlist} = {next_value}` is **executed for each item** in the iterable.\n",
" An interesting example that illustrates this:\n"
" - The assignment statement `i = 10` never affects the iterations of the loop because of the way for loops work in Python. Before the beginning of every iteration, the next item provided by the iterator (`range(4)` in this case) is unpacked and assigned the target list variables (`i` in this case).\n",
"* The `enumerate(some_string)` function yields a new value `i` (a counter going up) and a character from the `some_string` in each iteration. It then sets the (just assigned) `i` key of the dictionary `some_dict` to that character. The unrolling of the loop can be simplified as:\n"
"- In a [generator](https://wiki.python.org/moin/Generators) expression, the `in` clause is evaluated at declaration time, but the conditional clause is evaluated at runtime.\n",
"- So before runtime, `array` is re-assigned to the list `[2, 8, 22]`, and since out of `1`, `8` and `15`, only the count of `8` is greater than `0`, the generator only yields `8`.\n",
"- The differences in the output of `g1` and `g2` in the second part is due the way variables `array_1` and `array_2` are re-assigned values.\n",
"- In the first case, `array_1` is binded to the new object `[1,2,3,4,5]` and since the `in` clause is evaluated at the declaration time it still refers to the old object `[1,2,3,4]` (which is not destroyed).\n",
"- In the second case, the slice assignment to `array_2` updates the same old object `[1,2,3,4]` to `[1,2,3,4,5]`. Hence both the `g2` and `array_2` still have reference to the same object (which has now been updated to `[1,2,3,4,5]`).\n",
"- Okay, going by the logic discussed so far, shouldn't be the value of `list(g)` in the third snippet be `[11, 21, 31, 12, 22, 32, 13, 23, 33]`? (because `array_3` and `array_4` are going to behave just like `array_1`). The reason why (only) `array_4` values got updated is explained in [PEP-289](https://www.python.org/dev/peps/pep-0289/#the-details)\n",
" \n",
" > Only the outermost for-expression is evaluated immediately, the other expressions are deferred until the generator is run.\n",
"- `is not` is a single binary operator, and has behavior different than using `is` and `not` separated.\n",
"- `is not` evaluates to `False` if the variables on either side of the operator point to the same object and `True` otherwise. \n",
"- In the example, `(not None)` evaluates to `True` since the value `None` is `False` in a boolean context, so the expression becomes `'something' is True`.\n",
"<img src=\"https://raw.githubusercontent.com/satwikkansal/wtfpython/refs/heads/master/images/tic-tac-toe/after_row_initialized.svg\" alt=\"Shows a memory segment after row is initialized.\" style=\"display=block; margin:auto\">\n",
"And when the `board` is initialized by multiplying the `row`, this is what happens inside the memory (each of the elements `board[0]`, `board[1]` and `board[2]` is a reference to the same list referred by `row`)\n",
"<img src=\"https://raw.githubusercontent.com/satwikkansal/wtfpython/refs/heads/master/images/tic-tac-toe/after_board_initialized.svg\" alt=\"Shows a memory segment after board is initialized.\" style=\"display=block; margin:auto\">\n",
"We can avoid this scenario here by not using `row` variable to generate `board`. (Asked in [this](https://github.com/satwikkansal/wtfpython/issues/68) issue).\n",
"The values of `x` were different in every iteration prior to appending `some_func` to `funcs`, but all the functions return 6 when they're evaluated after the loop completes.\n",
"powers_of_x = [lambda x: x**i for i in range(10)]\n",
"[f(2) for f in powers_of_x]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"* When defining a function inside a loop that uses the loop variable in its body, the loop function's closure is bound to the *variable*, not its *value*. The function looks up `x` in the surrounding context, rather than using the value of `x` at the time the function is created. So all of the functions use the latest value assigned to the variable for computation. We can see that it's using the `x` from the surrounding context (i.e. *not* a local variable) with:\n"
"* To get the desired behavior you can pass in the loop variable as a named variable to the function. **Why does this work?** Because this will define the variable *inside* the function's scope. It will no longer go to the surrounding (global) scope to look up the variables value but will create a local variable that stores the value of `x` at that point in time.\n",
"- `type` is a [metaclass](https://realpython.com/python-metaclasses/) in Python.\n",
"- **Everything** is an `object` in Python, which includes classes as well as their objects (instances).\n",
"- class `type` is the metaclass of class `object`, and every class (including `type`) has inherited directly or indirectly from `object`.\n",
"- There is no real base class among `object` and `type`. The confusion in the above snippets is arising because we're thinking about these relationships (`issubclass` and `isinstance`) in terms of Python classes. The relationship between `object` and `type` can't be reproduced in pure python. To be more precise the following relationships can't be reproduced in pure Python,\n",
" + class A is an instance of class B, and class B is an instance of class A.\n",
" + class A is an instance of itself.\n",
"- These relationships between `object` and `type` (both being instances of each other as well as themselves) exist in Python because of \"cheating\" at the implementation level.\n",
"The Subclass relationships were expected to be transitive, right? (i.e., if `A` is a subclass of `B`, and `B` is a subclass of `C`, the `A` _should_ a subclass of `C`)\n",
"* Subclass relationships are not necessarily transitive in Python. Anyone is allowed to define their own, arbitrary `__subclasscheck__` in a metaclass.\n",
"* When `issubclass(cls, Hashable)` is called, it simply looks for non-Falsey \"`__hash__`\" method in `cls` or anything it inherits from.\n",
"* Since `object` is hashable, but `list` is non-hashable, it breaks the transitivity relation.\n",
"* More detailed explanation can be found [here](https://www.naftaliharris.com/blog/python-subclass-intransitivity/).\n",
"- Trailing comma is not always legal in formal parameters list of a Python function.\n",
"- In Python, the argument list is defined partially with leading commas and partially with trailing commas. This conflict causes situations where a comma is trapped in the middle, and no rule accepts it.\n",
"- **Note:** The trailing comma problem is [fixed in Python 3.6](https://bugs.python.org/issue9232). The remarks in [this](https://bugs.python.org/issue9232#msg248399) post discuss in brief different usages of trailing commas in Python.\n",
"- In a usual python string, the backslash is used to escape characters that may have a special meaning (like single-quote, double-quote, and the backslash itself).\n"
"- In a raw string literal (as indicated by the prefix `r`), the backslashes pass themselves as is along with the behavior of escaping the following character.\n"
"- This means when a parser encounters a backslash in a raw string, it expects another character following it. And in our case (`print(r\"\\\")`), the backslash escaped the trailing quote, leaving the parser without a terminating quote (hence the `SyntaxError`). That's why backslashes don't work at the end of a raw string.\n",
"* Operator precedence affects how an expression is evaluated, and `==` operator has higher precedence than `not` operator in Python.\n",
"* So `not x == y` is equivalent to `not (x == y)` which is equivalent to `not (True == False)` finally evaluating to `True`.\n",
"* But `x == not y` raises a `SyntaxError` because it can be thought of being equivalent to `(x == not) y` and not `x == (not y)` which you might have expected at first sight.\n",
"* The parser expected the `not` token to be a part of the `not in` operator (because both `==` and `not in` operators have the same precedence), but after not being able to find an `in` token following the `not` token, it raises a `SyntaxError`.\n",
"+ `'''` and `\"\"\"` are also string delimiters in Python which causes a SyntaxError because the Python interpreter was expecting a terminating triple quote as delimiter while scanning the currently encountered triple quoted string literal.\n",
"* See this StackOverflow [answer](https://stackoverflow.com/a/8169049/4354153) for the rationale behind it.\n",
"\n",
"* Initially, Python used to have no `bool` type (people used 0 for false and non-zero value like 1 for true). `True`, `False`, and a `bool` type was added in 2.x versions, but, for backward compatibility, `True` and `False` couldn't be made constants. They just were built-in variables, and it was possible to reassign them\n",
"\n",
"* Python 3 was backward-incompatible, the issue was finally fixed, and thus the last snippet won't work with Python 3.x!\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Class attributes and instance attributes\n",
"* Class variables and variables in class instances are internally handled as dictionaries of a class object. If a variable name is not found in the dictionary of the current class, the parent classes are searched for it.\n",
"* The `+=` operator modifies the mutable object in-place without creating a new object. So changing the attribute of one instance affects the other instances and the class attribute as well.\n",
"+ From Python 3.3 onwards, it became possible to use `return` statement with values inside generators (See [PEP380](https://www.python.org/dev/peps/pep-0380/)). The [official docs](https://www.python.org/dev/peps/pep-0380/#enhancements-to-stopiteration) say that,\n",
"\n",
"> \"... `return expr` in a generator causes `StopIteration(expr)` to be raised upon exit from the generator.\"\n",
"\n",
"+ In the case of `some_func(3)`, `StopIteration` is raised at the beginning because of `return` statement. The `StopIteration` exception is automatically caught inside the `list(...)` wrapper and the `for` loop. Therefore, the above two snippets result in an empty list.\n",
"\n",
"+ To get `[\"wtf\"]` from the generator `some_func` we need to catch the `StopIteration` exception,\n",
"- `'inf'` and `'nan'` are special strings (case-insensitive), which, when explicitly typecast-ed to `float` type, are used to represent mathematical \"infinity\" and \"not a number\" respectively.\n",
"- Since according to IEEE standards ` NaN != NaN`, obeying this rule breaks the reflexivity assumption of a collection element in Python i.e. if `x` is a part of a collection like `list`, the implementations like comparison are based on the assumption that `x == x`. Because of this assumption, the identity is compared first (since it's faster) while comparing two elements, and the values are compared only when the identities mismatch. The following snippet will make things clearer,\n",
" Since the identities of `x` and `y` are different, the values are considered, which are also different; hence the comparison returns `False` this time.\n",
"\n",
"- Interesting read: [Reflexivity, and other pillars of civilization](https://bertrandmeyer.com/2010/02/06/reflexivity-and-other-pillars-of-civilization/)\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Mutating the immutable!\n",
"This might seem trivial if you know how references work in Python.\n",
"* Quoting from https://docs.python.org/3/reference/datamodel.html\n",
"\n",
" > Immutable sequences\n",
" An object of an immutable sequence type cannot change once it is created. (If the object contains references to other objects, these other objects may be mutable and may be modified; however, the collection of objects directly referenced by an immutable object cannot change.)\n",
"\n",
"* `+=` operator changes the list in-place. The item assignment doesn't work, but when the exception occurs, the item has already been changed in place.\n",
"* There's also an explanation in [official Python FAQ](https://docs.python.org/3/faq/programming.html#why-does-a-tuple-i-item-raise-an-exception-when-the-addition-works).\n",
" This means the exception must be assigned to a different name to be able to refer to it after the except clause. Exceptions are cleared because, with the traceback attached to them, they form a reference cycle with the stack frame, keeping all locals in that frame alive until the next garbage collection occurs.\n",
"\n",
"* The clauses are not scoped in Python. Everything in the example is present in the same scope, and the variable `e` got removed due to the execution of the `except` clause. The same is not the case with functions that have their separate inner-scopes. The example below illustrates this:\n",
"* According to [Python language reference](https://docs.python.org/3/reference/simple_stmts.html#assignment-statements), assignment statements have the form\n",
"> An assignment statement evaluates the expression list (remember that this can be a single expression or a comma-separated list, the latter yielding a tuple) and assigns the single resulting object to each of the target lists, from left to right.\n",
"\n",
"* The `+` in `(target_list \"=\")+` means there can be **one or more** target lists. In this case, target lists are `a, b` and `a[b]` (note the expression list is exactly one, which in our case is `{}, 5`).\n",
"\n",
"* After the expression list is evaluated, its value is unpacked to the target lists from **left to right**. So, in our case, first the `{}, 5` tuple is unpacked to `a, b` and we now have `a = {}` and `b = 5`.\n",
"\n",
"* `a` is now assigned to `{}`, which is a mutable object.\n",
"\n",
"* The second target list is `a[b]` (you may expect this to throw an error because both `a` and `b` have not been defined in the statements before. But remember, we just assigned `a` to `{}` and `b` to `5`).\n",
"\n",
"* Now, we are setting the key `5` in the dictionary to the tuple `({}, 5)` creating a circular reference (the `{...}` in the output refers to the same object that `a` is already referencing). Another simpler example of circular reference could be\n"
"* Iteration over a dictionary that you edit at the same time is not supported.\n",
"* It runs eight times because that's the point at which the dictionary resizes to hold more keys (we have eight deletion entries, so a resize is needed). This is actually an implementation detail.\n",
"* How deleted keys are handled and when the resize occurs might be different for different Python implementations.\n",
"* So for Python versions other than Python 2.7 - Python 3.5, the count might be different from 8 (but whatever the count is, it's going to be the same every time you run it). You can find some discussion around this [here](https://github.com/satwikkansal/wtfpython/issues/53) or in [this](https://stackoverflow.com/questions/44763802/bug-in-python-dict) StackOverflow thread.\n",
"* Python 3.7.6 onwards, you'll see `RuntimeError: dictionary keys changed during iteration` exception if you try to do this.\n",
"* When you make an assignment to a variable in scope, it becomes local to that scope. So `a` becomes local to the scope of `another_func`, but it has not been initialized previously in the same scope, which throws an error.\n",
"* To modify the outer scope variable `a` in `another_func`, we have to use the `global` keyword.\n"
"* In `another_closure_func`, `a` becomes local to the scope of `another_inner_func`, but it has not been initialized previously in the same scope, which is why it throws an error. \n",
"* To modify the outer scope variable `a` in `another_inner_func`, use the `nonlocal` keyword. The nonlocal statement is used to refer to variables defined in the nearest outer (excluding the global) scope.\n"
"* The keywords `global` and `nonlocal` tell the python interpreter to not delcare new variables and look them up in the corresponding outer scopes.\n",
"* Read [this](https://sebastianraschka.com/Articles/2014_python_scope_and_namespaces.html) short but an awesome guide to learn more about how namespaces and scope resolution works in Python.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Deleting a list item while iterating\n"
"* It's never a good idea to change the object you're iterating over. The correct way to do so is to iterate over a copy of the object instead, and `list_3[:]` does just that.\n",
"- The list iteration is done index by index, and when we remove `1` from `list_2` or `list_4`, the contents of the lists are now `[2, 3, 4]`. The remaining elements are shifted down, i.e., `2` is at index 0, and `3` is at index 1. Since the next iteration is going to look at index 1 (which is the `3`), the `2` gets skipped entirely. A similar thing will happen with every alternate element in the list sequence.\n",
"* Refer to this StackOverflow [thread](https://stackoverflow.com/questions/45946228/what-happens-when-you-try-to-delete-a-list-element-while-iterating-over-it) explaining the example\n",
"* See also this nice StackOverflow [thread](https://stackoverflow.com/questions/45877614/how-to-change-all-the-dictionary-keys-in-a-for-loop-with-d-items) for a similar example related to dictionaries in Python.\n",
"- So the function takes in arbitrary number of iterable objects, adds each of their items to the `result` list by calling the `next` function on them, and stops whenever any of the iterable is exhausted. \n",
"- The caveat here is when any iterable is exhausted, the existing elements in the `result` list are discarded. That's what happened with `3` in the `numbers_iter`.\n",
"- The correct way to do the above using `zip` would be,\n"
"- In Python, for-loops use the scope they exist in and leave their defined loop-variable behind. This also applies if we explicitly defined the for-loop variable in the global namespace before. In this case, it will rebind the existing variable.\n",
"\n",
"- The differences in the output of Python 2.x and Python 3.x interpreters for list comprehension example can be explained by following change documented in [What\u2019s New In Python 3.0](https://docs.python.org/3/whatsnew/3.0.html) changelog:\n",
"\n",
" > \"List comprehensions no longer support the syntactic form `[... for var in item1, item2, ...]`. Use `[... for var in (item1, item2, ...)]` instead. Also, note that list comprehensions have different semantics: they are closer to syntactic sugar for a generator expression inside a `list()` constructor, and in particular, the loop control variables are no longer leaked into the surrounding scope.\"\n",
"- The default mutable arguments of functions in Python aren't really initialized every time you call the function. Instead, the recently assigned value to them is used as the default value. When we explicitly passed `[]` to `some_func` as the argument, the default value of the `default_arg` variable was not used, so the function returned as expected.\n",
"- A common practice to avoid bugs due to mutable arguments is to assign `None` as the default value and later check if any value is passed to the function corresponding to that argument. Example:\n",
"* To add multiple Exceptions to the except clause, you need to pass them as parenthesized tuple as the first argument. The second argument is an optional name, which when supplied will bind the Exception instance that has been raised. Example,\n"
" IndentationError: unindent does not match any outer indentation level\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"* Separating the exception from the variable with a comma is deprecated and does not work in Python 3; the correct way is to use `as`. Example,\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" some_list = [1, 2, 3]\n",
" try:\n",
" some_list.remove(4)\n",
"\n",
" except (IndexError, ValueError) as e:\n",
" print(\"Caught again!\")\n",
" print(e)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
" **Output:**\n",
" ```\n",
" Caught again!\n",
" list.remove(x): x not in list\n",
" ```\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Same operands, different story!\n",
"1\\.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = [1, 2, 3, 4]\n",
"b = a\n",
"a = a + [5, 6, 7, 8]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"[1, 2, 3, 4, 5, 6, 7, 8]\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"[1, 2, 3, 4]\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"b\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"2\\.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = [1, 2, 3, 4]\n",
"b = a\n",
"a += [5, 6, 7, 8]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"[1, 2, 3, 4, 5, 6, 7, 8]\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"[1, 2, 3, 4, 5, 6, 7, 8]\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"b\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"\n",
"* `a += b` doesn't always behave the same way as `a = a + b`. Classes *may* implement the *`op=`* operators differently, and lists do this.\n",
"\n",
"* The expression `a = a + [5,6,7,8]` generates a new list and sets `a`'s reference to that new list, leaving `b` unchanged.\n",
"\n",
"* The expression `a += [5,6,7,8]` is actually mapped to an \"extend\" function that operates on the list such that `a` and `b` still point to the same list that has been modified in-place.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Name resolution ignoring class scope\n",
"1\\.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"x = 5\n",
"class SomeClass:\n",
" x = 17\n",
" y = (x for i in range(10))\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"5\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"list(SomeClass.y)[0]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"2\\.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"x = 5\n",
"class SomeClass:\n",
" x = 17\n",
" y = [x for i in range(10)]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output (Python 2.x):**\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"17\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"SomeClass.y[0]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output (Python 3.x):**\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"5\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"SomeClass.y[0]\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation\n",
"- Scopes nested inside class definition ignore names bound at the class level.\n",
"- A generator expression has its own scope.\n",
"- Starting from Python 3.X, list comprehensions also have their own scope.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Needles in a Haystack *\n",
"I haven't met even a single experience Pythonist till date who has not come across one or more of the following scenarios,\n",
"\n",
"1\\.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"x, y = (0, 1) if True else None, None\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"((0, 1), None)\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"x, y # expected (0, 1)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"2\\.\n",
"\n"
]
},
{
"cell_type": "code",
"metadata": {
"collapsed": true
},
"execution_count": null,
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": []
}
],
"source": [
"t = ('one', 'two')\n",
"for i in t:\n",
" print(i)\n",
"\n",
"t = ('one')\n",
"for i in t:\n",
" print(i)\n",
"\n",
"t = ()\n",
"print(t)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"one\n",
"two\n",
"o\n",
"n\n",
"e\n",
"tuple()\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"3\\.\n",
"\n",
"```\n",
"ten_words_list = [\n",
" \"some\",\n",
" \"very\",\n",
" \"big\",\n",
" \"list\",\n",
" \"that\"\n",
" \"consists\",\n",
" \"of\",\n",
" \"exactly\",\n",
" \"ten\",\n",
" \"words\"\n",
"]\n",
"```\n",
"\n",
"**Output**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"9\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"len(ten_words_list)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"4\\. Not asserting strongly enough\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"a = \"python\"\n",
"b = \"javascript\"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"# No AssertionError is raised\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"# An assert statement with an assertion failure message.\n",
"assert(a == b, \"Both languages are different\")\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"5\\.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"some_list = [1, 2, 3]\n",
"some_dict = {\n",
" \"key_1\": 1,\n",
" \"key_2\": 2,\n",
" \"key_3\": 3\n",
"}\n",
"\n",
"some_list = some_list.append(4) \n",
"some_dict = some_dict.update({\"key_4\": 4})\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n",
"\n"
]
},
{
"cell_type": "code",
"metadata": {
"collapsed": true
},
"execution_count": null,
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"None\n"
]
}
],
"source": [
"print(some_list)\n"
]
},
{
"cell_type": "code",
"metadata": {
"collapsed": true
},
"execution_count": null,
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"None\n"
]
}
],
"source": [
"print(some_dict)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"6\\.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"def some_recursive_func(a):\n",
" if a[0] == 0:\n",
" return\n",
" a[0] -= 1\n",
" some_recursive_func(a)\n",
" return a\n",
"\n",
"def similar_recursive_func(a):\n",
" if a == 0:\n",
" return a\n",
" a -= 1\n",
" similar_recursive_func(a)\n",
" return a\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output:**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"[0, 0]\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"some_recursive_func([5, 0])\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"4\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"similar_recursive_func(5)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"\n",
"* For 1, the correct statement for expected behavior is `x, y = (0, 1) if True else (None, None)`.\n",
"\n",
"* For 2, the correct statement for expected behavior is `t = ('one',)` or `t = 'one',` (missing comma) otherwise the interpreter considers `t` to be a `str` and iterates over it character by character.\n",
"\n",
"* `()` is a special token and denotes empty `tuple`.\n",
"\n",
"* In 3, as you might have already figured out, there's a missing comma after 5th element (`\"that\"`) in the list. So by implicit string literal concatenation,\n",
"* No `AssertionError` was raised in 4th snippet because instead of asserting the individual expression `a == b`, we're asserting entire tuple. The following snippet will clear things up,\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" Traceback (most recent call last):\n",
" File \"<stdin>\", line 1, in <module>\n",
" AssertionError\n",
" \n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" a = \"python\"\n",
" b = \"javascript\"\n",
" assert a == b\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" <stdin>:1: SyntaxWarning: assertion is always true, perhaps remove parentheses?\n",
" \n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" assert (a == b, \"Values are not equal\")\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" Traceback (most recent call last):\n",
" File \"<stdin>\", line 1, in <module>\n",
" AssertionError: Values are not equal\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" assert a == b, \"Values are not equal\"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"* As for the fifth snippet, most methods that modify the items of sequence/mapping objects like `list.append`, `dict.update`, `list.sort`, etc. modify the objects in-place and return `None`. The rationale behind this is to improve performance by avoiding making a copy of the object if the operation can be done in-place (Referred from [here](https://docs.python.org/3/faq/design.html#why-doesn-t-list-sort-return-the-sorted-list)).\n",
"\n",
"* Last one should be fairly obvious, mutable object (like `list`) can be altered in the function, and the reassignation of an immutable (`a -= 1`) is not an alteration of the value.\n",
"\n",
"* Being aware of these nitpicks can save you hours of debugging effort in the long run. \n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Splitsies *\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"['a']\n",
"\n",
"# is same as\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"'a'.split()\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"['a']\n",
"\n",
"# but\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"'a'.split(' ')\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"0\n",
"\n",
"# isn't the same as\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"len(''.split())\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"1\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"len(''.split(' '))\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"\n",
"- It might appear at first that the default separator for split is a single space `' '`, but as per the [docs](https://docs.python.org/3/library/stdtypes.html#str.split)\n",
" > If sep is not specified or is `None`, a different splitting algorithm is applied: runs of consecutive whitespace are regarded as a single separator, and the result will contain no empty strings at the start or end if the string has leading or trailing whitespace. Consequently, splitting an empty string or a string consisting of just whitespace with a None separator returns `[]`.\n",
" > If sep is given, consecutive delimiters are not grouped together and are deemed to delimit empty strings (for example, `'1,,2'.split(',')` returns `['1', '', '2']`). Splitting an empty string with a specified separator returns `['']`.\n",
"- Noticing how the leading and trailing whitespaces are handled in the following snippet will make things clear,\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" ['', 'a', '']\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" ' a '.split(' ')\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" ['a']\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" ' a '.split()\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" ['']\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" ''.split(' ')\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 All sorted? *\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"False\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"x = 7, 8, 9\n",
"sorted(x) == x\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"True\n",
"\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"sorted(x) == sorted(x)\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
"False\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"y = reversed(x)\n",
"sorted(y) == sorted(y)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"\n",
"- The `sorted` method always returns a list, and comparing lists and tuples always returns `False` in Python. \n",
"\n",
"- ```py\n",
" >>> [] == tuple()\n",
" False\n",
" >>> x = 7, 8, 9\n",
" >>> type(x), type(sorted(x))\n",
" (tuple, list)\n",
" ```\n",
"\n",
"- Unlike `sorted`, the `reversed` method returns an iterator. Why? Because sorting requires the iterator to be either modified in-place or use an extra container (a list), whereas reversing can simply work by iterating from the last index to the first.\n",
"\n",
"- So during comparison `sorted(y) == sorted(y)`, the first call to `sorted()` will consume the iterator `y`, and the next call will just return an empty list.\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": [
" ([7, 8, 9], [])\n"
]
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
" x = 7, 8, 9\n",
" y = reversed(x)\n",
" sorted(y), sorted(y)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Midnight time doesn't exist?\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"from datetime import datetime\n",
"\n",
"midnight = datetime(2018, 1, 1, 0, 0)\n",
"midnight_time = midnight.time()\n",
"\n",
"noon = datetime(2018, 1, 1, 12, 0)\n",
"noon_time = noon.time()\n",
"\n",
"if midnight_time:\n",
" print(\"Time at midnight is\", midnight_time)\n",
"\n",
"if noon_time:\n",
" print(\"Time at noon is\", noon_time)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output (< 3.5):**\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [
{
"data": {
"text/plain": []
},
"output_type": "execute_result",
"metadata": {},
"execution_count": null
}
],
"source": [
"('Time at noon is', datetime.time(12, 0))\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The midnight time is not printed.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"\n",
"Before Python 3.5, the boolean value for `datetime.time` object was considered to be `False` if it represented midnight in UTC. It is error-prone when using the `if obj:` syntax to check if the `obj` is null or some equivalent of \"empty.\"\n",
"+ `antigravity` module is one of the few easter eggs released by Python developers.\n",
"+ `import antigravity` opens up a web browser pointing to the [classic XKCD comic](https://xkcd.com/353/) about Python.\n",
"+ Well, there's more to it. There's **another easter egg inside the easter egg**. If you look at the [code](https://github.com/python/cpython/blob/master/Lib/antigravity.py#L7-L17), there's a function defined that purports to implement the [XKCD's geohashing algorithm](https://xkcd.com/426/).\n",
"- A working version of `goto` in Python was [announced](https://mail.python.org/pipermail/python-announce-list/2004-April/002982.html) as an April Fool's joke on 1st April 2004.\n",
"- Current versions of Python do not have this module.\n",
"- Although it works, but please don't use it. Here's the [reason](https://docs.python.org/3/faq/design.html#why-is-there-no-goto) to why `goto` is not present in Python.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Brace yourself!\n",
"If you are one of the people who doesn't like using whitespace in Python to denote scopes, you can use the C-style {} by importing,\n",
"Braces? No way! If you think that's disappointing, use Java. Okay, another surprising thing, can you find where's the `SyntaxError` raised in `__future__` module [code](https://github.com/python/cpython/blob/master/Lib/__future__.py)?\n",
"+ The `__future__` module is normally used to provide features from future versions of Python. The \"future\" in this specific context is however, ironic.\n",
"+ This is an easter egg concerned with the community's feelings on this issue.\n",
"+ The code is actually present [here](https://github.com/python/cpython/blob/025eb98dc0c1dc27404df6c544fc2944e0fa9f3a/Python/future.c#L49) in `future.c` file.\n",
"+ When the CPython compiler encounters a [future statement](https://docs.python.org/3.3/reference/simple_stmts.html#future-statements), it first runs the appropriate code in `future.c` before treating it as a normal import statement.\n",
"- This is relevant to [PEP-401](https://www.python.org/dev/peps/pep-0401/) released on April 1, 2009 (now you know, what it means).\n",
"- Quoting from the PEP-401\n",
" \n",
" > Recognized that the != inequality operator in Python 3.0 was a horrible, finger-pain inducing mistake, the FLUFL reinstates the <> diamond operator as the sole spelling.\n",
"- There were more things that Uncle Barry had to share in the PEP; you can read them [here](https://www.python.org/dev/peps/pep-0401/).\n",
"- It works well in an interactive environment, but it will raise a `SyntaxError` when you run via python file (see this [issue](https://github.com/satwikkansal/wtfpython/issues/94)). However, you can wrap the statement inside an `eval` or `compile` to get it working,\n"
"* `this` module in Python is an easter egg for The Zen Of Python ([PEP 20](https://www.python.org/dev/peps/pep-0020)).\n",
"* And if you think that's already interesting enough, check out the implementation of [this.py](https://hg.python.org/cpython/file/c3896275c0f6/Lib/this.py). Interestingly, **the code for the Zen violates itself** (and that's probably the only place where this happens).\n",
"* Regarding the statement `love is not True or False; love is love`, ironic but it's self-explanatory (if not, please see the examples related to `is` and `is not` operators).\n",
"- The `else` clause after a loop is executed only when there's no explicit `break` after all the iterations. You can think of it as a \"nobreak\" clause.\n",
"- `else` clause after a try block is also called \"completion clause\" as reaching the `else` clause in a `try` statement means that the try block actually completed successfully.\n",
" So our `three_dimensional_array` is an array of array of arrays. Let's say we want to print the second element (index `1`) of all the innermost arrays, we can use Ellipsis to bypass all the preceding dimensions\n"
" three_dimensional_array[..., 1] # using Ellipsis.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
" Note: this will work for any number of dimensions. You can even select slice in first and last dimension and ignore the middle ones this way (`n_dimensional_array[firs_dim_slice, ..., last_dim_slice]`)\n",
" + In [type hinting](https://docs.python.org/3/library/typing.html) to indicate only a part of the type (like `(Callable[..., int]` or `Tuple[str, ...]`))\n",
" + You may also use Ellipsis as a default function argument (in the cases when you want to differentiate between the \"no argument passed\" and \"None value passed\" scenarios).\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### \u25b6 Inpinity\n",
"The spelling is intended. Please, don't submit a patch for this.\n",
"* [Name Mangling](https://en.wikipedia.org/wiki/Name_mangling) is used to avoid naming collisions between different namespaces.\n",
"* In Python, the interpreter modifies (mangles) the class member names starting with `__` (double underscore a.k.a \"dunder\") and not ending with more than one trailing underscore by adding `_NameOfTheClass` in front.\n",
"* So, to access `__honey` attribute in the first snippet, we had to append `_Yo` to the front, which would prevent conflicts with the same name attribute defined in any other class.\n",
"* But then why didn't it work in the second snippet? Because name mangling excludes the names ending with double underscores.\n",
"* The third snippet was also a consequence of name mangling. The name `__variable` in the statement `return __variable` was mangled to `_A__variable`, which also happens to be the name of the variable we declared in the outer scope.\n",
"* Also, if the mangled name is longer than 255 characters, truncation will happen.\n",
"The built-in `ord()` function returns a character's Unicode [code point](https://en.wikipedia.org/wiki/Code_point), and different code positions of Cyrillic 'e' and Latin 'e' justify the behavior of the above example.\n",
"* Notice that the numpy array created in the `energy_send` function is not returned, so that memory space is free to reallocate.\n",
"* `numpy.empty()` returns the next free memory slot without reinitializing it. This memory spot just happens to be the same one that was just freed (usually, but not always).\n",
"* **Don't mix tabs and spaces!** The character just preceding return is a \"tab\", and the code is indented by multiple of \"4 spaces\" elsewhere in the example.\n",
"* This is how Python handles tabs:\n",
" \n",
" > First, tabs are replaced (from left to right) by one to eight spaces such that the total number of characters up to and including the replacement is a multiple of eight <...>\n",
"* So the \"tab\" at the last line of `square` function is replaced with eight spaces, and it gets into the loop.\n",
"* Python 3 is kind enough to throw an error for such cases automatically.\n",
"+ `+=` is faster than `+` for concatenating more than two strings because the first string (example, `s1` for `s1 += s2 + s3`) is not destroyed while calculating the complete string.\n",
"- You can read more about [timeit](https://docs.python.org/3/library/timeit.html) or [%timeit](https://ipython.org/ipython-doc/dev/interactive/magics.html#magic-timeit) on these links. They are used to measure the execution time of code pieces.\n",
"- Don't use `+` for generating long strings \u2014 In Python, `str` is immutable, so the left and right strings have to be copied into the new string for every pair of concatenations. If you concatenate four strings of length 10, you'll be copying (10+10) + ((10+10)+10) + (((10+10)+10)+10) = 90 characters instead of just 40 characters. Things get quadratically worse as the number and size of the string increases (justified with the execution times of `add_bytes_with_plus` function)\n",
"- Therefore, it's advised to use `.format.` or `%` syntax (however, they are slightly slower than `+` for very short strings).\n",
"- Or better, if already you've contents available in the form of an iterable object, then use `''.join(iterable_object)` which is much faster.\n",
"- Unlike `add_bytes_with_plus` because of the `+=` optimizations discussed in the previous example, `add_string_with_plus` didn't show a quadratic increase in execution time. Had the statement been `s = s + \"x\" + \"y\" + \"z\"` instead of `s += \"xyz\"`, the increase would have been quadratic.\n"
"- So many ways to format and create a giant string are somewhat in contrast to the [Zen of Python](https://www.python.org/dev/peps/pep-0020/), according to which,\n",
" \n",
" > There should be one-- and preferably only one --obvious way to do it.\n",
"+ CPython has a generic dictionary lookup function that handles all types of keys (`str`, `int`, any object ...), and a specialized one for the common case of dictionaries composed of `str`-only keys.\n",
"+ The specialized function (named `lookdict_unicode` in CPython's [source](https://github.com/python/cpython/blob/522691c46e2ae51faaad5bbbce7d959dd61770df/Objects/dictobject.c#L841)) knows all existing keys (including the looked-up key) are strings, and uses the faster & simpler string comparison to compare keys, instead of calling the `__eq__` method.\n",
"+ The first time a `dict` instance is accessed with a non-`str` key, it's modified so future lookups use the generic function.\n",
"+ This process is not reversible for the particular `dict` instance, and the key doesn't even have to exist in the dictionary. That's why attempting a failed lookup has the same effect.\n",
"What makes those dictionaries become bloated? And why are newly created objects bloated as well?\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation:\n",
"+ CPython is able to reuse the same \"keys\" object in multiple dictionaries. This was added in [PEP 412](https://www.python.org/dev/peps/pep-0412/) with the motivation to reduce memory usage, specifically in dictionaries of instances - where keys (instance attributes) tend to be common to all instances.\n",
"+ This optimization is entirely seamless for instance dictionaries, but it is disabled if certain assumptions are broken.\n",
"+ Key-sharing dictionaries do not support deletion; if an instance attribute is deleted, the dictionary is \"unshared\", and key-sharing is disabled for all future instances of the same class.\n",
"+ Additionaly, if the dictionary keys have be resized (because new keys are inserted), they are kept shared *only* if they are used by a exactly single dictionary (this allows adding many attributes in the `__init__` of the very first created instance, without causing an \"unshare\"). If multiple instances exist when a resize happens, key-sharing is disabled for all future instances of the same class: CPython can't tell if your instances are using the same set of attributes anymore, and decides to bail out on attempting to share their keys.\n",
"+ A small tip, if you aim to lower your program's memory footprint: don't delete instance attributes, and make sure to initialize all attributes in your `__init__`!\n",
"* `join()` is a string operation instead of list operation. (sort of counter-intuitive at first usage)\n",
"\n",
" **\ud83d\udca1 Explanation:** If `join()` is a method on a string, then it can operate on any iterable (list, tuple, iterators). If it were a method on a list, it'd have to be implemented separately by every type. Also, it doesn't make much sense to put a string-specific method on a generic `list` object API.\n",
" \n",
"* Few weird looking but semantically correct statements:\n",
" + `[] = ()` is a semantically correct statement (unpacking an empty `tuple` into an empty `list`)\n",
" + `'a'[0][0][0][0][0]` is also a semantically correct statement as strings are [sequences](https://docs.python.org/3/glossary.html#term-sequence)(iterables supporting element access using integer indices) in Python.\n",
" + `3 --0-- 5 == 8` and `--5 == 5` are both semantically correct statements and evaluate to `True`.\n",
"\n",
"* Given that `a` is a number, `++a` and `--a` are both valid Python statements but don't behave the same way as compared with similar statements in languages like C, C++, or Java.\n",
" ```py\n",
" >>> a = 5\n",
" >>> a\n",
" 5\n",
" >>> ++a\n",
" 5\n",
" >>> --a\n",
" 5\n",
" ```\n",
"\n",
" **\ud83d\udca1 Explanation:**\n",
" + There is no `++` operator in Python grammar. It is actually two `+` operators.\n",
" + `++a` parses as `+(+a)` which translates to `a`. Similarly, the output of the statement `--a` can be justified.\n",
" + This StackOverflow [thread](https://stackoverflow.com/questions/3654830/why-are-there-no-and-operators-in-python) discusses the rationale behind the absence of increment and decrement operators in Python.\n",
"\n",
"* You must be aware of the Walrus operator in Python. But have you ever heard about *the space-invader operator*?\n",
" ```py\n",
" >>> a = 42\n",
" >>> a -=- 1\n",
" >>> a\n",
" 43\n",
" ```\n",
" It is used as an alternative incrementation operator, together with another one\n",
" ```py\n",
" >>> a +=+ 1\n",
" >>> a\n",
" >>> 44\n",
" ```\n",
" **\ud83d\udca1 Explanation:** This prank comes from [Raymond Hettinger's tweet](https://twitter.com/raymondh/status/1131103570856632321?lang=en). The space invader operator is actually just a malformatted `a -= (-1)`. Which is equivalent to `a = a - (- 1)`. Similar for the `a += (+ 1)` case.\n",
" \n",
"* Python has an undocumented [converse implication](https://en.wikipedia.org/wiki/Converse_implication) operator. \n",
" \n",
" ```py\n",
" >>> False ** False == True\n",
" True\n",
" >>> False ** True == False\n",
" True\n",
" >>> True ** False == True\n",
" True\n",
" >>> True ** True == True\n",
" True\n",
" ```\n",
"\n",
" **\ud83d\udca1 Explanation:** If you replace `False` and `True` by 0 and 1 and do the maths, the truth table is equivalent to a converse implication operator. ([Source](https://github.com/cosmologicon/pywat/blob/master/explanation.md#the-undocumented-converse-implication-operator))\n",
" \n",
"* Since we are talking operators, there's also `@` operator for matrix multiplication (don't worry, this time it's for real).\n",
" **\ud83d\udca1 Explanation:** The `@` operator was added in Python 3.5 keeping the scientific community in mind. Any object can overload `__matmul__` magic method to define behavior for this operator.\n",
"\n",
"* From Python 3.8 onwards you can use a typical f-string syntax like `f'{some_var=}` for quick debugging. Example,\n",
"* Python uses 2 bytes for local variable storage in functions. In theory, this means that only 65536 variables can be defined in a function. However, python has a handy solution built in that can be used to store more than 2^16 variable names. The following code demonstrates what happens in the stack when more than 65536 local variables are defined (Warning: This code prints around 2^18 lines of text, so be prepared!):\n",
" \n",
" ```py\n",
" import dis\n",
" exec(\"\"\"\n",
" def f():\n",
" \"\"\" + \"\"\"\n",
" \"\"\".join([\"X\" + str(x) + \"=\" + str(x) for x in range(65539)]))\n",
"* Multiple Python threads won't run your *Python code* concurrently (yes, you heard it right!). It may seem intuitive to spawn several threads and let them execute your Python code concurrently, but, because of the [Global Interpreter Lock](https://wiki.python.org/moin/GlobalInterpreterLock) in Python, all you're doing is making your threads execute on the same core turn by turn. Python threads are good for IO-bound tasks, but to achieve actual parallelization in Python for CPU-bound tasks, you might want to use the Python [multiprocessing](https://docs.python.org/3/library/multiprocessing.html) module.\n",
" This will print the `wtfpython` after 3 seconds due to the `end` argument because the output buffer is flushed either after encountering `\\n` or when the program finishes execution. We can force the buffer to flush by passing `flush=True` argument.\n",
"* `int('\u0661\u0662\u0663\u0664\u0665\u0666\u0667\u0668\u0669')` returns `123456789` in Python 3. In Python, Decimal characters include digit characters, and all characters that can be used to form decimal-radix numbers, e.g. U+0660, ARABIC-INDIC DIGIT ZERO. Here's an [interesting story](https://chris.improbable.org/2014/8/25/adventures-in-unicode-digits/) related to this behavior of Python.\n",
">>> (a, b := 16, 19) # This prints out a weird 3-tuple\n",
"```\n",
"```py\n",
"(6, 16, 19)\n",
"\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
">>> a # a is still unchanged?\n",
"```\n",
"```py\n",
"6\n",
"\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
">>> b\n",
"```\n",
"```py\n",
"16\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### \ud83d\udca1 Explanation\n",
"\n",
"**Quick walrus operator refresher**\n",
"\n",
"The Walrus operator (`:=`) was introduced in Python 3.8, it can be useful in situations where you'd want to assign values to variables within an expression.\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
"def some_func():\n",
" # Assume some expensive computation here\n",
" # time.sleep(1000)\n",
" return 5\n",
"\n",
"# So instead of,\n",
"if some_func():\n",
" print(some_func()) # Which is bad practice since computation is happening twice\n",
"\n",
"# or\n",
"a = some_func()\n",
"if a:\n",
" print(a)\n",
"\n",
"# Now you can concisely write\n",
"if a := some_func():\n",
" print(a)\n",
"```\n",
"```py\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Output (> 3.8):**\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
"5\n",
"5\n",
"5\n",
"```\n",
"```py\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"This saved one line of code, and implicitly prevented invoking `some_func` twice.\n",
"\n",
"- Unparenthesized \"assignment expression\" (use of walrus operator), is restricted at the top level, hence the `SyntaxError` in the `a := \"wtf_walrus\"` statement of the first snippet. Parenthesizing it worked as expected and assigned `a`. \n",
"\n",
"- As usual, parenthesizing of an expression containing `=` operator is not allowed. Hence the syntax error in `(a, b = 6, 9)`. \n",
"- The syntax of the Walrus operator is of the form `NAME:= expr`, where `NAME` is a valid identifier, and `expr` is a valid expression. Hence, iterable packing and unpacking are not supported which means, \n",
"Phew, deleted at last. You might have guessed what saved `__del__` from being called in our first attempt to delete `x`. Let's add more twists to the example.\n",
"+ When `del x` is encountered, Python deletes the name `x` from current scope and decrements by 1 the reference count of the object `x` referenced. `__del__()` is called only when the object's reference count reaches zero.\n",
"+ In the second output snippet, `__del__()` was not called because the previous statement (`>>> y`) in the interactive interpreter created another reference to the same object (specifically, the `_` magic variable which references the result value of the last non `None` expression on the REPL), thus preventing the reference count from reaching zero when `del y` was encountered.\n",
"+ Calling `globals` (or really, executing anything that will have a non `None` result) caused `_` to reference the new result, dropping the existing reference. Now the reference count reached 0 and we can see \"Deleted!\" being printed (finally!).\n",
"- It is often advisable to not use wildcard imports. The first obvious reason for this is, in wildcard imports, the names with a leading underscore don't get imported. This may lead to errors during runtime.\n",
"- Had we used `from ... import a, b, c` syntax, the above `NameError` wouldn't have occurred.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
" >>> from module import some_weird_name_func_, _another_weird_name_func\n",
" >>> _another_weird_name_func()\n",
"```\n",
"```py\n",
" works!\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"- If you really want to use wildcard imports, then you'd have to define the list `__all__` in your module that will contain a list of public objects that'll be available when we do wildcard imports.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
" __all__ = ['_another_weird_name_func']\n",
"\n",
" def some_weird_name_func_():\n",
" print(\"works!\")\n",
"\n",
" def _another_weird_name_func():\n",
" print(\"works!\")\n",
"```\n",
"```py\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
" **Output**\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
" >>> _another_weird_name_func()\n",
"```\n",
"```py\n",
" \"works!\"\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"```py\n",
" >>> some_weird_name_func_()\n",
"```\n",
"```py\n",
" Traceback (most recent call last):\n",
" File \"<stdin>\", line 1, in <module>\n",
" NameError: name 'some_weird_name_func_' is not defined\n",
"```\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Contributing\n",
"\n",
"A few ways in which you can contribute to wtfpython,\n",
"\n",
"- Suggesting new examples\n",
"- Helping with translation (See [issues labeled translation](https://github.com/satwikkansal/wtfpython/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation))\n",
"- Minor corrections like pointing out outdated snippets, typos, formatting errors, etc.\n",
"- Identifying gaps (things like inadequate explanation, redundant examples, etc.)\n",
"- Any creative suggestions to make this project more fun and useful\n",
"\n",
"Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for more details. Feel free to create a new [issue](https://github.com/satwikkansal/wtfpython/issues/new) to discuss things.\n",
"\n",
"PS: Please don't reach out with backlinking requests, no links will be added unless they're highly relevant to the project.\n",
"\n",
"# Acknowledgements\n",
"\n",
"The idea and design for this collection were initially inspired by Denys Dovhan's awesome project [wtfjs](https://github.com/denysdovhan/wtfjs). The overwhelming support by Pythonistas gave it the shape it is in right now.\n",
"* WFTPython discussion threads on [Hacker News](https://news.ycombinator.com/item?id=21862073) and [Reddit](https://www.reddit.com/r/programming/comments/edsh3q/what_the_fck_python_30_exploring_and/).\n",
