Pydantic中Optional 和Union类型的使用

 更新时间:2025年04月09日 10:54:25   作者:霍格沃兹测试开发学社  
本文主要介绍了Pydantic中Optional 和Union类型的使用,这两者在处理可选字段和多类型字段时尤为重要,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧

简介

Pydantic 是一个用于数据验证和设置管理的 Python 库,它通过类型注解(type hints)提供了强大的数据验证功能。本文将深入探讨 Pydantic中 Optional 和 Union 类型的使用,这两者在处理可选字段和多类型字段时尤为重要。

Optional 类型

Optional类型用于表示一个字段可以是指定类型或 None。这在需要可选字段时非常有用。

定义可选字段

通过 typing.Optional 可以定义可选字段。实际使用中,Optional[X] 等价于 Union[X, None]

from typing import Optional
from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    age: Optional[int] = None  # age 可以是 int 或 None

user1 = User(id=1, name='Alice', age=30)
user2 = User(id=2, name='Bob')  # age 省略,默认为 None

print(user1)
print(user2)

验证可选字段

Pydantic 会自动处理可选字段的验证。如果字段值为 None 或不提供值,它不会引发验证错误。

from pydantic import ValidationError

try:
    user = User(id=3, name='Charlie', age='thirty')
except ValidationError as e:
    print(e)

上述代码会因为 age 不能转换为整数而引发验证错误。

Union 类型

Union 类型用于表示字段可以是多个类型中的一种。它允许更灵活的数据输入。

定义多类型字段

通过 typing.Union 可以定义字段可以接受多个类型。

from typing import Union
from pydantic import BaseModel

class Item(BaseModel):
    id: int
    value: Union[str, int]  # value 可以是 str 或 int

item1 = Item(id=1, value='a string')
item2 = Item(id=2, value=100)

print(item1)
print(item2)

验证多类型字段

Pydantic 会尝试将字段值匹配到 Union 类型中列出的每一种类型,直到成功为止。

from pydantic import ValidationError

try:
    item = Item(id=3, value=[1, 2, 3])  # list 不是合法的类型
except ValidationError as e:
    print(e)

上述代码会因为 value 不是 str 或 int 而引发验证错误。

Optional 和 Union 的组合

在实际应用中,我们经常需要组合使用 Optional 和 Union 来处理更复杂的场景。

可选的多类型字段

我们可以使用 Optional[Union[X, Y]] 表示字段可以是 X 类型或 Y 类型,或者 None。

class Product(BaseModel):
    id: int
    discount: Optional[Union[int, float]] = None  # discount 可以是 int、float 或 None

product1 = Product(id=1, discount=20)
product2 = Product(id=2, discount=15.5)
product3 = Product(id=3)  # discount 省略,默认为 None

print(product1)
print(product2)
print(product3)

验证可选的多类型字段

Pydantic 会按顺序验证 Union 中列出的每个类型,并允许字段为 None

from pydantic import ValidationError

try:
    product = Product(id=4, discount='50%')  # str 不是合法的类型
except ValidationError as e:
    print(e)

上述代码会因为 discount 不是 int 或 float 而引发验证错误。

总结

Pydantic 的 Optional 和 Union 类型提供了灵活的数据验证机制,使得我们能够处理复杂的可选字段和多类型字段。在定义数据模型时,合理使用这两种类型可以显著提高代码的健壮性和可读性。

到此这篇关于Pydantic中Optional 和Union类型的使用的文章就介绍到这了,更多相关Pydantic Optional  Union内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Flask前后端分离项目案例

    详解Flask前后端分离项目案例

    这篇文章主要介绍了Flask前后端分离项目案例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Pytorch搭建yolo3目标检测平台实现源码

    Pytorch搭建yolo3目标检测平台实现源码

    这篇文章主要为大家介绍了Pytorch搭建yolo3目标检测平台实现源码,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • windows系统Tensorflow2.x简单安装记录(图文)

    windows系统Tensorflow2.x简单安装记录(图文)

    这篇文章主要介绍了windows系统Tensorflow2.x简单安装记录(图文),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Python Requests库知识汇总

    Python Requests库知识汇总

    这篇文章主要介绍了Python Requests库学习总结,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-05-05
  • 只用20行Python代码实现屏幕录制功能

    只用20行Python代码实现屏幕录制功能

    python小哥哥发现女朋友最近总是很忙的样子,晚上匆匆忙忙道过晚安就不说话了.可是,QQ头像却会偶尔亮起来.小哥哥非常担心,是不是账号被盗了呢然后,就想帮女朋友排查一下所以就用python写了一个录制脚本,悄悄装在女友电脑上,需要的朋友可以参考下
    2021-06-06
  • python dataframe 输出结果整行显示的方法

    python dataframe 输出结果整行显示的方法

    今天小编就为大家分享一篇python dataframe 输出结果整行显示的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • 对Xpath 获取子标签下所有文本的方法详解

    对Xpath 获取子标签下所有文本的方法详解

    今天小编就为大家分享一篇对Xpath 获取子标签下所有文本的方法详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-01-01
  • 详解Python做一个名片管理系统

    详解Python做一个名片管理系统

    这篇文章主要介绍了Python如何做一个名片管理系统,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Python随手笔记第一篇(2)之初识列表和元组

    Python随手笔记第一篇(2)之初识列表和元组

    Python中,列表和元组是一种数据结构:序列,序列中的每个元素都被分配一个序号,元素的位置,第一原元素的位置为0,因此类推,序列是最基本的数据结构,本文给大家分享Python随手笔记第一篇(2)之初识列表和元组,感兴趣的朋友一起学习吧
    2016-01-01
  • centos 自动运行python脚本和配置 Python 定时任务

    centos 自动运行python脚本和配置 Python 定时任务

    这篇文章主要介绍了centos 自动运行python脚本和配置 Python 定时任务,文章内容介绍详细,需要的小伙伴可以参考一下,希望对你有所帮助
    2022-03-03

最新评论