Введение

MyPy¹ — средство проверки статического типа для Python. В отличие от статически типизированных языков, таких как C или Java, Python является динамически типизированным. Это означает, что в Python вам не нужно явно объявлять тип переменной; это выводится во время выполнения. Например:

Python (динамически типизированный)

num = 4                # `num` is inferred as an integer
newString = "new string"  # `newString` is inferred as a string

Напротив, статически типизированные языки требуют указания типа каждой переменной во время компиляции. Это помогает обнаружить ошибки, связанные с типом, во время разработки, а не во время выполнения.

C (статически типизированный)

int num = 4;            // `num` is declared as an integer
std::string newString = "new string";  // `newString` is declared as a string

Зачем использовать MyPy?

В динамически типизированных языках, таких как Python, ошибки типа могут возникать во время выполнения, что может привести к ошибкам, которые сложнее отследить. MyPy решает эту проблему, позволяя вам добавлять подсказки типов в ваш код Python, которые можно проверить статически перед выполнением. Это дает несколько преимуществ:

• Раннее обнаружение ошибок: выявляйте ошибки, связанные с типом, во время разработки, а не сталкивайтесь с ними во время выполнения.
• Улучшенная читаемость кода: подсказки типов поясняют ожидаемые типы переменных и аргументов функций, улучшая читаемость кода.
• Лучшая поддержка IDE: обеспечивает улучшенное завершение кода и встроенную документацию в средах IDE, поддерживающих подсказки типов.

Пример с MyPy

Вот простой пример, демонстрирующий использование подсказок типов в MyPy:

Без подсказок типа

def add(a, b):
    return a   b

print(add(5, 3))      # Output: 8
print(add("hello", "world"))  # Output: helloworld

В приведенном выше коде функция add может принимать как целые числа, так и строки, что может быть не совсем ожидаемым.

С подсказками по типу

def add(a: int, b: int) -> int:
    return a   b

print(add(5, 3))      # Output: 8
# mypy will report an error for the following line:
# print(add("hello", "world"))  # TypeError: Expected int, got str

Включая подсказки типов (a: int, b: int), вы указываете, что add должен работать только с целыми числами. MyPy проверяет код на соответствие этим подсказкам типов, заранее выявляя потенциальные проблемы, связанные с типами.

Установка и запуск MyPy

Чтобы начать работу с MyPy:

1. Установка: установите MyPy с помощью pip:

   python3 -m pip install mypy

1. Запуск MyPy: после установки вы можете запустить MyPy, чтобы проверить свой код на наличие ошибок типа. Используйте следующую команду:

   mypy program.py

Эта команда проверит ваш код статически, подобно тому, как компилятор проверяет синтаксис в C. Он будет сообщать о любых обнаруженных ошибках типа без фактического запуска кода.

Эффективное использование MyPy позволяет интегрировать преимущества статической типизации в Python, сохраняя при этом гибкость ее динамической природы.

Давайте напишем пример с помощью MyPy

Без MyPy

def greeting(name):
    return 'Hello '   name

# These calls will fail when the program runs, but MyPy will not report an error
greeting(123)
greeting(b"Aniket")

С MyPy

Добавляя аннотации типов (также известные как подсказки типов), MyPy может обнаруживать потенциальные проблемы:

def greeting(name: str) -> str:
    return 'Hello '   name

greeting(3)         # mypy will report: Argument 1 to "greeting" has incompatible type "int"; expected "str"
greeting(b'Alice')  # mypy will report: Argument 1 to "greeting" has incompatible type "bytes"; expected "str"
greeting("World!")  # No error

Здесь:

• name: аннотация str указывает, что аргумент name должен быть строкой.
• -> аннотация str указывает, что функция Greeting вернет строку.

Когда использовать MyPy

MyPy полезен в нескольких ситуациях:

• Заблаговременное обнаружение ошибок: используйте MyPy для поиска ошибок, связанных с типом, перед запуском кода. Это помогает заранее обнаружить ошибки и повышает надежность кода.

• Сделайте код понятнее: добавление подсказок по типам упрощает понимание вашего кода. Он показывает, какие типы значений ожидаются, что помогает другим (и вам в будущем) лучше понять ваш код.

• Обновление старого кода: при обновлении старого кода MyPy помогает находить проблемы с типами при добавлении подсказок по типу, делая переход более плавным.

• Улучшите прототипы: при создании новых функций или прототипов MyPy помогает гарантировать правильную работу нового кода с существующим кодом, применяя правила типов.

• Поддержка больших проектов: в больших проектах с большим количеством участников MyPy помогает поддерживать согласованность кода и предотвращает ошибки, связанные с типами.

• Увеличение возможностей IDE: если вы используете IDE, MyPy улучшает такие функции, как завершение кода и навигация, что упрощает разработку.

Использование MyPy поможет вам писать более качественный и надежный код Python, сохраняя при этом гибкость Python.

Официальная краткая шпаргалка для mypy

1. Официальная документация ↩