Merge pull request #334 from nifadyev/master

Change link to Russian translation (follow up to PR #325)

.gitignore

@@ -1,5 +1,18 @@
+.DS_Store
+
 node_modules
 npm-debug.log
 wtfpython-pypi/build/
 wtfpython-pypi/dist/
 wtfpython-pypi/wtfpython.egg-info
+
+# Python-specific byte-compiled files should be ignored
+__pycache__/
+*.py[cod]
+*$py.class
+
+irrelevant/.ipynb_checkpoints/
+
+irrelevant/.python-version
+
+.idea/

.npmignore

@@ -1 +0,0 @@
-irrelevant/

.travis.yml

@@ -0,0 +1,3 @@
+language: python
+install: pip install flake8
+script: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics

CONTRIBUTING.md

@@ -1,10 +1,8 @@
-All kinds of patches are welcome. Feel free to even suggest some catchy and funny titles for the existing Examples. The goal is to make this collection as interesting to read as possible.
+All kinds of patches are welcome. Feel free to even suggest some catchy and funny titles for the existing Examples. The goal is to make this collection as interesting to read as possible. Here are a few ways through which you can contribute,
 
-If the changes you suggest are siginificant, filing an issue before submitting the actual patch will be appreciated. If you'd like to work on the issue (highly encouraged), you can mention that you're interested in working on it while creating the issue and get assigned to it.
-
-If you're adding a new example, please do create an issue to discuss it before submitting a patch.
-
-You can use the following template for adding a new example:
+- If you are interested in translating the project to another language (some people have done that in the past), please feel free to open up an issue, and let me know if you need any kind of help.
+- If the changes you suggest are significant, filing an issue before submitting the actual patch will be appreciated. If you'd like to work on the issue (highly encouraged), you can mention that you're interested in working on it while creating the issue and get assigned to it.
+- If you're adding a new example, it is highly recommended to create an issue to discuss it before submitting a patch. You can use the following template for adding a new example:
 
 <pre>
 ### ▶ Some fancy Title *
@@ -27,10 +25,39 @@ Probably unexpected output
   ```py
   Setting up examples for clarification (if necessary)
   ```
-  **Outupt:**
+  **Output:**
   ```py
   >>> trigger # some example that makes it easy to unveil the magic
   # some justified output
   ```
 ```
 </pre>
+
+
+Few things that you can consider while writing an example, 
+
+- If you are choosing to submit a new example without creating an issue and discussing, please check the project to make sure there aren't similar examples already.
+- Try to be consistent with the namings and the values you use with the variables. For instance, most variable names in the project are along the lines of `some_string`, `some_list`, `some_dict`, etc. You'd see a lot of `x`s for single letter variable names, and `"wtf"` as values for strings. There's no strictly enforced scheme in the project as such, but you can take a glance at other examples to get a gist.
+- Try to be as creative as possible to add that element of "surprise" in the setting up part of an example. Sometimes this may mean writing a snippet a sane programmer would never write.
+- Also, feel free to add your name to the [contributors list](/CONTRIBUTORS.md).
+
+**Some FAQs**
+
+    What is is this after every snippet title (###) in the README: <!-- Example ID: 30f1d3fc-e267-4b30-84ef-4d9e7091ac1a --->? Should it be added manually or can it be ignored when creating new snippets?
+
+That's a random UUID, it is used to keep identify the examples across multiple translations of the project. As a contributor, you don't have to worry about behind the scenes of how it is used, you just have to add a new random UUID to new examples in that format.
+
+    Where should new snippets be added? Top/bottom of the section, doesn't ?
+
+There are multiple things that are considered to decide the order (the dependency on the other examples, difficulty level, category, etc). I'd suggest simply adding the new example at the bottom of a section you find more fitting (or just add it to the Miscellaneous section). Its order will be taken care of in future revisions.
+
+    What's the difference between the sections (the first two feel very similar)?
+
+The section "Strain your brain" contains more contrived examples that you may not really encounter in real life, whereas the section "Slippery Slopes" contains examples that have the potential to be encountered more frequently while programming.
+
+    Before the table of contents it says that markdown-toc -i README.md --maxdepth 3 was used to create it. The pip package markdown-toc does not contain either -i or --maxdepth flags. Which package is meant, or what version of that package?
+    Should the new table of contents entry for the snippet be created with the above command or created manually (in case the above command does more than only add the entry)?
+
+We use the [markdown-toc](https://www.npmjs.com/package/markdown-toc) npm package to generate ToC. It has some issues with special characters though (I'm not sure if it's fixed yet). More often than not, I just end up inserting the toc link manually at the right place. The tool is handy when I have to big reordering, otherwise just updating toc manually is more convenient imo.
+
+If you have any questions feel free to ask on [this issue](https://github.com/satwikkansal/wtfpython/issues/269) (thanks to [@LiquidFun](https://github.com/LiquidFun) for starting it).

CONTRIBUTORS.md

@@ -1,13 +1,42 @@
-I'm really greatful to all the contributors. Following are the wonderful people (in no specific order) who have contributed their examples to wtfpython.
+Following are the wonderful people (in no specific order) who have contributed their examples to wtfpython.
 
 | Contributor | Github | Issues |
 |-------------|--------|--------|
-| Lucas-C | [Lucas-C](https://github.com/Lucas-C) | [#36](https:/github.com/satwikkansal/wtfpython/issues/36) |
-| MittalAshok | [MittalAshok](https://github.com/MittalAshok) | [#23](https:/github.com/satwikkansal/wtfpython/issues/23) |
-| asottile | [asottile](https://github.com/asottile) | [#40](https:/github.com/satwikkansal/wtfpython/issues/40) |
-| MostAwesomeDude | [MostAwesomeDude](https://github.com/MostAwesomeDude) | [#1](https:/github.com/satwikkansal/wtfpython/issues/1) |
-| tukkek | [tukkek](https://github.com/tukkek) | [#11](https:/github.com/satwikkansal/wtfpython/issues/11), [#26](https:/github.com/satwikkansal/wtfpython/issues/26) |
-| PiaFraus | [PiaFraus](https://github.com/PiaFraus) | [#9](https:/github.com/satwikkansal/wtfpython/issues/9) |
-| chris-rands | [chris-rands](https://github.com/chris-rands) | [#32](https:/github.com/satwikkansal/wtfpython/issues/32) |
+| Lucas-C | [Lucas-C](https://github.com/Lucas-C) | [#36](https://github.com/satwikkansal/wtfpython/issues/36) |
+| MittalAshok | [MittalAshok](https://github.com/MittalAshok) | [#23](https://github.com/satwikkansal/wtfpython/issues/23) |
+| asottile | [asottile](https://github.com/asottile) | [#40](https://github.com/satwikkansal/wtfpython/issues/40) |
+| MostAwesomeDude | [MostAwesomeDude](https://github.com/MostAwesomeDude) | [#1](https://github.com/satwikkansal/wtfpython/issues/1) |
+| tukkek | [tukkek](https://github.com/tukkek) | [#11](https://github.com/satwikkansal/wtfpython/issues/11), [#26](https://github.com/satwikkansal/wtfpython/issues/26) |
+| PiaFraus | [PiaFraus](https://github.com/PiaFraus) | [#9](https://github.com/satwikkansal/wtfpython/issues/9) |
+| chris-rands | [chris-rands](https://github.com/chris-rands) | [#32](https://github.com/satwikkansal/wtfpython/issues/32) |
+| sohaibfarooqi | [sohaibfarooqi](https://github.com/sohaibfarooqi) | [#63](https://github.com/satwikkansal/wtfpython/issues/63) |
+| ipid | [ipid](https://github.com/ipid) | [#145](https://github.com/satwikkansal/wtfpython/issues/145) |
+| roshnet | [roshnet](https://github.com/roshnet) | [#140](https://github.com/satwikkansal/wtfpython/issues/140) |
+| daidai21 | [daidai21](https://github.com/daidai21) | [#137](https://github.com/satwikkansal/wtfpython/issues/137) |
+| scidam | [scidam](https://github.com/scidam) | [#136](https://github.com/satwikkansal/wtfpython/issues/136) |
+| pmjpawelec | [pmjpawelec](https://github.com/pmjpawelec) | [#121](https://github.com/satwikkansal/wtfpython/issues/121) |
+| leisurelicht | [leisurelicht](https://github.com/leisurelicht) | [#112](https://github.com/satwikkansal/wtfpython/issues/112) |
+| mishaturnbull | [mishaturnbull](https://github.com/mishaturnbull) | [#108](https://github.com/satwikkansal/wtfpython/issues/108) |
+| MuseBoy | [MuseBoy](https://github.com/MuseBoy) | [#101](https://github.com/satwikkansal/wtfpython/issues/101) |
+| Ghost account | N/A | [#96](https://github.com/satwikkansal/wtfpython/issues/96) |
+| koddo | [koddo](https://github.com/koddo) | [#80](https://github.com/satwikkansal/wtfpython/issues/80), [#73](https://github.com/satwikkansal/wtfpython/issues/73) |
+| jab | [jab](https://github.com/jab) | [#77](https://github.com/satwikkansal/wtfpython/issues/77) |
+| Jongy | [Jongy](https://github.com/Jongy) | [#208](https://github.com/satwikkansal/wtfpython/issues/208), [#210](https://github.com/satwikkansal/wtfpython/issues/210), [#233](https://github.com/satwikkansal/wtfpython/issues/233) |
+| Diptangsu Goswami | [diptangsu](https://github.com/diptangsu) | [#193](https://github.com/satwikkansal/wtfpython/issues/193) |
+| Charles | [charles-l](https://github.com/charles-l)  | [#245](https://github.com/satwikkansal/wtfpython/issues/245) |
+| LiquidFun | [LiquidFun](https://github.com/LiquidFun)  | [#267](https://github.com/satwikkansal/wtfpython/issues/267) |
 
-Thank you all for taking out time, and helping to make this project awesome! :smile:
+---
+
+**Translations**
+
+| Translator | Github | Language |
+|-------------|--------|--------|
+| leisurelicht | [leisurelicht](https://github.com/leisurelicht) | [Chinese](https://github.com/leisurelicht/wtfpython-cn) |
+| vuduclyunitn | [vuduclyunitn](https://github.com/vuduclyunitn) | [Vietnamese](https://github.com/vuduclyunitn/wtfptyhon-vi) |
+| José De Freitas | [JoseDeFreitas](https://github.com/JoseDeFreitas) | [Spanish](https://github.com/JoseDeFreitas/wtfpython-es) |
+| Vadim Nifadev | [nifadyev](https://github.com/nifadyev) | [Russian](https://github.com/satwikkansal/wtfpython/tree/master/translations/ru-russian) |
+
+Thank you all for your time and making wtfpython more awesome! :smile:
+
+PS: This list is updated after every major release, if I forgot to add your contribution here, please feel free to raise a Pull request.

code-of-conduct.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

irrelevant/insert_ids.py

@@ -0,0 +1,24 @@
+import uuid
+
+new_file = []
+original_file = []
+
+fname = "../README.md"
+
+
+def generate_random_id_comment():
+    random_id = uuid.uuid4()
+    return f"<!-- Example ID: {random_id} --!>"
+
+
+with open(fname, "r") as f:
+    original_file = f.readlines()
+
+
+for line in original_file:
+    new_file.append(line)
+    if line.strip().startswith("### "):
+        new_file.append(generate_random_id_comment())
+
+with open(fname, "w") as f:
+    f.write("".join(new_file))

irrelevant/notebook_generator.py

@@ -0,0 +1,397 @@
+"""
+An inefficient monolithic piece of code that'll generate jupyter notebook
+from the projects main README.
+
+PS: If you are a recruiter, please don't judge me by this piece of code. I wrote it
+in hurry. I know this is messy and can be simplified, but I don't want to change it
+much because it just works. 
+
+Simplifictions and improvements through patches are more than welcome however :)
+
+
+#TODOs
+
+- CLI arguments for running this thing
+- Add it to prepush hook
+- Add support for skip comments, to skip examples that are not meant for notebook environment.
+- Use templates?
+"""
+
+import json
+import os
+import pprint
+
+fpath = os.path.join(os.path.dirname( __file__ ), '..', 'README.md')
+examples = []
+
+# The globals
+current_example = 1
+sequence_num = 1
+current_section_name = ""
+
+
+STATEMENT_PREFIXES = ["...", ">>> ", "$ "]
+
+HOSTED_NOTEBOOK_INSTRUCTIONS = """
+
+## Hosted notebook instructions
+
+This is just an experimental attempt of browsing wtfpython through jupyter notebooks. Some examples are read-only because, 
+- they either require a version of Python that's not supported in the hosted runtime.
+- or they can't be reproduced in the notebook envrinonment.
+
+The 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
+
+```py
+>>> import sys
+>>> sys.version
+# Prints out Python version here.
+```
+
+That 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!
+
+---
+"""
+
+
+def generate_code_block(statements, output):
+    """
+    Generates a code block that executes the given statements.
+
+    :param statements: The list of statements to execute.
+    :type statements: list(str)
+    """
+    global sequence_num
+    result = {
+        "type": "code",
+        "sequence_num": sequence_num,
+        "statements": statements,
+        "output": output
+    }
+    sequence_num += 1
+    return result
+
+
+def generate_markdown_block(lines):
+    """
+    Generates a markdown block from a list of lines.
+    """
+    global sequence_num
+    result = {
+        "type": "markdown",
+        "sequence_num": sequence_num,
+        "value": lines
+    }
+    sequence_num += 1
+    return result
+
+
+def is_interactive_statement(line):
+    for prefix in STATEMENT_PREFIXES:
+        if line.lstrip().startswith(prefix):
+            return True
+    return False
+
+
+def parse_example_parts(lines, title, current_line):
+    """
+    Parse the given lines and return a dictionary with two keys:
+    build_up, which contains all the text before an H4 (explanation) is encountered,
+    and
+    explanation, which contains all the text after build_up until --- or another H3 is encountered.
+    """
+    parts = {
+        "build_up": [],
+        "explanation": []
+    }
+    content = [title]
+    statements_so_far = []
+    output_so_far = []
+    next_line = current_line
+    # store build_up till an H4 (explanation) is encountered
+    while not (next_line.startswith("#### ")or next_line.startswith('---')):
+        # Watching out for the snippets
+        if next_line.startswith("```py"):
+            # It's a snippet, whatever found until now is text
+            is_interactive = False
+            output_encountered = False
+            if content:
+                parts["build_up"].append(generate_markdown_block(content))
+                content = []
+
+            next_line = next(lines)
+
+            while not next_line.startswith("```"):
+                if is_interactive_statement(next_line):
+                    is_interactive = True
+                    if (output_so_far):
+                        parts["build_up"].append(generate_code_block(statements_so_far, output_so_far))
+                        statements_so_far, output_so_far = [], []
+                    statements_so_far.append(next_line)
+                else:
+                    # can be either output or normal code
+                    if is_interactive:
+                        output_so_far.append(next_line)
+                    elif output_encountered:
+                        output_so_far.append(next_line)
+                    else:
+                        statements_so_far.append(next_line)
+                next_line = next(lines)
+
+            # Snippet is over
+            parts["build_up"].append(generate_code_block(statements_so_far, output_so_far))
+            statements_so_far, output_so_far = [], []
+            next_line = next(lines)
+        else:
+            # It's a text, go on.
+            content.append(next_line)
+            next_line = next(lines)
+
+    # Explanation encountered, save any content till now (if any)
+    if content:
+        parts["build_up"].append(generate_markdown_block(content))
+
+    # Reset stuff
+    content = []
+    statements_so_far, output_so_far = [], []
+
+    # store lines again until --- or another H3 is encountered
+    while not (next_line.startswith("---") or
+               next_line.startswith("### ")):
+        if next_line.lstrip().startswith("```py"):
+            # It's a snippet, whatever found until now is text
+            is_interactive = False
+            if content:
+                parts["explanation"].append(generate_markdown_block(content))
+                content = []
+
+            next_line = next(lines)
+
+            while not next_line.lstrip().startswith("```"):
+                if is_interactive_statement(next_line):
+                    is_interactive = True
+                    if (output_so_far):
+                        parts["explanation"].append(generate_code_block(statements_so_far, output_so_far))
+                        statements_so_far, output_so_far = [], []
+                    statements_so_far.append(next_line)
+                else:
+                    # can be either output or normal code
+                    if is_interactive:
+                        output_so_far.append(next_line)
+                    else:
+                        statements_so_far.append(next_line)
+                next_line = next(lines)
+
+            # Snippet is over
+            parts["explanation"].append(generate_code_block(statements_so_far, output_so_far))
+            statements_so_far, output_so_far = [], []
+            next_line = next(lines)
+        else:
+            # It's a text, go on.
+            content.append(next_line)
+            next_line = next(lines)
+
+    # All done
+    if content:
+        parts["explanation"].append(generate_markdown_block(content))
+
+    return next_line, parts
+
+
+def remove_from_beginning(tokens, line):
+    for token in tokens:
+        if line.lstrip().startswith(token):
+            line = line.replace(token, "")
+    return line
+
+
+def inspect_and_sanitize_code_lines(lines):
+    """
+    Remove lines from the beginning of a code block that are not statements.
+
+    :param lines: A list of strings, each representing a line in the code block.
+    :returns is_print_present, sanitized_lines: A boolean indicating whether print was present in the original code and a list of strings representing
+    sanitized lines.  The latter may be an empty list if all input lines were removed as comments or whitespace (and thus did not contain any statements).
+    This function does not remove blank lines at the end of `lines`.
+    """
+    tokens_to_remove = STATEMENT_PREFIXES
+    result = []
+    is_print_present = False
+    for line in lines:
+        line = remove_from_beginning(tokens_to_remove, line)
+        if line.startswith("print ") or line.startswith("print("):
+            is_print_present = True
+        result.append(line)
+    return is_print_present, result
+
+
+def convert_to_cells(cell_contents, read_only):
+    """
+    Converts a list of dictionaries containing markdown and code cells into a Jupyter notebook.
+
+    :param cell_contents: A list of dictionaries, each
+    dictionary representing either a markdown or code cell. Each dictionary should have the following keys: "type", which is either "markdown" or "code",
+    and "value". The value for type = 'markdown' is the content as string, whereas the value for type = 'code' is another dictionary with two keys,
+    statements and output. The statements key contains all lines in between ```py\n``` (including) until ```\n```, while output contains all lines after
+    ```.output py\n```. 
+    :type cell_contents: List[Dict]
+
+        :param read_only (optional): If True then only print outputs are included in converted
+    cells. Default False
+        :type read_only (optional): bool
+
+        :returns A Jupyter notebook containing all cells from input parameter `cell_contents`.
+    Each converted cell has metadata attribute collapsed set to true if it's code-cell otherwise None if it's markdow-cell.
+    """
+    cells = []
+    for stuff in cell_contents:
+        if stuff["type"] == "markdown":
+            # todo add metadata later
+            cells.append(
+                {
+                    "cell_type": "markdown",
+                    "metadata": {},
+                    "source": stuff["value"]
+                }
+            )
+        elif stuff["type"] == "code":
+            if read_only:
+                # Skip read only
+                # TODO: Fix
+                cells.append(
+                {
+                    "cell_type": "markdown",
+                    "metadata": {},
+                    "source": ["```py\n"] + stuff["statements"] + ["```\n"] + ["```py\n"] + stuff['output'] + ["```\n"]
+                    }
+                )
+                continue
+
+            is_print_present, sanitized_code = inspect_and_sanitize_code_lines(stuff["statements"])
+            if is_print_present:
+                cells.append(
+                    {
+                        "cell_type": "code",
+                        "metadata": {
+                            "collapsed": True,
+
+                        },
+                        "execution_count": None,
+                        "outputs": [{
+                            "name": "stdout",
+                            "output_type": "stream",
+                            "text": stuff["output"]
+                        }],
+                        "source": sanitized_code
+                    }
+                )
+            else:
+                cells.append(
+                    {
+                        "cell_type": "code",
+                        "execution_count": None,
+                        "metadata": {
+                            "collapsed": True
+                        },
+                        "outputs": [{
+                            "data": {
+                                "text/plain": stuff["output"]
+                            },
+                            "output_type": "execute_result",
+                            "metadata": {},
+                            "execution_count": None
+                        }],
+                        "source": sanitized_code
+                    }
+                )
+
+    return cells
+
+
+def convert_to_notebook(pre_examples_content, parsed_json, post_examples_content):
+    """
+    Convert a JSON file containing the examples to a Jupyter Notebook.
+    """
+    result = {
+        "cells": [],
+        "metadata": {},
+        "nbformat": 4,
+        "nbformat_minor": 2
+    }
+
+    notebook_path = "wtf.ipynb"
+
+    result["cells"] += convert_to_cells([generate_markdown_block(pre_examples_content)], False)
+
+    for example in parsed_json:
+        parts = example["parts"]
+        build_up = parts.get("build_up")
+        explanation = parts.get("explanation")
+        read_only = example.get("read_only")
+
+        if build_up:
+            result["cells"] += convert_to_cells(build_up, read_only)
+
+        if explanation:
+            result["cells"] += convert_to_cells(explanation, read_only)
+
+    result["cells"] += convert_to_cells([generate_markdown_block(post_examples_content)], False)
+
+    #pprint.pprint(result, indent=2)
+    with open(notebook_path, "w") as f:
+        json.dump(result, f, indent=2)
+
+
+with open(fpath, 'r+', encoding="utf-8") as f:
+    lines = iter(f.readlines())
+    line = next(lines)
+    result = []
+    pre_examples_phase = True
+    pre_stuff = []
+    post_stuff = []
+    try:
+        while True:
+            if line.startswith("## "):
+                pre_examples_phase = False
+                # A section is encountered
+                current_section_name = line.replace("## ", "").strip()
+                section_text = []
+                line = next(lines)
+                # Until a new section is encountered
+                while not (line.startswith("## ") or line.startswith("# ")):
+                    # check if it's a H3
+                    if line.startswith("### "):
+                        # An example is encountered
+                        title_line = line
+                        line = next(lines)
+                        read_only = False
+                        while line.strip() == "" or line.startswith('<!--'):
+                            #TODO: Capture example ID here using regex.
+                            if '<!-- read-only -->' in line:
+                                read_only = True
+                            line = next(lines)
+
+                        example_details = {
+                            "id": current_example,
+                            "title": title_line.replace("### ", ""),
+                            "section": current_section_name,
+                            "read_only": read_only
+                        }
+                        line, example_details["parts"] = parse_example_parts(lines, title_line, line)
+                        result.append(example_details)
+                        current_example += 1
+                    else:
+                        section_text.append(line)
+                        line = next(lines)
+            else:
+                if pre_examples_phase:
+                    pre_stuff.append(line)
+                else:
+                    post_stuff.append(line)
+                line = next(lines)
+
+    except StopIteration as e:
+        #pprint.pprint(result, indent=2)
+        pre_stuff.append(HOSTED_NOTEBOOK_INSTRUCTIONS)
+        result.sort(key = lambda x: x["read_only"])
+        convert_to_notebook(pre_stuff, result, post_stuff)

irrelevant/notebook_instructions.md

@@ -0,0 +1,7 @@
+## Generating the notebook
+
+- Expand the relative links in README.md to absolute ones
+- Remove the TOC in README.md (because Google colab generates its own anyway)
+- Reorder the examples, so that the ones that work are upfront.
+- Run the `notebook_generator.py`, it will generate a notebook named `wtf.ipynb`
+- Revert the README.md changes (optional)

irrelevant/obsolete/add_categories

@@ -139,7 +139,7 @@ f*
 Half triple-quoted strings
 f
 
-Implicity key type conversion
+Implicit key type conversion
 f*
 
 Stubborn `del` operator

irrelevant/obsolete/generate_contributions.py

@@ -1,6 +1,8 @@
 """
-Parses the README.md and generated the table
+This script parses the README.md and generates the table
 `CONTRIBUTORS.md`.
+
+No longer works since we've moved on contributors to CONTRIBUTORS.md entirely.
 """
 
 import pprint
@@ -39,7 +41,7 @@ for handle, issues in contribs.items():
     issue_string = ', '.join([issue_format.format(i, i) for i in issues])
     resp = requests.get(github_rest_api.format(handle))
     name = handle
-    if resp.status_code is 200:
+    if resp.status_code == 200:
         pprint.pprint(resp.json()['name'])
     else:
         print(handle, resp.content)
@@ -48,4 +50,4 @@ for handle, issues in contribs.items():
                                         handle,
                                         issue_string))
 
