validation
最后更新
luxonis_ml.utils.validationPydantic 验证错误的人类可读渲染。Pydantic 默认的 ValidationError 消息准确但冗长:它重复原始错误类型、截断的输入值以及每个问题的文档 URL,并且每个联合成员报告一次联合失败。此模块将此类错误转换为 ValidationProblem 条目的简短列表,并将其呈现为纯文本或 rich 面板。示例
Python
1from pydantic import ValidationError
2from rich.console import Console
3
4from luxonis_ml.utils.validation import render_validation_error
5
6try:
7 MyModel(**data)
8except ValidationError as e:
9 Console().print(render_validation_error(e))pydantic.TypeAdapter 引发的错误,显式传递 model,它验证的可能根本不是模型。类
ValidationProblem
属性
hint
location
[i] 表示序列索引,例如 model.inputs[0].dtype。对于涉及顶层值本身的问题,此项为空。message
value
函数
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:error(ValidationError): 要渲染的验证错误。model(type[BaseModel] | None): 已验证的模型。用于解析错误位置并为拼写错误的键建议有效的字段名。默认为从错误的追溯中恢复的模型。title(str | None): 面板边框中显示的标题。默认为一行,命名未能验证的模型。
RenderableType: 适用于rich.console.Console.print的可渲染对象。