python pydantic库中的Field 类
时间: 2024-04-09 12:34:09 浏览: 13
Field 类是 pydantic 库中一个重要的类,用于定义模型字段的元数据。它的作用是指定字段的验证规则、默认值、别名等。
使用 Field 类,可以在模型类的字段声明上添加装饰器的方式来指定字段的元数据信息。下面是一个示例:
```python
from pydantic import BaseModel, Field
class MyModel(BaseModel):
name: str = Field(..., title="Name of the object", description="This field represents the name of the object.")
age: int = Field(..., gt=0, description="This field represents the age of the object.")
m = MyModel(name="John", age=25)
```
在上面的示例中,我们使用 Field 类为 name 字段和 age 字段指定了元数据信息。具体来说:
- `...` 表示该字段是必需的,这是 Field 类的一个特殊标记。
- `title` 参数指定了字段的标题,用于生成文档或 API 文档。
- `description` 参数指定了字段的描述信息,用于生成文档或 API 文档。
- `gt` 参数指定了 age 字段的验证规则,要求其值必须大于 0。
通过 Field 类,我们可以更加灵活地定义模型字段的元数据,以及验证规则和默认值。这样可以提高代码的可读性和可维护性,同时也方便生成文档或 API 文档。