PEP 8 — это рекомендации и руководство по написанию кода на python, содержащий ответы на многие вопросы. Придерживаясь рекомендаций при написании кода, улучшит читаемость кода, сделает его согласованным между большим числом проектов и каждый программист сможет его прочесть.
Основные рекомендации по написанию кода:
- Для чего нужны отступы? — принято использовать отступы в 4 пробела на каждом уровне отступа, для определения вложенных инструкций и визуального восприятия. При нарушении отступов возможно неправильное выполнение действий кода.
- Табуляция или пробелы? — 4 пробела (каждый редактор умеет настраивать кнопку табуляции чтобы при нажатии на нее ставилось указанное количество пробелов);
- Максимальная длина строки? — необходимо придерживаться 80 символов;
- Двойные или одинарные кавычки? — не важно, самое главное чтобы было единообразно, на протяжении всего кода. Исключение для тройных кавычек, при их написании, одинарные кавычки использовать не рекомендуется необходимо использовать двойные кавычки;
- Где ставить пробелы, а где нет? — пробелы ставятся после запятых, перед и после арифметических действий;
- Где и сколько ставить пустые строки? — между функциями две пустые строки, между методами в классе одна пустая строка
- Стили имен? — рекомендуется использовать для переменных и функций snake_case, для классов CamelCase, для глобальных констант UPPER_CASE_WITH_UNDERSCORES.
Эти и другие рекомендации описаны в руководстве PEP 8. Можно воспользоваться простой консольной утилитой pycodestyle которая анализирует (проверяет) код python на соответствие PEP 8.
Пакет pycodestyle устанавливается с помощью pip, командой pip install pycodestyle.
Запускаем пакет pycodestyle и указываем файл с кодом для проверки.
Для более наглядного вывода используем команду pycodestyle --show-source Functions.py. Где после каждого сообщения об ошибке будет выведена строка исходного кода, в которой содержится ошибка.
С помощью ключа --show-pep8 используя команду pycodestyle --show-pep8 <имя файла> - программа выведет список всех проверок с выдержками из PEP 8, там где встретится нарушения.
Предыдущие статьи по изучению языка программирования Python3.
8. Цикл for и цикл while в Python3.
7. Условный оператор if в Python3.
6. Словари и работа с ними в Python3.
5. Основа работы со списками в Python3.
3. Переменные в языке Python 3 и для чего они нужны.
