Puuttuvien kenttien korjaaminen pydantisissa malleissa

Puuttuvien kenttien korjaaminen pydantisissa malleissa
Puuttuvien kenttien korjaaminen pydantisissa malleissa
Mia Chevalier
Perjantai 17. toukokuuta 2024 klo 18.50.26

Pydantic-sähköpostiilmoitusongelmien vianmääritys

Tässä artikkelissa tutkimme, miksi Pydantic ilmoittaa, että kentät puuttuvat, vaikka ne on ilmoitettu koodissa. Tämä ongelma ilmenee usein luotaessa sovellusliittymää, joka käsittelee sähköposti-ilmoituksia lisäkentillä, kuten tunnuksella ja aikaleimoilla.

Sukellaan virheilmoituksen yksityiskohtiin ja tarjoamme vaiheittaisen ratkaisun varmistaaksemme, että kaikki kentät tunnistetaan oikein. Lisäksi keskustelemme parhaista käytännöistä tällaisten ilmoitusten käsittelemiseksi Pydantic-malleissa.

Komento Kuvaus
uuid.uuid4() Luo satunnaisen UUID:n (Universally Unique Identifier).
datetime.datetime.now(datetime.UTC).isoformat() Hakee nykyisen päivämäärän ja kellonajan ISO 8601 -muodossa UTC-aikavyöhykkeellä.
@app.post("/notifications/email") Määrittää FastAPI:n päätepisteen sähköposti-ilmoitusten luomista koskevien POST-pyyntöjen käsittelyä varten.
Enum Käytetään luomaan luetteloita, symbolisia nimiä, jotka on sidottu ainutlaatuisiin, vakioarvoihin.
BaseModel Pydanticin perusluokka tietomallien luomiseen tyyppitarkistuksella.
dict() Muuntaa Pydantic-mallin ilmentymän sanakirjaksi.

Pydantic-sähköpostiilmoitusjärjestelmän ymmärtäminen

Mukana toimitetut komentosarjat on suunniteltu luomaan API FastAPI:n ja Pydanticin avulla sähköposti-ilmoitusten käsittelyyn. Päärakenne sisältää ilmoituksen määrittämisen eri kentillä, kuten ilmoituksen sisältö, prioriteetti ja lähettäjätiedot. The NotificationPriority enumeration class luokittelee prioriteettitasot korkeaan, keskitasoon ja matalaan. The Notification perusmalli sisältää ilmoitusten perustiedot, kun taas EmailNotification malli laajentaa tämän kattamaan sähköpostikohtaiset kentät, kuten email_to ja email_from.

The EmailNotificationSystem luokka laajenee entisestään EmailNotification lisäämällä automaattisesti luotu yksilöllinen tunnus käyttämällä uuid.uuid4() ja aikaleima datetime.datetime.now(datetime.UTC).isoformat(). API-päätepiste, joka on määritetty @app.post("/notifications/email"), käsittelee POST-pyyntöjä ilmoitusten luomiseksi. Päätepistefunktio create_notification vastaanottaa an EmailNotification objekti, tulostaa sen sisällön käyttämällä email_notification.dict(), ja palauttaa esiintymän EmailNotificationSystem lisäkentillä.

Puuttuvien kenttien ongelman ratkaiseminen Pydantic API:ssa

Python, jossa on FastAPI ja 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

Pydanticin ilmoitusten käsittelyn parhaat käytännöt

Python, jossa on FastAPI ja 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

Pydanticin ja FastAPI:n edistynyt käyttö ilmoituksissa

Toinen tärkeä näkökohta, joka on otettava huomioon käytettäessä Pydanticia ja FastAPI:tä API:iden luomiseen, on tietojen validointi ja serialisointi. Pydantic on erinomainen varmistaessaan, että tiedot ovat tiettyjen tyyppien mukaisia, mikä on ratkaisevan tärkeää tietojen eheyden ylläpitämiseksi. Esimerkissämme käyttämällä enumeita kuten NotificationPriority varmistaa, että vain kelvolliset prioriteettitasot hyväksytään. Lisäksi Pydanticin kyvyn jäsentää ja validoida sisäkkäisiä malleja hyödyntäminen voi yksinkertaistaa monimutkaisten tietorakenteiden käsittelyä. Määrittelemällä EmailNotification mallia, tiivistämme kaikki asiaankuuluvat sähköposti-ilmoituksiin liittyvät kentät.

