Профессиональный подход к разработке Python-проектов: 10 шагов к успеху

Профессиональный подход к разработке Python-проектов: 10 шагов к успеху

Как разработчик Python, для успеха необходимы правильные инструменты. Есть несколько инструментов, которые могут помочь оптимизировать разработку и упростить кодирование.

Linux — это мощная операционная система, которую выбирают многие программисты. Он предлагает множество преимуществ по сравнению с другими вариантами, что делает его идеальным выбором для разработчиков, которым необходимо выполнять свою работу быстро и эффективно.

Рекомендуем загрузить ISO-образ последней LTS (Long-term support) версии дистрибутива Ubuntu или Ubuntu Mate и последовать любой актуальной инструкции с интернета для установки линукса в качестве основной или второй операционной системы на ваше устройство. 

Работать на Windows крайне не рекомендуется. Ознакомление с принципиально новой ОС - это сложный, но необходимый процесс. После установки Linux - просмотрите несколько

PyCharm — один из самых популярных вариантов для разработчиков Python, предлагающий интуитивно понятный интерфейс с мощными возможностями отладки и функциями завершения кода. Он также легко интегрируется с системами контроля версий, такими как Git, поэтому вы можете легко отслеживать изменения в своей кодовой базе.

Community версия подойдет для разработки API, ботов или обычных скриптов. Для написания веб-приложений со статикой (HTML / JS / CSS) лучше использовать пробный период Professional-издания Pycharm. Скачать Pycharm вы можете .

Moqups — еще один полезный инструмент, позволяющий быстро создавать каркасы без написания кода. Это делает его идеальным для создания прототипов пользовательских интерфейсов или тестирования различных дизайнерских идей.

Рекомендуемый инструмент для построения архитектур приложений, схем баз данных, диаграмм классов. Проведите несколько дней за изучением UML Class diagrams и Entity Relationship Diagram (ERD), читая статью и смотря видео на ютубе. Не забудьте попрактиковаться. Несколько ссылок:

• UML Диаграмма классов (UML Class Diagram)
• UML Tutorial: How to Draw UML Class Diagram
• Entity Relationship Diagram (ERD) Tutorial - Part 1
• Entity Relationship Diagram (ERD) Tutorial - Part 2

Github — это платформа с открытым исходным кодом, принадлежащая Microsoft, которая позволяет разработчикам хранить код в репозиториях и отслеживать изменения с течением времени.

Связанные вопросы и ответы:

Что такое Python-проект и почему он может быть полезен

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

1. Другая причина заключается в том, что Python занимает первое место в рейтингах популярности среди языков программирования. Это широко используемый язык, и его используют все виды ИТ-специалистов. Поэтому, если вы знаете Python, скорее всего, вам не нужно будет изучать другой язык, если вы этого не хотите. Позже в этой статье мы обсудим, кому может быть полезен Python и почему, но тот факт, что это язык подходит всем, делает его желанным выбором для многих.
2. Третья причина заключается в том, что Python является языком общего назначения , а это означает, что он не имеет ограничений в использовании. Вы можете применять Python буквально к каждому проекту, над которым работаете. Даже если вы поменяете работу, Python по-прежнему полезен для многих компаний и продуктов. По сути, это язык, который подходит для любых нужд, и вы можете использовать его всю жизнь. В моем профессиональном опыте я использовала его для веб-разработки, задач автоматизации QA, анализа данных и общего управления системой. Например, запустив простой скрипт Python, вы можете легко переопределить системные настройки.

Какие шаги следует предпринять для создания успешного Python-проекта

У меня для вас хорошая новость: любой человек может достичь хорошего уровня владения Python или же любым другим языком, благодаря правильному подходу, а именно синергией заинтересованности, мотивации и дисциплины.

