Проверка типов

После установки ty можно перейти к проверке типов в коде.

Запуск проверяющего типов

Чтобы запустить проверяющий типов, используйте команду check:

ty check

Tip

Если вы находитесь внутри проекта, может понадобиться использовать uv run или предварительно активировать виртуальное окружение, чтобы ty смог найти ваши зависимости.

Обнаружение окружения

Проверяющему типов необходимо обнаружить установленные пакеты, чтобы проверять использование импортируемых вами зависимостей.

ty найдёт установленные пакеты в активном виртуальном окружении (через переменную VIRTUAL_ENV) или обнаружит виртуальное окружение с именем .venv в корне проекта или рабочем каталоге. Если этого сделать не удаётся, ty попытается найти бинарный файл python3 или python, доступный в PATH. В качестве альтернативы можно передать флаг --python, чтобы явно указать путь к интерпретатору Python.

Подробнее см. документацию по обнаружению модулей.

Выбор файлов

По умолчанию ty будет запускаться на всех файлах Python в рабочем каталоге (включая подкаталоги, рекурсивно). Если ty используется внутри проекта, он будет запускаться на всех файлах Python в проекте (начиная с каталога, в котором находится pyproject.toml).

Также можно указать конкретные пути для проверки:

ty check example.py

Вы также можете постоянно настраивать включённые и исключённые файлы.

Выбор правил и уровни серьёзности

Диагностика проверки типов в ty часто связана с конкретным правилом.

Правила проверки типов в ty можно настроить под потребности вашего проекта. Подробности см. в документации по правилам.

Кроме того, вы можете подавлять отдельные нарушения правил с помощью комментариев подавления.

Режим наблюдения

ty можно запускать в инкрементальном режиме наблюдения:

ty check --watch

ty будет отслеживать изменения файлов и повторно проверять все затронутые файлы — включая файлы, которые зависят от изменённого файла. ty использует тонко настроенную инкрементальность, чтобы последующие проверки выполнялись значительно быстрее, чем многократный запуск ty check.

Система типов

Чтобы подробнее узнать, чем система проверки типов в ty отличается от других, прочитайте раздел о системе типов.