что такое pep: Что такое PEP-8 и почему важно следовать его правилам?

То, как Вы расположите ваш код, имеет огромную роль в повышении его читаемость. В этом разделе вы узнаете, как добавить вертикальные пробелы для улучшения восприятия вашего кода. Вы также узнаете, как правильно пользоваться ограничением в 79 символов на строку, рекомендованным в PEP8. Используйте блочные (т.е. многострочные) комментарии, чтобы задокументировать небольшой фрагмент кода.

PEP — это документ для сообщества, который описывает новые функции, предлагаемые для Python, и содержит такие аспекты языка, как дизайн и стиль. PEP 8, иногда обозначаемый PEP8 или PEP-8, представляет собой документ, содержащий рекомендации по написанию кода на Python. Он был составлен в 2001 году Гвидо ван Россумом, Барри Варшавой и Ником Когланом.

При именовании переменных у вас может возникнуть соблазн выбрать простые, состоящие из одной буквы имена в нижнем регистре,
например x. Но если вы не используете x в качестве аргумента математической функции,
непонятно, что представляет собой этот самый x. Представьте, что вы храните имя человека в виде строки
и хотите использовать срез строки, чтобы по-другому отформатировать его имя.

• Как и в случае с большинством рекомендаций по программированию, целью этих является удобочитаемость и простота.
• Пустые строки могут быть опущены между несколькими связанными однострочниками (например, набор фиктивных реализаций).
• Однако, не все редакторы распознают control+L и могут на его месте отображать другой символ.
• Теперь вы знаете, как писать качественный, читаемый код на Python, используя рекомендации, изложенные в PEP 8.
• То, как Вы расположите ваш код, имеет огромную роль в повышении его читаемость.
• Мы часто обнаруживаем, что в Python (как и в любом другом языке программирования) бывает несколько способов выполнить одно и то же действие.

Теперь вы знаете, как писать качественный, читаемый код на Python, используя рекомендации, изложенные в PEP 8. Хотя эти рекомендации могут показаться педантичными, следование им может действительно улучшить ваш код. Это особенно важно, когда вы собираетесь делиться своим кодом с потенциальными работодателями или соавторами. Встроенные комментарии более конкретны, чем блочные, и их легко добавить, когда они не нужны, что приводит к беспорядку. Если в вашем коде есть ошибки, flake8 выведет список проблем с указанием номера строки и столбца. Узнайте о PEP 8, официальном стандарте написания кода на Python, и советы по его применению для читаемого и понятного кода.

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

Пробелы в выражениях и инструкциях

В чужом коде вам может встретиться другой вид отступа — табуляция. Его PEP 8 категорически не рекомендует, но с одной оговоркой. Если вы дорабатываете готовый проект, где отступы сделаны табуляцией, придерживайтесь принятого до вас стандарта.

Это принесет пользу вам, а также сотрудникам и потенциальным работодателям. Необходимо заметить, что в Python можно придумать несколько способов для выполнения одного и того же действия. Далее будет рассказано, как избавляться от двусмысленности при сохранении последовательности. Та же самая философия относится и ко всем прочим типам данных и объектов в Python.

Это инструмент для проверки вашего кода на соответствие некоторым стилевым соглашениям в PEP8. Линтеры – это программы, которые анализируют код, помечают ошибки и предлагают способы их исправления. Они особенно полезны как расширения редактора, поскольку выявляют ошибки и стилистические проблемы во время написания кода. Следование PEP 8 особенно важно, если вы претендуете на должность разработчика. Написание понятного, читаемого кода свидетельствует о профессионализме.

Непубличные атрибуты, в свою очередь, не предназначены для использования третьими лицами, поэтому вы можете не гарантировать, что не измените или не удалите их. Чтобы избежать конфликтов имен с подклассами, используйте два ведущих подчеркивания. Будем надеяться, что глобальные переменные используются только внутри одного модуля. Руководствуйтесь теми же соглашениями, что и для имен функций. Используйте пустые строки в функциях, чтобы указать логические разделы. Если нужно сравнить что-то со значением «None», вместо операторов сравнения используйте is/is not.

Когда стоит игнорировать PEP 8

Иногда сложная функция должна выполнить несколько шагов перед оператором return. Чтобы помочь читателю понять логику внутри функции, может быть полезно оставлять пустую строку между каждым шагом. Точно так же, слишком много пустых строк в коде делает его очень разреженным, что заставит читателя
пролистывать его чаще, чем необходимо. Ниже приведены три основных правила использования вертикальных пробелов.

• Наш сайт использует файлы cookie для улучшения пользовательского опыта, сбора статистики и обеспечения доступа к обучающим материалам.
• Например, функция os.stat() возвращает кортеж, имена в котором традиционно имеют вид st_mode, st_size, st_mtime и так далее.
• Поможем вам распознать, какой стиль именования используется, независимо от того, для чего он используется.
• PEP важен, потому что он способствует развитию Python в направлении, который считается наиболее полезным и функциональным для пользователей.
• PEP — Python Enhancement Proposal, предложения по развитию Python.
• Оно содержит советы и рекомендации по оформлению кода, позволяющие сделать его более читаемым и понятным для других разработчиков.

