Освоение форматирования кода: настройка максимальной длины строки в Python с помощью Black и кода Visual Studio

Форматирование кода — важный аспект написания чистого и удобного в сопровождении кода. В Python соблюдение единого руководства по стилю повышает читаемость кода и улучшает совместную работу разработчиков. Одним из часто обсуждаемых аспектов форматирования кода является максимальная длина строки. В этой статье будут рассмотрены различные методы настройки максимальной длины строки в Python с использованием средства форматирования кода Блэка в редакторе кода Visual Studio (VSCode).

Метод 1. Настройка Black с помощью pyproject.toml
Шаг 1. Откройте папку проекта в VSCode.
Шаг 2. Создайте файл pyproject.tomlв корневом каталоге или найдите существующий one.
Шаг 3. Добавьте в файл pyproject.tomlследующую конфигурацию:

[tool.black]
line-length = 88

Шаг 4. Сохраните файл, чтобы применить изменения конфигурации.

Метод 2. Настройка черного цвета с помощью настроек VSCode
Шаг 1. Откройте VSCode и выберите «Файл» >«Настройки» >«Настройки».
Шаг 2. Найдите «Python Formatting Black Path» в строке поиска и выберите «Редактировать». в settings.json.”
Шаг 3. Добавьте следующую конфигурацию в файл settings.json:

"python.formatting.blackArgs": [
    "--line-length",
    "88"
]

Шаг 4. Сохраните файл, чтобы применить изменения конфигурации.

Метод 3. Настройка Black с использованием настроек расширения VSCode.
Шаг 1. Установите расширение «Python» от Microsoft в VSCode, если оно еще не установлено.
Шаг 2. Откройте палитру команд в VSCode, нажав Ctrl+Shift. +P (или Cmd+Shift+P в macOS).
Шаг 3. Найдите «Настройки: открыть настройки рабочей области» и выберите его.
Шаг 4. Найдите «Python Formatting Black Args» в строке поиска. и добавьте следующую конфигурацию:

"python.formatting.blackArgs": [
    "--line-length",
    "88"
]

Шаг 5. Сохраните файл, чтобы применить изменения конфигурации.

Метод 4. Настройка Black с помощью файла конфигурации.
Шаг 1. Откройте VSCode и выберите «Файл» >«Настройки» >«Настройки».
Шаг 2. Найдите «Поставщик форматирования Python» в строке поиска и выберите «Изменить». в settings.json.”
Шаг 3. Добавьте следующую конфигурацию в файл settings.json:

"python.formatting.provider": "black",
"python.formatting.blackPath": "path/to/black",
"python.formatting.blackArgs": [
    "--line-length",
    "88"
]

Шаг 4. Сохраните файл, чтобы применить изменения конфигурации.

Постоянная максимальная длина строки в вашей кодовой базе Python может значительно улучшить читаемость и удобство обслуживания. В этой статье мы рассмотрели несколько методов настройки максимальной длины строки с помощью средства форматирования кода Блэка в редакторе кода Visual Studio. Независимо от того, предпочитаете ли вы настраивать Black с помощью файла pyproject.toml, настроек VSCode или использования файла конфигурации, теперь у вас есть инструменты для обеспечения определенной длины строки и обеспечения единообразного форматирования кода в ваших проектах Python.