python pydantic的field使用案例

python pydantic的field使用案例

Pydantic是一个用于数据验证和序列化的Python库。它提供了一种简单的方式来定义数据模型，并且可以自动验证输入数据是否符合模型定义。Pydantic的核心是Field类，它可以用来定义数据模型的字段。在本文中，我们将介绍Pydantic的Field类的使用案例。

1. 基本用法

Field类可以用来定义数据模型的字段。它有很多参数，可以用来指定字段的类型、默认值、验证规则等。下面是一个简单的例子：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(..., gt=0, description="年龄")

p = Person(name="Tom", age=20)

print(())

在上面的例子中，我们定义了一个Person类，它有两个字段：name和age。name字段的类型是str，age字段的类型是int。我们使用Field类来定义这两个字段，并且指定了它们的默认值和描述信息。在创建Person对象时，我们可以直接传入name和age的值，然后调用dict()方法来获取对象的字典表示。

2. 验证规则

Field类可以用来指定字段的验证规则。例如，我们可以使用gt参数来指定一个数值字段的最小值：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(..., gt=0, description="年龄")

p = Person(name="Tom", age=-1)

print(())

在上面的例子中，我们指定了age字段的最小值为0。当我们创建一个age小

于0的Person对象时，Pydantic会抛出一个ValidationError异常。

除了gt参数，Field类还支持很多其他的验证规则，例如lt、ge、le、regex等。这些验证规则可以用来验证字符串、数值、日期等类型的字段。

3. 默认值

Field类可以用来指定字段的默认值。例如，我们可以使用default参数来指定一个字段的默认值：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(default=18, gt=0, description="年龄")

p = Person(name="Tom")

print(())

在上面的例子中，我们指定了age字段的默认值为18。当我们创建一个没有指

定age值的Person对象时，Pydantic会自动将age字段的值设置为18。

4. 描述信息

Field类可以用来指定字段的描述信息。例如，我们可以使用description参数来指定一个字段的描述信息：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(..., gt=0, description="年龄")

p = Person(name="Tom", age=20)

print(())

在上面的例子中，我们指定了name字段和age字段的描述信息。当我们调用schema()方法来获取Person对象的模式时，Pydantic会将这些描述信息包含在模式中。

5. 多个验证规则

Field类可以用来指定多个验证规则。例如，我们可以使用多个验证规则来验证一个数值字段的值：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(..., gt=0, le=100, description="年龄")

p = Person(name="Tom", age=200)

print(())

在上面的例子中，我们指定了age字段的最小值为0，最大值为100。当我们创建一个age大于100的Person对象时，Pydantic会抛出一个ValidationError异常。

6. 自定义验证规则

Field类可以用来指定自定义的验证规则。例如，我们可以使用一个函数来验证一个字符串字段的值：

python

from pydantic import BaseModel, Field, validator

class Person(BaseModel):

name: str = Field(..., description="姓名")

email: str = Field(..., description="邮箱")

@validator('email')

def validate_email(cls, v):

if not th('@example'):

raise ValueError('邮箱必须以@example结尾')

return v

p = Person(name="Tom",email="***************")print(())

在上面的例子中，我们定义了一个validate_email方法，用来验证email字段的值。当email字段的值不以@example结尾时，Pydantic会抛出一个

ValidationError异常。

7. 自定义错误信息

Field类可以用来指定自定义的错误信息。例如，我们可以使用error_msg参数来指定一个验证规则的错误信息：

python

from pydantic import BaseModel, Field

class Person(BaseModel):

name: str = Field(..., description="姓名")

age: int = Field(..., gt=0, le=100, description="年龄", error_msg={

'gt': '年龄必须大于0',

'le': '年龄必须小于等于100',

})

p = Person(name="Tom", age=-1)

print(())

在上面的例子中，我们指定了age字段的最小值为0，最大值为100，并且指定

了gt和le验证规则的错误信息。当我们创建一个age小于0或大于100的Person对象时，Pydantic会抛出一个ValidationError异常，并且使用我们指定的错误信息。

总结

在本文中，我们介绍了Pydantic的Field类的使用案例。Field类可以用来定义数据模型的字段，并且可以指定字段的类型、默认值、验证规则、描述信息等。Field类还支持自定义验证规则和错误信息，可以帮助我们更好地验证和序列化数据。Pydantic是一个非常强大的Python库，可以帮助我们更好地处理数据。