Мы не используем термин «приватный атрибут», потому что на самом деле в python таких не бывает. Файлы в ASCII (Python 2) или UTF-8 (Python 3) не должны иметь объявления кодировки. PEP 8 создан на основе рекомендаций Гуидо ван Россума с добавлениями от Барри. И, конечно, этот PEP может быть неполным (фактически, он, наверное, никогда не будет закончен). Помните, что знать PEP 8 вы обязаны, а следовать ему — не всегда. Отступы придётся соблюдать, иначе интерпретатор откажется выполнять ваш код.

Это скажет работодателю, что вы понимаете, как правильно структурировать свой код. Есть и другие случаи, когда PEP 8 не рекомендует добавлять лишние пробелы, например, непосредственно после открывающей и перед закрывающей скобкой. Самое важное место, где следует избегать пробелов, – это конец строки. Такой пробел невидим и может приводить к ошибкам, которые трудно отследить. Публичные атрибуты — это те, которые будут использовать другие программисты, и вы должны быть уверены в отсутствии обратной несовместимости.

Не сравнивайте логические значения с True или False при помощи оператора эквивалентности (==)

PEP-8 (Python Enhancement Proposal 8) — это руководство по стилю написания кода на языке Python. Оно содержит советы и рекомендации по оформлению кода, позволяющие сделать его более читаемым и понятным для других разработчиков. В первой статье мы рассмотрели, в чем вообще смысл стандартов и соглашений, что такое PEP 8 и какие инструменты помогают нам придерживаться выбранного стиля оформления кода. Во второй статье мы более подробно остановились на вопросах размещения кода, нейминга, отступов. Сейчас давайте остановимся на правилах оформления комментариев, использовании пробелов и рекомендациях по написанию более чистого кода. Так как исключения являются классами, к исключениям применяется стиль именования классов.

Отделяйте функции верхнего уровня и определения классов двумя пустыми строками. Табуляция должна использоваться только для поддержки кода, написанного с отступами с помощью табуляции. В идеале наиболее сложный фрагмент кода должен быть понятен с первого прочтения. Это упрощает командную разработку и обучение новичков, позволяет вам быстро возвращаться к собственным давним проектам. В этих документах вы найдете, не попавшие в эту «выжимку», рекомендации.

Когда вы проектируете такой класс, решите и явно укажите, какие атрибуты являются публичными, какие принадлежат API подклассов, а какие используются только базовым классом. Поможем вам распознать, какой стиль именования используется, независимо от того, для чего он используется. Однако, не все редакторы распознают control+L и могут на его месте отображать другой символ.

Правильный выбор имени¶

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

Особенно много времени уходит на приведение прошлых проектов к стандарту PEP 8. К счастью, есть инструменты, которые помогут ускорить этот процесс. PEP расшифровывается как Python Enhancement Proposal («Предложение по усовершенствованию Python»), и их несколько.

Это рекомендуется делать, чтобы вы имели возможность
открывать несколько файлов рядом друг с другом, а также избегать переноса строк. Если вы правильно используете вертикальные пробелы, это может значительно улучшить читаемость вашего кода
и помочь читателю визуально понять, что этот код делает. Соблюдение PEP8 особенно важно, если вы в поисках вакансии python-разработчика. Он говорит работодателю о вашем понимании
правильного структурирования программного кода. В итоге, следование правилам PEP-8 делает ваш код более читаемым, чистым и профессиональным, что улучшает работу над проектами и повышает эффективность командной работы. Вдобавок ко всему, вы также увидели, как использовать линтеры и автоформаттеры для проверки вашего кода на соответствие рекомендациям PEP 8.

Когда лучше проигнорировать PEP8¶

Но в самом руководстве указаны случаи, когда разработчик по своему усмотрению может и должен нарушать рекомендации. Помните, что пустые списки, кортежи и последовательности по умолчанию хранят значение false. Если хотите назвать переменную одним символом, избегайте строчной латинской l («эль»), заглавной I («ай») и заглавной O — в некоторых шрифтах они неотличимы от цифр 1 и 0 соответственно.

Основная цель PEP 8 – улучшить читабельность и логичность кода на Python. Если вы начинающий программист Python, вам может быть тяжело запомнить, что делает определенная часть
кода по прошествии нескольких дней после ее написания. Однако, если вы будете следовать рекомендациям PEP8,
можете быть уверены, ваш код будет в полном порядке. Вы будете знать, что добавили достаточно пробелов, в соответствии с разделением на логические блоки кода.

Однако вы можете добавить Error в конце имени (если, конечно, исключение действительно является ошибкой). Вместо этого могут использоваться соглашения для именования функций, если интерфейс документирован и используется в основном как функции. В библиотеке X11 используется префикс Х для всех public-функций. В python этот стиль считается излишним, потому что перед полями и именами методов стоит имя объекта, а перед именами функций стоит имя модуля. Абзацы внутри блока комментариев разделяются строкой, состоящей из одного символа #. Стандартная библиотека Python консервативна и требует ограничения длины строки в 79 символов (а строк документации/комментариев в 72).

А согласованность внутри модуля или функции — самое важное. Но важно помнить, что иногда это руководство неприменимо, и понимать, когда можно отойти от рекомендаций. Когда вы сомневаетесь, просто посмотрите на другие примеры и решите, какой выглядит лучше.