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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Python自制一个PDF转PNG图片小工具

    Python自制一个PDF转PNG图片小工具

    这篇文章主要为大家详细介绍了如何利用Python中的PyQt5自制一个PDF转PNG格式图片的小工具,文中的示例代码讲解详细,感兴趣的可以了解一下
    2023-02-02
  • Python通过OpenPyXL处理Excel的完整教程

    Python通过OpenPyXL处理Excel的完整教程

    OpenPyXL是一个强大的Python库,用于处理Excel文件,允许读取、编辑和创建Excel工作簿和工作表,本文将详细介绍OpenPyXL的各种功能,希望对大家有所帮助
    2023-11-11
  • Python 解决中文写入Excel时抛异常的问题

    Python 解决中文写入Excel时抛异常的问题

    下面小编就为大家分享一篇Python 解决中文写入Excel时抛异常的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • 二十种Python代码游戏源代码分享

    二十种Python代码游戏源代码分享

    这篇文章主要介绍了二十种Python代码游戏源代码分享,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • Python开根号的几种方式详解

    Python开根号的几种方式详解

    使用Python中的自带库math、自带函数pow和自带库cmath来对数字进行开根号运算,这篇文章主要介绍了Python开根号的几种方式,需要的朋友可以参考下
    2023-01-01
  • 关于Python数据处理中的None、NULL和NaN的理解与应用

    关于Python数据处理中的None、NULL和NaN的理解与应用

    这篇文章主要介绍了关于Python数据处理中的None、NULL和NaN的理解与应用,None表示空值,一个特殊Python对象,None的类型是NoneType,需要的朋友可以参考下
    2023-08-08
  • python调用jenkinsAPI构建jenkins,并传递参数的示例

    python调用jenkinsAPI构建jenkins,并传递参数的示例

    这篇文章主要介绍了python调用jenkinsAPI构建jenkins,并传递参数的示例,帮助大家更好的理解和学习python,感兴趣的朋友可以了解下
    2020-12-12
  • python的依赖管理的实现

    python的依赖管理的实现

    这篇文章主要介绍了python的依赖管理的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-05-05
  • python实现随机漫步方法和原理

    python实现随机漫步方法和原理

    在本篇文章里小编给大家整理了关于python如何实现随机漫步的相关知识点内容,需要的朋友们学习下。
    2019-06-06
  • Flask实现swagger在线文档与接口测试流程详解

    Flask实现swagger在线文档与接口测试流程详解

    Flask是一个使用Python编写的轻量级Web应用框架。其WSGI工具箱采用 Werkzeug,模板引擎则使用Jinja2。Flask使用 BSD 授权。Flask也被称为“microframework”,因为它使用简单的核心,用 extension 增加其他功能,本篇带你用Flask实现swagger在线文档与接口测试
    2022-07-07

最新评论