• Stars
    star
    18,263
  • Rank 1,448 (Top 0.03 %)
  • Language
    Python
  • License
    Other
  • Created almost 12 years ago
  • Updated about 2 months ago

Reviews

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

Repository Details

Optional static typing for Python

mypy logo

Mypy: Static Typing for Python

Stable Version Downloads Build Status Documentation Status Chat at https://gitter.im/python/typing Checked with mypy Code style: black Linting: Ruff

Got a question?

We are always happy to answer questions! Here are some good places to ask them:

If you're just getting started, the documentation and type hints cheat sheet can also help answer questions.

If you think you've found a bug:

To report a bug or request an enhancement:

To discuss a new type system feature:

What is mypy?

Mypy is a static type checker for Python.

Type checkers help ensure that you're using variables and functions in your code correctly. With mypy, add type hints (PEP 484) to your Python programs, and mypy will warn you when you use those types incorrectly.

Python is a dynamic language, so usually you'll only see errors in your code when you attempt to run it. Mypy is a static checker, so it finds bugs in your programs without even running them!

Here is a small example to whet your appetite:

number = input("What is your favourite number?")
print("It is", number + 1)  # error: Unsupported operand types for + ("str" and "int")

Adding type hints for mypy does not interfere with the way your program would otherwise run. Think of type hints as similar to comments! You can always use the Python interpreter to run your code, even if mypy reports errors.

Mypy is designed with gradual typing in mind. This means you can add type hints to your code base slowly and that you can always fall back to dynamic typing when static typing is not convenient.

Mypy has a powerful and easy-to-use type system, supporting features such as type inference, generics, callable types, tuple types, union types, structural subtyping and more. Using mypy will make your programs easier to understand, debug, and maintain.

See the documentation for more examples and information.

In particular, see:

Quick start

Mypy can be installed using pip:

python3 -m pip install -U mypy

If you want to run the latest version of the code, you can install from the repo directly:

python3 -m pip install -U git+https://github.com/python/mypy.git
# or if you don't have 'git' installed
python3 -m pip install -U https://github.com/python/mypy/zipball/master

Now you can type-check the statically typed parts of a program like this:

mypy PROGRAM

You can always use the Python interpreter to run your statically typed programs, even if mypy reports type errors:

python3 PROGRAM

You can also try mypy in an online playground (developed by Yusuke Miyazaki). If you are working with large code bases, you can run mypy in daemon mode, that will give much faster (often sub-second) incremental updates:

dmypy run -- PROGRAM

Integrations

Mypy can be integrated into popular IDEs:

Web site and documentation

Additional information is available at the web site:

https://www.mypy-lang.org/

Jump straight to the documentation:

https://mypy.readthedocs.io/

Follow along our changelog at:

https://mypy-lang.blogspot.com/

Contributing

Help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels.

To get started with developing mypy, see CONTRIBUTING.md.

If you need help getting started, don't hesitate to ask on gitter.

Mypyc and compiled version of mypy

Mypyc uses Python type hints to compile Python modules to faster C extensions. Mypy is itself compiled using mypyc: this makes mypy approximately 4 times faster than if interpreted!

To install an interpreted mypy instead, use:

python3 -m pip install --no-binary mypy -U mypy

To use a compiled version of a development version of mypy, directly install a binary from https://github.com/mypyc/mypy_mypyc-wheels/releases/latest.

To contribute to the mypyc project, check out https://github.com/mypyc/mypyc

More Repositories

1

cpython

The Python programming language
Python
55,867
star
2

peps

Python Enhancement Proposals
reStructuredText
4,337
star
3

typeshed

Collection of library stubs for Python, with static types
Python
4,316
star
4

devguide

The Python developer's guide
Python
1,841
star
5

typing

Python static typing home. Hosts the documentation and a user help forum.
Python
1,587
star
6

pythondotorg

Source code for python.org
Python
1,414
star
7

asyncio

asyncio historical repository
1,015
star
8

pyperformance

Python Performance Benchmark Suite
Python
847
star
9

python-docs-zh-cn

zh_CN translation of the Python documentation
431
star
10

typing_extensions

Backported and experimental type hints for Python
Python
418
star
11

python-docs-fr

Mirroir en lecture seule de https://git.afpy.org/AFPy/python-docs-fr
355
star
12

python-docs-es

Spanish translation of the Python documentation.
Python
319
star
13

python-docs-zh-tw

Traditional Chinese (zh-tw) translation of the Python Documentation
Python
246
star
14

typed_ast

Modified fork of CPython's ast module that parses `# type:` comments
C
227
star
15

raspberryio

Source code for raspberry.io
Python
222
star
16

steering-council

Communications from the Steering Council
Makefile
138
star
17

mypy_extensions

Extensions for mypy
Python
134
star
18

planet

