Не следование стандарту кодирования PEP8.
PEP8 это документ, который описывает соглашение о том, как писать код на языке python. Ключевая идея такова: код читается намного больше раз, чем пишется. Собственно, рекомендации о стиле написания кода направлены на то, чтобы улучшить читаемость кода и сделать его согласованным между большим числом проектов. В идеале, весь код будет написан в едином стиле, и любой сможет легко его прочесть.
Неправильный нейминг.
Начинающие программисты не придают значение именованию переменных, функций, классов при написании кода. С развитием проекта, количество кода увеличивается, и в один момент разработчик понимает, что большая часть времени тратиться на чтение и осмысление кода, а не на его поддержку и развитие. Основной принцип хорошего именования имена должны быть содержательными (полностью отражать своё назначение).
Отсутствие комментариев.
Добавление комментариев считается хорошей практикой. Это неисполняемые, но все равно важные части кода. Комментарии это способ выражения того, что делает программа на самом высоком уровне. С помощью комментариев, разработчик сообщает, какая задача решается данным блоком кода. Комментарии делают программы более читаемыми и пригодными для последующей поддержки.
Отсутствие документации к проекту.
Хорошая документация облегчает пользователю и другим разработчикам понимание как проекта в целом, так и отдельных его частей. Строки документации используются для объяснения общего назначения объекта, в отличие от комментариев, объясняющих более мелкие и неочевидные части кода. В файле документации должно быть краткое описание проекта и список имеющихся функций, будет полезным добавить примеры и скриншоты программы.
Не использование f строк.
f строки улучшают читаемость кода, а также работают быстрее чем другие способы форматирования. f-строки задаются с помощью литерала «f» перед кавычками. f-строки делают очень простую вещь — они берут значения переменных, которые есть в текущей области видимости, и подставляют их в строку. В самой строке вам лишь нужно указать имя этой переменной в фигурных скобка.
Пустые условия if.
В некоторых случаях встречаются пустые инструкции if, что в большинстве случаев является неправильным. Пустой блок кода, можно использовать чтобы предотвратить синтаксическую ошибку. В других случаях, нам необходимо более грамотно продумывать условия выполнения инструкций.
Ручное закрытие файла.
Использование функции close() для закрытия файла является неверной и ошибочной практикой при разработке приложений. В случае возникновения ошибки в процессе записи или чтении файла, файл не закроется никогда. Лучшей практикой является использование конструкции with, которая гарантирует закрытие файла.
Неправильное обрабатывание ошибок.
Обработка ошибок увеличивает отказоустойчивость кода, защищая его от потенциальных сбоев, которые могут привести к преждевременному завершению работы. Наиболее легким вариантом является помещения всего блока кода в конструкцию try: except: finally. Но данное решение является не совсем верным. Да с помощью него мы защитим нашу программу от преждевременного закрытия, но мы не сможем грамотно обработать ошибку или вывести пользователю сообщение о причине ошибки. Делайте исключения конкретными. Не отлавливайте все исключения разом. Проанализируйте код, выясните какие исключения в нем могут возникнуть и обрабатывайте их.
Использование знака равенства для определения типа переменной.
Использование знака равенства для определения типа переменной нарушает принципы объектно ориентированного программирования на которых основан Python. Для определения типа переменной необходимо использовать функцию isinstance().
Использование функции print() вместо ведения журнала логов.
Логи, помогают разобраться в нестандартных ситуациях, которые могут приключиться с вашим скриптом. Логирование способ записи информации о состоянии программы. Логами называют сами записи. При использовании функции print() вы не сможете быстро и удобно вносить изменения, а также для записи сообщений в файл необходимо будет писать много дополнительного кода.
Python это мощный и гибкий язык. Сегодня мы рассмотрели 10 распространенных ошибок программистов Python и пути их устранения. Надеемся статья была вам полезна. Рекомендуем практиковаться и каждый день узнавать что-то новое.
С уважением, Карян Армен.
Занимаюсь профессиональной разработкой прикладных программ на Python.
email SoftSAR@yandex.ru
Telegram @SoftSar_am