Могу предположить, что некоторые люди пытаются попасть в ИТ в первую очередь из‑за денег. Не будем лукавить: денежная мотивация занимает далеко не последнее место и это вполне естественно: труд должен соответствующе оплачиваться. На одной лишь мотивации, а особенно на денежной, в принципе долго выезжать не получится. В данной сфере нужно очень много учиться. Причем делать это нужно постоянно. А какой нормальный человек сможет тратить огромное количество своего драгоценного времени на изучение того, что ему не интересно? Естественно, бывают разные программисты, я даже лично знаю некоторых, кто с трудом ориентируется в базовом синтаксисе языка, хотя уже несколько месяцев работают в ИТ‑компании. Мы же хотим стать хорошими специалистами, так?

Будучи новичком, я не сразу обрел истинный интерес к языку. На своих первых курсах мы решали математические задачки при помощи этого языка, и скажу вам так: это меня совсем не заинтересовало. Прошел достаточно продолжительный период времени(около года), прежде чем я вернулся к языку. Я вспоминал основы, после чего начал изучать фреймворк Django и сопутствующие технологии прямо во время процесса разработки.

Перейдя на любую вакансию новичок вполне может ужаснуться от списка технических требований к кандидатам: уверенное знание языка, опыт работы с N количеством фреймворков и библиотек, SQL, REST API, GIT, Docker. И данный список может расширяться в зависимости от конкретной вакансии.

Как же все выучить, работать эффективно, не потерять интерес и не сойти с ума?

Для ответа на этот вопрос, оставлю некоторые общие рекомендации:

Выберите удобную IDE. Процесс разработки в первую очередь должен быть комфортным для вас самих. Фактически, на рынке есть лучшая IDE для разработки на Python — это Pycharm. К сожалению, из‑за политики JetBrains их продукты больше не доступны для покупки аккаунтам из Беларуси и России. Альтернативой является VS Code, достаточно шустрый редактор кода, который благодаря плагинам оставляет большинство плюшек Pycharm.

Обязательно делайте перерывы: дайте вашему мозгу шанс обработать и усвоить полученную информацию. Вы можете удивиться, но эта штука практически всегда работает. Если вы видите, что у вас долго что‑то не получается — просто отдохните и отвлекитесь. Но данный отдых должен быть, в первую очередь, отдыхом для мозга. Лучшим отвлечением лично для меня является прогулка. Зачастую, после такого перерыва вы сможете по‑другому взглянуть на вашу задачу, у вас появятся новые мысли и вы увидите другие пути решения.

Выработайте привычку заниматься каждый день. Теория + много практики. Теоретические знания — это безусловно хорошо, но без должного количества практики они ничего не значат. Часто бывает такое, что в теории вам все кажется очевидным и понятным, но как дело касается решения вы обнаруживаете, что сильно путаетесь и голова будто бы не работает. Это нормально! Пытайтесь, пока не получится.

Не прыгайте между темами. Обучайтесь поэтапно и в комфортном для вас темпе. Никто не выиграет от того, что вы с утра до вечера будете сидеть за книгами и задачами, после чего сильно перегорите. Перегорание — это в целом распространенная проблема у программистов(и не только). Во время обучения и работы я тоже перегорал и знаю, что это такое. Но в итоге я нашел комфортный для себя темп и определил некоторые рабочие правила, вроде периодического отдыха.

Не злоупотребляйте копипастом кода. Особенно это касается проектов. Во всех курсах авторы закрепляют теорию практикой. В роли такой практики выступает создание проекта. Старайтесь думать сами. Это не значит, что вы не должны слушать автора, напротив, изучайте курс внимательно. Я говорю о том, что вы не должны слепо переписывать код и ждать чуда. Пытайтесь решить задачу сами, экспериментируйте, думайте над задачей вместе с автором.

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

Присоединяйтесь к сообществу: присоединение к сообществу изучающих Python и разработчиков может быть отличным способом сохранять мотивацию и учиться у других.

Создавайте пет‑проекты. Создание пет‑проектов — очень важный аспект в обучении, а также способ применить полученные знания и получить практический опыт, который можно будет добавить в резюме. Начните с простых проектов, таких как калькулятор или текстовая игра, и постепенно переходите к более сложным.

Как определиться с идеей Python-проекта

