Python之Pydantic基础教程

Pydantic库教程

1. Pydantic库是什么

Pydantic是一个数据解析和验证库，它使用Python类型注解来验证输入数据。它能够自动将输入数据解析为Python数据类型，并且能够验证数据是否符合预定义的模式。Pydantic非常适合用于Web应用开发，特别是与FastAPI等现代Python框架一起使用。

2. Pydantic库用法考察

1. 基本使用方法

1.1 schema基本定义方法

在Pydantic中，一个schema是一个继承自BaseModel的类，它定义了数据模型的结构和类型。

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str

1.2 基本的schema实例化方法

创建一个schema的实例，你需要传递一个字典，其键值对与schema中定义的字段相匹配。

user = User(id=1, name="John Doe")
print(user)

2. 高级数据结构考察

2.1 enum数据类型

Pydantic支持枚举类型，这可以用来限制字段的值只能是预定义的一组值之一。

from enum import Enum
from pydantic import BaseModel

class Color(str, Enum):
    RED = "red"
    GREEN = "green"
    BLUE = "blue"

class Item(BaseModel):
    color: Color

2.2 可选数据类型

使用Optional类型，可以定义一个字段是可选的。

from typing import Optional
from pydantic import BaseModel

class User(BaseModel):
    name: str
    age: Optional[int] = None

2.3 数据默认值的设置

可以在定义字段时直接设置默认值。

from pydantic import BaseModel

class User(BaseModel):
    name: str
    age: int = 18  # 默认年龄为18

2.4 允许多种数据类型

可以通过类型提示允许字段接受多种数据类型。

from pydantic import BaseModel
from typing import Union

class User(BaseModel):
    name: str
    age: Union[int, str]  # 年龄可以是整数或字符串

2.5 异名数据传递方法

使用Field函数，可以为字段设置别名。

from pydantic import BaseModel, Field

class User(BaseModel):
    name: str = Field(..., alias="username")  # 使用别名"username"

3. 多级schema定义样例

可以定义嵌套的schema来表示复杂的数据结构。

from pydantic import BaseModel

class Address(BaseModel):
    street: str
    city: str

class User(BaseModel):
    name: str
    address: Address

4. 数据检查方法考察

4.1 validator用法考察

使用validator装饰器可以在数据被解析后进行额外的验证。

from pydantic import BaseModel, validator

class User(BaseModel):
    name: str
    age: int

    @validator('age')
    def check_age(cls, value):
        if value < 0:
            raise ValueError('Age must be a non-negative integer')
        return value

4.2 Config方法考察

Config类可以用来全局配置模型的行为。

from pydantic import BaseModel

class User(BaseModel):
    name: str
    age: int

    class Config:
        allow_population_by_field_name = True

在这个配置中，allow_population_by_field_name允许通过字段名而不是属性名来创建实例。

这个教程提供了Pydantic库的基本使用方法和一些高级特性。通过这些示例，你可以开始使用Pydantic来构建健壮的数据验证逻辑。