代码参考

阅读此页面以了解如何使用 primitive-type 库。

目前，所有的方法、类型别名都可以从路径 primitive_type 直接导入。

类型别名

原始类型的类型别名。

备注

实际 API 路径：primitive_type.types

type Primitive = str | int | float | bool | None

原始值的类型别名。

包括：str, int, float, bool, and None.

type PrimitiveMap = dict[str, Primitive]

字符串键到原始值的映射的类型别名。

此字典表示元数据或属性的集合，其中每个值都保证为 Primitive 类型，从而确保类型安全并易于序列化。

类型检查

检查对象的一些工具。

备注

实际 API 路径：primitive_type.checker

is_primitive(val: object) → bool

检查一个对象是不是一个原始对象。

参数:

val -- 任何要检查的实例。

返回:

• True -- 如果这个对象是原始的。

• False -- 反之。

is_nested_dict(obj: dict) → bool

检查一个字典是否含有嵌套结构。

参数:

obj -- 任何要检查的字典对象。

返回:

• True -- 如果这个字典含有嵌套结构。

• False -- 反之。

类型转换

一个快速简单的类型转换器，可用于转换单个对象的类型。

备注

实际 API 路径：primitive_type.converter

class ConvertError

一个应在类型转换失败时被抛出的错误。

get_primitive_object(val: Primitive, obj_type: type[Primitive] = None) → Primitive

从给定的一个值中获取一个原始对象。

参数:

• val -- 需要被转换（类型）的给定对象。

• obj_type -- 对象最终要转换出的目标类型。默认为 None 以禁用（即自动推断）。

返回:

• str -- 如果给定的值是一个普通字符串，或者指定了转换类型。

• int -- 原始的或转换出的对象。

• float -- 原始的或转换出的对象。

• bool -- 原始的或转换出的对象。

• None -- 仅在给定的对象为 None 时。

备注

方法 get_str_object、get_int_object、get_float_object 和 get_bool_object 是 get_primitive_object 的简化方法，他们会返回 get_primitive_object(val, <type>) 并确认返回类型是指定的类型。

get_str_object(val: Primitive) → str

从给定的一个值中获取一个原始对象。

参数:

val -- 需要被转换（类型）的给定对象。

返回:

一个字符串对象。

get_int_object(val: Primitive) → int

从给定的一个值中获取一个整数对象。

参数:

val -- 需要被转换（类型）的给定对象。

返回:

一个整数对象。

get_float_object(val: Primitive) → float

从给定的一个值中获取一个浮点数对象。

参数:

val -- 需要被转换（类型）的给定对象。

返回:

一个浮点数对象。

get_bool_object(val: Primitive) → bool

从给定的一个值中获取一个布尔值对象。

参数:

val -- 需要被转换（类型）的给定对象。

返回:

一个布尔值对象。