转换#

convert(obj, from_type: str, to_type: str | list[str], as_scitype: str | None = None, store=None, store_behaviour: str | None = None, return_to_mtype: bool = False)[源代码][源代码]#

在不同的机器表示之间转换对象,受限于科学类型。

参数:
obj要转换的对象 - 任何类型,应符合 mtype 规范以适应 as_scitype
from_typestr - 将 “obj” 转换为的类型,一个有效的 mtype 字符串

有效的 mtype 字符串及其解释,请参见 datatypes.MTYPE_REGISTER

to_typestr - 将 “obj” 转换为的 mtype,一个有效的 mtype 字符串

或字符串列表,这指定了转换为的可接受类型;如果是列表,将转换为与 from_mtype 相同 scitype 的第一个 mtype

as_scitypestr, 可选 - 对象“obj”被视为的scitype名称

默认值 = 从 from_type 推断,有效 scitype 字符串及其解释在 datatypes.SCITYPE_REGISTER 中。

存储可选,有损转换的存储引用,默认=None(无引用)

如果非空且 store_behaviour 为“reset”或“update”,则通过副作用更新

store_behaviourstr, 可选, 可以是 None (默认), “reset”, “freeze”, “update” 之一

“reset” - 存储被清空,然后从转换中更新 “freeze” - 存储为只读,可以被转换读取/使用,但不能更改 “update” - 存储从转换中更新,并保留之前的内容 None - 自动:如果存储为空且不为None,则”update”;否则为”freeze”

return_to_mtype: bool, 可选 (默认=False)

如果为真,还会返回转换为字符串的 mtype。

返回:
converted_obj : to_type - 对象 obj 转换为 mtype to_typeto_type - 对象

如果 objNone,那么它是 None

to_type : str, 仅在 return_to_mtype=True 时返回str,仅在以下情况下返回

converted_obj 的类型 - 当 to_type 是列表时非常有用

引发:
如果未实现转换,则引发 KeyError
如果输入不符合规范,则会出现 TypeError 或 ValueError