Стилевое руководство PEP 8

PEP — это аббrevиaтura oт Pythoн Enhancemеnt Proposаl, котоpyю непocтoяннo тpyдиtся пepexoдить ca "Пpeдcтaвлeниe пo yлучшeнию Pythoнa". Koличecтвo PEP xocepдит тexничecкий дokyмeнт, пpeднapoдeнный cooccyтвuuющим Pythoнu, кoтopый pacпocтpyживaeт peдaкцию языкa в лyчшиx cфepax. Booчнoe пpeдлoжeниe (PEP 8) являeтcя pyкoвoдcтвoм пo cтилю пиccaния кoдa нa Pythoнe. Aлe ecть мoжнocть пиccaть Pythoн-кoд c пpaвильнoй гpaммaтикoй пo cвoemu ccытaнию, иcпoлзoвaниe cooгacoвaннoгo cтиля при пиccaнии читaeмыx кoдoв являeтcя зaкoнoм для кaждoгo пpoфeccioнaльнoгo пpoгpaммистa и coздaния пpoгpaмм, кoтopaя ceмeчтaнa в имeннo этoм cфepax. Moжнo нayти eтoт дokyмeнт нa oфициaльнoм cyйтe Pythoнa пo cылкe PEP 8, a нижe пpeдcтaвлeнa кpacтивa cуммaризaция кypьeвyx чacтeй цeлocoбющeгo pyкoвoдcтвa.

Иcпoлзoвaниe пpocтoв

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

Использование пробелов1. Используйте пробелы для представления отступов, а не табуляцию. Это может показаться нелогичным для тех, кто привык к другим языкам программирования, поскольку большинство программистов используют табуляцию для представления отступов. Однако следует помнить, что Python не имеет синтаксического сахара вроде фигурных скобок для создания блока кода, как в C/C++ или Java. В Python ветвление и циклы используются для представления уровня кода через отступы. Поэтому Python-код сильно зависит от отступов и ширины отступов. Ширина табуляции может отличаться в разных редакторах — от двух до восьми символов или даже больше. Использование табуляции для представления отступов может стать проблемой для Python-кода.

2. Каждый уровень отступа, связанный с синтаксисом, должен представляться четырьмя пробелами.
3. Длина строки кода должна быть не более 79 символов. Если выражение слишком длинное и занимает несколько строк, то все строки после первой должны иметь обычную ширину отступа плюс четыре пробела.
4. Определения функций и классов должны отделяться двумя пустыми строками перед и после кода.
5. Методы внутри одного класса должны отделяться одной пустой строкой.
6. С каждой стороны бинарного оператора должно быть по одному пробелу.### Название идентификаторов

PEP 8 рекомендует использовать различные стили названий для различных идентификаторов в Python, чтобы можно было определить роль идентификатора в Python по его имени (что иногда плохо реализуется в модулях Python по умолчанию и некоторых сторонних модулях).

1. Переменные, функции и свойства должны писаться строчными буквами, а слова в названии разделены нижним подчеркиванием.
2. Защищённые экземплярные свойства класса должны начинаться с одного нижнего подчёркивания.
3. Приватные экземплярные свойства класса должны начинаться с двух нижних подчёркиваний.
4. Название классов и исключений должно состоять из слов, каждое из которых начинается с большой буквы.
5. Константы модуля следует записывать прописными буквами, а слова в названии — разделить нижним подчёркиванием.
6. Экземплярные методы класса должны иметь первый параметр self, который представляет объект.
7. Методы класса должны иметь первый параметр cls, который представляет сам класс.

Выражения и операторы

В Python Zen (можно просмотреть с помощью команды import this) есть следующее высказывание: "Есть и лучше всего один очевидный способ сделать это", что в переводе означает "Есть и лучше всего один очевидный способ сделать это". Эта идея также широко распространена в PEP 8.1. Используйте отрицание в виде inline, а не перед всем выражением. Например, if a is not b проще понять, чем if not a is b. 2. Не используйте проверку длины для определения того, является ли строка или список None или пустым, вместо этого используйте if not x. 3. Даже если в блоках if, for циклах или блоках except захвата исключения содержится одна строка кода, не объединяйте её с if, for, except. Разбирайте код на строки для лучшей читаемости. 4. Команды импорта всегда должны располагаться в начале файла. 5. При импорте модулей, from math import sqrt предпочтительнее, чем import math. 6. Если используются несколько команд импорта, они должны быть разделены на три части: стандартные модули Python, сторонние модули и пользовательские модули. Внутри каждой группы модули должны быть расположены в алфавитном порядке.