
С полгода назад я начал чаще использовать для программирования Python. Почему? Конечно, из-за ИИ. Лично для меня очевидно, что сегодня эта сфера связана с очень большими деньгами перспективами во всех направлениях. А какой язык является самым распространённым для ИИ? Да-да, этот самый проныра.
Я уже писал на Python, но только небольшие скрипты. К примеру, вот этот скрейпит метаданные всех видео с моего канала на YouTube. Собранные метаданные выводятся в виде файла JSON, который я использую для показа красивой статистики роликов на этой статичной странице. Как можно видеть здесь, этот скромный скрипт через GitHub Actions выполняется в соло-режиме каждый понедельник. Просто реализовать всё это на Python куда проще, чем с помощью того же Bash. И не только из-за более дружественного синтаксиса, но и потому что его интерпретатор нативно интегрирован во все дистрибутивы Unix. Разве не круто?
Так что, да, Python силён и отлично сочетается с распространённым сегодня VSCode. Но всерьёз я начал к нему относиться лишь недавно1, когда решил заняться созданием приложений на базе ИИ (RAG, агентов, генеративных инструментов и прочего) для реальных задач. Тогда я понял, что независимо от того, нравится он вам или нет, для всего этого оптимальным выбором будет именно Python.
В итоге я решил взяться за него всерьёз и к своему удивлению выяснил, что Python вместе со всей окружающей его средой за последние десятилетия существенно развился.
Вот лишь несколько подтверждений тому:
-
Вокруг этого языка выстроилась полноценная экосистема библиотек и инструментов для обработки/анализа данных.2
-
Python стал быстрее, благодаря использованию оптимизированных статических компиляторов вроде Cython.
-
Разработчики Python проделали старательную работу, скрыв его легаси-уродство (например,
__init__,__new__и аналогичные искажения), сделав синтаксис более удобным для разработчиковс хорошим вкусом.
Благодаря всем перечисленным и многим другим доработкам, теперь работать с этим языком мне стало особенно приятно.
Тем не менее за эти полгода я также узнал, что по-прежнему велика разница между пригодностью Python для обычных рабочих потоков на базе блокнотов Jupyter или скриптов и его использованием для создания готовых к продакшну3 приложений.
Так что в этой статье я расскажу об инструментах, библиотеках, конфигурациях и прочих дополнениях для языка, которые дарят мне удобство, и которые я использую для создания приложений.
⚠️ Эта статья ориентирована на инструменты, с которыми работаю лично я. Если вы можете порекомендовать мне какие-то другие полезные решения, поделитесь в комментариях.
Примечание: так вышло, что моя статья набрала на Hacker News более 680 комментариев. Ещё раз убеждаюсь в непредсказуемости жизни.
Структура проекта
Я предпочитаю использовать для своих проектов Python структуру монорепозитория, включая в него и бэкенд, и фронтенд.4
Почему?
-
Из-за сложностей с запоминанием: мне не нравится, когда части кода разбросаны по нескольким репозиториям (это явно не облегчает поиск).
-
Наличие нескольких репозиториев зачастую излишне. Я работаю один и считаю, что если проект дорастёт до потребности его разделения на разные репозитории, это уже будет говорить о чрезмерном усложнении.
-
Ну и я банально ленивый, стараюсь ничего не усложнять — компилирую, тестирую, пакую в контейнеры и развёртываю из одного расположения.5
Мне бы хотелось иметь инструмент, который бы генерировал структуру проекта, но пока подходящих я не нашёл. Раньше я использовал CCDS — инструмент для инициализации проектов, преимущественно в сфере дата-сайенс. Он очень хорош, но не ориентирован на фулстек разработчиков.
Вот типичная структура проекта с архитектурой фронт-бэк (чуть позже я пробегусь по каждой её части):
project/ │ ├── .github/ # Рабочие потоки GitHub Actions для пайплайнов CI/CD. │ ├── workflows/ # Каталог с файлами YAML для автоматизированных рабочих потоков. │ └── dependabot.yml # Конфигурация Dependabot для управления зависимостями. │ ├── .vscode/ # Конфигурация VSCode для проекта. │ ├── launch.json # Отладочные настройки для VSCode. │ └── settings.json # Настройки проекта для VSCode. │ ├── docs/ # Сайт и документация (статичный SPA с MkDocs). │ ├── project-api/ # API бэкенда для обработки бизнес-логики и основных задач. │ ├── data/ # Каталог для хранения датасетов и других статичных файлов. │ ├── notebooks/ # Блокноты Jupyter для оперативных экспериментов и прототипирования. │ ├── tools/ # Вспомогательные скрипты и инструменты для разработки и развёртывания. │ ├── src/ # Исходный код для бэкенд-приложения. │ │ ├── app/ # Основной код приложения. │ │ └── tests/ # Модульные тесты для бэкенда. │ │ │ ├── .dockerignore # Указание файлов, исключаемых из сборок Docker. │ ├── .python-version # Указание версии Python для pyenv. │ ├── Dockerfile # Конфигурация Docker для контейнеризации бэкенда. │ ├── Makefile # Автоматические задачи для сборки, тестирования и развёртывания. │ ├── pyproject.toml # Файл конфигурации проекта Python. │ ├── README.md # Документация для API бэкенда. │ └── uv.lock # Lockfile, содержащий список зависимостей, управляемых UV. │ ├── project-ui/ # UI фронтенда для проекта (Next.js, React и так далее). │ ├── .gitignore # Глобальный файл gitignore для репозитория. ├── .pre-commit-config.yaml # Конфигурация для pre-commit хуков. ├── CONTRIBUTING.md # Руководства для участников проекта. ├── docker-compose.yml # Настройки Docker Compose для мульти-контейнерных конфигураций. ├── LICENSE # Лицензионная информация проекта (я всегда выбираю MIT). ├── Makefile # Автоматические задачи для сборки, тестирования и деплоя. └── README.md # Основная документация проекта (его базовые функции, процесс установки и инструкции к использованию).
Мой project представлен адресом корневого каталога и именем репозитория GitHub. Мне нравится давать проектам короткие названия длиной до 10 символов, без использования snake_case — меня вполне устраивает разделение дефисами. Заметьте, что проект должен быть самодостаточным, то есть включать документацию, инфраструктуру сборки/деплоя и любые другие необходимые файлы для его автономного развёртывания.
Важно не проделывать в project-ui никаких этапов сложной обработки данных, так как я стараюсь отделять логику фронтенда от задач бэкенда. Вместо этого я выполняю HTTP-запросы к серверу project-api, который содержит Python-код. Таким образом мы сохраняем браузерное приложение лёгким, делегируя всю основную работу и бизнес-логику серверу.
В project-api/src/app есть файл __init__.py, указывающий, что app — это модуль Python (его можно импортировать из других модулей).
Инструменты Python
uv
Для управления пакетами и сборки я использую uv. Этого инструмента мне вполне хватает для установки зависимостей и управления ими.
Вот основные команды для его настройки:
# Глобальная установка uv, если он ещё не установлен. curl -sSfL <https://astral.sh/install.sh> | sh # Инициализация нового проекта (добавляет .gitignore, .python-version, pyproject.toml и так далее). uv init project-api # Добавление в проект некоторых зависимостей и обновление pyproject.toml. uv add --dev pytest ruff pre-commit mkdocs gitleaks fastapi pydantic # Указание в Lockfile последних версий зависимостей (создаёт .venv, если ещё не создан). uv sync # Активация .venv. uv venv activate
Обратите внимание, что самым важным для uv файлом является pyproject.toml.6 Он содержит метаданные и список зависимостей, необходимых для сборки и выполнения проекта.
Ruff
Ruff мне очень нравится. Это супербыстрый линтер и форматер кода для Python, помогающий ленивым разработчикам вроде меня сохранять кодовые базы в чистом и обслуживаемом виде. Он совмещает в себе isort, flake8, autoflake и аналогичные инструменты, доступные через единый интерфейс командной строки:
# Линтинг всех файлов в /path/to/code (и всех подкаталогах). ruff check path/to/code/ # Форматирование всех файлов в /path/to/code (и всех подкаталогах). ruff format path/to/code/
Ruff штатно поддерживает руководство по стилю PEP 8.
ty
ty — это модуль проверки типов для Python. При этом он прекрасно сочетается с typing, популярным модулем для добавления статической типизации. Думаю, что типизация реально помогает мне перехватывать ошибки типов на ранних стадиях разработки. Я не боюсь писать дополнительный код и с готовностью иду на это, если такое решение повышает качество программы, попутно уменьшая вероятность ошибок в среде выполнения.
Примечание: на момент написания статьи
tyещё находится на ранней стадии разработки, но за время использования этой утилиты я никаких ощутимых недочётов не заметил. Кстати, работают над ней ребята из Astral, той же компании, которая создалаuvиruff.
pytest
pytest — это оптимальная библиотека тестирования для Python, значительно облегчающая написание простых и масштабируемых тестов. Она поддерживает фикстуры, параметризованные тесты, а также имеет богатую экосистему плагинов. Просто создайте в project-api/src/app/tests/ файл с именем test_<unit_or_module>.py и выполните:
uv run pytest
Готово!
Pydantic
Pydantic — это библиотека для валидации данных и управления настройками. Она помогает настраивать всевозможные детали конфигурации, такие как ключи API, подключение к базе данных или параметры модели (жёсткое прописывание этих значений — очень плохая практика, если что).
В частности, Pydantic Settings позволяет определять конфигурацию приложения с помощью моделей Pydantic. Эта утилита может автоматически загружать настройки из переменных среды или специальных файлов .env, проверять их типы и обеспечивать удобный доступ к ним в коде.
Вот пример:
from pydantic import BaseSettings class Settings(BaseSettings): api_key: str db_url: str class Config: env_file = ".env" settings = Settings()
При выполнении этого кода Pydantic будет автоматически загружать значения api_key и db_url из файла .env или переменных среды. В итоге эти значения будут доступны для изменений и проверяться в соответствии с типами из модели Settings. Прекрасно!
MkDocs
С помощью MkDocs я создаю документацию и генерирую статический сайт для проекта.7 Сам я не дизайнер, поэтому предпочитаю просто копировать красивые эскизы из других опенсорсных проектов и вносить в их CSS небольшие доработки (например, изменять шрифты и цвета).
FastAPI
FastAPI я использую для создания API. Лично мне этот инструмент сильно облегчил жизнь. Он позволяет легко создавать RESTful API с автоматической валидацией, сериализацией и документацией. FastAPI построен на базе Starlette и Pydantic, благодаря чему обеспечивает превосходное быстродействие и безопасность типов. Он быстр, прост в использовании и легко интегрируется с Pydantic для валидации данных.
Dataclasses
Dataclasses — это не библиотека, а функциональность самого Python, обеспечивающая возможность определения классов, используемых в основном для хранения данных. Она предоставляет простой синтаксис для создания классов, автоматически генерирующих особые методы вроде __init__(), __repr__() и __eq__().
Это существенно сокращает объём шаблонного кода при создании контейнеров данных.
Вот пример:
from dataclasses import dataclass @dataclass class Point: x: int y: int p = Point(1, 2) print(p) # Вывод: Point(x=1, y=2)
Так что можно попрощаться с бойлерплейтом и загадочным кодом!
Контроль версий
GitHub Actions
Я люблю GitHub Actions, особенно за то, что эта платформа обеспечивает непрерывную интеграцию в разных ОС. Рекомендую использовать её для налаживания пайплайнов API и UI.
Вот типичный рабочий поток project-api:
name: CI-API on: push: branches: - main pull_request: branches: - main jobs: build-and-test: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v3 - name: Build Docker image run: docker build -t project-api:ci ./project-api - name: Run tests run: docker run --rm project-api:ci pytest
Заметьте, что здесь для выполнения тестов в изолированной среде используется Docker.8 Изменить ОС можно через установку параметра runs-on на windows-latest или macos-latest.
Dependabot
Обработка зависимостей — это всегда боль, но Dependabot её облегчает. Он автоматически проверяет актуальность зависимостей и создаёт пул-реквесты для их обновления.
Вот образец конфигурации этого инструмента из файла .github/dependabot.yml:
version: 2 updates: - package-ecosystem: "uv" directory: "/" schedule: interval: "weekly"
Gitleaks
Думаю, что одним из основных недочётов, способных повредить нашей репутации, является сохранение чувствительных данных вроде ключей API или паролей непосредственно в репозитории. К счастью, Gitleaks помогает исключить подобные проблемы. Не вижу причин её не использовать.
Pre-commit хуки
Я использую pre-commit для выполнения проверок и форматирования кода перед отправкой коммита. Это позволяет сохранять код в опрятной форме и обеспечивать соблюдение им стандартов проекта. К примеру, я использую вот этот фреймворк для выполнения ruff-pre-commit и gitleaks перед отправкой кода в репозиторий.
Вот образец моего файла .pre-commit-config.yaml:
repos: - repo: <https://github.com/astral-sh/ruff-pre-commit> rev: v0.12.3 # Версия Ruff. hooks: - id: ruff-check # Запуск линтера. args: [ --fix ] - id: ruff-format # Запуск форматирования. - repo: <https://github.com/gitleaks/gitleaks> rev: v8.27.2 hooks: - id: gitleaks
Управление инфраструктурой
Make
Make — это классическая утилита для автоматизации задач, которую можно по праву назвать мультитулом. Я с его помощью создаю простые сокращения для частых команд разработки. Вместо того, чтобы запоминать и вводить длинные выражения для выполнения тестов, сборки образов Docker или запуска сервисов, я определяю все эти задачи в Makefile. Потом остаётся просто выполнять команды вроде make test или make infrastructure-up.
Как вы могли заметить, Makefile есть в каталоге project-api и глобальном каталоге project:
1. project/project-api/Makefile: для линтинга, тестирования и выполнения API.
2. project/Makefile: для сборки и запуска инфраструктуры (через docker-compose).
Вот очень упрощённый пример Makefile для project-api:
DIR := . # project/project-api/Makefile test: uv run pytest format-fix: uv run ruff format $(DIR) uv run ruff check --select I --fix lint-fix: uv run ruff check --fix
Теперь, если я захочу прогнать тесты, то выполню make test, и программа запустит uv run pytest в текущем каталоге.
Для проекта в целом я использую такой Makefile:
infrastructure-build: docker compose build infrastructure-up: docker compose up --build -d infrastructure-stop: docker compose stop
make — это мощный инструмент, помогающий автоматизировать в потоке разработки практически всё. И хотя выше я привёл весьма упрощённые примеры, всегда есть возможность добавить любые сложные задачи, которые вам нужны.
Docker
Docker — это инструмент, который позволяет упаковывать приложение с его зависимостями в контейнер, включая всё необходимое для выполнения: зависимости, системные инструменты, код и среду выполнения. Работая локально, я использую Docker Compose для соединения всех образов Docker в единой сети. По аналогии с Docker, работающим с зависимостями, Docker Compose позволяет инкапсулировать весь стек приложений и отделить его от остальной локальной среды разработки.
Чтобы лучше понять этот механизм, взглянем на простой файл docker-compose.yml:
version: '3.8' services: project-api: build: context: ./project-api dockerfile: Dockerfile ports: - "8000:8000" volumes: - ./project-api:/app environment: - ENV_VAR=value networks: - project-network project-ui: build: context: ./project-ui dockerfile: Dockerfile ports: - "3000:3000" networks: - project-network networks: project-network: driver: bridge
Здесь мы определяем два сервиса: project-api и project-ui. Каждый из них имеет собственный контекст сборки (Dockerfile), порты, тома и переменные среды.
Вот образец Dockerfile для сервиса project-api:
FROM python:3.11-slim # Установка системных зависимостей. COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/ WORKDIR /app COPY uv.lock pyproject.toml README.md ./ RUN uv sync --frozen --no-cache # Включение кода приложения. COPY src/app app/ COPY tools tools/ # Определение команды для запуска приложения. CMD ["/app/.venv/bin/fastapi", "run", "project/infrastructure/api.py", "--port", "8000", "--host", "0.0.0.0"]
Как видите, Dockerfile начинается с базового образа Python, устанавливает зависимости, копирует файлы проекта и определяет команду для запуска приложения FastAPI.
Таким образом вы можете запускать весь стек приложений одной командой:
docker compose up --build -d
Сноски
1. Кто меня знает, тот помнит, что раньше я работал преимущественно на Java/JavaScript/R. ↩
2. К примеру, сегодня Jupyter используется практически всеми ведущими облачными провайдерами в качестве штатного инструмента для интерактивной обработки данных и научных вычислений. ↩
3. Под «готовыми к продакшну» я подразумеваю, что могу развернуть приложение в облаке как есть без необходимости вносить множество изменений в инфраструктуру. ↩
4. Да, я знаю, что порой необходима структура, включающая несколько репозиториев — например, при работе разных команд над разными частями проекта или для разделения зависимостей между несколькими проектами. ↩
5. Я считаю, что лучше избегать преждевременного разделения. Если кодовая база содержит, скажем, 1/2 миллиона строк кода, то настройка сетевого уровня (например, вызовов API) создаст для здравомыслящих разработчиков только лишние хлопоты. ↩
6. Файл pyproject.toml аналогичен package.json в Node.js или pom.xml в Java. ↩
7. Кстати, я думаю, что каждый проект на GitHub должен иметь свой сайт (это очень легко реализовать через GitHub Pages), так что оправдания не принимаются. ↩
8. Использование Docker для непрерывной интеграции позволяет обеспечить паритет с продакшн-средами, хотя может вносить издержки на старте. Компромиссы, куда без них. ↩
ссылка на оригинал статьи https://habr.com/ru/articles/930234/
Добавить комментарий