denisxab / fastdjango

Использование

Запустить проект

Запустить DEV сервер:

invoke server.rundev

Аналог команды:

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Работа с фикстурами

Прочитать записи из таблицы БД

invoke db.dumpdata ИмяТаблицы -o='ИмяФикстуры.json'

Прочитать из файла и записать в БД

invoke db.loaddata ИмяТаблицы.json

Удалить все записи из таблицы БД

invoke db.flushtable users

Проверки проекта

Запустить проверки:

1. Проверить подключение к БД

invoke server.check

Аналог ViewSet

Есть аналог ViewSet из Django:

from fhelp.viewset import FViews
from api.schema import CU_UserSchema, UserSchema
from .models import User

router_persons = APIRouter()

class UsersRouter(FViews, APIRouter):
    model = User
    url = "users"
    # Схема ответа
    response_model = UserSchema
    # Схема POST BODY
    schema_body = CU_UserSchema
    # Разрешить фильтрацию списка по точному совпадению
    filter_column_eq = ("level",)
    # Разрешить фильтрацию списка по не точному совпадению
    filter_column_like = ("snils",)
    # Пагинация списка
    page_size = 2
    # Сортировка списка
    order_by = ("id",)
    # Использовать кеширование GET запросов через redis. При POST,PUT,DELETE кеш будет удалён
    cached = "redis"


router_persons.include_router(UsersRouter())

Админ панель

Подключить админ панель:

from fastapi import FastAPI
from fhelp.fadmin import add_model_in_admin, router_admin
from api.models import Person, User

app = FastAPI()

# Добавляем миддлвару для обработки CORS
app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],  # Можете заменить "*" на домен вашего фронтенда
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

# Подключить модели в админ панель:

add_model_in_admin(model=User)
add_model_in_admin(model=Person)

app.include_router(router_admin)

Теперь можно пользоваться API админ панели localhost:8000/admin/:

• 
• 

Использовать логгер

В файл main.py

from fhelp.flogger import basicConfigLogger

basicConfigLogger(path_log_dir=Path(__file__).parent / "log")

Использовать логгер

import logging

logger = logging.getLogger("fhelp")

logger.debug("Ответ из кеша")

Авторизация по JWT

1. Создать SECRET_KEY

Сгенерировать секретный ключ:

invoke server.gensecretkey

Вставьте этот ключ в settings.py:

SECRET_KEY = "f58f7156911ebf46b9d9ad35b43e60388dc8f639b356f59eac3aa8df45290d47"

2. Подключить к проекту

Подключите аутентификацию и авторизацию по JWT:

from fhelp.fjwt import router_jwt,add_handler_login_jwt

app = FastAPI()

def handler_login_jwt(username: str, password: str):
    """Проверка аутентификации пользователя перед выдачей токена"""

    ...

    # Если (False, 'Текст ошибки') то будет исключение
    return (True,'')

add_handler_login_jwt(handler_login_jwt)
app.include_router(router_jwt)

3. Аутентификация

Выполнить аутентификацию и получить JWT:

curl -X 'POST' \
  'http://localhost:8000/login_jwt?username=Имя&password=Пароль' \
  -H 'accept: application/json' \

4. Авторизация

Использовать авторизацию для функций:

from fhelp.fjwt import get_current_user

@app.get("/Имя")
async def Имя(current_user: dict = Depends(get_current_user)):
    # Только авторизованный пользователь попадет в эту функцию
    return current_user

Выполнить запрос с JWT:

curl --location 'http://localhost:8000/Путь' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkMTIzMTIzIiwiZXhwIjoxNjk5MjAyNzc4fQ.xv5G6e3HUS3rahvdYFwCzx7rK5cNplOFmbe4RQw5xig'

Текст ошибки авторизации:

HTTP 403

{
    "detail": "Could not validate credentials"
}

4.1 Авторизация для Views

Используйте класс FViewsJwt вместо FViews

Тестирование FastAPI

Пример подключения:

Создать файл ./conftest.py:

from fhelp.base_conftest import setup_before_tests  # noqa F401

Пример теста:

from fastapi.testclient import TestClient
from fhelp.ftest import BaseFastApiTest
from settings import SettingsFastApi

settings = SettingsFastApi()

class TestMainApp(BaseFastApiTest):
    # Список фикстур которые нужно устанавливать при каждой функции теста
    fixtures = [settings.BASE_DIR / "fixtures" / "test_base.json"]

    def setup_method(self):
        # Можете добавить логику при запуске тестовой функции
        super().setup_method()

    # Пример тестовой функции
    def test_read_main(self, client: TestClient):
        excepted_response = [
            {
                "username": "2Petro",
                "email_user": "[e-mail]",
                "snils": "1231121245",
                "level": 1,
                "id": 2,
            },
            {
                "username": "Иванов",
                "email_user": "[e-mail]",
                "snils": "453514",
                "level": 3,
                "id": 3,
            },
        ]
        # Тест синхронного router
        response = client.get("/test")
        assert response.status_code == 200
        assert response.json() == excepted_response

        # Тест асинхронного router
        response2 = client.get("/async_test")
        assert response2.status_code == 200
        assert response.json() == excepted_response

Оформление проекта

• ИмяПриложения
  • __init__.py
  • models.py - Файл с определением моделей данных
  • query_db.py - Модуль для выполнения запросов к базе данных
  • view.py - Модуль для маршрутизации URL и обработки запросов
  • schema.py - Схема запросов и ответов
• main.py - Файл, откуда запускается проект
• models.py - Файл, где происходит подключение моделей
• settings.py - Файл с настройками проекта
• tasks.py - Модуль для автоматизации задач через командную строку
• README.md - Документация проекта
• pyproject.toml - Файл с описанием зависимостей библиотек
• alembic.ini - Файл с настройками для инструмента alembic

Миграции

Использовать готовый CLI

• invoke db.makemigrations - Создать миграцию
• invoke db.migrate - Применить миграцию

Alembic

CLI Alembic

Инициализация Alembic: alembic init alembic

Создать миграцию: alembic revision --autogenerate

• -m "ИмяМиграции"

Применить все миграции к БД: alembic upgrade head

Откатить миграцию на один шаг назад: alembic downgrade -1