Configuration for Python planets (e.g. http://planetpython.org)
Python
132
star
19

python-docs-pt-br

Brazilian Portuguese translation of the Python Documentation
Makefile
115
star
20

bedevere

A bot to help identify missing information for CPython pull requests
Python
113
star
21

python-docs-tr

Turkish Translation of the Python Documentation
Python
112
star
22

miss-islington

๐Ÿ๐Ÿ’โ›๐Ÿค– - A bot for backporting and merging CPython pull requests
Python
104
star
23

psf-salt

PSF infrastructure configuration
SaltStack
104
star
24

importlib_metadata

Backport of the importlib.metadata module
Python
100
star
25

pycon-code-of-conduct

pycon code of conduct
97
star
26

core-workflow

Issue tracker for CPython's workflow
Python
87
star
27

the-knights-who-say-ni

CLA enforcement bot for Python organization projects
Python
81
star
28

tzdata

Python package wrapping the IANA time zone database
Python
76
star
29

python-docs-theme

Sphinx theme for Python documentation
CSS
73
star
30

python-docs-ko

Korean translation of the Python documentation
63
star
31

python-docs-ja

Shell
61
star
32

docsbuild-scripts

scripts for building documentation on docs.python.org
Python
61
star
33

python-docs-id

Terjemahan Bahasa Indonesia untuk Dokumentasi Python
58
star
34

pythoncapi-compat

The pythoncapi-compat project can be used to write a C extension supporting a wide range of Python versions with a single code base.
Python
53
star
35

importlib_resources

Backport of the importlib.resources module
Python
52
star
36

cherry-picker

๐Ÿ๐Ÿ’โ› Utility script for backporting/cherry-picking CPython changes from master into one of the maintenance branches.
Python
48
star
37

community-starter-kit

Collection of resources for Python community organizers
Python
46
star
38

python-docs-pl

Polskie tล‚umaczenie dokumentacji Pythona
Python
46
star
39

getpython3.com

getpython3.com page and resources.
CSS
44
star
40

psf-chef

Chef configuration and cookbooks for the Python Software Foundation
Ruby
44
star
41

typing-council

Decisions by the Python Typing Council
42
star
42

docs-community

Community management for documentation contributors and the Docs Workgroup
Makefile
41
star
43

pythonineducation.org

The pythonineducation.org website
HTML
29
star
44

release-tools

Scripts for making (C)Python releases
Python
28
star
45

buildmaster-config

Configuration for buildbot.python.org
Python
27
star
46

blurb_it

`blurb add` over the internet
Python
26
star
47

cpython-bin-deps

Binaries that the cpython build process depends on
22
star
48

exceptiongroups

An early draft of a PEP around Exception Groups in Python
22
star
49

cpython-source-deps

Source for packages that the cpython build process depends on
22
star
50

python-docs-uk

Ukrainian translation of the Python Documentation
Makefile
21
star
51

discord-bot

Discord Bot for Core Devs Discord server
Python
20
star
52

psf-docs

PSF Docs
Python
18
star
53

historic-python-materials

Contains some old pages from python.org
Python
18
star
54

consul-operator

A kubernetes operator for consul
Go
17
star
55

core-sprint

Repo for Virtual Core Dev Sprint 2020
Python
16
star
56

speed.python.org

HTML
14
star
57

devinabox

Documentation and tools to help host a sprint on Python core development
Python
14
star
58

docker-bpo

Docker image for bugs.python.org
Python
14
star
59

pythontestdotnet

source of pythontest.net (resources used for Python test suite)
HTML
12
star
60

.github

Organization-wide GitHub settings
11
star
61

bugs.python.org

Meta-issue tracker for bugs.python.org
11
star
62

hugs.python.org

10
star
63

psf-infra-meta

Meta-repository for PSF backed or managed systems. Created mainly for the issue tracker :)
10
star
64

psf-community-resources

Short guides to PSF-related resources
10
star
65

python-docs-it

Italian translation of the Python documentation.
10
star
66

python-dev-survey

Place for gathering feedback from the public on the Python Developers Survey
8
star
67

bpo-builder

bugs.python.org builder image & other deployment artifacts
Python
7
star
68

language-summit

Resources for the annual Python Language Summit
7
star
69

python-docs-hu

Hungarian Translation of the Python Documentation
7
star
70

psfoutreach

PSF Outreach website
Shell
6
star
71

tlsproxy

Python
6
star
72

psf-packages

HTML
5
star
73

redistributor-guide

Guidance & recommendations for anyone publishing their own binary builds of CPython
4
star
74

overload-sig

Discussion about discussion overload, see https://mail.python.org/mm3/mailman3/lists/[email protected]/
4
star
75

issues-test-cpython

Test repository for the bpo migration
3
star
76

python-docs-bn-in

3
star
77

cpython-devcontainers

Repository for devcontainers of CPython
Dockerfile
2
star
78

pootle-python-org-backup

Python
2
star
79

issues-test-demo-20220218

Test repository for the bpo migration
1
star
80

issues-test-demo-20220402

Test repository for the bpo migration
1
star