Рубрики
Без рубрики

Intro в черный – бескомпромиссная форма Python Code

Получите практические, реальные навыки Python на наших ресурсах и пути

Автор оригинала: Mike Driscoll.

Есть несколько шашек Code Python. Например, многие разработчики пользуются использованием Пилинт или Flake8 Чтобы проверить их код для ошибок. Эти инструменты используют анализ статического кода для проверки вашего кода для ошибок или проблем именования. FLAKE8 также проверит ваш код, чтобы увидеть, если вы придерживаетесь Pep8 Руководство по стилю Python.

Однако есть новый инструмент, который вы можете использовать под названием Черный Отказ Черный – это форма Python код. Он будет переформатировать весь ваш файл на месте в соответствии с стилем черного кода, который довольно близко к Pep8.

Монтаж

Установка черного проста. Вы можете просто использовать Pip для этого:

pip install black

Вы также можете настроить популярные текстовые редакторы и IDes, чтобы использовать черный, следующий за этим Инструкции Отказ

Теперь, когда черный установлен, давайте попробуем!

Используя черный

Черный требует, чтобы у вас был какой-код, чтобы запустить его. Давайте создадим простой функцию, которая имеет много параметров, а затем запустить черный скрипт.

Вот пример:

def long_func(x, param_one=None, param_two=[], param_three={}, param_four=None, param_five="", param_six=123456):
    print("This function has several params")

Теперь в вашем терминале попробуйте запустить Черный против вашего файла кода, как это:

черный long_func.py.

Когда вы запускаете эту команду, вы должны увидеть следующий вывод:

Reformatted Long_func.py. Все сделано! ✨ 🍰 ✨ 1 файл переформатирован.

Это означает, что ваш файл был переформатирован, чтобы следовать черному стандарту.

Давайте откроем файл и посмотрите, как выглядит:

def long_func(
    x,
    param_one=None,
    param_two=[],
    param_three={},
    param_four=None,
    param_five="",
    param_six=123456,
):
    print("This function has several params")

Как видите, черный положил каждый из параметров на собственную линию.

Проверка файлов для форматирования

Если вы не хотите, чтобы черный изменить свой файл, но вы хотите знать, если Black думает, что файл должен быть изменен, вы можете использовать одну из следующих командных флагов:

  • --check - который проверяет, должен ли файл переформатировать, но на самом деле не модифицирует файл
  • --diff - который пишет различие того, что черный сделает с файлом, но не модифицирует файл

Мне нравится использовать их, чтобы пройти тест на моих файлах и посмотреть, как черный будет переформатировать мой код. Я не использовал черное долгое время, так что это давайте посмотрим, нравится ли мне то, что черное будет делать, не делая ничего не делать.

Обертывание

Мне нравится черный. Я думаю, что это может быть действительно полезно, особенно в организации, когда речь идет о соблюдении определенного стиля Python. Обратите внимание, что черные по умолчанию для 88 символов для длины его линии, но вы можете изменить, что используя -L или - Ленту, если вам нужно. Есть также несколько других вариантов, которые вы можете найти полезные, перечисленные на Страница проекта Отказ Если у вас есть шанс, я думаю, вы должны дать черную попытку!

Связанное чтение

  • Пилинт: Анализируя код Python
  • Pyflakes – Пассивный контролер программ Python
  • Python 101: Эпизод № 32 – Анализ статического кода

Читайте ещё по теме: