Kā labot trūkstošos laukus Pydantic modeļos

Kā labot trūkstošos laukus Pydantic modeļos
Kā labot trūkstošos laukus Pydantic modeļos
Mia Chevalier
Piektdiena, 2024. gada 17. maijs 19:11:11

Pydantic e-pasta paziņojumu problēmu novēršana

Šajā rakstā mēs izpētām, kāpēc Pydantic norāda, ka trūkst lauku, lai gan tie ir deklarēti kodā. Šī problēma bieži rodas, veidojot API, kas apstrādā e-pasta paziņojumus ar papildu laukiem, piemēram, ID un laikspiedoliem.

Mēs iedziļināsimies kļūdas ziņojuma specifikā un nodrošināsim soli pa solim risinājumu, lai nodrošinātu, ka visi lauki ir pareizi atpazīti. Turklāt mēs apspriedīsim paraugpraksi šādu paziņojumu apstrādei Pydantic modeļos.

Komanda Apraksts
uuid.uuid4() Ģenerē nejaušu UUID (universāli unikālo identifikatoru).
datetime.datetime.now(datetime.UTC).isoformat() Iegūst pašreizējo datumu un laiku ISO 8601 formātā ar UTC laika joslu.
@app.post("/notifications/email") Definē FastAPI galapunktu, lai apstrādātu POST pieprasījumus, lai izveidotu e-pasta paziņojumus.
Enum Izmanto, lai izveidotu uzskaitījumus — simbolisku nosaukumu kopu, kas saistīta ar unikālām, nemainīgām vērtībām.
BaseModel Pamatklase programmā Pydantic datu modeļu izveidei ar tipa validāciju.
dict() Pārvērš Pydantic modeļa gadījumu par vārdnīcu.

Izpratne par Pydantic e-pasta paziņojumu sistēmu

Nodrošinātie skripti ir paredzēti, lai izveidotu API, izmantojot FastAPI un Pydantic e-pasta paziņojumu apstrādei. Galvenā struktūra ietver paziņojuma definēšanu ar dažādiem laukiem, piemēram, paziņojuma saturu, prioritāti un sūtītāja informāciju. The NotificationPriority uzskaitīšanas klase prioritāšu līmeņus klasificē kā augstu, vidēju un zemu. The Notification Pamatmodelis satur pamata paziņojumu informāciju, savukārt EmailNotification modelis paplašina to, iekļaujot e-pastam raksturīgus laukus, piemēram email_to un email_from.

The EmailNotificationSystem klase vēl paplašinās EmailNotification pievienojot automātiski ģenerētu unikālu ID, izmantojot uuid.uuid4() un laikspiedols ar datetime.datetime.now(datetime.UTC).isoformat(). API galapunkts, kas definēts ar @app.post("/notifications/email"), apstrādā POST pieprasījumus, lai izveidotu paziņojumus. Galapunkta funkcija create_notification saņem an EmailNotification objektu, izdrukā tā saturu, izmantojot email_notification.dict()un atgriež gadījumu EmailNotificationSystem ar papildu laukiem.

Trūkstošo lauku problēmas atrisināšana Pydantic API

Python ar FastAPI un 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

Paziņojumu apstrādes paraugprakse programmā Pydantic

Python ar FastAPI un 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

Papildu Pydantic un FastAPI izmantošana paziņojumiem

Vēl viens svarīgs aspekts, kas jāņem vērā, izmantojot Pydantic un FastAPI API izveidei, ir datu validācija un serializācija. Pydantic ir izcils, nodrošinot datu atbilstību noteiktiem veidiem, kas ir ļoti svarīgi datu integritātes saglabāšanai. Mūsu piemērā, izmantojot enums, piemēram, NotificationPriority nodrošina, ka tiek pieņemti tikai derīgi prioritātes līmeņi. Turklāt, izmantojot Pydantic spēju parsēt un apstiprināt ligzdotos modeļus, var vienkāršot sarežģītu datu struktūru apstrādi. Definējot EmailNotification modeli, mēs iekapsulējam visus attiecīgos laukus, kas saistīti ar e-pasta paziņojumiem.

Turklāt laika zīmogu un UUID apstrāde Pydantic modeļos palīdz automātiski pārvaldīt unikālos identifikatorus un laikspiedolus, nodrošinot, ka katrs paziņojums ir izsekojams un unikāls. Šī prakse ne tikai palīdz atkļūdot, bet arī uzlabo sistēmas drošību un uzticamību. FastAPI integrācija ar Pydantic nodrošina netraucētu pieprasījumu apstrādi un datu validāciju, padarot to par lielisku izvēli stabilu API izveidei. Šo rīku kombinācija nodrošina, ka lietojumprogramma var graciozi apstrādāt dažādus malas gadījumus un kļūdas, nodrošinot vienmērīgu lietotāja pieredzi.

Bieži uzdotie jautājumi par Pydantic un FastAPI

  1. Kāpēc lieto Pydantic?
  2. Pydantic tiek izmantots datu validācijai un iestatījumu pārvaldībai, izmantojot Python tipa anotācijas.
  3. Kā jūs definējat enumu valodā Pydantic?
  4. Jūs definējat enum programmā Pydantic, veicot apakšklasi Enum un izveidot simboliskus nosaukumus, kas saistīti ar unikālām vērtībām.
  5. Ko dara BaseModel darīt Pydantic?
  6. BaseModel kalpo kā bāzes klase datu modeļu izveidei ar tipa validācijas un serializācijas iespējām.
  7. Kā izveidot unikālu identifikatoru Pydantic modelī?
  8. Varat izveidot unikālu identifikatoru Pydantic modelī, izmantojot uuid.uuid4() nejaušu UUID ģenerēšanai.
  9. Kā iegūt pašreizējo laikspiedolu ISO formātā?
  10. Pašreizējo laikspiedolu var iegūt ISO formātā, izmantojot datetime.datetime.now(datetime.UTC).isoformat().
  11. Ko dara @app.post dekorators dara FastAPI?
  12. The @app.post dekorators definē galapunktu POST pieprasījumu apstrādei FastAPI lietojumprogrammā.
  13. Kā pārvērst Pydantic modeli vārdnīcā?
  14. Varat pārvērst Pydantic modeli par vārdnīcu, izmantojot dict() metodi.
  15. Kādas ir Pydantic lietošanas priekšrocības ar FastAPI?
  16. Pydantic izmantošanas ar FastAPI priekšrocības ietver stabilu datu validāciju, automātisku dokumentāciju un netraucētu pieprasījumu apstrādi.

Pēdējās domas par pidantiskā lauka jautājumiem

Noslēgumā jāsaka, ka trūkstošo lauku problēmu Pydantic modeļos var risināt, nodrošinot pareizu datu validāciju un modeļa institūciju. Izmantojot FastAPI kopā ar Pydantic, tiek piedāvāta jaudīga kombinācija spēcīgu API izveidei. Pareiza enumu noteikšana, ligzdoto modeļu apstrāde un UUID un laikspiedolu izmantošana efektīvi palīdz pārvaldīt sarežģītas datu struktūras. Šāda prakse ne tikai atrisina validācijas kļūdas, bet arī uzlabo sistēmas kopējo uzticamību un apkopi, nodrošinot vienmērīgu un bez kļūdām darbību.