Python使用最广泛的数据验证库Pydantic

Pydantic是Python使用最广泛的数据验证库。

快速且可扩展，Pydantic与您的林特/IDE/大脑很好地搭配。定义数据应该如何在纯、规范的Python 3.8+中；使用Pydantic验证它。

 

https://docs.pydantic.dev/latest/

例子：

from datetime import datetime
from typing import Tuple

from pydantic import BaseModel


class Delivery(BaseModel): # Delivery：这是一个继承自BaseModel的类，定义了Delivery数据的结构。
    timestamp: datetime # 这是一个datetime类型的字段，用于存储时间戳。pydantic会自动将传入的字符串（或其他可转换为datetime的类型）转换为datetime对象。
    dimensions: Tuple[int, int] # 这是一个元组（Tuple）类型的字段，要求元组中包含两个整数。这里使用了typing.Tuple[int, int]来指定类型注解，意味着这个元组必须恰好有两个整数元素。


m = Delivery(timestamp='2020-01-02T03:04:05Z', dimensions=['10', '20'])
# timestamp被传入为字符串'2020-01-02T03:04:05Z'，这是一个ISO 8601格式的日期时间字符串。pydantic会自动将其转换为datetime对象，并假设时区是UTC（因为字符串以'Z'结尾，表示UTC时间）。
# dimensions被传入为列表['10', '20']。虽然这里传入的是字符串，但pydantic会根据Tuple[int, int]的类型注解，尝试将这些字符串转换为整数，并创建一个元组(10, 20)。
print(repr(m.timestamp))
#> datetime.datetime(2020, 1, 2, 3, 4, 5, tzinfo=TzInfo(UTC))
print(m.dimensions)
#> (10, 20)

 Pydantic名字的由来

“Pydantic”这个名字是“Py”和“pedantic”的组合。“Py”部分表示库与Python相关联，“pedantic”指的是库对数据验证和类型强制执行的细致方法。

结合这些元素，“Pydantic”描述了我们的Python库，该库提供以细节为导向、严格的数据验证。

安装Pydantic

pip install pydantic

一个简单示例

from datetime import datetime

from pydantic import BaseModel, PositiveInt


class User(BaseModel):
    id: int  
    name: str = 'John Doe'  
    signup_ts: datetime | None  
    tastes: dict[str, PositiveInt]  


external_data = {
    'id': 123,
    'signup_ts': '2019-06-01 12:22',  
    'tastes': {
        'wine': 9,
        b'cheese': 7,  
        'cabbage': '1',  
    },
}

user = User(**external_data)  

print(user.id)  
#> 123
print(user.json())  

输出

'{"id": 123, "name": "John Doe", "signup_ts": "2019-06-01T12:22:00", "tastes": {"wine": 9, "cheese": 7, "cabbage": 1}}'