Lisäksi aikaleimojen ja UUID-tunnusten käsittely Pydantic-malleissa auttaa hallitsemaan automaattisesti yksilöllisiä tunnisteita ja aikaleimoja, mikä varmistaa, että jokainen ilmoitus on jäljitettävissä ja yksilöllinen. Tämä käytäntö ei ainoastaan ​​auta virheenkorjauksessa, vaan myös parantaa järjestelmän turvallisuutta ja luotettavuutta. FastAPI:n integrointi Pydanticin kanssa mahdollistaa saumattoman pyyntöjen käsittelyn ja tietojen validoinnin, mikä tekee siitä erinomaisen valinnan kestävien API:iden rakentamiseen. Näiden työkalujen yhdistelmä varmistaa, että sovellus pystyy käsittelemään erilaisia ​​reunatapauksia ja virheitä sulavasti, mikä tarjoaa sujuvan käyttökokemuksen.

Yleisiä kysymyksiä Pydanticista ja FastAPI:sta

  1. Mihin Pydanticia käytetään?
  2. Pydanticia käytetään tietojen validointiin ja asetusten hallintaan Python-tyyppisten huomautusten avulla.
  3. Kuinka määrittelet enumin Pydanticissa?
  4. Voit määrittää enumin Pydanticissa alaluokituksen avulla Enum ja luomalla ainutlaatuisiin arvoihin sidottuja symbolisia nimiä.
  5. Mikä tekee BaseModel tehdä Pydanticissa?
  6. BaseModel toimii perusluokkana luotaessa tietomalleja, joissa on tyyppitarkistus- ja serialisointiominaisuudet.
  7. Kuinka luot yksilöllisen tunnisteen Pydantic-mallissa?
  8. Pydantiseen malliin voit luoda yksilöllisen tunnisteen käyttämällä uuid.uuid4() satunnaisten UUID-tunnusten luomiseen.
  9. Kuinka saat nykyisen aikaleiman ISO-muodossa?
  10. Voit saada nykyisen aikaleiman ISO-muodossa käyttämällä datetime.datetime.now(datetime.UTC).isoformat().
  11. Mikä tekee @app.post sisustaja tekee FastAPI:ssa?
  12. The @app.post decorator määrittää päätepisteen POST-pyyntöjen käsittelemiseksi FastAPI-sovelluksessa.
  13. Kuinka muutat Pydantic-mallin sanakirjaksi?
  14. Voit muuntaa Pydantic-mallin sanakirjaksi käyttämällä dict() menetelmä.
  15. Mitä hyötyä Pydanticin käyttämisestä FastAPI:n kanssa on?
  16. Pydanticin käytön etuja FastAPI:n kanssa ovat vankka tietojen validointi, automaattinen dokumentointi ja saumaton pyyntöjen käsittely.

Viimeisiä ajatuksia pydantisen kentän kysymyksistä

Yhteenvetona voidaan todeta, että Pydantic-malleissa puuttuvien kenttien ongelma voidaan ratkaista varmistamalla tietojen oikea validointi ja mallin toteutus. FastAPI:n käyttäminen Pydanticin kanssa tarjoaa tehokkaan yhdistelmän kestävien API:iden rakentamiseen. Enumien oikea määrittely, sisäkkäisten mallien käsittely sekä UUID-tunnusten ja aikaleimojen käyttö auttavat tehokkaasti monimutkaisten tietorakenteiden hallinnassa. Nämä käytännöt eivät ainoastaan ​​ratkaise validointivirheet, vaan myös parantavat järjestelmän yleistä luotettavuutta ja ylläpidettävyyttä varmistaen sujuvan ja virheettömän toiminnan.