typeddjango/awesome-python-typing

Collection of awesome Python types, stubs, plugins, and tools to work with them.

awesome-python-typing's Issues

Suggest adding mypy-protobuf

Project link: https://github.com/dropbox/mypy-protobuf

Should be categorized to "Tools" IMO

[Request] Please list "beartype" in the "Dynamic type checkers" section

Thanks for all the awesome typing lists, @sobolevn, @orsinium, and other fearless contributors. If someone could find a spare moment to add a terse link to beartype, a recently released constant-time (i.e., O(1) with negligible constants at call time regardless of container size) runtime type checker compliant with Python 3.6—3.9 and PEPs 483, 484, 540, 560, 563, 593 and soon to be compliant with PEP 585 that I personally maintain, that would be... like, super awesome: e.g.,

• beartype - Constant-time runtime type checker.

...or something. I leave everything to your skilled and talented hands.

Thanks again. This has been an extreme year for humanity, so I humbly appreciate everyone's continued focus on this small (but crucial) slice of the Python pie. You're all awesome!

Libraries and frameworks leveraging Type annotations

Should there be a section about tools, libraries, frameworks that leverage type annotations, like FastAPI, Pydantic, Typer, ... ?

Background: I just stumbled over https://github.com/cal-pratt/flexdi and was wondering how to promote something like this. https://github.com/pschanely/CrossHair is another example falling into this category (if we want to make one)

Add this list to https://github.com/sindresorhus/awesome and similar

There are multiple lists like this one!

We also need to mature for at least 30 days. So, October will be the date.

Curses helper i made, maybe fits.

I got started on so.e curses helper stuff, including a (to be expanded) types module. You can find it on my github. Currently it has a window type.

Some offerings

Caveat: I do not have experience with the tools yet, but they aren't the first thing I googled, either.

Tools (not sure what subcategory):
https://pypi.org/project/typing-json/
https://github.com/contains-io/typingplus/
https://github.com/contains-io/typet

Articles (new subcategory: Python doc):
https://docs.python.org/3/library/typing.html

Articles (Third party):
https://www.bernat.tech/the-state-of-type-hints-in-python/

Add Python-typing-koans when matured

https://github.com/kracekumar/python-typing-koans

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

One of the best of 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.

The issue is just meant to be a reminder/Note to self, to create a PR once the repo has matured enough to be included

Disable Projects, Wiki, Security tabs for repo

data-science-types has stopped development

https://github.com/predictive-analytics-lab/data-science-types/

data-science-types has archived the github repository and stopped development due to types added into the upstream packages.

Add python-typecheckers to the list

https://github.com/ethanhs/python-typecheckers

We can also add some important libs from there to our own list.

Suggest adding to Articles

Below is a personal document I wrote before, might be useful for people who are new to python typing, feel free to take some into the Articles part.

---

Python Type Hints

Basic Guides

• PEP 483 -- The Theory of Type Hints: https://www.python.org/dev/peps/pep-0483/
• PEP 484 -- Type Hints: https://www.python.org/dev/peps/pep-0484/
• PEP 3107 -- Function Annotations: https://www.python.org/dev/peps/pep-3107/
• PEP 526 -- Syntax for Variable Annotations: https://www.python.org/dev/peps/pep-0526/
• mypy
  • Python 3: https://mypy.readthedocs.io/en/latest/cheat_sheet_py3.html
  • Python 2: https://mypy.readthedocs.io/en/latest/cheat_sheet.html
• PyCharm: https://www.jetbrains.com/help/pycharm/type-hinting-in-product.html

Advanced Guides

PEP 563 -- Postponed Evaluation of Annotations

https://www.python.org/dev/peps/pep-0563/

This PEP describes the support of referencing a type that is yet to defined in the annotation, and how to enabling it by calling from __future__ import annotations in Python after 3.7

In Python before 3.7 (<= 3.6), same thing can be achieved by adding single quote around the type, this is called Forward references in PEP 484.

Literal

• mypy Literal: https://mypy.readthedocs.io/en/latest/literal_types.html
• PEP 586 -- Literal Types: https://www.python.org/dev/peps/pep-0586/

Protocol

• mypy Protocol: https://mypy.readthedocs.io/en/latest/protocols.html
• PEP 544 -- Protocols: Structural subtyping (static duck typing): https://www.python.org/dev/peps/pep-0544/

Generic

• mypy Generics: https://mypy.readthedocs.io/en/latest/generics.html
• PEP 483 Defining and using generic types: https://www.python.org/dev/peps/pep-0483/#defining-and-using-generic-types
• PEP 484 User-defined generic types: https://www.python.org/dev/peps/pep-0484/#user-defined-generic-types

Create CONTRIBUTING.md

https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md

Run awesome-lint on this list

https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md

numpy-stubs is archived

https://github.com/numpy/numpy-stubs

These stubs have been merged into NumPy, and all further development will happen in the NumPy main repo. We welcome your contributions there!

Add section for additional types

Some tools allow to have empowered type annotations, extending mypy capabilities. Let's talk if we want a new section for them or "mypy plugins" fits well enough.

• https://github.com/dry-python/returns
• https://github.com/antonagestam/phantom-types
• https://github.com/mplanchard/safetywrap
• https://github.com/contains-io/typet
• https://github.com/alice-biometrics/meiga
• https://github.com/MaT1g3R/option

Add `strongtyping` to the list of runtime typecheckers

https://strongtyping.readthedocs.io

add pyannotatate

Add data-science-types

data-science-types - provides stubs for numpy, pandas, and matplotlib.

Ruff: A new, fast and correct Python checker/linter

Please have a look at ruff.

An extremely fast Python linter, written in Rust.
https://github.com/charliermarsh/ruff

Notes on ruff
https://whynothugo.nl/journal/2023/01/20/notes-on-ruff/

A pre-commit hook for Ruff.
https://github.com/charliermarsh/ruff-pre-commit

I have no association with ruff or its developer(s).

Pravda

Brand new, to keep an eye on:
https://github.com/wemake-services/pravda
Python type-checker written in Rust