Hur man åtgärdar saknade fält i Pydantiska modeller

Hur man åtgärdar saknade fält i Pydantiska modeller
Hur man åtgärdar saknade fält i Pydantiska modeller
Mia Chevalier
Fredag 17 maj 2024 19:37:46

Felsökning av Pydantic e-postaviseringsproblem

I den här artikeln undersöker vi varför Pydantic indikerar att fält saknas, även om de är deklarerade i koden. Det här problemet uppstår ofta när du skapar ett API som behandlar e-postmeddelanden med ytterligare fält som ID och tidsstämplar.

Vi kommer att dyka ner i detaljerna i felmeddelandet och tillhandahålla en steg-för-steg-lösning för att säkerställa att alla fält identifieras korrekt. Dessutom kommer vi att diskutera bästa praxis för att hantera sådana meddelanden i Pydantic-modeller.

Kommando Beskrivning
uuid.uuid4() Genererar ett slumpmässigt UUID (Universally Unique Identifier).
datetime.datetime.now(datetime.UTC).isoformat() Hämtar aktuellt datum och tid i ISO 8601-format med UTC-tidszon.
@app.post("/notifications/email") Definierar en slutpunkt i FastAPI för hantering av POST-förfrågningar för att skapa e-postmeddelanden.
Enum Används för att skapa uppräkningar, en uppsättning symboliska namn bundna till unika, konstanta värden.
BaseModel En basklass i Pydantic för att skapa datamodeller med typvalidering.
dict() Konverterar en Pydantisk modellinstans till en ordbok.

Förstå Pydantic e-postmeddelandesystem

De medföljande skripten är utformade för att skapa ett API med FastAPI och Pydantic för hantering av e-postmeddelanden. Huvudstrukturen inkluderar att definiera ett meddelande med olika fält såsom meddelandeinnehåll, prioritet och avsändarinformation. De NotificationPriority uppräkningsklassen kategoriserar prioritetsnivåerna som hög, medium och låg. De Notification basmodellen innehåller de grundläggande meddelandedetaljerna, medan EmailNotification modellen utökar detta till att omfatta e-postspecifika fält som email_to och email_from.

De EmailNotificationSystem klass sträcker sig ytterligare EmailNotification genom att lägga till ett automatiskt genererat unikt ID med hjälp av uuid.uuid4() och en tidsstämpel med datetime.datetime.now(datetime.UTC).isoformat(). API-slutpunkten, definierad med @app.post("/notifications/email"), hanterar POST-förfrågningar för att skapa aviseringar. Endpoint-funktionen create_notification får en EmailNotification objekt, skriver ut dess innehåll med hjälp av email_notification.dict(), och returnerar en instans av EmailNotificationSystem med ytterligare fält.

Löser problem med saknade fält i Pydantic API

Python med FastAPI och 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

Bästa praxis för hantering av meddelanden i Pydantic

Python med FastAPI och 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

Avancerad användning av Pydantic och FastAPI för meddelanden

En annan viktig aspekt att tänka på när du använder Pydantic och FastAPI för att skapa API:er är datavalidering och serialisering. Pydantic utmärker sig i att säkerställa att data överensstämmer med specificerade typer, vilket är avgörande för att upprätthålla dataintegriteten. I vårt exempel använder vi enums som NotificationPriority säkerställer att endast giltiga prioritetsnivåer accepteras. Att utnyttja Pydantics förmåga att analysera och validera kapslade modeller kan dessutom förenkla hanteringen av komplexa datastrukturer. Genom att definiera EmailNotification modell, kapslar vi in ​​alla relevanta fält relaterade till e-postmeddelanden.

Dessutom hjälper hantering av tidsstämplar och UUID inom Pydantic-modeller till att automatiskt hantera unika identifierare och tidsstämplar, vilket säkerställer att varje meddelande är spårbart och unikt. Denna praxis hjälper inte bara till vid felsökning utan ökar också systemets säkerhet och tillförlitlighet. FastAPIs integration med Pydantic möjliggör sömlös förfrågningshantering och datavalidering, vilket gör det till ett utmärkt val för att bygga robusta API:er. Kombinationen av dessa verktyg säkerställer att applikationen kan hantera olika kantfall och fel elegant, vilket ger en smidig användarupplevelse.

Vanliga frågor om Pydantic och FastAPI

  1. Vad används Pydantic till?
  2. Pydantic används för datavalidering och inställningshantering med anteckningar av Python-typ.
  3. Hur definierar man en enum i Pydantic?
  4. Du definierar en enum i Pydantic genom att underklassa Enum och skapa symboliska namn bundna till unika värden.
  5. Vad gör BaseModel göra i Pydantic?
  6. BaseModel fungerar som en basklass för att skapa datamodeller med typvaliderings- och serialiseringsmöjligheter.
  7. Hur skapar man en unik identifierare i en Pydantisk modell?
  8. Du kan skapa en unik identifierare i en Pydantisk modell med hjälp av uuid.uuid4() för att generera slumpmässiga UUID.
  9. Hur kan du få den aktuella tidsstämpeln i ISO-format?
  10. Du kan få den aktuella tidsstämpeln i ISO-format med hjälp av datetime.datetime.now(datetime.UTC).isoformat().
  11. Vad gör @app.post dekoratör gör i FastAPI?
  12. De @app.post decorator definierar en slutpunkt för hantering av POST-förfrågningar i en FastAPI-applikation.
  13. Hur konverterar man en Pydantisk modell till en ordbok?
  14. Du kan konvertera en Pydantisk modell till en ordbok med hjälp av dict() metod.
  15. Vilka är fördelarna med att använda Pydantic med FastAPI?
  16. Fördelarna med att använda Pydantic med FastAPI inkluderar robust datavalidering, automatisk dokumentation och sömlös förfrågningshantering.

Slutliga tankar om Pydantic Field Issues

Sammanfattningsvis kan problemet med saknade fält i Pydantiska modeller lösas genom att säkerställa korrekt datavalidering och modellinstansiering. Att använda FastAPI tillsammans med Pydantic erbjuder en kraftfull kombination för att bygga robusta API:er. Att korrekt definiera enums, hantera kapslade modeller och använda UUID och tidsstämplar hjälper effektivt till att hantera komplexa datastrukturer. Dessa metoder löser inte bara valideringsfel utan förbättrar också systemets övergripande tillförlitlighet och underhållsbarhet, vilket säkerställer smidig och felfri drift.