Kako popraviti nedostajuća polja u Pydantic modelima

Mia Chevalier

Petak, 17. svibnja 2024. u 18:41:02

Rješavanje problema s obavijestima Pydantic e-poštom
U ovom članku istražujemo zašto Pydantic ukazuje da polja nedostaju, iako su navedena u kodu. Taj se problem često javlja prilikom izrade API-ja koji obrađuje obavijesti putem e-pošte s dodatnim poljima kao što su ID i vremenske oznake.
Uronit ćemo u pojedinosti poruke o pogrešci i pružiti korak po korak rješenje kako bismo osigurali da su sva polja ispravno prepoznata. Osim toga, raspravljat ćemo o najboljim praksama za rukovanje takvim obavijestima u modelima Pydantic.

Naredba Opis

uuid.uuid4() Generira nasumični UUID (Universally Unique Identifier).

datetime.datetime.now(datetime.UTC).isoformat() Dobiva trenutni datum i vrijeme u ISO 8601 formatu s UTC vremenskom zonom.

@app.post("/notifications/email") Definira krajnju točku u FastAPI-ju za rukovanje POST zahtjevima za stvaranje obavijesti putem e-pošte.

Enum Koristi se za stvaranje enumeracija, skupa simboličkih imena vezanih za jedinstvene, konstantne vrijednosti.

BaseModel Osnovna klasa u Pydantic-u za stvaranje modela podataka s provjerom valjanosti tipa.

dict() Pretvara instancu Pydantic modela u rječnik.

Naredba	Opis
uuid.uuid4()	Generira nasumični UUID (Universally Unique Identifier).
datetime.datetime.now(datetime.UTC).isoformat()	Dobiva trenutni datum i vrijeme u ISO 8601 formatu s UTC vremenskom zonom.
@app.post("/notifications/email")	Definira krajnju točku u FastAPI-ju za rukovanje POST zahtjevima za stvaranje obavijesti putem e-pošte.
Enum	Koristi se za stvaranje enumeracija, skupa simboličkih imena vezanih za jedinstvene, konstantne vrijednosti.
BaseModel	Osnovna klasa u Pydantic-u za stvaranje modela podataka s provjerom valjanosti tipa.
dict()	Pretvara instancu Pydantic modela u rječnik.

Razumijevanje Pydantic sustava obavijesti e-poštom

Isporučene skripte dizajnirane su za stvaranje API-ja koji koristi FastAPI i Pydantic za rukovanje obavijestima putem e-pošte. Glavna struktura uključuje definiranje obavijesti s različitim poljima kao što su sadržaj obavijesti, prioritet i informacije o pošiljatelju. The klasa enumerationa kategorizira razine prioriteta kao visoke, srednje i niske. The osnovni model sadrži osnovne pojedinosti obavijesti, dok model ovo proširuje kako bi uključio polja specifična za e-poštu kao što su email_to i .

The klasa dalje proteže dodavanjem automatski generiranog jedinstvenog ID-a pomoću i vremenska oznaka s datetime.datetime.now(datetime.UTC).isoformat(). API krajnja točka, definirana s , obrađuje POST zahtjeve za stvaranje obavijesti. Funkcija krajnje točke prima objekt, ispisuje njegov sadržaj pomoću email_notification.dict(), i vraća instancu od sa dodatnim poljima.

Rješavanje problema s nedostajućim poljima u Pydantic API-ju

Python s FastAPI i Pydantic

from enum import Enum
from pydantic import BaseModel
from fastapi import FastAPI
import uuid
import datetime

app = FastAPI()

class NotificationPriority(Enum):
    high = "high"
    medium = "medium"
    low = "low"

class Notification(BaseModel):
    notification: str
    priority: NotificationPriority
    notification_from: str

class EmailNotification(Notification):
    email_to: str
    email_from: str | None = None

class EmailNotificationSystem(BaseModel):
    id: uuid.UUID = uuid.uuid4()
    ts: datetime.datetime = datetime.datetime.now(datetime.UTC).isoformat()
    email: EmailNotification

@app.post("/notifications/email")
async def create_notification(email_notification: EmailNotification):
    print(email_notification.dict())
    system = EmailNotificationSystem(email=email_notification)
    return system

Najbolje prakse za rukovanje obavijestima u Pydantic-u

Python s FastAPI i Pydantic

