Изучение черных альтернатив: полное руководство по инструментам форматирования кода

Привет, коллеги-разработчики! Сегодня мы окунемся в чудесный мир инструментов форматирования кода и исследуем некоторые популярные альтернативы любимому инструменту под названием «Black». Являетесь ли вы питонистом или просто любите чистый и согласованный код, эта статья поможет вам открыть для себя новые возможности. Мы рассмотрим несколько альтернатив, демонстрируя их функции и попутно предоставляя примеры кода. Итак, начнём!

  1. Сортировка:

Isort — это фантастическая альтернатива Black, которая фокусируется на импорте операторов и их последовательной сортировке. Это гарантирует, что ваш импорт организован в соответствии с рекомендациями PEP 8, что делает ваш код более читабельным. Вот фрагмент кода, демонстрирующий работу Isort:

# Before Isort
from os import path
import sys
from my_module import MyClass
# After Isort
import sys
from os import path
from my_module import MyClass
  1. Autopep8:

Если вы ищете инструмент, который не только форматирует ваш код, но и исправляет различные нарушения PEP 8, Autopep8 — отличный выбор. Он автоматически регулирует отступы, переносит строки, добавляет или удаляет пробелы и многое другое. Взгляните на этот пример кода, чтобы увидеть Autopep8 в действии:

# Before Autopep8
def my_function(    arg1, arg2,  arg3):
        print("Hello, World!")
# After Autopep8
def my_function(arg1, arg2, arg3):
    print("Hello, World!")
  1. ЯПФ:

YAPF (Еще один форматировщик Python) известен своей простотой и мощными возможностями настройки. Он следует правилу «максимальной длины строки» и может соответствующим образом переформатировать ваш код. Давайте посмотрим, как YAPF может преобразовать ваш код:

# Before YAPF
def long_function_name(parameter_one, parameter_two, parameter_three):
    print("This is a long function name, and it violates the line length limit.")
# After YAPF
def long_function_name(
    parameter_one, parameter_two,
    parameter_three,
):
    print("This is a long function name, and it violates the line length limit.")
  1. Красивее:

Хотя Black фокусируется в основном на Python, Prettier – это форматировщик кода, поддерживающий несколько языков программирования. Это обеспечивает единообразный стиль кода в различных базах кода, что делает совместную работу более плавной. Вот пример, демонстрирующий возможности Prettier в JavaScript:

// Before Prettier
const myFunction = (arg1,arg2,arg3) => {console.log("Hello, World!");}
// After Prettier
const myFunction = (arg1, arg2, arg3) => {
  console.log("Hello, World!");
};

В этой статье мы рассмотрели несколько альтернатив черному варианту, каждый из которых имеет свои уникальные особенности и преимущества. Isort помогает организовать импорт, Autopep8 исправляет нарушения PEP 8, YAPF предоставляет возможности настройки, а Prettier предлагает поддержку нескольких языков. Включив эти инструменты в свой рабочий процесс, вы можете улучшить читаемость и удобство обслуживания кода. Так что давайте, попробуйте и найдите инструмент форматирования кода, который лучше всего соответствует вашим потребностям!