Chronaxis用户手册English
本页目录成员导航PlanValidationErrorPlanValidationError.__init__PlanValidationError.refresh_textPlanValidationError.to_dictPlanValidationError.diagnosticsPlanValidationError.from_diagnostics

chronaxis.PlanValidationError

使用from chronaxis import PlanValidationError导入。本页只列直接公开成员与必要的构造/上下文协议;内部实现见模块参考。

返回公开API索引。参数表中的类型可跳转到定义;先核对必填、默认值与返回/异常说明。

成员导航

PlanValidationError

保存配置字段路径、原因和可选原文定位。diagnostics提供全部独立错误,单错也为一项;blocked_checks列出因上游声明无效而尚未执行的检查,其元素含path和reason,不是额外确认错误。

python
PlanValidationError(path: str, message: str, code: str = 'invalid_config', *, hint=None, source=None, location=None, object_name=None, value=None)

继承关系:ValueError。下表列本类声明的字段;基类字段及其约束见对应类型链接。

源码:src/chronaxis/planning/checks.py:26(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

PlanValidationError.__init__

建立明确路径错误,保留原异常链供load_analysis_plan诊断。

python
PlanValidationError.__init__(path: str, message: str, code: str='invalid_config', *, hint=None, source=None, location=None, object_name=None, value=None)

参数

名称 数据类型 必填 省略时的值 用途、取值和效果
path str 是 无 位置或关键字。标识配置中的出错字段,例如$.signals[0].unit;由校验器根据实际声明位置生成。
message str 是 无 位置或关键字。解释该字段违反的要求,例如需要正整数;用于面向用户的错误正文,不应包含完整私有输入数据。
code str 否 'invalid_config' 位置或关键字。提供机器可识别的错误类别,默认invalid_config表示无效配置;读取异常时用code分类,不依赖中文message匹配。
hint str 或 None 否 None 仅关键字。可选修正提示,例如有效枚举值或可用名称;提示不会自动修改原配置。
source str 或 None 否 None 仅关键字。配置来源文件或显示名,与字段path分开;没有可靠来源时保留None。
location ConfigurationLocation 或 None 否 None 仅关键字。可证明的原始行列;缺失时只给文件与字段,不猜位置。
object_name str 或 None 否 None 仅关键字。错误所属的来源、信号或节点名称;只用于定位,不参与名称推断。
value str 或 None 否 None 仅关键字。已截短的当前值说明,大容器仅显示类型与大小,避免打印整份配置。

返回说明

None;异常文本含路径和原因。

异常说明

无;参数由校验器内部构造。

源码:src/chronaxis/planning/checks.py:32(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

PlanValidationError.refresh_text

重建人读消息。

python
PlanValidationError.refresh_text()

参数:无显式参数。

参数说明

无。

返回说明

None。

异常说明

无;附加定位后调用。

源码:src/chronaxis/planning/checks.py:58(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

PlanValidationError.to_dict

返回稳定机器诊断。

python
PlanValidationError.to_dict()

参数:无显式参数。

参数说明

无。

返回说明

当前单项的原生dict;聚合异常的本方法只描述第一项。获取全部诊断时使用[item.to_dict() for item in error.diagnostics]。

异常说明

无。

源码:src/chronaxis/planning/checks.py:78(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

PlanValidationError.diagnostics

返回各项独立诊断。

python
PlanValidationError.diagnostics

装饰器:property。

读取属性,不使用调用括号。

参数说明

无。

返回说明

tuple;单错也为一项。

异常说明

无。

源码:src/chronaxis/planning/checks.py:86(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

PlanValidationError.from_diagnostics

合并错误并保留原类型兼容。

python
PlanValidationError.from_diagnostics(errors, blocked=())

装饰器:classmethod。

参数

名称 数据类型 必填 省略时的值 用途、取值和效果
errors Sequence[PlanValidationError] 是 无 位置或关键字。非空PlanValidationError序列;单项且没有阻断说明时原样返回。
blocked Iterable[dict] 否 () 位置或关键字。可选阻断说明序列,每项是含path和reason的字典;默认空元组。

返回说明

异常。

异常说明

空序列ValueError。

源码:src/chronaxis/planning/checks.py:91(行号属于 8904c2f744951857659abd40aaa3535d57faf53c)。

Chronaxis 用户手册 · 离线阅读