【无标题】

最新推荐文章于 2024-04-16 14:28:48 发布

qx_szj

最新推荐文章于 2024-04-16 14:28:48 发布

阅读量177

点赞数

文章标签： python

本文链接：https://blog.csdn.net/qx_szj/article/details/131209782

版权

Pydantic 完整学习指南

什么是 Pydantic？

Pydantic 是一个用于数据验证和解析的 Python 库。它提供了一种简洁而强大的方式来定义数据模型，并自动处理数据的验证、类型转换和序列化等任务。Pydantic 还具有很好的性能和灵活性，使其成为处理数据验证和解析的理想选择。

安装 Pydantic

您可以使用 pip 包管理器来安装 Pydantic：

pip install pydantic

定义模型

在 Pydantic 中，您可以通过创建一个继承自 pydantic.BaseModel 的类来定义数据模型。在模型类中，您可以定义各种字段，每个字段都有其类型和验证规则。

以下是一个示例模型的定义：

from pydantic import BaseModel

class Person(BaseModel):
    name: str
    age: int
    email: str

在上面的示例中，我们定义了一个名为 Person 的模型，它有三个字段：name、age 和 email。这些字段分别指定了它们的类型。

数据验证

Pydantic 使用字段的类型信息来验证数据。当您创建一个模型对象时，Pydantic 会自动验证提供的数据是否符合模型定义的规则。

以下是一个示例验证数据的过程：

person_data = {
    "name": "Alice",
    "age": 25,
    "email": "alice@example.com"
}

person = Person(**person_data)

在上面的示例中，我们使用提供的数据创建了一个 Person 对象。Pydantic 会自动验证数据是否符合模型的定义。如果数据不符合规则，Pydantic 将引发 pydantic.ValidationError 异常。

您还可以使用 model.dict() 方法将模型对象转换为字典，并使用 json.dumps() 将字典转换为 JSON 格式的字符串。

import json

json_data = json.dumps(person.dict())
print(json_data)

默认值和验证规则

您可以在模型字段中使用 default 参数来指定默认值，并使用 Field 类来指定其他验证规则。

以下是一个示例，展示如何为字段定义默认值和验证规则：

from pydantic import BaseModel, Field

class Order(BaseModel):
    customer_name: str = Field(..., max_length=50)
    quantity: int = Field(..., gt=0)

在上面的示例中，我们为 customer_name 字段指定了最大长度为 50，并为 quantity 字段指定了大于 0 的验证规则。

数据解析

Pydantic 可以自动解析和验证各种数据源，包括 JSON、表单数据、数据库记录等。您可以使用 parse_obj 方法将数据解析为模型对象。

以下是一个示例，展示如何解析 JSON 数据为模型对象：

from pydantic import BaseModel

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

json_data = '{"name": "Alice", "age": 25}'
person = Person.parse_obj(json.loads(json_data))

在上面的示例中，我们将 JSON 数据解析为 Person 对象。Pydantic 会自动验证数据是否符合模型的定义。

异常处理

当数据验证失败时，Pydantic 会引发 pydantic.ValidationError 异常。您可以使用 try/except 块来处理这些异常，并根据需要进行错误处理。

以下是一个示例，展示如何处理验证异常：

from pydantic import BaseModel, ValidationError

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

def parse_person(data):
    try:
        person = Person.parse_obj(data)
        return person
    except ValidationError as e:
        # 处理验证错误
        print(e.errors())
        return None

# 示例数据
data = {
    "name": "Alice",
    "age": "25"  # 错误的数据类型
}

# 转换并验证数据
person = parse_person(data)
if person:
    print(person.name)
    print(person.age)

在上面的示例中，我们定义了一个 parse_person 函数来进行数据转换和验证。如果数据验证失败，函数将返回 None。您可以根据需要处理验证错误。

当然可以！以下是整理后的学习文档，包含了之前的问题和解答：

Pydantic 配置文件加载

Pydantic 是一个强大的 Python 库，用于数据验证和解析。它还提供了加载配置数据的功能，使您可以轻松地从文件、环境变量等来源加载配置。

从文件中加载配置数据

要从文件中加载配置数据，您可以使用 BaseSettings 类来定义配置文件的模型，并使用 @root_validator 装饰器来验证配置数据。

以下是一个示例，展示如何从文件中加载配置数据：

from pydantic import BaseSettings, root_validator

class Config(BaseSettings):
    host: str
    port: int
    username: str
    password: str

    @root_validator
    def validate_config(cls, values):
        if values.get('password') == 'password123':
            raise ValueError('Insecure password')
        return values

config = Config(_env_file='.env')

print(config.host)  # 输出：localhost
print(config.port)  # 输出：8080
print(config.username)  # 输出：admin
print(config.password)  # 输出：********

在上面的示例中，我们创建了一个名为 Config 的 Pydantic 模型，并使用 @root_validator 装饰器定义了一个验证方法 validate_config。在验证方法中，我们检查了密码是否为不安全的值，并引发了一个异常。

然后，我们使用 _env_file 参数指定了配置文件的路径（在这里是 .env 文件），Pydantic 会自动加载配置文件中的数据，并进行验证。

从环境变量中加载配置数据

Pydantic 还支持从环境变量中加载配置数据。您可以使用 BaseSettings 类来定义配置文件的模型，并在字段上使用 Field 类的 env 参数来指定环境变量的名称。

以下是一个示例，展示如何从环境变量中加载配置数据：

from pydantic import BaseSettings, Field

class Config(BaseSettings):
    host: str = Field(..., env='HOST')
    port: int = Field(..., env='PORT')
    username: str = Field(..., env='USERNAME')
    password: str = Field(..., env='PASSWORD')

config = Config()

print(config.host)  # 输出：localhost
print(config.port)  # 输出：8080
print(config.username)  # 输出：admin
print(config.password)  # 输出：password123

在上面的示例中，我们创建了一个名为 Config 的 Pydantic 模型，并在每个字段上使用 Field 类来指定环境变量的名称。

然后，我们创建了一个 Config 实例，Pydantic 会自动从环境变量中加载配置数据，并进行验证。在这个示例中，我们假设环境变量 HOST、PORT、USERNAME 和 PASSWORD 分别对应配置文件的 host、port、username 和 password 字段。

如果环境变量不存在或不符合字段的验证规则，Pydantic 会引发相应的异常。

Pydantic 提供了使用默认值和别名的功能，以增强配置文件加载的灵活性和可定制性。

使用默认值

要在 Pydantic 模型中使用默认值，您可以在字段的声明中指定一个默认值。例如：

from pydantic import BaseModel

class Config(BaseModel):
    host: str = 'localhost'
    port: int = 8080
    username: str
    password: str

在上面的示例中，我们在 Config 模型的字段声明中指定了默认值。如果配置文件中没有为这些字段提供值，Pydantic 将使用默认值。

使用别名

要在 Pydantic 模型中使用别名，您可以在字段的声明中使用 Field 类的 alias 参数来指定别名。例如：

from pydantic import BaseModel, Field

class Config(BaseModel):
    host: str = Field(..., alias='server_host', default='localhost')
    port: int = Field(..., alias='server_port')
    username: str = Field(..., alias='user_name')
    password: str = Field(..., alias='user_password')