Дружим VS Code и blue форматтер для Python

17 ноября 2022 г.

0 минут

У Python есть отличный автоформаттер — black. Быстрый, простой и, главное, бескомпромиссный и почти не настраиваемый. Похож на gofmt у Go.

Но black предлагает использование двойных кавычек для строк, в то время как большинство питонистов привыкло к одинарным, т.е. "foo" вместо 'foo'. Этого оказалось достаточно для появления клона-близнеца — автоформаттера blue. Он использует black под капотом, поэтому отличия минимальны (см. документацию).

10 месяцев

С нуля

Python-разработчик

Программирование на Python, Разработка веб-приложений и сервисов используя Django, проектирование и реализация REST API

1 месяц

С опытом

СИКП на Python

Навык понимать код на фундаментальном уровне, уверенно проходить собеседования и решать сложные задачи

2 месяца

С опытом

ООП на Python

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

1 месяц

С нуля

Основы Python

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

1 месяц

Веб разработка на Python

Навык создания веб-приложений на Flask для разработки лёгких и гибких серверных решений

Официальный экстеншн Python в VS Code знает про black, но не знает про blue, документация тоже молчит. Но так как совместимость гарантируется, то достаточно в настройках указать blue как путь для форматтера black.

Итого:

Устанавливаем blue: poetry add --dev blue. Если до этого уже был установлен black, то, скорее всего, придется его удалить poetry remove --dev black т.к. может быть конфликт версий.
Открываем Command Palette (Ctrl+Shift+P), вводим settings json, выбираем Open Workspace Settings (JSON) и добавляем:

{
    "python.formatting.provider": "black",
    "python.formatting.blackPath": "blue",
}

Использование:

Стандартный хоткей для автоформатирования Ctrl+Shift+I
Или можно включить "editor.formatOnSave": true, но это не всегда удобный вариант

Настройка:

Добавляем "python.formatting.blackArgs": ["--line-length", "100"], — все там же, в json файле
Или в pyproject.toml:

[tool.blue]
line-length = 100

Alexey Ryabokon

3 года назад