Написание кода Python – это одно и запись кода в хорошем формате – это другое. Младшие программисты часто сосредоточены на том, чтобы их код работать и забыть правильно отформатировать код по пути.
Если вы пишете небольшую программу (с 1000 строками кодов), вы можете
Но поскольку программы становятся все более сложными, они становятся все сложнее и сложнее понять. В какой-то момент (около 15 000 строк кода) становится сложнее понять код, который вы сами писали.
Разница между работой над хорошо отформатированным кодом и работающим по плохому отформатированному коду похоже на разницу между жизнью во дворце и проживание в грязном доме.
Читаемость
Форматирование вашего кода поможет вам читать Ваш код эффективно Отказ Это выглядит более организованным, и когда кто-то смотрит на ваш код, они получит хорошее впечатление.
Это поможет в ваших кодированных интервью
Когда вы в кодирующем интервью, когда-нибудь интервьюеры позаботятся, если вы правильно форматировали свой код. Если вы забыли сделать это форматирование, вы можете потерять перспективы работы, только из-за вашего плохо отформатированного кода.
Поддержка команды
Форматирование вашего кода становится более важным, когда вы работаете в Команда Отказ Несколько человек, вероятно, будут работать над одним и тем же программным проектом и кодом, который вы пишете, должны быть поняты своими товарищами по команде. В противном случае становится сложнее работать вместе.
Это облегчает пятнистые ошибки
Плохому отформатированному коду может сделать это действительно, очень трудно определить ошибки или даже работать над программой. Это также просто ужасно смотреть. Это преступление к твоим глазам.
Большинство разработчиков Python наслаждаются использованием Пилинт или Flake8 Чтобы проверить свой код на ошибки и гиды стилей.
Пилинт это инструмент, который проверяет на ошибки в Python. Он пытается обеспечить соблюдение стандарта кодирования и ищет запахов кода. Он также может искать определенные ошибки типа, он может порекомендовать предложения о том, как конкретные блоки могут быть повторными, и могут предложить вам детали о сложности кода.
Flake8 это библиотека Python, которая оборачивает Pyflakes , Pycodestyle и Сценарий McCabe Batchelder Batchelder Отказ Это отличный инструментарий для проверки вашей кодовой базы против стиля кодирования (Pep8) , ошибки программирования, такие как «библиотека импортированного, но неиспользованного», «неопределенное имя» и код, который не является отступом.
Проблема в том, что эти инструменты сообщают только о проблемах, которые они идентифицируют в исходном коде и оставляют бремя для разработчиков Python, чтобы исправить их!
Но что, если у нас был инструмент, который мог бы определить и решить проблему одновременно? Черный это инструмент, который позволяет вам Определите ошибки и Форматировать свой код Python в то же время. Таким образом, это делает вас более продуктивным.
Из проекта Readme:
Черный может переформатировать весь ваш файл на месте в соответствии с черным стилем кода. Это помогает вашему мозгу фокусироваться на проблеме, которую вы хотите решить и кодовые решения, а не отвлекать структуру кода и незначительные стилистические различия.
Итак, давайте посмотрим, как его использовать.
Установите черный
Черный может быть установлен бегом PIP Установите черный Отказ Для запуска требуется Python 3.6.0+. Как только черный установлен, у вас будет новый инструмент командной строки, называемый Black, доступным для вас в вашей оболочке, и вы готовы начать!
Чтобы начать прямо сейчас с разумными значениями по умолчанию, выберите файл Python, который вы хотите отформатировать, а затем написать Black Filename.py в терминале. Затем черный отформатирует ваш файл Python.
Теперь мы посмотрим, что может помочь нам.
Форматировать один файл
Давайте посмотрим на этот простой пример: вот мои два функции Python в моем файле Python называется Famcure_Code.py.
Вы можете использовать черный образец_code.py В терминале для изменения формата. После запуска черный вы увидите следующий вывод:
Тогда вы можете открыть образец_Code.py, чтобы увидеть отформатированный код Python:
Код Python теперь отформатирован, и это более читаемо.
Форматировать несколько файлов
Чтобы отформатировать более одного файла Python, напишите Black Folder_Name/ в терминале.
Три файла Python в папке с именем python_with_black были переформатированы.
Проверка файлов для форматирования
Если вы не хотите, чтобы черный изменить свой файл, но вы хотите знать, если Black думает, что файл должен быть изменен, вы можете использовать одну из следующих команд:
Black --check. : Это будет проверять, какая файла (ы) Python может быть отформатирована в текущей папке (но на самом деле не модифицирует файлы Python).
Black --check --diff file_name.py : Это показывает, что нужно сделать для файла, но не изменяет файл.
Изменить количество символов в соответствии с
Обратите внимание, что черные по умолчанию для 88 символов для длины его линии, но вы можете изменить, что используя опцию «-L» или «—lline».
Например, чтобы изменить на 60 символов: Black -l 60 python_file.py Отказ
Для пользователей ноутбуков Jupyter вы все равно можете автоматически форматировать свой код Python с этим простым расширением, называемым Jupyter Black Отказ Это расширение реформатов/предел кода в коде кода ноутбука по черный Отказ
Черное расширение Jupyter обеспечивает
- Кнопка панели инструментов.
- Ярлык клавиатуры для переформатирования текущей кодовой ячейки (по умолчанию: Ctrl-B).
- Сочетание клавиш для переформатирования целых кодовых клеток (по умолчанию: Ctrl-Shift-B).
Установите Jupyter Black
Сначала убедитесь, что вы установили jupyter-app-nbextensions и черный Затем запустите следующие команды.
jupyter nbextension install https://github.com/drillan/jupyter-black/archive/master.zip — user
Затем включите расширение, запустив:
jupyter nbextension enable jupyter-black-master/jupyter-black
Теперь вы можете начать форматировать свой код Python в каждой ячейке ноутбука.
Во-первых, выберите ячейку ноутбука, которую вы хотите отформатировать код Python, затем нажмите кнопку Удлинитель под названием Black.
Затем нажмите кнопку Jupyter Black:
Вы можете интегрировать черные с вашими любимыми редакторами. В настоящее время Black Black поддерживает идею Pycharm/Intellij, IDE IDE, VIM, Visual Studio Code, Sublime Text 3, Atom/нуклид, Какун и Тонный. Следуйте инструкциям здесь Чтобы интегрировать черный с вашим любимым редактором.
Если вы хотите узнать больше о черном, я рекомендую смотреть Pycon 2019 Talk Лукаш Ланга.
Если вы узнали что-то новое или наслаждались чтением этой статьи, пожалуйста, поделитесь этим, чтобы другие могли его увидеть. До этого увидимся в следующем посте! Я также можно добраться в Twitter @Davis_mcdavid Отказ