Конфигурация

Конфигурационные файлы

ty поддерживает постоянные конфигурационные файлы как на уровне проекта, так и на уровне пользователя.

В частности, ty будет искать файл pyproject.toml или ty.toml в текущем каталоге или в ближайшем родительском каталоге.

Если найден файл pyproject.toml, ty прочитает конфигурацию из секции [tool.ty]. Например, чтобы игнорировать правило index-out-of-bounds, добавьте следующее в pyproject.toml:

pyproject.toml

[tool.ty.rules]
index-out-of-bounds = "ignore"

Note

Если секции tool.ty нет, файл pyproject.toml будет проигнорирован, и ty продолжит поиск по иерархии каталогов.

ty также будет искать файлы ty.toml, которые имеют идентичную структуру, но без префикса [tool.ty]. Например:

ty.toml

[rules]
index-out-of-bounds = "ignore"

Important

Файлы ty.toml имеют приоритет над файлами pyproject.toml, поэтому если в одном каталоге присутствуют и ty.toml, и pyproject.toml, конфигурация будет прочитана из ty.toml, а секция [tool.ty] в соответствующем pyproject.toml будет проигнорирована.

ty также обнаруживает пользовательскую конфигурацию по пути ~/.config/ty/ty.toml (или $XDG_CONFIG_HOME/ty/ty.toml) на macOS и Linux, или %APPDATA%\ty\ty.toml в Windows. Конфигурация на уровне пользователя должна использовать формат ty.toml, а не формат pyproject.toml, поскольку pyproject.toml предназначен для описания Python‑проекта.

Если найдены конфигурационные файлы уровня проекта и уровня пользователя, настройки будут объединены, при этом конфигурация проекта будет иметь приоритет над пользовательской.

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

Настройки, переданные через командную строку, имеют приоритет над постоянной конфигурацией.

См. справочник по конфигурации для полного списка доступных параметров.