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

Учебник Python Pep 8: Начните писать читаемый код

Предложение Python Envancement 8, или PEP 8, является руководством стиля для кода Python. В 2001 году Guido Van Rossum, … Tagged с учебником, Python, программированием, производительностью.

Предложение Python Envancement 8, или PEP 8, является руководством стиля для кода Python. В 2001 году Guido Van Rossum, Барри Варшава и Ник Каглан создали PEP 8, чтобы помочь программистам Python написать последовательный и читаемый код. Руководство по стилю не всегда может применяться к вашей работе, но это важный и полезный инструмент, который будет повысить процесс записи кода. Сегодня мы предоставим краткий обзор некоторых фундаментальных произведений Руководства по стилю POP 8 Python, включая соглашения о именовании, макете кода, комментарии и многое другое.

Давайте начнем!

Мы покроем :

  • Зачем использовать PEP 8?
  • Pep 8 Соглашения о именах
  • Планировка кода PEP 8
  • Pep 8 комментариев
  • ЛИНТЕРЫ И АВТОФОРМАТЕРТЕРЫ
  • Упаковка и следующие шаги

Зачем использовать PEP 8?

Как сказал Гвидо Ван Россум: «Код читается намного чаще всего, чем написано. «Кодирование включает в себя много совместной работы и совместной работы, что означает, что многие разные люди могут в конечном итоге прочитать наш код. С этой идеей имеет смысл провести дополнительное время, написание нашего кода, чтобы убедиться, что это читается и последовательно. Мы можем использовать руководства по стилю программирования, чтобы убедиться, что мы создаем лучший код возможен. При работе с новым или незнакомым языком программирования есть так много правил и практики для изучения. Может быть трудно запомнить все конвенции языка.

Python Pep 8 помогает решить эту проблему. Руководство по стилю было разработано, чтобы помочь нам Улучшить читабельность из кода Python. Он описывает правила для таких вещей, как имена переменной, пробелы, встроенные комментарии, отступы и многое другое. Это солидный и всеобъемлющий ресурс, который мы можем использовать для написания отличного кода. Написание ясных, последовательных и читаемых кода IS важно для рабочих мест . Он показывает потенциальные работодатели, которые знают, как хорошо структурировать код.

Pep 8 Соглашения о именах

Соглашения об именах в программировании очень важны. Они Улучшить читабельность и ускорить время разработки. Помните, что код прочитан намного больше, чем написано, поэтому с использованием обозначений именования помогут себе, а другие лучше понять наш код. При соблюдении соглашений о именовании нам не нужно проводить время, обсуждая то, что назвать переменные, методы, классы или функции. Мы можем следить за конвенциями именования, чтобы ускорить этот процесс и более эффективно.

Выбирая соответствующие имена, когда мы пишем код сэкономит время и усилия и усилия США в долгосрочной перспективе. Давайте посмотрим на некоторые рекомендации PEP 8 для именования.

Стили именования

Вот некоторые из конвенций именования в Python:

  • Названия классов : Используйте камеру. Начните каждое слово с заглавной буквой. Не используйте подчеркивание для разделения слов.

    • Примеры: OurClass , сорт
  • Постоянные имена : Используйте прописные одно буква, слово или слова. Используйте подчеркивание для разделения слов.

    • Примеры: Our_constant. , ПОСТОЯННЫЙ
  • Функциональные имена : Используйте строчные слова или слова. Используйте подчеркивание для разделения слов.

    • Примеры: our_function , функция
  • Имена методов : Используйте строчные слова или слова. Используйте подчеркивание для разделения слов.

    • Примеры: our_method , метод
  • Имена модулей : Используйте короткое, строчное слово или слова. Используйте подчеркивание для разделения слов.

    • Примеры: our_module.py. , module.py
  • Имена пакетов : Используйте короткое, строчное слово или слова. Не используйте подчеркивание для разделения слов.

    • Примеры: ampackage. , упаковка
  • Переменные имена : Используйте строчную одно письмо, слово или слова. Используйте подчеркивание для разделения слов.

    • Примеры: opy_variabiable , Икс

Выбирая имена

Не всегда легко выбрать имена для ваших переменных, функций, методов и т. Д. Важно помнить о именах, которые вы выбираете, чтобы убедиться, что они понятны, уместно и эффективны. Мы предлагаем использовать описательные имена, чтобы сделать это очень понятно, что означает объект. Выбор Описательный Имена помогут вам в краткосрочной перспективе и долгосрочной перспективе. Если вы используете смутное имя для одной из ваших функций, вы можете вернуться к вашему коду за несколько дней или недель и забыть, что это значит. Это где Pep 8 пригодится!

Планировка кода PEP 8

Пробел

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

  • Окружите функции верхнего уровня и классы с двумя пустыми линиями
  • Определения метода Surround внутри классов с одной пустой линией
  • Используйте пустые строки внутри функций, чтобы показать четкие шаги (но используйте их экономно)

