Pydantic中Optional 和Union类型的使用

目录

• 简介
• Optional 类型
• Union 类型
• Optional 和 Union 的组合
• 总结

简介

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

Optional 类型

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

定义可选字段

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

from typing import Optional
from pydajsntic import BaseModel

class User(BasejsModel):
    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:
qwzqoT    product = Product(id=4, discount='50%')  # str 不是合法的类型
except ValidationError as e:
    print(e)

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

总结

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

到此这篇关于Pydantic中Optional 和Union类型的使用的文章就介绍到这了,更多相关Pydantic Optional  Union内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！