Платформа должна помочь вести проекты которые реализуются в рамках стажировки молодых специалистов.
Аналитика успеваемости стажёров.
Собственная система ведения задач. По причине блокировок пользователей такими ресурсами как Trello и ограничение на использование на подобных ресурсах.
Управление командами и участниками стажировки.
переименовать
.env.example на .env
docker-compose up --build
Не выключая контейнеры выполнить команду
docker exec -it sup-back alembic upgrade head
http:\\127.0.0.1:8000\docs
Не выключая контейнеры выполнить команду
docker exec -it sup-back alembic revision --autogenerate -m 'название модели или миграции'
Слоистая Архитектура на FastAPI
- Python 3.12
- FastAPI
- SqlAlchemy
- Postgres
- Alembic
- Docker
Отчасти подобие элемента DDD (Domain-driven design) - ограниченный контекст (bounded context).
Не требуется глубоко разбираться в DDD, но без понимания контекста никуда.
Контроллеры везде называют по разному: routers, endpoints, controllers, мы используем
controllers.
Контроллеры отвечают за запрос\ответ. Можно сказать что они должны быть "тупые", не иметь бизнес-логики, вообще не иметь бизнес-логики.
Они вызывают нужные зависимости: авторизация, проверка прав и т.д.
Передают данные в сервис. Обрабатывают HttpExceptions.
Сервис - это "бизнес контроллеры", отвечает за бизнес логику, взаимодействуют с репозиторием и другими сервисами.
Если в пределах одной сессии (в нашем случае SqlAlchemy) нужно взаимодействовать с несколькими репозиториями, то следует использовать QueryRepository.
Репозиторий — это коллекция, которая содержит сущности, может фильтровать и возвращать результат обратно, в зависимости от требований нашего приложения. Где и как он хранит эти объекты, является ДЕТАЛЬЮ РЕАЛИЗАЦИИ.
В нашем случае репозиторий может взаимодействовать с базой данных, например Postgres, Redis, MongoDB.
Каждый отдельный репозиторий взаимодействует только с одной моделью (таблицей).
Паттерн репозиторий служит цели отделить логику работы с БД от бизнес-логики приложения. Лично для себя выделяю основной плюс в переиспользовании методов выборки.
Примерами методов репозитория могут быть такие названия методов как:
- get_single()
- get_by_id()
- get_user_list()
- get_multi()
- и т.д.
Также репозиторий может использоваться для create/update/delete операций.
Контексты - отдельная часть логики проекта. Содержит свои контроллеры, сервисы, репозитории, зависимости, модели, exceptions и т.д.
- Файлы находятся в папке разбитые по контекстам. Каждый контекст относится к определенной сущности либо бизнес-процессу.
- Для выборок данных используем паттерн репозиторий.
- Бизнес-логика и операции создания/изменения моделей выносим в сервис-классы. Сервис классы не хранят свое состояние, что позволяет их переиспользовать без повторной инициализации.
- Для того чтобы не зависеть от Request в сервисы передаем либо одиночные параметры, либо DTO (Pydantic Model). Это позволяет переиспользовать код вне контроллеров (например, команда создания нового пользователя и т.д.).
- Стараемся, чтобы модели оставались максимально тонкими. В основном содержат в себе связи (relations).
- Все relation_ship lazy должны быть raise_on_sql
- migrations - директория alembic для миграций
- migrations/versions - файлы миграций
- migrations/base.py - файл с импортированными модулями моделей для работы автогенерации миграций
- migrations/env.py - скрипт alembic для работы миграций
- src - верхний уровень, содержит общие routes, main.py и все контексты
- src/config - директория для общих настроек
- src/config/database/db_config.py - настройки базы данных
- src/config/database/db_helper.py - получение сессии базы данных
- src/config/project_config.py - настройки для проекта
- src/main.py - корень проекта, который запускает приложение FastAPI
- src/routes.py - общие routers для всех приложений проекта
- tests - тесты проекта
- .env.example - пример (шаблон) для файла .env, переменные окружения
- pyproject.toml - файл зависимостей для poetry
- poetry.lock - обеспечить согласованность между текущими установленными зависимостями и теми, которые вы указали в файле pyproject.toml
- src/lib/models/base_model - базовый класс SqlAlchemy
- src/lib/dtos/base_dto - класс базовой модели Pydantic, с настройкой для интеграция с ORM (Ранее известный как "ORM Mode"/from_orm)
- prefix_controller.py - контроллеры контекста
- prefix_repository.py - работа с БД (Postgres, Redis, MongoDB и т.д.)
- prefix_service.py - специфичная для модуля бизнес-логика
- prefix_schema.py - pydantic модели
- routes.py - общие routes для всех контроллеров контекста
- prefix_model.py - модели ORM
- dependencies.py - зависимости для контекста
- exceptions.py - специфические для контекста исключения
- constants.py - константы контекста
- Логическая часть проекта находиться внутри контекста
- Контекст называем в единственном числе (например session, user, support)
- Избегаем длинных названий файлов и используем
_(например user_service.py) - Сущности более одной собираются в папки (например services, schemas)
- Поддерживаем цепочку Controller -> Service -> Repository
- Запросы контекста пишем в локальном репозитории (например support_repository.py)
Вначале, описываем библиотеки, группируем логически.
from starlette.status import HTTP_400_BAD_REQUEST, HTTP_204_NO_CONTENT
from fastapi import Depends, HTTPException, APIRouter
Перечисляем используемые контексты.
from ...auth.user_schema import UserSchema
from ...auth.auth_service import is_admin
В конце, локальные зависимости контекста.
from ..schemas.support_schema import (
CreateSupportSchema,
UpdateSupportSchema,
SupportResponseSchema
)
from ..services.support_service import SupportService
