Использование Pydantic в веб-разработке: Зачем и Как

[D2]

Введение.​

Привет! Сегодня я хочу поделиться с вами интересной темой, которая может значительно упростить вашу работу в веб-разработке.

Мы поговорим о библиотеке Pydantic — инструменте, который быстро завоевал популярность благодаря своей способности эффективно валидировать данные и обеспечивать строгую типизацию.

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

Pydantic — простота использования и легкая интеграция с популярными фреймворками, такими как FastAPI и Django.

---

Зачем использовать Pydantic?​

— Автоматическая валидация данных: Ошибки данных выявляются на раннем этапе, что снижает риск возникновения багов.
— Типизация и конвертация данных: Pydantic автоматически конвертирует данные в нужные типы (например, строки в числа или даты).
— Простота и чистота кода: Код становится более читаемым и поддерживаемым за счет устранения необходимости ручной валидации.

Пример использования Pydantic​

Рассмотрим простой проект управления закладками (не теме которые вы могли подумать).

Без Pydantic:
Python: Скопировать в буфер обмена

from fastapi import FastAPI, HTTPException

app = FastAPI()

pins = {}

@app.post("/pins/")
def create_pin(pin_id: int, url: str, description: str):
    if not isinstance(pin_id, int) or not isinstance(url, str) or not isinstance(description, str):
        raise HTTPException(status_code = 400, detail = "Invalid input")
    
    if pin_id in pins:
        raise HTTPException(status_code = 400, detail = "Pin ID already exists")
    
    pins[pin_id] = {"url": url, "description": description}
    return pins[pin_id]

Проблемы без Pydantic:
— Необходимость ручной валидации данных.
— Сложность поддержки и избыточность кода.
— Повышенный риск ошибок при добавлении новых параметров.


С использованием Pydantic:
Python: Скопировать в буфер обмена

from fastapi import FastAPI
from pydantic import BaseModel, HttpUrl

app = FastAPI()

pins = {}

class Pin(BaseModel):
    pin_id: int
    url: HttpUrl
    description: str

@app.post("/pins/")
def create_pin(pin: Pin):
    if pin.pin_id in pins:
        raise HTTPException(status_code = 400, detail = "Pin ID already exists")
    
    pins[pin.pin_id] = pin.dict()
    return pins[pin.pin_id]

Преимущества с Pydantic:
— Упрощение кода за счет автоматической валидации данных.
— Гарантированная типизация и конвертация данных.
— Более структурированный и поддерживаемый код.

---

Заключение​

Pydantic — мощный инструмент, который значительно улучшает качество и устойчивость кода в веб-разработке.
Использование Pydantic рекомендуется для большинства проектов на Python, особенно тех, где важно минимизировать ошибки и упрощать поддержку кода.

---

Впервые пишу тему, пострался максимально просто описать всё, не знаю на сколько всё это вышло, если остались вопросы, то буду рад ответить в комментариях.