kracekumar/python-typing-koans kracekumar/python-typing-koans

  • Stars
    star
    118
  • Rank 299,923 (Top 6 %)
  • Language
    Python
  • Created over 3 years ago
  • Updated almost 3 years ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
kracekumar/python-typing-koans
github

kracekumar

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Python typing koans to learn type-hints in Python3 using Mypy

Python-typing-koans

A set of examples to learn optional static typing in Python.

asciicast

Install

  • Install Python 3.9.4+.

  • Install poetry - https://python-poetry.org/docs/#installation .

  • Clone the repository and change the directory to the cloned one.

  • Install requirements like poetry install.

  • If you want to use pip, pip install -r requirements.txt.

Idea

One of the best ways to learn python-typing is to annotate the code. In this repo, koans directory contains a set of files which will teach you python type-hints by fixing errors. The files carry a suffix from 100 in the increasing order. By solving errors in the each file in the increasing suffix order, you will gain knowledge about Python hints. It starts with simple variable annotation and covers topics function annotation, generics, protocols, classes.

How to learn?

The existing files has no annotations or wrong annotation, as a learner, you run one file and fix each errors till there are no type-errors. In the next section, you will learn, how to list all koans and how to run the modified koan file.

All the koan files are present in the following directories

koans/py
koans/dj_koans/mysite/polls/koans

How to run?

  • Display one koan file
$cat koans/py/100-easy-variable-wrong-type.py
# msg variable is wrongly annotated as int, annotate it as string
msg: int = "hello world!"

# salary is annotated as int, annotate as float
salary: int = 2345.67

# Set is_active as bool
is_active: int = True
  • Run one koan file
$poetry run python cli.py one koans/py/100-easy-variable-wrong-type.py
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
Running Mypy on koan file koans/py/100-easy-variable-wrong-type.py
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€  Mypy errors in koan file koans/py/100-easy-variable-wrong-type.py โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
koans/py/100-easy-variable-wrong-type.py:2: error: Incompatible types in assignment (expression has type "str", variable has type "int")
    msg: int = "hello world!"
               ^
koans/py/100-easy-variable-wrong-type.py:5: error: Incompatible types in assignment (expression has type "float", variable has type
"int")
    salary: int = 2345.67
                  ^
Found 2 errors in 1 file (checked 1 source file)

โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ End โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
  • Run after fixing the errors(riddles) in the file.
$poetry run python cli.py one koans/py/100-easy-variable-wrong-type.py
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
Running Mypy on koan file koans/py/100-easy-variable-wrong-type.py
No errors in koan file koans/py/100-easy-variable-wrong-type.py ๐Ÿ‘
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
  • List all files: poetry run python cli.py list
$poetry run python cli.py list
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
koans/py/100-easy-variable-wrong-type.py
koans/py/101-easy-tuple-value.py
koans/py/102-easy-list-homogenous.py
koans/py/103-easy-mixed-values.py
koans/py/104-easy-union-example.py
koans/py/105-easy-dictionary-example.py
koans/py/106-easy-function-example.py
koans/py/107-easy-typed-dict.py
koans/py/108-easy-type-alias.py
koans/py/109-easy-user-defined-class.py
koans/py/110-easy-class-variable.py
koans/py/111-medium-callable-annotate.py
koans/py/112-medium-type-as-example.py
koans/py/113-easy-builder-pattern.py
koans/py/114-medium-factory-pattern.py
koans/py/115-medium-protocol-covariant-dbapi-example.py
koans/py/116-easy-factory-example.py
koans/py/117-easy-protocol-across-objects.py
koans/py/118-medium-protocol-behave-like-dict.py
koans/py/119-medium-queue-genrics.py
koans/py/120-medium-decorator.py
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
  • Print summary of all koan files.
$poetry run python cli.py summary
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€
 Ran mypy in koan file: koans/py/100-easy-variable-wrong-type.py ๐Ÿ‘
 Ran mypy in koan file: koans/py/101-easy-tuple-value.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/102-easy-list-homogenous.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/103-easy-mixed-values.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/104-easy-union-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/105-easy-dictionary-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/106-easy-function-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/107-easy-typed-dict.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/108-easy-type-alias.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/109-easy-user-defined-class.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/110-easy-class-variable.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/111-medium-callable-annotate.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/112-medium-type-as-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/113-easy-builder-pattern.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/114-medium-factory-pattern.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/115-medium-protocol-covariant-dbapi-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/116-easy-factory-example.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/117-easy-protocol-across-objects.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/118-medium-protocol-behave-like-dict.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/119-medium-queue-genrics.py ๐Ÿ‘Ž
 Ran mypy in koan file: koans/py/120-medium-decorator.py ๐Ÿ‘Ž
  Koans Summary
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Status โ”ƒ Count โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ Passed โ”‚ 1     โ”‚
โ”‚ Failed โ”‚ 20    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€

Resource for learning Python type-hints

Supported Koans

  • Python - koans/py
  • Django - koans/dj_koans/mysite/polls/koans
  • Django Rest Framework - koans/dj_koans/mysite/polls/drf_koans

