check_raise#

check_raise(obj, mtype: str, scitype: str | None = None, var_name: str = 'input')[源代码][源代码]#

检查对象是否符合mtype规范,如有错误则抛出。

参数:
obj - 要检查的对象
mtype: str 或 str 列表, 检查 obj 的 mtype

有效的 mtype 字符串在 datatypes.MTYPE_REGISTER(第1列)中

scitype: str, 可选, 检查对象的科学类型; 默认 = 从mtype推断

如果从 mtype 推断,mtype 的列表元素不需要具有相同的 scitype。有效的 mtype 字符串位于 datatypes.SCITYPE_REGISTER(第一列)中。

var_name: str, 可选, 默认=”input” - 错误信息中输入的名称
返回:
valid: bool - 如果 obj 符合规范,则为 True

与当 check_is_mtype 的返回参数为 True 时相同,否则引发错误

引发:
如果 obj 不符合要求,则带有信息性消息的 TypeError
如果没有为 mtype/scitype 组合定义检查,则引发 TypeError
如果 mtype 输入参数的类型不符合预期,则抛出 ValueError