-print(table_header + "\n".join(rows_so_far))
+print(table_header + "\n".join(rows_so_far))

irrelevant/obsolete/parse_readme.py

@@ -2,7 +2,7 @@
 
 """
 This inefficient module would parse the README.md in the initial version of
-WTFPython, and enabl me to categorize and reorder a hell lot of examples with
+WTFPython, and enable me to categorize and reorder a hell lot of examples with
 the help of the file `add_categories` (part of which is automatically
 generated).
 
@@ -10,6 +10,12 @@ After the refactor, this module would not work now with necessary updates in
 the code.
 """
 
+try:
+    raw_input          # Python 2
+except NameError:
+    raw_input = input  # Python 3
+    
+
 fname = "README.md"
 snippets = []
 
@@ -80,6 +86,7 @@ with open("add_categories", "r") as f:
             }
             content.next()
     except StopIteration:
+        pass
 
 for idx, snip in enumerate(snippets):
     snippets[idx]["category"] = snips_by_title[snip["title"]]["category"]

package.json

@@ -1,41 +0,0 @@
-{
-  "name": "wtfpython",
-  "version": "2.0.0",
-  "description": "A collection of trick Python snippets and lesser known features",
-  "bin": "wtfpython",
-  "scripts": {
-    "postpublish": "git push origin master",
-    "toc": "doctoc --github --title '# Table of Contents' --maxlevel 3 README.md"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/satwikkansal/wtfPython.git"
-  },
-  "keywords": [
-    "python",
-    "specification",
-    "notes",
-    "wtf",
-    "learning",
-    "guide",
-    "handbook"
-  ],
-  "author": "Satwik Kansal <satwikkansal@gmail.com> (https://satwikkansal.xyz)",
-  "license": "WTFPL 2.0",
-  "bugs": {
-    "url": "https://github.com/satwikkansal/wtfPython/issues"
-  },
-  "homepage": "https://github.com/satwikkansal/wtfPython#readme",
-  "devDependencies": {
-    "doctoc": "^1.3.0"
-  },
-  "dependencies": {
-    "boxen": "^1.1.0",
-    "chalk": "^1.1.1",
-    "default-pager": "^1.1.0",
-    "meow": "^3.7.0",
-    "msee": "^0.3.3",
-    "through2": "^2.0.2",
-    "update-notifier": "^2.0.0"
-  }
-}

