isort, Giga

isort, Giga

https://giga.chat/link/gcsJhXtnzn Python, Project Structure

isort — это инструмент для автоматического упорядочивания и группировки импортов в Python-код. 
Основная цель isort — 
обеспечить консистентность и легкую читаемость кода путём правильной сортировки и группировки инструкций импорта.
Основные функции isort:
Классификация импортов: 
разделение импортов на блоки по типу (стандартные библиотеки, внешние зависимости, внутренние модули проекта).
Сортировка: 
автоматическое расположение импортов в алфавитном порядке внутри блоков.
Конвенции порядка: 
сохранение естественного порядка следования импортов, рекомендованного сообществом Python-разработчиков.
Распределение по длине строки: 
распределение длинных списков импортов на несколько строк, чтобы сохранить компактность и эстетичность.
Польза isort:
Уменьшается когнитивная нагрузка при чтении кода.
Повышается читаемость и поддержка больших проектов.
Нет необходимости вручную организовывать и перемещать инструкции импорта.
Снижается шанс пропустить ошибку или конфликт импорта.
Применение isort:
Установите isort через pip:

pip install isort

Примените его к вашему проекту:

isort .

isort автоматически реорганизует импортированные модули, выравнивая их в нужной последовательности.
Настройки isort:
Для тонкого контроля над поведением isort можно создать файл конфигурации pyproject.toml или .isort.cfg:

[tool.isort]
force_single_line=True
line_length=100
known_first_party=["my_project"]

Работа с блоками импортов:
isort делит импорт на четыре блока:
Стандартные библиотеки (builtins).
Сторонние зависимости (third-party libraries).
Внутренние модули проекта (first-party modules).
Локальные относительные импортные пути (local relative imports).
Советы по применению isort:
Подключите isort к вашей среде разработки (IDE или редактору) для автоматического форматирования при сохранении файла.
Используйте isort совместно с другими инструментами, такими как Black или Ruff, 
для достижения полной автоматизации форматирования и проверки качества кода.
Устанавливайте правило автоформатирования в конвейере CI/CD, 
чтобы предотвратить появление несогласованных импортеров в рабочем дереве.
Итоги:
isort — полезный инструмент для повышения качества и согласованности Python-кода. 
Его применение экономит время и усилия, 
снижая необходимость ручной коррекции импортов и улучшая общую управляемость проекта.