mypy README

The project's README from github.com/python/mypy. As one markdown file: README.md.

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

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

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

You can also try mypy in an online playground (developed by Yusuke Miyazaki).

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.

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 the issue tracker at https://github.com/mypyc/mypyc

mypy (python/mypy)

Searching Database…

20.7K ·GitHub
Mypy
Что это такое?Mypy — это статический анализатор типов для Python: вы добавляете в код подсказки типов (PEP 484), а он предупреждает, когда вы используете эти типы неправильно, находя баги даже без запуска программы.
Чем это отличается от того, чтобы просто запустить код и посмотреть, что сломается?В динамическом языке вроде Python ошибки обычно видны только при запуске кода. Mypy проверяет программу статически, поэтому может находить баги, вообще не выполняя её.
С чего начать?Установите его через pip ('pip install mypy'), затем запустите 'mypy' на файлах вашей программы. Свежий код из разработки можно установить прямо из репозитория.
Нужно ли добавить подсказки типов во весь код, прежде чем mypy станет полезен?Нет — mypy создан для постепенной типизации: добавляйте подсказки понемногу и возвращайтесь к динамической типизации там, где статическая неудобна.
Если mypy нашёл ошибки типов, программа всё равно запустится?Да. Подсказки типов работают как комментарии и не меняют поведение программы — код всегда можно запустить интерпретатором Python, даже если mypy сообщает об ошибках.
Можно попробовать mypy, ничего не устанавливая?Да — есть онлайн-песочница (её разработал Yusuke Miyazaki), где mypy можно попробовать прямо в браузере.
Что такое Mypyc?Сопутствующий проект, который компилирует модули Python в более быстрые C-расширения, используя подсказки типов. Сам Mypy скомпилирован с помощью mypyc, из-за чего он примерно в 4 раза быстрее интерпретируемой версии.
О чём стоит помнить при запуске mypy через pre-commit?Хук pre-commit (mirrors-mypy) работает, но по умолчанию он ограничивает возможность mypy анализировать ваши сторонние зависимости.
What are similar projects?shellcheck, pyright, ruff, ast-grep, knip, perch, standard, static-analysis
Which topics is it in?typechecker, types, static-code-analysis, code-analysis, linter, code-quality, static-analysis, compiler, command-line-tool, terminal, tool, cli
Creator
python
Size
85.8 MB
Stars
20.7K
Updated
CommitOct 17
Age
13y
Commits · 90 Days