check_raise#

check_raise(obj, mtype: str, scitype: str = None, var_name: str = 'input')[source]#

检查对象是否符合 mtype 规范,如果不符合则引发错误。

有关 :glossary:`mtype`:glossary:`scitype` 的解释,请参阅术语表。

参数:
obj

要检查的对象

mtype: str 或 str 列表,用于检查 obj 的 mtype

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

scitype: str,可选;默认值 = 从 mtype 推断

用于检查 obj 的 scitype

如果从 mtype 推断,mtype 列表元素无需具有相同的 scitype

有效 mtype 字符串可在 数据格式规范 中找到

var_name: str,可选,默认值=”input”

错误消息中的输入名称

返回值:
valid: bool - 如果 obj 符合规范则为 True

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

引发:
如果 obj 不符合规范,则引发带有信息性消息的 TypeError
如果未为 mtype/scitype 组合定义检查,则引发 TypeError
如果 mtype 输入参数类型不正确,则引发 ValueError