此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 类
  • ValidationProblem
  • 函数
  • format_validation_error
  • install_excepthook
  • iter_validation_problems
  • render_validation_error
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包
最后更新
Python API: luxonis_ml.utils.validationPydantic 验证错误的人类可读渲染。Pydantic 默认的 ValidationError 消息准确但冗长:它重复原始错误类型、截断的输入值以及每个问题的文档 URL,并且每个联合成员报告一次联合失败。此模块将此类错误转换为 ValidationProblem 条目的简短列表,并将其呈现为纯文本或 rich 面板。失败的模型是从错误的追溯中恢复的。了解它使格式化程序能够区分字段名与映射键或 pydantic 内部联合成员标签之一,并为拼写错误的键建议最接近的有效字段名。对于没有追溯的错误,或者由 pydantic.TypeAdapter 引发的错误,显式传递 model,它验证的可能根本不是模型。

类

ValidationProblem

单个验证失败,以人类可读的方式表达。

属性

hint
可选的后续建议,例如拼写错误的键最接近的匹配字段名。
location
指向违规值的点分路径,使用 [i] 表示序列索引,例如 model.inputs[0].dtype。对于涉及顶层值本身的问题,此项为空。
message
问题所在,以小写句子片段表示。其成员在其自身字段上失败的联合跨越数行:一个标题,然后每个备选项一行缩进。
value
违规输入值的可选 repr。

函数

format_validation_error

Python
1def format_validation_error(error: ValidationError, *, model: type[BaseModel] | None = None, title: str | None = None) -> str:
将验证错误格式化为可读的纯文本。参数
  • error (ValidationError): 要格式化的验证错误。
  • model (type[BaseModel] | None): 已验证的模型。用于解析错误位置并为拼写错误的键建议有效的字段名。默认为从错误的追溯中恢复的模型。
  • title (str | None): 消息的标题。默认为一行,命名未能验证的模型。
返回
  • str: 每问题一个缩进块的多行消息。

install_excepthook

Python
1def install_excepthook(*, use_rich: bool = True, enabled: bool = True):
配置未捕获验证错误的摘要。用一个包装 sys.excepthook,该包装首先让先前安装的钩子运行——这样追溯仍然显示错误来自何处,并且崩溃报告器仍然看到它——然后打印 ValidationError 的可读摘要作为读者看到的最后一件事。现有的 Luxonis 钩子被重新配置,或者在 enabled 为 False 时被移除。多次调用此函数无害。参数
  • use_rich (bool): 如果为 True,摘要是一个 rich 面板。如果为 False,则为纯文本。
  • enabled (bool): 是否启用验证错误摘要。

iter_validation_problems

Python
1def iter_validation_problems(error: ValidationError, *, model: type[BaseModel] | None = None) -> Iterator[ValidationProblem]:
将验证错误转换为人性化问题。每个联合成员报告一次的联合失败被折叠为一个问题,并删除重复的问题。参数
  • error (ValidationError): 要检查的验证错误。
  • model (type[BaseModel] | None): 已验证的模型。用于解析错误位置并为拼写错误的键建议有效的字段名。默认为从错误的追溯中恢复的模型。
返回
  • Iterator[ValidationProblem]
生成
  • 每个不同的验证失败一个问题。

render_validation_error

Python
1def render_validation_error(error: ValidationError, *, model: type[BaseModel] | None = None, title: str | None = None) -> RenderableType:
将验证错误渲染为 rich 面板。参数
  • error (ValidationError): 要渲染的验证错误。
  • model (type[BaseModel] | None): 已验证的模型。用于解析错误位置并为拼写错误的键建议有效的字段名。默认为从错误的追溯中恢复的模型。
  • title (str | None): 面板边框中显示的标题。默认为一行,命名未能验证的模型。
返回
  • RenderableType: 适用于 rich.console.Console.print 的可渲染对象。