Мы должны избегать использования пробела в следующих ситуациях:

  • Внутри скобок, скобок или брекетов
# Do this:

fruit(banana[1], {strawberry: 2})

# Not this:

fruit( banana[ 1 ], { strawberry: 2 })
  • Между задними запятыми и следующим замкнутым скобками
# Do this:

foo = (1,)

# Not this:

foo = (1, )
  • Прямо перед запятой, точкой, точкой или толстой кишкой
# Do this:

if x == 5: print x, y; x, y = y, x

# Not this:

if x == 5: print x , y ; x , y = y , x
  • Прямо перед открытой скобками, который запускает список аргументов вызова функции
# Do this:

dog(1)

# Not this:

dog (1)
  • Прямо перед открытой скобками, который начинает индексирование или нарезку
# Do this:

dct["key"] = lst[index]

# Not this:

dct ["key"] = lst [index]
  • Более одного пространства вокруг оператора, чтобы выровнять его с другим
# Do this:

x = 5
y = 10
our_variable = 20

# Not this:

x          = 5
y          = 10
our_variable = 20
  • Избегайте конечного пробела

Длина линии и разрывы линии

PEP 8 предполагает, что все линии должны быть ограничены 79 символами. Для более длинных блоков текста, таких как DocStrings или комментарии, длина должна быть ограничена 72 персонажей Отказ Ограничение длины линии помогает сделать наш код более читабельным. Мы можем иметь разные файлы, открытые бок о бок, и мы избегаем упаковки линии.

Существуют некоторые ситуации, когда команды могут захотеть иметь более длинную длину линии. Предлагаемый способ обернуть длинные строки – использовать подразумеваемое продолжение линии Python внутри скобок, кронштейнов или брекетов вместо того, чтобы использовать обратную косание.

Если нам нужно использовать разрыв строки вокруг бинарных операторов, таких как + и * Мы должны разместить его до того, как оператор такой:

# Do this:

total = (first_variable
         + second_variable
         - third_variable)

# Not this:

total = (first_variable +
         second_variable -
         third_variable)

Отступ

Отступ очень важен при написании кода Python. Уровни вдавливания определяют, как операторы сгруппированы вместе. Основные рекомендации PEP 8 включают в себя:

  • Используйте четыре пробела, чтобы указать отступ
  • Используйте пробелы вместо вкладок

Давайте посмотрим на пример:

x = 20
if x > 50:
  print("x is greater than 50")

В приведенном выше примере наш отступ Печать Заявление говорит Python, что он должен выполнить только утверждение, если Если Отложение возвращает Правда Отказ

Вкладки и пробелы

Пространства являются предпочтительным способом для идентификации кода. Мы должны использовать только вкладки, если мы работаем с кусочком или участком кода, который уже отступает с помощью вкладок. Python 3 не позволяет нам использовать как вкладки, так и пробелы для отступа, что означает, что наш код не будет запускать, если мы используем смесь вкладок и пробелов. PEP 8 рекомендует использовать четыре пространства для указания отступа.

Python 2 не имеет того же правила, что означает, что мы не будем заметить ошибки, если мы используем смесь вкладок и пробелов. Чтобы убедиться, что мы используем последовательный метод отступа в Python 2, мы можем добавить -t Флаг при запуске нашего кода из командной строки. Переводчик даст нам предупреждение, если он найдет какие-либо несоответствия. Если мы используем -Тта Флаг, переводчик даст нам ошибки, что означает, что наш код не будет работать.

Pep 8 комментариев

Комментарии – большая часть процесса кодирования. Важно убедиться, что они ясны, актуальные и полезные. Не только комментарии помогают нам, но они помогают кому-либо еще, что вступает в контакт с нашим кодом. Когда кто-то читает наш код, наши комментарии должны четко выровнять с частью кода. Они также должны помочь читателю понять, что происходит в коде.

Это хорошая практика, чтобы написать комментарии как Полные предложения , с первой буквой первого слова капитализированного. Это называется корпусом стиля предложения. Если наш код начинается с идентификатора, все в порядке, чтобы использовать строчную букву здесь. Мы никогда не должны менять имя идентификатора в любом случае.

Еще одна хорошая практика комментирования включает ограничение длины линии наших комментариев и Docstrings до 72 персонажей . Если наши комментарии превышают 72 символов, мы должны начать новую строку. Мы также должны обеспечить обновление ваших комментариев, если ваш код изменяется по любой причине. Давайте посмотрим на некоторые из различных типов комментариев и как они вписываются в PEP 8:

Блок Комментарии

Мы можем использовать комментарии Block для документирования A Меньшая часть кода Отказ Мы обычно видим их в функциях или кусках кода или данных. PEP 8 изложены следующие правила для комментариев блоков:

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

Давайте посмотрим на пример:

for i in range(0,10):
    # Loop over i ten times and print the value of i
    # followed by a string of your name
    print(i, "Erin")

Встроенные комментарии