How to contribute?

  • If you feel, some examples will make a great learning material, add a new file in the format 1xx-<easy|medium|hard>-filename.py and send a PR.
  • If you feel some of the koan file is missing enough links or not well-defined please send a PR or raise an issue.
  • If you feel some of the concepts needs a better examples or missing, open a PR or create an issue.

To Support

  • Add async example koans
  • Add third party annotation koans like django, DRF in separate sub-directory in koans/.

More Repositories

1

jut

Render Jupyter notebook in the terminal
Python
173
star
2

facetouch

Neural Network to predict face touch on live feed and warn you, "don't touch the face".
Python
24
star
3

pythonbyexamplestutorial

Set of examples problems to learn python
Python
15
star
4

Gummi

A Multi User Chat room developed with Flask
Python
15
star
5

imon

Internet bandwidth monitor by domain
Rust
15
star
6

bt

A BitTorrent client written in Python and asyncio
Python
11
star
7

ipynb2viewer

Upload `.ipynb` files to gist.github.com as anonymous user and returns nbviewr url.
Python
10
star
8

flask_vs_django_bench

Benchmark Flask vs Django for simple JsonResponse
Python
9
star
9

gist

Command Line Interface to paste gist(github)
Python
8
star
10

learnpythoninminutes

Quick intro to getting started with Python
Python
8
star
11

gevent_multiprocessing

gevent + multitprocessing experiments
Python
8
star
12

UTFT

Writing Unit tests and Functional Testing in Python
Python
7
star
13

sachintweets

Fan made site for greatest batsmen ever played in universe. Complete real time tweet update about sachin.
JavaScript
6
star
14

Song-Fetcher

Will download songs from mp3.tamilwire.com
Python
5
star
15

python-training

Training material for Python workshop
Python
5
star
16

edht

Distributed Hash Table in Erlang
Erlang
5
star
17

missing-python-mode

missing emacs snippets for python-mode
Emacs Lisp
4
star
18

playstore

Python library to access Android App details from Google Play Store.
Python
4
star
19

drf_tada

Django REST Framework + Todo
Python
4
star
20

reddit-comment-fetcher

fetch reddit comments in json format and populate user id and up votes in HTML
Python
4
star
21

ircutils

IRCUtils is a Python framework for communicating with the IRC protocol. Unofficial Mirror of http://dev.guardedcode.com/projects/ircutils
Python
3
star
22

datasette-render-local-images

A datasette plugin to render images in the local system
Python
3
star
23

wetirc

An IRC bot to log IRC discussion
Python
3
star
24

python-flickr

Python flickr demo
JavaScript
3
star
25

tamil-dataset

Tamil Language dataset for NLP related work.
3
star
26

wordscrapper

Program to get all gre words and their meaning from http://www.gredics.com.
Python
3
star
27

dropbox-maildir

store imap mails in maildir format in dropbox
Python
2
star
28

offline-python

Chrome extension using empythoned to run python in the browser.
Python
2
star
29

go-mwapi

client library for Mediawiki api written in go
Go
2
star
30

go-instagram

Go lang API for accessing instagram data
2
star
31

simpleurl

SimpleURL is based on werkzeug.routing for brubeck - Escape from Regex
Python
2
star
32

tn_elections

TN Assembly Elections data
2
star
33

pulse-plus

Utilities to explore, convert PhonePe Pulse data - https://github.com/PhonePe/pulse
Python
2
star
34

City-info

1
star
35

contactup

Django app for teaching
Python
1
star
36

test-empythoned

Testing empythoned - https://github.com/replit/empythoned
Python
1
star
37

.emacs.d

My emacs files (Prelude)
Emacs Lisp
1
star
38

tweetpie

Python library to connect to twitter
Python
1
star
39

python-wiktionary

JavaScript
1
star
40

drsf_task

Python
1
star
41

pluggy_talk

Sample code for Pluggy Talk
Python
1
star
42

type_coverage_as_comment

Post Python type coverage as a comment to GH PR.
Python
1
star
43

http_framework_probe

flask and aiohttp examples
Python
1
star
44

cookiecutter-flask-kracekumar

Flask project skeleton
JavaScript
1
star
45

crawlit

Python web crawler with limitations
Python
1
star
46

aaron-swartz-tweet-archive

Internet Archive have gathered all the tweets about @aaronsw after his death. Lets build a nice web interface to it. http://hacknight.in/hasgeek/aaronsw-memorial/projects/3-aaron-swartz-tweet-archive
1
star
47

Resume

My resume
1
star
48

julython_analysis

This work is carried out as part of Fifth elephant Hacknight http://beta.hacknight.in/fifthelephant/bangalore2012
Python
1
star
49

crunch

Command line utitlity to download files from terminal
1
star
50

tumblr

Go Tumblr api
Go
1
star
51

coderwall

CLI to access coderwall
Python
1
star
52

covid19_india

Data Analysis and scripts for extracting covid-19 spread in India
Jupyter Notebook
1
star