Cara Membetulkan Medan Hilang dalam Model Pydantic

Mia Chevalier

Jumaat, 17 Mei 2024 7:14:53 PTG

Menyelesaikan Masalah Pemberitahuan E-mel Pydantic
Dalam artikel ini, kami meneroka sebab Pydantic menunjukkan bahawa medan tiada, walaupun ia diisytiharkan dalam kod. Isu ini sering timbul apabila membuat API yang memproses pemberitahuan e-mel dengan medan tambahan seperti ID dan cap masa.
Kami akan menyelami butiran khusus mesej ralat dan menyediakan penyelesaian langkah demi langkah untuk memastikan semua medan dikenali dengan betul. Selain itu, kami akan membincangkan amalan terbaik untuk mengendalikan pemberitahuan sedemikian dalam model Pydantic.

Perintah Penerangan

uuid.uuid4() Menghasilkan UUID rawak (Pengecam Unik Sejagat).

datetime.datetime.now(datetime.UTC).isoformat() Mendapat tarikh dan masa semasa dalam format ISO 8601 dengan zon waktu UTC.

@app.post("/notifications/email") Mentakrifkan titik akhir dalam FastAPI untuk mengendalikan permintaan POST untuk membuat pemberitahuan e-mel.

Enum Digunakan untuk membuat penghitungan, satu set nama simbolik yang terikat pada nilai malar yang unik.

BaseModel Kelas asas dalam Pydantic untuk mencipta model data dengan pengesahan jenis.

dict() Menukar contoh model Pydantic kepada kamus.

Perintah	Penerangan
uuid.uuid4()	Menghasilkan UUID rawak (Pengecam Unik Sejagat).
datetime.datetime.now(datetime.UTC).isoformat()	Mendapat tarikh dan masa semasa dalam format ISO 8601 dengan zon waktu UTC.
@app.post("/notifications/email")	Mentakrifkan titik akhir dalam FastAPI untuk mengendalikan permintaan POST untuk membuat pemberitahuan e-mel.
Enum	Digunakan untuk membuat penghitungan, satu set nama simbolik yang terikat pada nilai malar yang unik.
BaseModel	Kelas asas dalam Pydantic untuk mencipta model data dengan pengesahan jenis.
dict()	Menukar contoh model Pydantic kepada kamus.

Memahami Sistem Pemberitahuan E-mel Pydantic

Skrip yang disediakan direka bentuk untuk mencipta API menggunakan FastAPI dan Pydantic untuk mengendalikan pemberitahuan e-mel. Struktur utama termasuk menentukan pemberitahuan dengan pelbagai medan seperti kandungan pemberitahuan, keutamaan dan maklumat penghantar. The kelas enumerasi mengkategorikan tahap keutamaan sebagai tinggi, sederhana dan rendah. The model asas memegang butiran pemberitahuan asas, manakala model memanjangkan ini untuk memasukkan medan khusus e-mel seperti email_to dan .

The kelas dilanjutkan lagi dengan menambahkan ID unik yang dijana secara automatik menggunakan dan cap masa dengan datetime.datetime.now(datetime.UTC).isoformat(). Titik akhir API, ditakrifkan dengan , mengendalikan permintaan POST untuk membuat pemberitahuan. Fungsi titik akhir menerima satu objek, mencetak kandungannya menggunakan email_notification.dict(), dan mengembalikan contoh daripada dengan medan tambahan.

Menyelesaikan Isu Medan Hilang dalam API Pydantic

Python dengan FastAPI dan 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

Amalan Terbaik untuk Mengendalikan Pemberitahuan dalam Pydantic

Python dengan FastAPI dan 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

Penggunaan Lanjutan Pydantic dan FastAPI untuk Pemberitahuan

Satu lagi aspek penting yang perlu dipertimbangkan apabila menggunakan Pydantic dan FastAPI untuk mencipta API ialah pengesahan data dan penyirian. Pydantic cemerlang dalam memastikan data mematuhi jenis tertentu, yang penting untuk mengekalkan integriti data. Dalam contoh kami, menggunakan enum seperti memastikan bahawa hanya tahap keutamaan yang sah diterima. Selain itu, memanfaatkan keupayaan Pydantic untuk menghuraikan dan mengesahkan model bersarang boleh memudahkan pengendalian struktur data yang kompleks. Dengan mentakrifkan model, kami merangkum semua medan berkaitan yang berkaitan dengan pemberitahuan e-mel.

Tambahan pula, pengendalian cap masa dan UUID dalam model Pydantic membantu mengurus pengecam dan cap masa unik secara automatik, memastikan setiap pemberitahuan boleh dikesan dan unik. Amalan ini bukan sahaja membantu dalam penyahpepijatan tetapi juga meningkatkan keselamatan dan kebolehpercayaan sistem. Penyepaduan FastAPI dengan Pydantic membolehkan pengendalian permintaan yang lancar dan pengesahan data, menjadikannya pilihan yang sangat baik untuk membina API yang mantap. Gabungan alatan ini memastikan aplikasi boleh mengendalikan pelbagai kes dan ralat kelebihan dengan anggun, memberikan pengalaman pengguna yang lancar.

Apakah kegunaan Pydantic?
Pydantic digunakan untuk pengesahan data dan pengurusan tetapan menggunakan anotasi jenis Python.
Bagaimanakah anda menentukan enum dalam Pydantic?
Anda mentakrifkan enum dalam Pydantic dengan subkelas dan mencipta nama simbolik yang terikat pada nilai unik.
Apakah lakukan di Pydantic?
berfungsi sebagai kelas asas untuk mencipta model data dengan keupayaan pengesahan jenis dan siri.
Bagaimanakah anda mencipta pengecam unik dalam model Pydantic?
Anda boleh mencipta pengecam unik dalam model Pydantic menggunakan untuk menjana UUID rawak.
Bagaimanakah anda boleh mendapatkan cap masa semasa dalam format ISO?
Anda boleh mendapatkan cap masa semasa dalam format ISO menggunakan .
Apakah penghias lakukan dalam FastAPI?
The penghias mentakrifkan titik akhir untuk mengendalikan permintaan POST dalam aplikasi FastAPI.
Bagaimanakah anda menukar model Pydantic kepada kamus?
Anda boleh menukar model Pydantic kepada kamus menggunakan kaedah.
Apakah faedah menggunakan Pydantic dengan FastAPI?
Faedah menggunakan Pydantic dengan FastAPI termasuk pengesahan data yang mantap, dokumentasi automatik dan pengendalian permintaan yang lancar.

Kesimpulannya, masalah kehilangan medan dalam model Pydantic boleh diatasi dengan memastikan pengesahan data dan instantiasi model yang betul. Menggunakan FastAPI bersama Pydantic menawarkan gabungan yang berkuasa untuk membina API yang mantap. Menentukan enum dengan betul, mengendalikan model bersarang, dan menggunakan UUID serta cap masa dengan berkesan membantu dalam mengurus struktur data yang kompleks. Amalan ini bukan sahaja menyelesaikan ralat pengesahan tetapi juga meningkatkan kebolehpercayaan dan kebolehselenggaraan keseluruhan sistem, memastikan operasi lancar dan bebas ralat.