config.basic.object¶

对象类型配置数据实现

在 0.2.0 版本加入.

Classes¶

`NoneConfigData`	空的配置数据
`ObjectConfigData`	对象配置数据

Module Contents¶

class NoneConfigData(data: None = None)¶

Bases: config.basic.core.BasicSingleConfigData[None]

空的配置数据

在 0.2.0 版本加入.

参数:: data (None) -- 配置的原始数据

__bool__() → bool¶

__deepcopy__(memo: dict[str, Any]) → Self¶

__eq__(other: Any) → bool¶

__format__(format_spec: str) → str¶

__repr__() → str¶

__str__() → str¶

freeze(freeze: bool | None = None) → Self¶

冻结配置数据 (切换只读模式)

参数:: freeze (bool | None) -- 是否冻结配置数据, 为 None 时进行切换
返回:: 返回当前实例便于链式调用
返回类型:: Self

在 0.1.5 版本加入.

classmethod from_data(*args: Any, **kwargs: Any) → Self¶

提供创建同类型配置数据的快捷方式

返回:: 新的配置数据
返回类型:: Self

备注

套壳 __init__ 主要是为了方便内部快速创建与传入的ABCConfigData同类型的对象

例如：

type(instance)(data)

可以简写为

instance.from_data(data)

在 0.2.0 版本发生变更: 现在会自适应初始化参数

__hash__ = None¶

__slots__ = ()¶

_data: D¶

_read_only: bool | None = False¶

property data: D¶: 配置的原始数据*快照*

property data_read_only: bool | None¶

配置数据是否为只读

返回:: 配置数据是否为只读
返回类型:: bool | None

在 0.1.3 版本加入.

在 0.1.5 版本发生变更: 改为抽象属性

property read_only: bool | None¶

配置数据是否为 只读模式

返回:: 配置数据是否为 只读模式
返回类型:: bool | None

class ObjectConfigData(data: D)¶

Bases: config.basic.core.BasicSingleConfigData[ObjectConfigData.D]

对象配置数据

参数:: data (D) -- 配置的原始数据

小心

未默认做深拷贝，可能导致非预期行为

__bool__() → bool¶

__deepcopy__(memo: dict[str, Any]) → Self¶

__eq__(other: Any) → bool¶

__format__(format_spec: str) → str¶

__repr__() → str¶

__str__() → str¶

freeze(freeze: bool | None = None) → Self¶

冻结配置数据 (切换只读模式)

参数:: freeze (bool | None) -- 是否冻结配置数据, 为 None 时进行切换
返回:: 返回当前实例便于链式调用
返回类型:: Self

在 0.1.5 版本加入.

classmethod from_data(*args: Any, **kwargs: Any) → Self¶

提供创建同类型配置数据的快捷方式

返回:: 新的配置数据
返回类型:: Self

备注

套壳 __init__ 主要是为了方便内部快速创建与传入的ABCConfigData同类型的对象

例如：

type(instance)(data)

可以简写为

instance.from_data(data)

在 0.2.0 版本发生变更: 现在会自适应初始化参数

__hash__ = None¶

__slots__ = ()¶

_data: ObjectConfigData.D¶

_read_only: bool | None = False¶

property data: D¶: 配置的原始数据

小心

未默认做深拷贝，可能导致非预期的行为

在 0.3.0 版本发生变更: 现在是可写属性

property data_read_only: False¶

配置数据是否为只读

返回:: 配置数据是否为只读
返回类型:: Literal[False]

备注

该配置数据类始终认为配置数据非只读，使其能正确作为配置数据容器使用

property read_only: bool | None¶

配置数据是否为 只读模式

返回:: 配置数据是否为 只读模式
返回类型:: bool | None