
在许多应用场景中,我们可能需要验证一组数据是否符合某个函数的参数要求,但又不希望立即执行该函数。例如:
Pydantic 提供了 pydantic.validate_call 装饰器,它能自动验证函数参数并在调用函数时强制类型检查。然而,其核心在于“调用函数”,这意味着它会执行函数体。如果我们的目标仅仅是“检查参数是否有效”而不触发函数执行,validate_call 就不完全适用。
解决上述问题的关键在于利用 Python 的内省机制(__annotations__ 属性)和 Pydantic 的 BaseModel 动态创建能力。我们可以从函数的类型注解中提取参数信息,并据此生成一个临时的 Pydantic 模型。
以下代码展示了如何实现一个辅助函数 form_validator_model,它接收一个函数作为输入,并返回一个动态生成的 Pydantic 模型,该模型可用于验证该函数的参数。
import collections.abc
from typing import Optional, Type, Dict, Any
import pydantic
def form_validator_model(func: collections.abc.Callable) -> Type[pydantic.BaseModel]:
"""
根据函数的类型注解动态创建一个 Pydantic 模型,用于验证函数参数。
Args:
func: 待验证参数的函数。
Returns:
一个 Pydantic BaseModel 类型,其字段对应于函数的参数。
"""
# 复制函数的注解字典,避免修改原始函数对象
annotations = func.__annotations__.copy()
# 移除返回类型注解,因为我们只关心参数
annotations.pop('return', None)
# 使用 type() 动态创建 BaseModel 子类
# 第一个参数是类名(方便调试),第二个是基类元组,第三个是类的属性字典
model_name = f'{func.__name__}_Validator'
DynamicValidatorModel = type(model_name, (pydantic.BaseModel,), {'__annotations__': annotations})
return DynamicValidatorModel
# ----------------------------------------------------------------------
# 示例应用
# ----------------------------------------------------------------------
# 假设有一个需要验证参数的函数
def process_user_data(
user_id: int,
username: str,
email: Optional[str] = None,
roles: list[str] = ['guest']
) -> Dict[str, Any]:
"""
一个示例函数,用于演示参数验证。
它接收用户数据并进行一些处理,但我们希望在调用前验证输入。
"""
print(f"模拟处理用户数据: ID={user_id}, Name={username}, Email={email}, Roles={roles}")
return {"status": "processed", "user_id": user_id}
# 1. 构建验证模型
UserValidator = form_validator_model(process_user_data)
print(f"动态生成的验证模型类名: {UserValidator.__name__}")
print(f"模型字段: {UserValidator.model_fields.keys()}")
print("\n--- 成功验证示例 ---")
valid_kwargs = {
'user_id': 123,
'username': 'alice',
'email': 'alice@example.com',
'roles': ['admin', 'user']
}
try:
# 实例化模型,Pydantic 会自动进行验证
validated_data = UserValidator(**valid_kwargs)
print(f"参数验证成功!验证结果: {validated_data.model_dump()}")
# 此时,可以安全地将 validated_data 传递给 process_user_data
# process_user_data(**validated_data.model_dump())
except pydantic.ValidationError as e:
print(f"参数验证失败: {e}")
print("\n--- 失败验证示例 (类型不匹配) ---")
invalid_kwargs_type = {
'user_id': 'not_an_int', # 类型错误
'username': 'bob',
'email': 'bob@example.com'
}
try:
UserValidator(**invalid_kwargs_type)
except pydantic.ValidationError as e:
print(f"参数验证失败: {e}")
print("\n--- 失败验证示例 (缺少必要参数) ---")
missing_kwargs = {
'user_id': 456,
# 缺少 'username'
}
try:
UserValidator(**missing_kwargs)
except pydantic.ValidationError as e:
print(f"参数验证失败: {e}")
print("\n--- 默认值和可选参数示例 ---")
default_kwargs = {
'user_id': 789,
'username': 'charlie'
# email 和 roles 将使用默认值或 None
}
try:
validated_default_data = UserValidator(**default_kwargs)
print(f"参数验证成功 (包含默认值/可选值): {validated_default_data.model_dump()}")
except pydantic.ValidationError as e:
print(f"参数验证失败: {e}")
print("\n--- 注意事项:不支持位置参数 ---")
# Pydantic BaseModel 实例化时只接受关键字参数
try:
# 尝试使用位置参数会直接导致 TypeError
# UserValidator(123, 'frank')
print("Pydantic BaseModel 实例化不支持位置参数。请始终使用关键字参数进行验证。")
except TypeError as e:
print(f"捕获到错误: {e}")
通过这种动态构建 Pydantic 模型的方法,我们能够灵活且强大地实现对函数参数的“无调用”验证,极大地提升了代码的健壮性和数据输入的可靠性。
以上就是利用 Pydantic 动态模型实现函数参数的无调用验证的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号