Когда формируются команды разработчиков, первое, что должны сделать старшие инженеры, — установить стандарты кодирования. Это помогает разработчикам писать чистый, читаемый код, повышать производительность и делать кодирование увлекательным. Это особенно важно для больших команд; однако даже в команде из одного человека вы хотите писать хороший код для себя в будущем.
В Python легко начать руководство по стандартам кодирования, потому что по большей части вы можете указать разработчикам на стандарты кодирования PEP8. Начните с этого, а затем измените правила в соответствии с потребностями вашей команды.
Если вы учитесь кодировать, вы должны начать с основ.
Что такое PEP8?
PEP8 — это руководство по стилю, которое большинство программистов на Python используют для написания чистого, удобочитаемого кода на Python, согласованного между проектами. Принятие такого универсального руководства по стилю позволяет программистам писать удобочитаемый код, более эффективно поддерживать кодовую базу и быстро вводить новых членов команды. Также приятнее работать с организованным и легко читаемым кодом.
Вот пример с двумя фрагментами кода. Первый фрагмент кода нарушает многие правила PEP8, а второй фрагмент кода следует PEP8. В какой кодовой базе вы хотели бы работать?
Это преувеличение плохо написанного кода, но вы поняли идею.
Я рекомендую прочитать Руководство по стилю PEP8, чтобы ознакомиться с правилами. Но, поскольку у большинства из вас не хватает времени и им нужно создать эту функцию или написать сценарий, я описал, как настроить ваши инструменты, чтобы обнаружить и мягко сообщить вам, что вы не следуете PEP8. Я также изложил некоторые из наиболее важных правил ниже.
Вспомогательные инструменты для обеспечения соблюдения PEP8
Поскольку у меня настроено форматирование PEP8 в PyCharm и VS Code, я быстро вижу, что некоторые программисты в моей команде не следуют PEP8, когда я работаю над их кодом. Это также позволяет мне узнать, когда я нарушаю правила, и позволяет мне быстро их исправить.
Если вы не прочитали и не запомнили правила PEP8, вам было бы невозможно следовать им без вспомогательных инструментов. Вы можете настроить PyCharm, VSCode, Jupyter Notebooks и большинство текстовых редакторов, чтобы принудительно применять линтинг PEP8 до того, как начнете программировать на Python.
Вот как настроить некоторые из самых популярных редакторов, чтобы они выделяли нарушения PEP8. Если вашего редактора нет в этом списке, просто Google PEP8 formatter ‹ваш редактор›.
Вы могли бы сделать это и учиться по ходу дела. Но если вы хотите узнать больше о специфике некоторых основных правил PEP8, это те, которые приносят наибольшую отдачу от затраченных средств.
Макет кода
- Отступ Четыре пробела
- Строки продолжения должны совпадать с открытым разделителем.
# Aligned with opening delimiter.
foo = long_function_name(var_one, var_two,
var_three, var_four)
- Максимальная длина строки – 79 символов.
- Разрыв строки перед бинарным оператором
# easy to match operators with operands
income = (gross_wages
+ taxable_interest
+ (dividends - qualified_dividends)
- ira_deduction
- student_loan_interest)
- Пустые строки — две пустые строки перед функциями верхнего уровня, одна пустая строка между определениями методов и попытка сгруппировать связанные строки кода без пустых строк между ними, экономно используйте между строками кода внутри функции и методы
- Импорт — должны быть в отдельных строках в следующем порядке:
- Импорт стандартных библиотек.
- Связанный сторонний импорт.
- Импорт локальных приложений/библиотек.
Строковые цитаты
Примечание о строковых кавычках: PEP8 не рекомендует использовать двойные или одинарные кавычки. Решите это как команда и придерживайтесь одного соглашения.
пробел
Вы можете прочитать документы PEP8 для получения дополнительной информации об этом. Но вообще избегайте лишних пробелов в коде, будь то в середине строки или в конце.
Комментарии
Наша команда в Мемориале Слоана Кеттеринга обычно следует правилу: если что-то непонятно, напишите комментарий. Но, что еще лучше, следуйте этой последовательности полномочий при написании кода, чтобы он был читабельным, и решайте, когда писать комментарий.
Во-первых, сделайте свой код удобочитаемым, указав хорошие имена переменных и функций (подробнее см. ниже). Во-вторых, добавьте дополнительную строку кода, если это поможет понять себя и следующего разработчика. Умение писать код иногда приводит к тому, что его трудно читать. В-третьих, если это еще нужно уточнить, напишите комментарий.
- Используйте блочные комментарии, чтобы объяснить блоки кода, которые могут быть непонятны.
- Используйте встроенные комментарии с осторожностью.
- Напишите строки документа для всех общедоступных модулей, функций, классов и методов. Вы можете пропустить их для частных планов.
Надеюсь, вам понравилось это обновление о том, как использовать PEP8 для написания отличного кода! Если да, аплодируйте этой истории, присоединяйтесь к Medium и читайте все истории Джули и всех писателей на Medium!
Рекомендации
Повышение уровня кодирования
Спасибо, что являетесь частью нашего сообщества! Перед тем, как ты уйдешь:
- 👏 Хлопайте за историю и подписывайтесь на автора 👉
- 📰 Смотрите больше контента в публикации Level Up Coding
- 💰 Бесплатный курс собеседования по программированию ⇒ Просмотреть курс
- 🔔 Подписывайтесь на нас: Twitter | ЛинкедИн | "Новостная рассылка"
🚀👉 Присоединяйтесь к коллективу талантов Level Up и найдите прекрасную работу