• Создайте генератор кода. Он может принимать текст в качестве входных данных, заменять каждую букву другой буквой и выводить «закодированное» сообщение.
• Создайте калькулятор обратного отсчета. Напишите код, который может принимать две даты в качестве входных данных, а затем вычислять время между ними. Это отличный способ познакомиться с модулем даты и времени Python.
• Напишите метод сортировки. Учитывая список, можете ли вы написать код, который сортирует его в алфавитном или числовом порядке? Да, Python имеет встроенную функциональность, но посмотрите, сможете ли вы сделать это без использования sort()!
• Создайте интерактивную викторину. Какой ты Мститель? Создайте викторину о личности или рекомендации, которая задает пользователям несколько вопросов, сохраняет их ответы, а затем выполняет какие-то вычисления, чтобы предоставить пользователю персонализированный результат на основе их ответов.
• Крестики-нолики по тексту. Создайте игру «Крестики-нолики», в которую можно играть как в текстовое приключение. Можете ли вы заставить его печатать текстовое представление доски после каждого хода?
• Сделайте преобразователь температуры/измерения. Напишите сценарий, который может конвертировать градусы Фаренгейта в градусы Цельсия и обратно, дюймы в сантиметры и обратно и т. д. Как далеко вы сможете зайти?
• Создайте приложение счетчика. Сделайте свои первые шаги в мире пользовательского интерфейса, создав очень простое приложение, которое будет увеличиваться на единицу каждый раз, когда пользователь нажимает кнопку.

Какие инструменты и технологии следует использовать для разработки Python-проекта

Редактор кода — это или самостоятельная программа, или часть IDE. Он выглядит как окно, где можно набрать текст, но более адаптирован под код.

Подсветка синтаксиса. Это означает, что, например, служебные слова будут одного цвета, комментарии — другого, классы будут выделяться другим начертанием и так далее. Это помогает быстрее ориентироваться в коде и находить нужные места. Более того, большинство существующих инструментов используются для нескольких языков программирования, поэтому знают синтаксис не только Python. При создании файла можно выбрать, на какой язык будет ориентироваться подсветка. Также программа может понять это самостоятельно по расширению файла.

Форматирование и установка отступов. Отступы используются практически во всех языках программирования, но в Python они обязательны и являются частью синтаксиса. Редакторы обычно умеют поддерживать и ставить нужные отступы автоматически. Но это только малая часть. Хорошие IDE и редакторы поддерживают более масштабное автоформатирование. например, во многих редакторах есть спеллчекеры — они показывают, если что-то написано неправильно, и обращают внимание пользователя на ошибку. Также есть инструменты, которые автоматически дополняют команды и функции из кода.

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

Создание, редактирование и сохранение файлов. Большинство редакторов и практически все IDE могут показывать структуру файлов в папке. Обычно это нужно для проектов, которые включают больше одного файла. Прямо внутри среды можно переключаться между файлами, создавать новые в папках и подпапках, сохранять изменения. Более того, многие приложения поддерживают системы контроля версий вроде Git и дают возможность делать коммиты прямо из среды, причем это умеют не только IDE, но и некоторые редакторы.

Отладка. Это процесс нахождения и исправления ошибок. Чтобы это можно было сделать быстрее, существуют расширенные возможности: пошаговое выполнение кода, остановка исполнения в определенной точке, просмотр содержимого переменных в любой момент времени и многое другое. Все это входит в функционал инструментов отладки.

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

Как организовать работу над Python-проектом

Достаточно вольный (настолько вольный, что отсутствуют два абзаца и изменен код) перевод статьи Джефа Кнаппа

Если вы подобны большинству начинающих python-программистов, вы вероятно в состоянии представить себе работу приложения целиком, но когда приходит время начать писать код и перед вами пустое окно редактора, вы чувствуете себя потерянным и подавленным. В этой статье я опишу метод, который использую когда начинаю писать программу с нуля. К концу статьи у вас будет хороший план для начала разработки любого приложения.

Установка