from enum import Enum
from pydantic import BaseModel
from fastapi import FastAPI
import uuid
import datetime

app = FastAPI()

class NotificationPriority(Enum):
    HIGH = "high"
    MEDIUM = "medium"
    LOW = "low"

class Notification(BaseModel):
    notification: str
    priority: NotificationPriority
    notification_from: str

class EmailNotification(Notification):
    email_to: str
    email_from: str | None = None

class EmailNotificationSystem(BaseModel):
    id: uuid.UUID = uuid.uuid4()
    ts: datetime.datetime = datetime.datetime.now(datetime.timezone.utc)
    email: EmailNotification

@app.post("/notifications/email")
async def create_notification(email_notification: EmailNotification):
    print(email_notification.dict())
    system = EmailNotificationSystem(email=email_notification)
    return system

Napredno korištenje Pydantic i FastAPI za obavijesti

Još jedan važan aspekt koji treba uzeti u obzir kada koristite Pydantic i FastAPI za stvaranje API-ja je provjera valjanosti i serijalizacija podataka. Pydantic se ističe u osiguravanju usklađenosti podataka s određenim vrstama, što je ključno za održavanje integriteta podataka. U našem primjeru, korištenje enuma poput osigurava da su prihvaćene samo važeće razine prioriteta. Osim toga, korištenje Pydanticove sposobnosti za analizu i provjeru valjanosti ugniježđenih modela može pojednostaviti rukovanje složenim strukturama podataka. Definiranjem modela, objedinjujemo sva relevantna polja koja se odnose na obavijesti putem e-pošte.

Nadalje, rukovanje vremenskim oznakama i UUID-ovima unutar Pydantic modela pomaže u automatskom upravljanju jedinstvenim identifikatorima i vremenskim oznakama, osiguravajući da je svaka obavijest sljediva i jedinstvena. Ova praksa ne samo da pomaže u otklanjanju pogrešaka, već također povećava sigurnost i pouzdanost sustava. Integracija FastAPI-ja s Pydanticom omogućuje besprijekorno rukovanje zahtjevima i provjeru valjanosti podataka, što ga čini izvrsnim izborom za izgradnju robusnih API-ja. Kombinacija ovih alata osigurava da se aplikacija može elegantno nositi s raznim rubnim slučajevima i pogreškama, pružajući glatko korisničko iskustvo.

Za što se koristi Pydantic?
Pydantic se koristi za provjeru valjanosti podataka i upravljanje postavkama pomoću komentara tipa Python.
Kako definirate enum u Pydantic-u?
Enum u Pydantic-u definirate potklasiranjem i stvaranje simboličkih imena vezanih uz jedinstvene vrijednosti.
Što znači učiniti u Pydantic?
služi kao osnovna klasa za kreiranje modela podataka s mogućnostima provjere valjanosti tipa i serijalizacije.
Kako stvoriti jedinstveni identifikator u Pydantic modelu?
Možete stvoriti jedinstveni identifikator u Pydantic modelu koristeći za generiranje nasumičnih UUID-ova.
Kako možete dobiti trenutnu vremensku oznaku u ISO formatu?
Možete dobiti trenutnu vremensku oznaku u ISO formatu pomoću .
Što znači dekorater učiniti u FastAPI-ju?
The dekorater definira krajnju točku za rukovanje POST zahtjevima u FastAPI aplikaciji.
Kako pretvoriti Pydantic model u rječnik?
Možete pretvoriti Pydantic model u rječnik pomoću metoda.
Koje su prednosti korištenja Pydantica s FastAPI-jem?
Prednosti korištenja Pydantica s FastAPI-jem uključuju robusnu provjeru valjanosti podataka, automatsku dokumentaciju i besprijekorno rukovanje zahtjevima.

Zaključno, problem nedostajućih polja u Pydantic modelima može se riješiti osiguravanjem ispravne provjere podataka i instanciranja modela. Korištenje FastAPI-ja uz Pydantic nudi moćnu kombinaciju za izgradnju robusnih API-ja. Ispravno definiranje enuma, rukovanje ugniježđenim modelima i korištenje UUID-ova i vremenskih oznaka učinkovito pomaže u upravljanju složenim strukturama podataka. Ove prakse ne samo da rješavaju pogreške pri provjeri valjanosti, već također poboljšavaju ukupnu pouzdanost i mogućnost održavanja sustava, osiguravajući nesmetan rad bez grešaka.