Как выработать хорошие навыки программирования у нового разработчика Python
Когда вы начинаете работать новым разработчиком Python, у вас, скорее всего, выработаются некоторые привычки, как хорошие, так и плохие.
Программирование — это что-то вроде искусства. Приветствуются гибкость и настройка — и обычно вы можете писать код так, как хотите, в контексте языка.
Проблема в том, что вы общаетесь с компьютером публично. Вам нужно писать свой код так, чтобы он был понятен другим.
Кроме того, использование неправильного синтаксиса или отсутствие уверенности в том, что вы пишете эффективно, могут привести к ошибкам в вашем программировании. Грязный код чрезвычайно затрудняет поиск этих ошибок в дальнейшем. Читабельное и чистое письмо — это путь, который означает формирование хороших привычек программирования на раннем этапе, чтобы вы следовали им на протяжении всей своей карьеры.
Вот шесть советов по формированию хороших привычек программирования, когда вы начинаете работать с Python.
1. Следуйте руководству по стилю PEP 8
Копирайтеры и другие авторы контента обычно используют так называемое руководство по стилю. Руководство по стилю устанавливает правила форматирования и организации текста. Это могло бы объяснить, следует ли использовать оксфордскую запятую, а когда использовать заглавные буквы и другие структурированные подходы.
В Python есть подобное руководство по стилю, известное как PEP 8, PEP8 или PEP-8. Несколько опытных разработчиков Python опубликовали руководство в 2001 году, чтобы рассказать, как писать идеально читаемый и согласованный код.
Некоторые принципы включают в себя:
Использование правильной техники отступов.
Оставаться ниже максимальной длины строки в 79 символов.
Использование разрывов строк.
Использование пустых строк — двойных или одинарных — для определений функций, классов и методов.
Использование правильных соглашений об именах для переменных, классов, функций и т. д.
Если вы еще этого не сделали, прочитайте руководство по стилю Python Pep 8 и убедитесь, что вы следуете всем методам.
2. Используйте новейшую версию Python
Языки программирования, такие как Python, в течение своего жизненного цикла проходят множество итераций. Старые версии обычно заменяются новыми выпусками. Как правило, новейшая версия включает исправления ошибок, а также улучшения безопасности и производительности.
Как минимум используйте Python 3 вместо Python 2, поскольку в январе 2020 года срок эксплуатации более старой версии истек. Кроме того, при работе со сторонними модулями, платформами или репозиториями всегда ссылайтесь на минимально необходимую версию Python. Это самая старая версия Python, совместимая со связанными компонентами.
3. Всегда комментируйте определенный код
В тот момент, когда вы пишете свой код, вы знаете, чего пытаетесь достичь. Когда вы прочитаете этот код позже, вы можете забыть — или, что еще хуже, если кто-то другой читает этот код, он может оказаться в недоумении. Вот для чего нужны комментарии.
В каждом языке есть способ «закомментировать» определенные участки кода. Идея состоит в том, чтобы использовать описательные, но краткие комментарии, чтобы объяснить, что происходит. Некоторые разработчики вообще забывают это сделать, но если вы начнете заранее и всегда будете следовать правилу, вы сможете написать легко читаемый синтаксис.
В Python вы используете символ «#» в начале комментария, чтобы закомментировать строку. Чтобы написать многострочный комментарий, вы можете использовать тройные кавычки (''') в начале или конце или несколько хэштегов в каждой строке.
#Это обычный комментарий.
‘’’
This is a multi-line comment.
To explain what the code is doing.
‘’’
Комментирование может быть важной частью процесса кодирования, поскольку оно позволяет вам лучше запоминать и визуализировать идеи, которые приходят вам в голову во время кодирования.
По мнению экспертов, написание заметок от руки, а затем их цифровая расшифровка с помощью таких вещей, как комментирование, улучшает удержание на 75 процентов. Это означает, что когда вы обнаружите ошибку или захотите внести улучшения позже, вам будет легче вызвать соответствующие фрагменты кода.
Встроенные комментарии также могут появляться в той же строке, что и фрагмент кода. Например:
print («Привет, мир. Это мой первый код.») # Вот как можно создать встроенный комментарий
4. Используйте линтер
Линтер Python проверяет расстояние между кодами, длину строк и различные параметры проектирования, такие как расположение аргументов. В результате ваш код выглядит чистым, организованным и последовательно написанным в нескольких файлах вашего проекта.
Имейте в виду, что линтер отличается от автоформатера или средства украшения — хотя в современном программировании один и тот же инструмент может выполнять обе эти вспомогательные функции. Вы можете думать о линтере как о чем-то, что решает практические проблемы, в отличие от автоформатера, который исправляет больше стилей.
Линтеры могут анализировать и выявлять ошибки кодирования, потенциальные ошибки, орфографические ошибки или синтаксические проблемы, а также стилистические несоответствия, например, использование отступов и пробелов. Автоформатеры фокусируются на письменной или стилистической части синтаксиса, такой как запятые, кавычки, правильная длина строки и т. д. Оба варианта полезны, но вам редко захочется писать код без удобного линтера.
Некоторые примеры лучших линтеров Python включают Pylint, Flake8, Ruff, Xenon и Radon и другие. На следующем снимке экрана используется линтер Ruff, установленный через VSCode.
5. Положитесь на встроенные функции и библиотеки
Прелесть Python и подобных ему языков в том, что вы никогда не начинаете с нуля. Вам не обязательно писать каждую функцию или достижение самостоятельно — вместо этого вы можете положиться на встроенные функции, библиотеки, фреймворки и репозитории.
Встроенные функции экономят ваше время, предоставляют рабочие функции и обычно управляются группой разработчиков. Что еще более важно, они повышают производительность вашего кода и программного обеспечения. Вы можете обратиться к официальной документации Python, чтобы увидеть встроенные функции языка.
Вот некоторые примеры:
append(): принимает один элемент и добавляет его в список, изменяя существующий список, добавляя к нему и увеличивая список на единицу.eval(): Оценивает любое указанное выражение, как если бы оно было официальным оператором Python.id(): Используется для ссылки на уникальный идентификатор объекта или целого числа.max(): Возвращает максимальное значение итерируемого объекта из нескольких заданных значений.print(): отображает или возвращает текстовые переменные в консоль Python.round(): Округляет число или значение до заданного десятичного знака.
Если использовать наиболее распространенный учебник для начинающих, когда вы используете функцию print(), это выглядит примерно так:
print(“Hello world I am coding.”)
Это вернется:
Привет, мир, я программирую
Эта встроенная функция всегда будет распознаваться независимо от используемой вами среды IDE или среды программирования, что относится ко всем встроенным функциям от Append() до Round().
С другой стороны, библиотеки многочисленны и разнообразны — они представляют собой гораздо большие коллекции предварительно написанного кода или функций. Чтобы использовать или ссылаться на библиотеки и их функции, вы просто импортируете их в свой скрипт Python. Примерами являются Requests, FastAPI, Asyncio, aiohttp, Tkinter и другие.
6. Исправляйте проблемы с кодом как можно скорее
Если при написании кода вы заметили, что что-то не так, исправьте это тут же. Не откладывайте это и не ждите, пока вы начнете тестирование позже. Вы можете потерять ошибку или ошибку — и представьте, что не сможете найти ее снова. От 23% до 42% времени разработчика тратится впустую из-за плохого кода, а это ценное время, которое вы могли бы потратить в другом месте.
Более того, ошибки и ошибки накапливаются с течением времени, поэтому чем дольше вы их оставляете, тем больше вероятность того, что целые сегменты вашего кода выдадут ошибку или перестанут работать. Многие IDE и линтеры могут помочь в этом процессе, особенно если вы используете модуль журналирования вместо простой печати результатов.
Модуль журналирования Python отслеживает события во время выполнения — когда программа работает. По сути, это позволяет вам выявлять проблемы или ошибки во время тестирования вашего кода. Он может помечать предупреждения, относящиеся к ошибкам, отладке или событиям, связанным с кодом, но также может помочь вам понять поведение вашего проекта во время выполнения — все, что вы можете упустить из виду в процессе написания.
Например, вы можете видеть и анализировать взаимодействие пользователей, особенно если внешние пользователи тестируют ваше приложение. Самое главное, что модуль журналирования — это инструмент аудита, который становится неоценимым, когда вы начинаете тестировать или запускать написанный вами код. Не кодируйте без него.
Практика приводит к совершенству
Есть много вещей, которые следует учитывать при работе с Python, и не имеет значения, насколько вы опытны или искусны. Следовать лучшим практикам Python — всегда правильный путь. Но, в конце концов, лучший способ учиться — это всегда применять практический подход, что означает практику.
Продолжайте использовать Python, даже для создания простых или небольших проектов для себя. Практикуйтесь в использовании обсуждаемых здесь привычек и написании чистого кода. Вам также следует прочитать код других разработчиков, чтобы увидеть, как они подходят к этому процессу.