Справочник по CLI
ty
Очень быстрый проверяющий типов для Python.
Использование
ty <COMMAND>
Команды
ty check
Проверить проект на ошибки типов
ty server
Запустить языковой сервер
ty version
Показать версию ty
ty help
Вывести это сообщение или справку по указанной подкоманде (подкомандам)
ty check
Проверить проект на ошибки типов
Использование
ty check [OPTIONS] [PATH]...
Аргументы
PATHS
Список файлов или каталогов для проверки [по умолчанию: корень проекта]
Опции
--add-ignore
Добавляет комментарии ty: ignore для подавления всех диагностик правил
--color when
Управляет использованием цветного вывода
Возможные значения:
never: Никогда не выводить цветаalways: Всегда выводить цветаauto: Выводить цвета, если вывод идёт в интерактивный терминал
--config, -c config-option
Пара «ключ=значение» в формате TOML (как в конфигурационном файле ty.toml) для переопределения отдельной опции конфигурации.
Переопределения через эту опцию всегда имеют приоритет над всеми конфигурационными файлами.
--config-file path
Путь к файлу ty.toml для использования в качестве конфигурации.
Конфигурация ty может быть в файле pyproject.toml, но в данном контексте это не допускается.
Можно также задать переменной окружения TY_CONFIG_FILE.
--error rule
Считать указанное правило имеющим уровень серьёзности «error». Можно указывать несколько раз. Используйте «all», чтобы применить ко всем правилам.
--error-on-warning
Использовать код выхода 1 при наличии любых диагностик уровня предупреждения
--exclude exclude
Glob-шаблоны файлов, исключаемых из проверки типов.
Используется синтаксис в стиле gitignore для исключения файлов и каталогов из проверки типов. Поддерживаются шаблоны вида tests/, *.tmp, **/__pycache__/**.
--exit-zero
Всегда использовать код выхода 0, даже при наличии диагностик уровня ошибки
--extra-search-path path
Дополнительный путь для использования как источник разрешения модулей (можно передать несколько раз).
Расширенная опция; обычно нужна только для модулей первого или стороннего уровня, не установленных в окружение Python обычным способом. Используйте --python, чтобы указать ty на ваше окружение Python, если оно в нестандартном месте.
--force-exclude
Применять исключения даже к путям, переданным ty напрямую в командной строке. Для отключения используйте --no-force-exclude
--help, -h
Вывести справку (краткий обзор с «-h»)
--ignore rule
Отключить правило. Можно указывать несколько раз. Используйте «all», чтобы применить ко всем правилам.
--no-progress
Скрывать весь вывод прогресса.
Например, спиннеры или индикаторы прогресса.
--output-format output-format
Формат вывода диагностических сообщений
Можно также задать переменной окружения TY_OUTPUT_FORMAT.
Возможные значения:
junit: Выводить диагностику в виде XML-отчёта в стиле JUnitgithub: Выводить диагностику в формате аннотаций ошибок GitHub Actionsgitlab: Выводить диагностику в формате JSON для отчётов GitLab Code Qualityconcise: Выводить диагностику кратко, по одной строке на сообщениеfull: Выводить диагностику подробно, с контекстом и подсказками (по умолчанию)
--project project
Выполнять команду в указанном каталоге проекта.
Все файлы pyproject.toml будут найдены при обходе дерева каталогов вверх от указанного каталога проекта; то же относится к виртуальному окружению проекта (.venv), если не задана опция venv-path.
Остальные аргументы командной строки (например, относительные пути) разрешаются относительно текущего рабочего каталога.
--python, --venv path
Путь к окружению Python или интерпретатору проекта.
ty использует ваше окружение Python для разрешения сторонних импортов в коде.
Может быть путём к:
- интерпретатору Python, например
.venv/bin/python3 - каталогу виртуального окружения, например
.venv - каталогу sys.prefix системного Python, например
/usr
При использовании инструмента управления проектами (uv) или активированного окружения Conda/venv обычно указывать эту опцию не нужно.
--python-platform, --platform platform
Целевая платформа, которую считать при разрешении типов.
Используется для уточнения типа sys.platform и влияет на видимость платформо-зависимых функций и атрибутов. При значении all платформа не предполагается. Если не указано, используется платформа текущей системы.
--python-version, --target-version version
Версия Python, которую считать при разрешении типов.
Версия Python влияет на допустимый синтаксис, определения типов стандартной библиотеки и определения типов модулей первого и стороннего уровня, зависящие от версии Python.
Если версия не указана в командной строке или в конфигурации, ty пытается определить её в следующем порядке: 1) параметр project.requires-python в pyproject.toml — используется минимальная версия из диапазона; 2) активное или настроенное окружение Python — попытка вывести версию из него; 3) последняя стабильная версия Python, поддерживаемая ty (см. вывод ty check --help)
Возможные значения:
3.153.143.133.123.113.103.93.83.7
--quiet, -q
Тихий вывод (или -qq для полностью без вывода)
--respect-ignore-files
Учитывать исключения файлов из .gitignore и других стандартных файлов игнорирования. Для отключения используйте --no-respect-ignore-files
--typeshed, --custom-typeshed-dir path
Пользовательский каталог для заглушек типов stdlib (typeshed)
--verbose, -v
Подробный вывод (или -vv и -vvv для ещё более подробного)
--warn rule
Считать указанное правило имеющим уровень серьёзности «warn». Можно указывать несколько раз. Используйте «all», чтобы применить ко всем правилам.
--watch, -W
Отслеживать изменения файлов и перепроверять файлы, связанные с изменёнными
ty server
Запустить языковой сервер
Использование
ty server
Опции
--help, -h
Вывести справку
ty version
Показать версию ty
Использование
ty version [OPTIONS]
Опции
--help, -h
Вывести справку
--output-format output-format
Формат вывода информации о версии
[по умолчанию: text]
Возможные значения:
jsontext
ty generate-shell-completion
Сгенерировать автодополнение для оболочки
Использование
ty generate-shell-completion <SHELL>
Аргументы
SHELL
Опции
--help, -h
Вывести справку
ty help
Вывести это сообщение или справку по указанной подкоманде (подкомандам)
Использование
ty help [COMMAND]