Читается ли ваш код Python?

Приступая к обучению программированию на Python, я обращаю внимание на детали того, как написан мой код. Не только его функциональность, но и уверенность в том, что мой код соответствует лучшим практикам и может быть легко интерпретирован другими. Это важная привычка, поэтому, если в будущем создается веб-приложение или часть базы кода, другие инженеры-программисты могут легко видеть, что делает код, и работу можно пересмотреть. Я обратился к Руководству по стилю PEP 8 для кода Python, чтобы получить более четкое представление о том, как выглядят лучшие практики кодирования Python.

В Python пробелы обычно предпочтительнее табуляции. Если вы решите это сделать, вы можете использовать код, но не следует смешивать вкладки и пробелы! Важность последовательности будет повторяющейся темой в этом блоге. Людям легче читать контент и понимать его, если он последователен. Идентификация должна состоять из четырех пробелов. В приведенном ниже примере print имеет отступ в 4 пробела от начала первой строки.

В Python длина строки должна быть ограничена 75 символами. Если ваш код превысит ограничение в 75 символов, вы можете использовать висячий отступ, чтобы переместить переполненный код на следующую строку и убедиться, что он по-прежнему читаем. Для передачи отступов приоритетом является выравнивание переполняющего кода с его аналогом в предыдущей строке, чтобы его было легче читать. Поэтому висячие отступы не обязательно должны иметь отступ в четыре пробела. Ниже приведен пример переполнения кода с использованием висячего отступа.

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

Наконец, важно, чтобы код Python содержал комментарии и чтобы эти комментарии было легко читать. Комментарии Python должны быть написаны полными предложениями и должны начинаться с заглавной буквы, если только первое слово не является переменной в нижнем регистре. Если в комментарии несколько предложений, после точки должно быть два пробела. (Наконец-то здесь пригодилась моя курсовая практика!). Комментарии особенно важны, если есть раздел кода, назначение которого неясно.

Бывают случаи, когда руководство по стилю PEP 8 не имеет предпочтения. В этих случаях вы можете выбрать, как вы хотели бы оформить свой код, но вы должны стремиться всегда быть последовательными. Помните, главное постоянство!

Источники:

Пять советов по повышению читабельности вашего кода Python. Инженерия для науки о данных

https://engineeringfordatascience.com/posts/top_tips_for_improving_python_code_without_refactoring/