До того как написать хоть строчку кода, первое что я делаю - создаю виртуальное окружение . Что такое виртуальное окружение? Это установка python отдельно от остальной части системы (и дефолтного pythona’а). Какая от этого польза? Представьте себе, что у вас есть два проекта, над которыми вы работаете. Если оба испольузют какую-либо библиотеку (например, requests ), и в одном из проектов используется старая версия (которую нельзя корректно обновить, т.к. другие библиотеки используют старую версию requests ), как вы сможете использовать новую версию requests в другом проекте? С помощью виртуального окружения.

Для начала установите virtualenvwrapper (обертка над фантастическим пакетом virtualenv ). Добавьте в ваш .bashrc строчку/usr/local/bin/virtualenvwrapper.shи перезагрузите свой профиль с помощью source :

source ~/.bashrc

Теперь у вас должна появиться команда mkvirtualenv , доступная через автодополнение с помощью tab . Если вы используете Python старше версии 3.3, виртуальное окружение поддерживает этот язык и установка этого пакета не требуется.mkvirtualenv создаст новое виртуальное окружение под названием my_project с уже установленными pip и setuptools . Для Python 3 требуемые команды выглядят так:

python -m venv source /bin/activate

Теперь когда виртуальное окружение создано, пришло время инициализировать средство управления исходниками. Предполагая что это git (ну, потому что он…), введем

git init .

Так же полезно добавить в .gitignore все скомпилированые Python-ом файлы и каталоги__pychache__. Для этого создайте файл.gitignoreи поместите в него следующее:

*.pyc __pycache__

Теперь подходящее время добавить в проект README файл. Даже если вы единственный, кто будет видеть код, это хорошее упражнение для организации ваших мыслей. README файл должен описывать что делает проект, его зависимости и как его использовать. Я пишу README файлы с использованием разметки Markdown , во-первых потому что GitHub автоматически оформляет любой файл названный README.md , а во-вторых потому что я пишу все (!) документы в разметке Markdown .

И наконец, сделайте первый коммит содержащий два файла ( .gitignore , README.md ), которые вы только что создали. Для этого введите:

git add .gitignore README.md git commit -m "initial commit"

Каркасы!

Почти каждое приложение я начинаю одинаково: создаю каркас приложения, состоящий из функций и классов с заполненой документацией, но без реализации. Я считаю, что необходимо сперва вынужденно писать документацию для функции, иначе если я не способен кратко описать что-либо, то у меня нет достаточно мыслей о проблеме.

В качестве примера приложения я использую скрипт, недавно написанный обучаемым во время одного из наших занятий. Цель скрипта - создать csv-файл, содержащий самые кассовые фильмы прошлого года (по версии IMDB) и ключевые слова связанные с этими фильмами на IMDB. Это был довольно простой проект, для того что бы завершить его за одно занятие, но достаточный по сложности, что бы требовать размышлений.

Как провести анализ требований к Python-проекту

Сначала обратим внимание на структуру директорий проекта, на именование файлов и организацию модулей.

Рекомендую держать все файлы модулей в директории src, а тесты — в поддиректорииtests этой директории:

