
在复杂的 python 应用中,函数是核心的逻辑单元。为了确保函数的健壮性,我们通常会对其输入参数进行校验。pydantic 作为一个强大的数据验证库,提供了基于类型提示的验证能力,例如通过 @validate_call 装饰器。然而,在某些场景下,我们可能需要在不实际执行函数体的情况下,仅验证其参数是否符合预期的类型提示。例如,构建 api 请求体校验器、模拟函数调用前的参数检查,或在动态代码生成前进行参数预检。pydantic 的 @validate_call 装饰器虽然能进行验证,但它会实际调用函数,并且其返回结果并不直接暴露底层的验证模型,这使得我们无法在不调用函数的情况下单独进行参数验证。
Python 函数的类型提示信息存储在其 __annotations__ 属性中。这个属性是一个字典,键是参数名,值是对应的类型提示。Pydantic 的 BaseModel 也是通过其类定义中的类型提示来定义字段的。因此,核心思路是:我们可以程序化地读取一个函数的 __annotations__,并将其转换为一个临时的 Pydantic BaseModel 类。然后,通过实例化这个动态生成的模型,即可对传入的参数进行 Pydantic 级别的验证。
我们将创建一个辅助函数 form_validator_model,它接收一个可调用对象(函数),并返回一个动态生成的 Pydantic BaseModel 类型。
import collections.abc
import pydantic
from typing import Optional, Type
def form_validator_model(func: collections.abc.Callable) -> Type[pydantic.BaseModel]:
"""
根据函数的类型提示动态生成一个 Pydantic 验证模型。
Args:
func: 需要为其生成验证模型的函数。
Returns:
一个 Pydantic BaseModel 类型,可用于验证 func 的参数。
"""
# 复制函数的 __annotations__,因为我们可能需要修改它
annotations = func.__annotations__.copy()
# 移除函数的返回值注解,因为它不是参数
# Pydantic 模型只关注输入字段
annotations.pop('return', None)
# 动态创建 Pydantic BaseModel 类
# type() 函数的第三个参数是类的属性字典
# 我们将 __annotations__ 直接传递给它,Pydantic 会自动识别并创建字段
model_name = f'{func.__name__}_Validator'
DynamicValidatorModel = type(model_name, (pydantic.BaseModel,), {'__annotations__': annotations})
return DynamicValidatorModel
代码解析:
让我们定义一个示例函数 foo,并使用上述 form_validator_model 来验证其参数。
# 定义一个示例函数
def foo(x: int, y: str, z: Optional[list] = None) -> str:
"""一个带有类型提示的示例函数。"""
return f"{x} - {y} - {z}"
# 使用辅助函数生成验证模型
FooValidator = form_validator_model(foo)
# 示例 1: 有效的参数
print("--- 验证有效参数 ---")
try:
valid_kwargs = {'x': 10, 'y': 'hello', 'z': [1, 2, 3]}
validated_data = FooValidator(**valid_kwargs)
print(f"验证成功: {validated_data.model_dump()}")
# 此时,validated_data 是一个 FooValidator 实例,其属性已通过验证
# 我们可以访问它们,例如 validated_data.x, validated_data.y
except pydantic.ValidationError as e:
print(f"验证失败: {e}")
print("\n--- 验证部分参数 (可选参数缺失) ---")
try:
valid_kwargs_partial = {'x': 20, 'y': 'world'} # z 缺失,但它是 Optional
validated_data_partial = FooValidator(**valid_kwargs_partial)
print(f"验证成功 (部分参数): {validated_data_partial.model_dump()}")
except pydantic.ValidationError as e:
print(f"验证失败: {e}")
# 示例 2: 无效的参数类型
print("\n--- 验证无效参数类型 ---")
try:
invalid_kwargs_type = {'x': 'not_an_int', 'y': 'hi'}
FooValidator(**invalid_kwargs_type) # 这将引发 ValidationError
except pydantic.ValidationError as e:
print(f"验证失败: {e}")
# Pydantic 会详细指出哪个字段验证失败以及原因
# 示例 3: 缺少必需参数
print("\n--- 验证缺少必需参数 ---")
try:
missing_kwargs = {'y': 'only_y'}
FooValidator(**missing_kwargs) # 这将引发 ValidationError
except pydantic.ValidationError as e:
print(f"验证失败: {e}")
通过上述示例,我们可以清晰地看到,即使 foo 函数本身从未被调用,我们也能利用 FooValidator 模型对其预期参数进行严格的 Pydantic 验证。
本文介绍了一种在不实际调用函数的情况下,利用 Pydantic 对其参数进行类型和数据验证的高级技巧。通过动态地从函数的 __annotations__ 创建一个 Pydantic BaseModel,我们能够实现灵活且强大的参数预校验机制。尽管存在仅支持关键字参数的局限性,但这种方法为需要提前验证函数输入的场景提供了宝贵的解决方案,极大地增强了 Python 代码的健壮性和可靠性。这对于构建可配置的系统、API接口验证层或任何需要解耦参数校验与函数执行的场景都非常有用。
以上就是Pydantic 进阶:不调用函数验证其参数的类型提示的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号