Cara Memperbaiki Bidang yang Hilang di Model Pydantic

Cara Memperbaiki Bidang yang Hilang di Model Pydantic
Cara Memperbaiki Bidang yang Hilang di Model Pydantic
Mia Chevalier
Jumat, 17 Mei 2024 19.01.49

Memecahkan Masalah Pemberitahuan Email Pydantic

Dalam artikel ini, kita mengeksplorasi mengapa Pydantic menunjukkan bahwa bidang tersebut hilang, meskipun bidang tersebut dideklarasikan dalam kode. Masalah ini sering muncul saat membuat API yang memproses notifikasi email dengan kolom tambahan seperti ID dan stempel waktu.

Kami akan mendalami pesan kesalahan secara spesifik dan memberikan solusi langkah demi langkah untuk memastikan semua bidang dikenali dengan benar. Selain itu, kami akan membahas praktik terbaik untuk menangani notifikasi tersebut dalam model Pydantic.

Memerintah Keterangan
uuid.uuid4() Menghasilkan UUID acak (Pengidentifikasi Unik Universal).
datetime.datetime.now(datetime.UTC).isoformat() Mendapatkan tanggal dan waktu saat ini dalam format ISO 8601 dengan zona waktu UTC.
@app.post("/notifications/email") Mendefinisikan titik akhir di FastAPI untuk menangani permintaan POST untuk membuat pemberitahuan email.
Enum Digunakan untuk membuat enumerasi, sekumpulan nama simbolik yang terikat pada nilai unik dan konstan.
BaseModel Kelas dasar di Pydantic untuk membuat model data dengan validasi tipe.
dict() Mengonversi instance model Pydantic menjadi kamus.

Memahami Sistem Notifikasi Email Pydantic

Skrip yang disediakan dirancang untuk membuat API menggunakan FastAPI dan Pydantic untuk menangani notifikasi email. Struktur utamanya mencakup pendefinisian notifikasi dengan berbagai bidang seperti konten notifikasi, prioritas, dan informasi pengirim. Itu NotificationPriority kelas enumerasi mengkategorikan tingkat prioritas menjadi tinggi, sedang, dan rendah. Itu Notification model dasar menyimpan rincian pemberitahuan dasar, sedangkan model EmailNotification model memperluas ini untuk memasukkan bidang khusus email seperti email_to Dan email_from.

Itu EmailNotificationSystem kelas semakin meluas EmailNotification dengan menambahkan ID unik yang dibuat secara otomatis menggunakan uuid.uuid4() dan stempel waktu dengan datetime.datetime.now(datetime.UTC).isoformat(). Titik akhir API, ditentukan dengan @app.post("/notifications/email"), menangani permintaan POST untuk membuat notifikasi. Fungsi titik akhir create_notification menerima sebuah EmailNotification objek, mencetak isinya menggunakan email_notification.dict(), dan mengembalikan sebuah instance dari EmailNotificationSystem dengan kolom tambahan.

Menyelesaikan Masalah Bidang yang Hilang di Pydantic API

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

Praktik Terbaik untuk Menangani Notifikasi di 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 Notifikasi

Aspek penting lainnya yang perlu dipertimbangkan saat menggunakan Pydantic dan FastAPI untuk membuat API adalah validasi dan serialisasi data. Pydantic unggul dalam memastikan bahwa data sesuai dengan tipe tertentu, yang sangat penting untuk menjaga integritas data. Dalam contoh kita, menggunakan enum seperti NotificationPriority memastikan bahwa hanya tingkat prioritas yang valid yang diterima. Selain itu, memanfaatkan kemampuan Pydantic untuk mengurai dan memvalidasi model bersarang dapat menyederhanakan penanganan struktur data yang kompleks. Dengan mendefinisikan EmailNotification model, kami merangkum semua bidang relevan yang terkait dengan pemberitahuan email.

Selain itu, menangani stempel waktu dan UUID dalam model Pydantic membantu mengelola pengidentifikasi dan stempel waktu unik secara otomatis, memastikan setiap notifikasi dapat dilacak dan unik. Praktik ini tidak hanya membantu dalam debugging tetapi juga meningkatkan keamanan dan keandalan sistem. Integrasi FastAPI dengan Pydantic memungkinkan penanganan permintaan dan validasi data yang lancar, menjadikannya pilihan tepat untuk membangun API yang tangguh. Kombinasi alat-alat ini memastikan bahwa aplikasi dapat menangani berbagai kasus dan kesalahan edge dengan baik, sehingga memberikan pengalaman pengguna yang lancar.

Pertanyaan Umum tentang Pydantic dan FastAPI

  1. Untuk apa Pydantic digunakan?
  2. Pydantic digunakan untuk validasi data dan manajemen pengaturan menggunakan anotasi tipe Python.
  3. Bagaimana Anda mendefinisikan enum di Pydantic?
  4. Anda mendefinisikan enum di Pydantic dengan membuat subkelas Enum dan membuat nama simbolis yang terikat pada nilai unik.
  5. Apa artinya? BaseModel lakukan di Pydantic?
  6. BaseModel berfungsi sebagai kelas dasar untuk membuat model data dengan kemampuan validasi tipe dan serialisasi.
  7. Bagaimana Anda membuat pengidentifikasi unik dalam model Pydantic?
  8. Anda dapat membuat pengidentifikasi unik dalam model Pydantic menggunakan uuid.uuid4() untuk menghasilkan UUID acak.
  9. Bagaimana Anda bisa mendapatkan stempel waktu saat ini dalam format ISO?
  10. Anda bisa mendapatkan stempel waktu saat ini dalam format ISO menggunakan datetime.datetime.now(datetime.UTC).isoformat().
  11. Apa artinya? @app.post dekorator lakukan di FastAPI?
  12. Itu @app.post dekorator mendefinisikan titik akhir untuk menangani permintaan POST dalam aplikasi FastAPI.
  13. Bagaimana Anda mengonversi model Pydantic ke kamus?
  14. Anda dapat mengonversi model Pydantic ke kamus menggunakan dict() metode.
  15. Apa keuntungan menggunakan Pydantic dengan FastAPI?
  16. Manfaat menggunakan Pydantic dengan FastAPI mencakup validasi data yang kuat, dokumentasi otomatis, dan penanganan permintaan yang lancar.

Pemikiran Akhir tentang Masalah Bidang Pydantic

Kesimpulannya, masalah kolom yang hilang dalam model Pydantic dapat diatasi dengan memastikan validasi data dan instantiasi model yang benar. Menggunakan FastAPI bersama Pydantic menawarkan kombinasi yang kuat untuk membangun API yang kuat. Mendefinisikan enum dengan benar, menangani model bersarang, dan memanfaatkan UUID dan stempel waktu secara efektif membantu dalam mengelola struktur data yang kompleks. Praktik-praktik ini tidak hanya menyelesaikan kesalahan validasi tetapi juga meningkatkan keandalan dan pemeliharaan sistem secara keseluruhan, memastikan pengoperasian yang lancar dan bebas kesalahan.