├── src │   ├── /* │   │    ├── __init__.py │   │    └── many_files.py │   │ │   └── tests/* │        └── many_tests.py │ ├── .gitignore ├── pyproject.toml └── README.md

Здесь  — это главный модуль проекта. Если вы не знаете точно — какой именно модуль у вас главный — подумайте о том, что пользователи проекта будут устанавливать командой pip install, и о том, как, по вашему мнению, должна выглядеть командаimport для вашего модуля.

Часто имя главного модуля совпадает с именем всего проекта. Но это — не некое жёсткое правило.

Аргументы в пользу директории src

Я видел множество проектов, устроенных по-другому.

Например, в проекте может отсутствовать директория src, а все модули будут просто лежать в его корневой директории:

non_recommended_project ├── /* │     ├── __init__.py │     └── many_files.py │ ├── .gitignore │ ├── tests/* │    └── many_tests.py │ ├── pyproject.toml │ ├── /* │     ├── __init__.py │     └── many_files.py │ └── README.md

Уныло смотрится проект, в структуре которого нет никакого порядка из-за того, что его папки и файлы просто расположены по алфавиту, в соответствии с правилами сортировки объектов в IDE.

Главная причина, по которой рекомендуется пользоваться папкой src, заключается в том, чтобы активный код проекта был бы собран в одной директории, а настройки, параметры CI/CD, метаданные проекта находились бы за пределами этой директории.

Единственный минус такого подхода заключается в том, что, без дополнительных усилий, не получится воспользоваться в своём коде командой вида import module_a. Для этого потребуется кое-что сделать. Ниже мы поговорим о том, как решить эту проблему.

Как создать прототип Python-проекта

1. Абстрактная фабрика (Abstract Factory) : Абстрактная фабрика — это порождающий паттерн, который предоставляет интерфейс для создания связанных или зависимых объектов без указания их конкретных классов. Он позволяет создавать семейства объектов, связанных между собой, и обеспечивает согласованность создания объектов в рамках этого семейства.

В Python можно реализовать абстрактную фабрику с использованием классов и наследования. Создается абстрактный класс фабрики, определяющий интерфейс для создания объектов. Затем создаются конкретные классы фабрик, которые наследуются от абстрактного класса и реализуют методы создания конкретных объектов.

Пример использования абстрактной фабрики в Python может быть в создании GUI-фреймворка. Абстрактная фабрика может определить методы для создания различных элементов пользовательского интерфейса, таких как кнопки, поля ввода и окна, а конкретные фабрики могут создавать объекты, соответствующие определенному стилю интерфейса, например, для операционных систем Windows и macOS.

1. Строитель (Builder): Строитель — это порождающий паттерн, который позволяет создавать сложные объекты шаг за шагом. Он отделяет процесс создания объекта от его представления, позволяя тем самым использовать один и тот же процесс создания для получения различных представлений объекта.

В Python строитель может быть реализован с помощью класса строителя и директора. Класс строителя определяет шаги создания объекта, а директор управляет последовательностью шагов и созданием объекта. Можно иметь различные строители, реализующие разные варианты создания объекта.

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

1. Фабричный метод (Factory Method): Фабричный метод — это порождающий паттерн, который определяет интерфейс для создания объекта, но позволяет субклассам выбрать класс создаваемого объекта. Он делегирует ответственность по созданию объектов субклассам, что позволяет локализовать знание о создании конкретных классов внутри субклассов.

В Python фабричный метод может быть реализован с использованием абстрактного класса фабрики и метода-фабрики. Абстрактный класс фабрики определяет интерфейс для создания объектов, а каждый конкретный субкласс фабрики реализует метод-фабрику для создания своего конкретного объекта.

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

1. Прототип (Prototype): Прототип — это порождающий паттерн, который позволяет создавать новые объекты путем копирования существующих объектов-прототипов. Он позволяет избежать сложностей с созданием новых объектов и позволяет динамически создавать объекты во время выполнения программы.

В Python прототип может быть реализован с помощью метода clone(). Классы объектов могут реализовать этот метод, чтобы создавать копии себя с помощью глубокого или поверхностного копирования.

Пример использования прототипа в Python может быть в создании игровых персонажей. Класс персонажа может иметь метод clone(), который позволяет создавать копии персонажей с определенными характеристиками и состоянием.

1. Одиночка (Singleton): Одиночка — это порождающий паттерн, который гарантирует, что класс имеет только один экземпляр, и предоставляет глобальную точку доступа к этому экземпляру. Он ограничивает создание объекта класса только одним экземпляром и обеспечивает доступ к этому экземпляру через статический метод.

В Python одиночка может быть реализован с использованием модуля или класса с приватным конструктором и статическим методом для получения экземпляра класса.

Пример использования одиночки в Python может быть в создании класса для работы с базой данных. Класс может иметь только один экземпляр, который представляет подключение к базе данных, и статический метод для получения этого экземпляра.

Эти порождающие паттерны проектирования предоставляют различные подходы к созданию объектов и управлению процессом создания. Их выбор зависит от конкретных требований проекта и ситуации.