PyEve/Cerberus 错误处理机制详解-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00928/article/details/148601847

PyEve/Cerberus 错误处理机制详解

cerberus Lightweight, extensible data validation library for Python 项目地址: https://gitcode.com/gh_mirrors/cer/cerberus

概述

在数据验证过程中，错误处理是至关重要的环节。PyEve/Cerberus 提供了一套完善的错误处理机制，能够帮助开发者清晰地了解验证失败的原因，并以结构化的方式获取错误信息。本文将深入解析 Cerberus 的错误处理体系，包括错误处理器的工作原理、错误信息的组织结构以及如何在实际应用中使用这些功能。

错误处理器(Error Handlers)

错误处理器是 Cerberus 中处理验证错误的核心组件，它决定了错误信息的最终呈现形式。

基本概念

错误处理器基于 BaseErrorHandler 基类实现，开发者可以通过以下方式指定使用的错误处理器：

在验证器初始化时通过 error_handler 参数指定
在验证器实例上随时设置 error_handler 属性

可以传递错误处理器类或实例，如果需要向处理器传递初始化参数，可以使用包含处理器类和参数字典的元组。

默认错误处理器

Cerberus 提供了 BasicErrorHandler 作为默认错误处理器，它返回一个字典结构：

键(key)对应文档中的字段名
值(value)是包含错误消息的列表
对于嵌套字段的错误，列表的最后一项会包含一个字典来保存嵌套错误

错误信息的Python接口

Cerberus 使用 ValidationError 类来表示单个验证错误，每个错误实例包含以下重要属性：

document_path：文档中的路径，以元组形式表示
- 对于扁平字典，就是键名组成的元组
- 对于嵌套结构，包含所有遍历的键名
- 序列中的项用索引表示
schema_path：模式(schema)中的路径
code：错误的唯一标识码
rule：触发错误的验证规则
constraint：规则的约束条件
value：被验证的实际值
info：包含额外信息的元组
- 对于批量验证(如使用 items 或 keysrules)，此属性保存所有单独的错误
- 大多数错误此属性为空

错误访问接口

验证器实例在处理文档后，提供以下属性来访问错误信息：

_errors：ErrorsList 实例，包含所有提交的错误
- 不建议直接操作此属性
- 可以使用 in 操作符检查特定错误是否存在
document_error_tree：类似字典的对象，按文档结构组织错误
- 可以通过下标访问特定错误或子节点
- 如果没有匹配错误则返回 None
- 节点的 errors 属性包含该节点的所有错误
- 支持 in 操作符检查错误或子节点是否存在
schema_error_tree：类似的结构，但按模式(schema)组织错误

实际应用示例

让我们通过一个具体例子来理解这些概念：

schema = {'cats': {'type': 'integer'}}
document = {'cats': 'two'}
v.validate(document, schema)  # 返回 False

# 检查特定错误类型是否存在
cerberus.errors.BAD_TYPE in v._errors  # 返回 True

# 比较文档和模式错误树中的错误
v.document_error_tree['cats'].errors == v.schema_error_tree['cats']['type'].errors  # True

# 检查特定错误类型是否存在于字段中
cerberus.errors.BAD_TYPE in v.document_error_tree['cats']  # True

# 获取特定错误实例
error = v.document_error_tree['cats'][cerberus.errors.BAD_TYPE]

# 访问错误详情
error.document_path  # ('cats',)
error.schema_path  # ('cats', 'type')
error.rule  # 'type'
error.constraint  # 'integer'
error.value  # 'two'