translations/ru-russian/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+Приветствуются все виды изменений. Не стесняйтесь предлагать броские и смешные названия для существующих примеров. Цель - сделать эту коллекцию как можно более интересной для чтения. Вот несколько способов, с помощью которых вы можете внести свой вклад,
+
+- Если вы заинтересованы в переводе проекта на другой язык (некоторые люди уже делали это в прошлом), пожалуйста, не стесняйтесь открыть тему и дайте мне знать, если вам нужна какая-либо помощь.
+- Если изменения, которые вы предлагаете, значительны, то создание issue перед внесением изменений будет оценено по достоинству. Если вы хотите поработать над issue (это очень рекомендуется), выразите свою заинтересованность и вы будете назначены исполнителем.
+- Если вы добавляете новый пример, настоятельно рекомендуется создать issue, чтобы обсудить ее перед отправкой изменений. Для добавления нового примера вы можете использовать следующий шаблон:
+
+<pre>
+### ▶ Какое-то причудливое название. *
+* в конце названия означает, что пример был добавлен недавно.
+
+```py
+# Подготовка кода.
+# Подготовка к волшебству...
+```
+
+**Вывод (версия Python):**
+```py
+>>> triggering_statement
+Вероятно, неожиданный вывод
+
+```
+(Необязательно): Одна строка, описывающая неожиданный вывод.
+
+#### 💡 Объяснение:
+* Краткое объяснение того, что происходит и почему это происходит.
+  ```py
+  Подготовка примеров для пояснения (при необходимости)
+  ```
+
+  **Вывод:**
+  ```py
+  >>> trigger # пример, облегчающий понимание магии
+  # обоснованный вывод
+  ```
+</pre>
+
+Несколько моментов, которые стоит учитывать при написании примера,
+
+- Если вы решили отправить новый пример без создания issue и обсуждения, пожалуйста, проверьте проект, чтобы убедиться, что в нем уже нет похожих примеров.
+- Старайтесь быть последовательными в именах и значениях, которые вы используете для переменных. Например, большинство имен переменных в проекте имеют вид `some_string`, `some_list`, `some_dict` и т.д. Вы увидите много `x` для однобуквенных имен переменных, и `"wtf"` в качестве значений для строк. В проекте нет строгой схемы, как таковой, но вы можете взглянуть на другие примеры, чтобы понять суть.
+- Старайтесь быть как можно более креативными, чтобы добавить элемент "сюрприза" во время подготовки примеров. Иногда это может означать написание фрагмента, который здравомыслящий программист никогда бы не написал.
+- Также не стесняйтесь добавлять свое имя в список [контрибьюторов](/CONTRIBUTORS.md).
+
+**Некоторые часто задаваемые вопросы**
+
+    Что это такое после каждого заголовка сниппета (###) в README: <!-- ID примера: 30f1d3fc-e267-4b30-84ef-4d9e7091ac1a --->? Нужно ли его добавлять вручную или можно игнорировать при создании новых сниппетов?
+
+Это случайный UUID, он используется для идентификации примеров в нескольких переводах проекта. Как контрибьютор, вы не должны беспокоиться о том, как он используется, вы просто должны добавлять новый случайный UUID к новым примерам в этом формате.
+
+    Куда следует добавлять новые сниппеты? В начало/в конец раздела?
+
+При определении порядка учитывается множество факторов (зависимость от других примеров, уровень сложности, категория и т.д.). Я бы предложил просто добавить новый пример в конец раздела, который вы считаете более подходящим (или просто добавить его в раздел "Разное"). О его порядке можно будет позаботиться в будущих редакциях.
+
+    В чем разница между разделами (первые два очень похожи)?
+
+Раздел "Напрягите мозг" содержит более надуманные примеры, с которыми вы не столкнетесь в реальной жизни, в то время как раздел "Скользкие склоны" содержит примеры, с которыми можно чаще сталкиваться при программировании.
+
+    Перед оглавлением написано, что для его создания использовался markdown-toc -i README.md --maxdepth 3. Пакет pip markdown-toc не содержит ни флагов -i, ни --maxdepth. Какой пакет имеется в виду, или какая версия этого пакета?
+    Должна ли новая запись в оглавлении для фрагмента быть создана с помощью вышеуказанной команды или вручную (в случае, если вышеуказанная команда делает больше, чем просто добавляет запись)?
+
+Мы используем пакет [markdown-toc](https://www.npmjs.com/package/markdown-toc) npm для создания ToC (содержание). Однако у него есть некоторые проблемы со специальными символами (не уверен, что они уже исправлены). Чаще всего я просто вставляю ссылку toc вручную в нужное место. Инструмент удобен, когда мне нужно сделать большую перестановку, в остальных случаях просто обновлять toc вручную удобнее.
+
+Если у вас есть вопросы, не стесняйтесь спрашивать в [issue](https://github.com/satwikkansal/wtfpython/issues/269) (спасибо [@LiquidFun](https://github.com/LiquidFun) за ее создание).

translations/ru-russian/CONTRIBUTORS.md

@@ -0,0 +1,42 @@
+Ниже перечислены (без определенного порядка) замечательные люди, которые внесли вклад в развитие wtfpython.
+
+| Автор | Github | Issues |
+|-------------|--------|--------|
+| Lucas-C | [Lucas-C](https://github.com/Lucas-C) | [#36](https://github.com/satwikkansal/wtfpython/issues/36) |
+| MittalAshok | [MittalAshok](https://github.com/MittalAshok) | [#23](https://github.com/satwikkansal/wtfpython/issues/23) |
+| asottile | [asottile](https://github.com/asottile) | [#40](https://github.com/satwikkansal/wtfpython/issues/40) |
+| MostAwesomeDude | [MostAwesomeDude](https://github.com/MostAwesomeDude) | [#1](https://github.com/satwikkansal/wtfpython/issues/1) |
+| tukkek | [tukkek](https://github.com/tukkek) | [#11](https://github.com/satwikkansal/wtfpython/issues/11), [#26](https://github.com/satwikkansal/wtfpython/issues/26) |
+| PiaFraus | [PiaFraus](https://github.com/PiaFraus) | [#9](https://github.com/satwikkansal/wtfpython/issues/9) |
+| chris-rands | [chris-rands](https://github.com/chris-rands) | [#32](https://github.com/satwikkansal/wtfpython/issues/32) |
+| sohaibfarooqi | [sohaibfarooqi](https://github.com/sohaibfarooqi) | [#63](https://github.com/satwikkansal/wtfpython/issues/63) |
+| ipid | [ipid](https://github.com/ipid) | [#145](https://github.com/satwikkansal/wtfpython/issues/145) |
+| roshnet | [roshnet](https://github.com/roshnet) | [#140](https://github.com/satwikkansal/wtfpython/issues/140) |
+| daidai21 | [daidai21](https://github.com/daidai21) | [#137](https://github.com/satwikkansal/wtfpython/issues/137) |
+| scidam | [scidam](https://github.com/scidam) | [#136](https://github.com/satwikkansal/wtfpython/issues/136) |
+| pmjpawelec | [pmjpawelec](https://github.com/pmjpawelec) | [#121](https://github.com/satwikkansal/wtfpython/issues/121) |
+| leisurelicht | [leisurelicht](https://github.com/leisurelicht) | [#112](https://github.com/satwikkansal/wtfpython/issues/112) |
+| mishaturnbull | [mishaturnbull](https://github.com/mishaturnbull) | [#108](https://github.com/satwikkansal/wtfpython/issues/108) |
+| MuseBoy | [MuseBoy](https://github.com/MuseBoy) | [#101](https://github.com/satwikkansal/wtfpython/issues/101) |
+| Ghost account | N/A | [#96](https://github.com/satwikkansal/wtfpython/issues/96) |
+| koddo | [koddo](https://github.com/koddo) | [#80](https://github.com/satwikkansal/wtfpython/issues/80), [#73](https://github.com/satwikkansal/wtfpython/issues/73) |
+| jab | [jab](https://github.com/jab) | [#77](https://github.com/satwikkansal/wtfpython/issues/77) |
+| Jongy | [Jongy](https://github.com/Jongy) | [#208](https://github.com/satwikkansal/wtfpython/issues/208), [#210](https://github.com/satwikkansal/wtfpython/issues/210), [#233](https://github.com/satwikkansal/wtfpython/issues/233) |
+| Diptangsu Goswami | [diptangsu](https://github.com/diptangsu) | [#193](https://github.com/satwikkansal/wtfpython/issues/193) |
+| Charles | [charles-l](https://github.com/charles-l)  | [#245](https://github.com/satwikkansal/wtfpython/issues/245) |
+| LiquidFun | [LiquidFun](https://github.com/LiquidFun)  | [#267](https://github.com/satwikkansal/wtfpython/issues/267) |
+
+---
+
+**Переводчики**
+
+| Переводчик | Github | Язык |
+|-------------|--------|--------|
+| leisurelicht | [leisurelicht](https://github.com/leisurelicht) | [Chinese](https://github.com/leisurelicht/wtfpython-cn) |
+| vuduclyunitn | [vuduclyunitn](https://github.com/vuduclyunitn) | [Vietnamese](https://github.com/vuduclyunitn/wtfptyhon-vi) |
+| José De Freitas | [JoseDeFreitas](https://github.com/JoseDeFreitas) | [Spanish](https://github.com/JoseDeFreitas/wtfpython-es) |
+| Vadim Nifadev | [nifadyev](https://github.com/nifadyev) | [Russian](https://github.com/satwikkansal/wtfpython/tree/master/translations/ru-russian) |
+
+Спасибо всем за ваше время и за то, что делаете wtfpython еще более потрясающим! :smile:
+
+PS: Этот список обновляется после каждого крупного релиза, если я забыл добавить сюда ваш вклад, пожалуйста, не стесняйтесь сделать Pull request.

translations/ru-russian/code-of-conduct.md

@@ -0,0 +1,70 @@
+# Кодекс Поведения участника
+
+## Наши обязательства
+
+Мы, как участники, авторы и лидеры обязуемся сделать участие в сообществе
+свободным от притеснений для всех, независимо от возраста, телосложения,
+видимых или невидимых ограничений способности, этнической принадлежности,
+половых признаков, гендерной идентичности и выражения, уровня опыта,
+образования, социально-экономического статуса, национальности, внешности,
+расы, религии, или сексуальной идентичности и ориентации.
+
+Мы обещаем действовать и взаимодействовать таким образом, чтобы вносить вклад в открытое,
+дружелюбное, многообразное, инклюзивное и здоровое сообщество.
+
+## Наши стандарты
+
+Примеры поведения, создающие условия для благоприятных взаимоотношений включают в себя:
+
+* Проявление доброты и эмпатии к другим участникам проекта
+* Уважение к чужой точке зрения и опыту
+* Конструктивная критика и принятие конструктивной критики
+* Принятие ответственности, принесение извинений тем, кто пострадал от наших ошибок
+  и извлечение уроков из опыта
+* Ориентирование на то, что лучше подходит для сообщества, а не только для нас лично
+
+Примеры неприемлемого поведения участников включают в себя:
+
+* Использование выражений или изображений сексуального характера и нежелательное сексуальное внимание или домогательство в любой форме
+* Троллинг, оскорбительные или уничижительные комментарии, переход на личности или затрагивание политических убеждений
+* Публичное или приватное домогательство
+* Публикация личной информации других лиц, например, физического или электронного адреса, без явного разрешения
+* Иное поведение, которое обоснованно считать неуместным в профессиональной обстановке
+
+## Обязанности
+
+Лидеры сообщества отвечают за разъяснение и применение наших стандартов приемлемого
+поведения и будут предпринимать соответствующие и честные меры по исправлению положения
+в ответ на любое поведение, которое они сочтут неприемлемым, угрожающим, оскорбительным или вредным.
+
+Лидеры сообщества обладают правом и обязанностью удалять, редактировать или отклонять
+комментарии, коммиты, код, изменения в вики, вопросы и другой вклад, который не совпадает
+с Кодексом Поведения, и предоставят причины принятого решения, когда сочтут нужным.
+
+## Область применения
+
+Данный Кодекс Поведения применим во всех публичных физических и цифровых пространства сообщества,
+а также когда человек официально представляет сообщество в публичных местах.
+Примеры представления проекта или сообщества включают использование официальной электронной почты,
+публикации в официальном аккаунте в социальных сетях,
+или упоминания как представителя в онлайн или офлайн мероприятии.
+
+## Приведение в исполнение
+
+О случаях домогательства, а так же оскорбительного или иного другого неприемлемого
+поведения можно сообщить ответственным лидерам сообщества с помощью email.
+Все жалобы будут рассмотрены и расследованы оперативно и беспристрастно.
+
+Все лидеры сообщества обязаны уважать неприкосновенность частной жизни и личную
+неприкосновенность автора сообщения.
+
+## Атрибуция
+
+Данный Кодекс Поведения основан на [Кодекс Поведения участника][homepage],
+версии 2.0, доступной по адресу
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Принципы Воздействия в Сообществе были вдохновлены [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org

wtfpython

@@ -1,85 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const obj = require('through2').obj;
-const pager = require('default-pager');
-const msee = require('msee');
-const join = require('path').join;
-const boxen = require('boxen');
-const chalk = require('chalk');
-const updateNotifier = require('update-notifier');
-const pkg = require('./package.json');
-const meow = require('meow');
-
-const cli = meow([
-  'Usage',
-  '  bash-handbook',
-  '',
-  'Options',
-  '  --lang, -l  Translation language',
-  '',
-  'Examples',
-  '  bash-handbook',
-  '  bash-handbook --lang pt-br'
-], {
-  string: [
-    'lang'
-  ],
-  alias: {
-    l: 'lang',
-    h: 'help'
-  },
-  default: {
-    lang: ''
-  }
-});
-
-const boxenOpts = {
-  borderColor: 'yellow',
-  margin: {
-    bottom: 1
-  },
-  padding: {
-    right: 1,
-    left: 1
-  }
-};
-
-const mseeOpts = {
-  paragraphEnd: '\n\n'
-};
-
-const notifier = updateNotifier({ pkg });
-
-process.env.PAGER = process.env.PAGER || 'less';
-process.env.LESS  = process.env.LESS  || 'FRX';
-
-const lang = cli.flags.lang
-  .toLowerCase()
-  .split('-')
-  .map((l, i) => i === 0 ? l : l.toUpperCase())
-  .join('-');
-
-const translation = join(__dirname, !lang ? './README.md' : `./README-${lang}.md`);
-
-fs.stat(translation, function (err, stats) {
-  if (err) {
-    console.log('The %s translation does not exist', chalk.bold(lang));
-    return;
-  }
-
-  fs.createReadStream(translation)
-    .pipe(obj(function (chunk, enc, cb) {
-      const message = [];
-
-      if (notifier.update) {
-        message.push(`Update available: {green.bold ${notifier.update.latest}} {dim current: ${notifier.update.current}}`);
-        message.push(`Run {blue npm install -g ${pkg.name}} to update.`);
-        this.push(boxen(message.join('\n'), boxenOpts));
-      }
-
-      this.push(msee.parse(chunk.toString(), mseeOpts));
-      cb();
-    }))
-    .pipe(pager());
-});

wtfpython-pypi/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 if __name__ == "__main__":
     setup(name='wtfpython',
-          version='0.1.3',
+          version='0.2',
           description='What the f*ck Python!',
           author="Satwik Kansal",
           maintainer="Satwik Kansal",

wtfpython-pypi/wtf_python/main.py

@@ -1,18 +1,25 @@
+from os.path import dirname, join, realpath
+
 import pydoc
 try:
     from urllib.request import urlretrieve
 except ImportError:
     from urllib import urlretrieve
 
-url = ("https://raw.githubusercontent.com/satwikkansal/"
+url = ("http://raw.githubusercontent.com/satwikkansal/"
        "wtfpython/master/README.md")
-file_name = "content.md"
+
+file_path = join(dirname(dirname(realpath(__file__))), "content.md")
 
 
 def fetch_updated_doc():
+    """
+    Fetch the latest version of the file at `url` and save it to `file_path`.
+    If anything goes wrong, do nothing.
+    """
     try:
         print("Fetching the latest version...")
-        urlretrieve(url, file_name)
+        urlretrieve(url, file_path)
         print("Done!")
     except Exception as e:
         print(e)
@@ -21,7 +28,7 @@ def fetch_updated_doc():
 
 
 def render_doc():
-    with open(file_name, 'r') as f:
+    with open(file_path, 'r', encoding="utf-8") as f:
         content = f.read()
         pydoc.pager(content)