Внешний вид кода
Есть такое понятие как PEP 8. Это специальный стандарт, правило хорошего тона, если хотите. Единый стиль оформления делает код понятным как для самого программиста, так и для его коллег с разным уровнем подготовки.
В идеале наиболее сложный фрагмент кода должен быть понятен с первого прочтения.
PEP 8 затрагивает следующие основные моменты:
▪️выбор кодировки исходного кода
▪️группировку инструкций по импорту модулей
▪️максимальную длину строки кода — рекомендуется до 79 знаков, а для строк документации (docstring) — 72 знака
▪️использование отступов — табуляции и пробелов
▪️использование пустых строк для разбивки кода на блоки и выделения функций верхнего уровня
▪️использование комментариев
▪️именование переменных, констант, классов и экземпляров, функций, аргументов, модулей, пакетов
▪️выбор уровня доступности классов и методов (public, private, API-подклассы), а также порядка их наследования.
Также оставляю ссылку тут
#pep8
Есть такое понятие как PEP 8. Это специальный стандарт, правило хорошего тона, если хотите. Единый стиль оформления делает код понятным как для самого программиста, так и для его коллег с разным уровнем подготовки.
В идеале наиболее сложный фрагмент кода должен быть понятен с первого прочтения.
PEP 8 затрагивает следующие основные моменты:
▪️выбор кодировки исходного кода
▪️группировку инструкций по импорту модулей
▪️максимальную длину строки кода — рекомендуется до 79 знаков, а для строк документации (docstring) — 72 знака
▪️использование отступов — табуляции и пробелов
▪️использование пустых строк для разбивки кода на блоки и выделения функций верхнего уровня
▪️использование комментариев
▪️именование переменных, констант, классов и экземпляров, функций, аргументов, модулей, пакетов
▪️выбор уровня доступности классов и методов (public, private, API-подклассы), а также порядка их наследования.
Также оставляю ссылку тут
#pep8
PEP8
PEP 8 де-факто представляет собой руководство по стилю написания кода Python. В нем рассматриваются соглашения по именованию, структура кода, пустые области (табуляция против пробелов) и другие аналогичные темы.
Писать код с учетом принципов PEP 8 — хорошая идея (помогает разработчикам создавать более стабильный код). С помощью программы pycodestyle, которая запускается из командной строки, можно проверить код на соответствие принципам PEP 8. Для установки этой программы введите в терминале такую команду:
Пример использования:
#pep8
PEP 8 де-факто представляет собой руководство по стилю написания кода Python. В нем рассматриваются соглашения по именованию, структура кода, пустые области (табуляция против пробелов) и другие аналогичные темы.
Писать код с учетом принципов PEP 8 — хорошая идея (помогает разработчикам создавать более стабильный код). С помощью программы pycodestyle, которая запускается из командной строки, можно проверить код на соответствие принципам PEP 8. Для установки этой программы введите в терминале такую команду:
$ pip3 install pycodestyle
Пример использования:
$ pycodestyle smooth.py
smooth.py:3:1: E265 block comment should start with '# '
smooth.py:4:1: E265 block comment should start with '# '
smooth.py:5:1: E265 block comment should start with '# '
smooth.py:10:51: E251 unexpected spaces around keyword / parameter equals
smooth.py:10:53: E251 unexpected spaces around keyword / parameter equals
smooth.py:14:33: W292 no newline at end of file
#pep8