如何修复 Pydantic 模型中缺失的字段

如何修复 Pydantic 模型中缺失的字段
如何修复 Pydantic 模型中缺失的字段
Mia Chevalier
2024年5月17日星期五 下午6:39:10

Pydantic 电子邮件通知问题故障排除

在本文中，我们将探讨为什么 Pydantic 指示缺少字段，即使它们已在代码中声明。在创建处理带有 ID 和时间戳等附加字段的电子邮件通知的 API 时，经常会出现此问题。

我们将深入研究错误消息的细节，并提供分步解决方案，以确保正确识别所有字段。此外，我们将讨论在 Pydantic 模型中处理此类通知的最佳实践。

命令 描述
uuid.uuid4() 生成随机 UUID（通用唯一标识符）。
datetime.datetime.now(datetime.UTC).isoformat() 获取采用 UTC 时区的 ISO 8601 格式的当前日期和时间。
@app.post("/notifications/email") 在 FastAPI 中定义一个端点，用于处理 POST 请求以创建电子邮件通知。
Enum 用于创建枚举，一组绑定到唯一常量值的符号名称。
BaseModel Pydantic 中的基类，用于创建具有类型验证的数据模型。
dict() 将 Pydantic 模型实例转换为字典。

了解 Pydantic 电子邮件通知系统

提供的脚本旨在使用 FastAPI 和 Pydantic 创建 API 来处理电子邮件通知。主要结构包括定义具有各种字段的通知，例如通知内容、优先级和发送者信息。这 NotificationPriority 枚举类将优先级分为高、中、低。这 Notification 基本模型保存基本的通知详细信息，而 EmailNotification 模型将其扩展为包括特定于电子邮件的字段，例如 email_to 和 email_from。

这 EmailNotificationSystem 类进一步延伸 EmailNotification 通过添加自动生成的唯一 ID 使用 uuid.uuid4() 和一个时间戳 datetime.datetime.now(datetime.UTC).isoformat()。 API 端点，定义为 @app.post("/notifications/email")，处理 POST 请求以创建通知。端点函数 create_notification 收到一个 EmailNotification 对象，使用打印其内容 email_notification.dict()，并返回一个实例 EmailNotificationSystem 与附加字段。

解决 Pydantic API 中的缺失字段问题

Python 与 FastAPI 和 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

在 Pydantic 中处理通知的最佳实践

Python 与 FastAPI 和 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

Pydantic 和 FastAPI 的通知高级用法

使用 Pydantic 和 FastAPI 创建 API 时要考虑的另一个重要方面是数据验证和序列化。 Pydantic 擅长确保数据符合指定类型，这对于维护数据完整性至关重要。在我们的示例中，使用像这样的枚举 NotificationPriority 确保仅接受有效的优先级。此外，利用 Pydantic 解析和验证嵌套模型的能力可以简化复杂数据结构的处理。通过定义 EmailNotification 模型中，我们封装了与电子邮件通知相关的所有相关字段。

此外，在 Pydantic 模型中处理时间戳和 UUID 有助于自动管理唯一标识符和时间戳，确保每个通知都是可追踪的和唯一的。这种做法不仅有助于调试，而且增强了系统的安全性和可靠性。 FastAPI 与 Pydantic 的集成可实现无缝请求处理和数据验证，使其成为构建强大 API 的绝佳选择。这些工具的组合确保应用程序可以优雅地处理各种边缘情况和错误，提供流畅的用户体验。

有关 Pydantic 和 FastAPI 的常见问题

  1. Pydantic 有何用途？
  2. Pydantic 用于使用 Python 类型注释进行数据验证和设置管理。
  3. 如何在 Pydantic 中定义枚举？
  4. 您可以通过子类化在 Pydantic 中定义枚举 Enum 并创建与唯一值绑定的符号名称。
  5. 什么是 17 号 在 Pydantic 做什么？
  6. 17 号 用作创建具有类型验证和序列化功能的数据模型的基类。
  7. 如何在 Pydantic 模型中创建唯一标识符？
  8. 您可以使用以下命令在 Pydantic 模型中创建唯一标识符 uuid.uuid4() 用于生成随机 UUID。
  9. 如何获取 ISO 格式的当前时间戳？
  10. 您可以使用 ISO 格式获取当前时间戳 datetime.datetime.now(datetime.UTC).isoformat()。
  11. 什么是 @app.post FastAPI 中的装饰器做什么？
  12. 这 @app.post 装饰器定义了一个端点，用于处理 FastAPI 应用程序中的 POST 请求。
  13. 如何将 Pydantic 模型转换为字典？
  14. 您可以使用以下命令将 Pydantic 模型转换为字典 dict() 方法。
  15. 将 Pydantic 与 FastAPI 结合使用有哪些好处？
  16. 将 Pydantic 与 FastAPI 结合使用的好处包括强大的数据验证、自动文档和无缝请求处理。

关于 Pydantic 场问题的最终想法

总之，Pydantic 模型中缺失字段的问题可以通过确保正确的数据验证和模型实例化来解决。将 FastAPI 与 Pydantic 结合使用为构建强大的 API 提供了强大的组合。正确定义枚举、处理嵌套模型以及利用 UUID 和时间戳有效地帮助管理复杂的数据结构。这些做法不仅解决了验证错误，还提高了系统的整体可靠性和可维护性，确保平稳无差错运行。