Краткое руководство по написанию чистого кода на языке Python в соответствии с рекомендациями PEP 8
- Используйте пробелы вместо табуляции:
- Используйте 4 пробела для каждого уровня отступа.
- Никогда не смешивайте пробелы и табуляцию.
- Ограничьте длину строки:
- Рекомендуется ограничить длину строки до 79 символов.
- Если строка не помещается в 79 символов, ее можно разбить на несколько строк, используя продолжающиеся строки или скобки.
- Импорты:
- Каждый импорт должен быть на отдельной строке.
- Группируйте импорты в следующем порядке: стандартные библиотеки, сторонние библиотеки, локальные модули.
- Пробелы вокруг операторов:
- Используйте пробелы вокруг операторов (например,
=
,+
,-
,*
,/
) для улучшения читаемости кода.
- Используйте пробелы вокруг операторов (например,
- Пустые строки:
- Используйте пустые строки для разделения логических блоков кода.
- Используйте две пустые строки для разделения функций и классов.
- Имена переменных и функций:
- Используйте осмысленные имена переменных и функций.
- Используйте нижний_регистр_с_подчеркивания для имен переменных и функций.
- Избегайте использования однобуквенных имен, кроме стандартных случаев, таких как счетчики циклов.
- Комментарии:
- Используйте комментарии для объяснения сложных участков кода или для документирования функций и классов.
- Комментарии должны быть ясными и информативными.
- Длина функций:
- Постарайтесь держать функции относительно короткими и однозначными.
- Если функция становится слишком большой, разделите ее на несколько более мелких функций.
- Строки документации:
- Используйте строки документации (docstrings) для документирования функций, классов и модулей.
- Строки документации должны быть представлены в тройных кавычках и содержать описание функции, аргументов и возвращаемых значений.
- Избегайте «голых» except:
- Избегайте использования пустых блоков
except
без указания конкретных исключений. - Лучше перехватывать конкретные исключения или использовать
except Exception as e
, чтобы получить информацию об ошибке.
- Избегайте использования пустых блоков
- Вертикальное выравнивание:
- Избегайте излишнего вертикального выравнивания.
- Сосредоточьтесь на группировке связанных строк кода.
- Рекомендации по именованию:
- Используйте осмысленные имена переменных, функций, классов и модулей.
- Избегайте использования однобуквенных имен, за исключением стандартных случаев.
- Используйте стиль snake_case для имен переменных и функций, и CamelCase для имен классов.
Это лишь некоторые основные рекомендации по написанию чистого кода в соответствии с PEP 8. Рекомендуется ознакомиться с полным руководством PEP 8 для получения более подробной информации и примеров использования: https://www.python.org/dev/peps/pep-0008/.
Leave a Reply