Мы можем использовать встроенные комментарии к документу A одно утверждение в кусочке кода. Обычно мы используем их, чтобы напомнить нам, почему некоторые строки кода актуальны или важны. PEP 8 изложены следующие правила для встроенных комментариев:

  • Используйте их экономно
  • Напишите их в той же строке, что и утверждение, к которому они относятся к
  • Используйте два или более пробелов, чтобы отделить их из оператора кода
  • Начните каждый встроенный комментарий с # сопровождаемый одним пространством
  • Не используйте их, чтобы объяснить что-то очевидное
x = 1 # This is an example of an inline comment!

Docstrings.

Docstrings – это строковые литералы, которые происходят как первая линия класса, функции, метода или модуля. Мы можем использовать их для документирования определенных блоков кода и описывать, что делает класс, функция, метод или модуль. Основные правила, которые применяются к DocStrings, включают в себя:

  • Окружающие Docstrings с тремя двойными кавычками "" " с обеих сторон, как это: " "" Привет, я Docstring! " ""
  • Напишите Docstrings для всех публичных классов, функций, методов и модулей
  • При написании многослойной DOCSTRING поставьте двойные цитаты, которые заканчивают, что DOCSTRING на отдельной строке
  • При написании одной линии DocString сохраните двойные кавычки на той же линии

ЛИНТЕРЫ И АВТОФОРМАТЕРТЕРЫ

Мы можем использовать Linters и AutoFormatters, чтобы помочь нам убедиться, что наш код PEP 8 соответствует. Давайте поговорим о них!

Летание

ЛИНТЕРЫ Проанализировать наши программы и флаг любые ошибки, которые у нас есть. Они дают нам предложения о том, как исправить наши ошибки. Мы можем установить Linters в качестве расширений в наших текстовых редакторах, что означает, что они будут помечать ошибки, как мы пишем код. Есть много разных линров Python Linters. Давайте посмотрим на два самых популярных летателя:

Flake8.

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

Pycodestyle.

Pycodestyle – это инструмент, который проверяет наш код Python против некоторых конвенций в стиле стиля, изложенных в руководстве по стилю PEP 8. Pycodestyle Библиотека не проверяет все Отказ Например, в настоящее время он не поддерживает проверки для именования соглашений, конвенций DOCSTRING или автоматического фиксации. Существуют различные расширения и доступные инструменты, которые могут проверить некоторые вещи, которые Pycodestyle не может проверить.

Автоформаттеры

Автоформатса Refactor наш код Python соблюдать руководство по стилю PEP 8. Автоформатцы обычно не такие же строгие, как лепки. Например, сплошной линт Linter даст нам знать, когда наш код слишком сложен, но Autoformatter не будет. Если у нас есть неуместное имя переменной, автоформаттер не будет помечать, что для нас. AutoformatterTT сделает наш код немного красивее, но он не обязательно будет гарантировать, что мы пишет читаемый и правильный код. Давайте посмотрим на два популярных автоформаттера:

autopep8.

AUTOPEP8 – это инструмент, который форматирует код Python на основе руководства по стилю PEP 8. Инструмент, похожий на AUTOPEP8, поможет вам написать постоянный и читаемый код, не надеясь слишком много дополнительного времени и усилий в него! Вот несколько способов установить AutopeP8:

PIP Установить :

pip install --upgrade autopep8

easy_install :

easy_install -ZU autopep8

Давайте посмотрим на пример реализации AUTOPEP8 на одном простом коде Python:

Перед Autopep8 :

import sys, os;
print(                 "hello"       );

После autopep8 :

import sys
import os
print("hello")

Чернить

Черный помогает заботиться о незначительных стилистических и структурных вопросах, поэтому мы можем сосредоточиться на более крупных проблемах кодирования. Мы можем установить его, запустив Пип устанавливаю черный Отказ Если вы хотите использовать его, убедитесь, что у вас есть Python 3.60+, в противном случае он не будет работать. Как только Black устанавливает, мы можем использовать его в качестве инструмента командной строки сразу.

Упаковка и следующие шаги

Руководство по стилю PEP 8 делает код чтения и записи намного более эффективным и эффективным. Хотя руководство не всегда может применяться к нашей работе, это полезный инструмент, который мы можем использовать для подъема наших процессов чтения кода и записи. Мы покрывали небольшую порцию PEP 8 в этой статье, и все еще есть так много, чтобы учиться. Некоторые рекомендуемые темы для покрытия следующего включают в себя:

  • Висячие отступления
  • Форматирование, если заявления
  • Лямбда
  • А также гораздо более

Чтобы начать с программирования Python, проверьте путь обучения Python для программистов Отказ Этот искушенный путь обучения поможет вам использовать ваш опыт программирования, чтобы получить удовольствие от Python. К концу у вас будут продвинутые знания, которые вам нужно уверенно использовать Python в вашем следующем проекте.

Счастливое обучение!

Продолжайте читать о языке программирования Python

Оригинал: “https://dev.to/educative/python-pep-8-tutorial-get-started-writing-readable-code-5e09”