core.config_manager

配置管理器类,负责加载、访问和管理系统配置。

该模块提供了ConfigManager类,用于处理系统配置的加载、访问、修改和保存。 它支持多级嵌套配置项的访问和修改,并集成了配置验证功能。

Classes

ConfigManager([config_path])

配置管理器类,负责加载、访问和管理系统配置。

class core.config_manager.ConfigManager(config_path='./config/config.json')[source]

Bases: object

配置管理器类,负责加载、访问和管理系统配置。

该类提供方法用于加载配置文件、获取配置值、设置配置值,以及保存配置。 它支持多级嵌套配置项的访问和修改,通过点号分隔的路径访问配置项。

例如,可以通过”storage.base_path”访问配置中的嵌套项。

__init__(config_path='./config/config.json')[source]

Initialize ConfigManager object.

Parameters:

config_path (str) – Configuration file path, defaults to “./config/config.json”

load_config()[source]

从配置文件加载配置,包含验证和标准化。

Returns:

如果成功加载配置则返回True,否则返回False

Return type:

bool

apply_config(config)[source]

Install a validated effective snapshot without writing its source file.

save_config()[source]

将当前配置保存到配置文件。

Returns:

如果成功保存配置则返回True,否则返回False

Return type:

bool

get_config()[source]

获取完整配置字典。

Returns:

配置字典

Return type:

Dict[str, Any]

get_value(key_path, default=None)[source]

获取指定键路径的配置值。 支持使用点号分隔的多级键路径,如”storage.base_path”。

Parameters:
  • key_path (str) – 键路径,使用点号分隔多级键

  • default (Any) – 如果键不存在,则返回的默认值

Returns:

配置值,如果键不存在则返回默认值

Return type:

Any

set_value(key_path, value)[source]

设置指定键路径的配置值。 支持使用点号分隔的多级键路径,如”storage.base_path”。

Parameters:
  • key_path (str) – 键路径,使用点号分隔多级键

  • value (Any) – 要设置的值

Returns:

如果成功设置则返回True,否则返回False

Return type:

bool

remove_key(key_path)[source]

移除指定键路径的配置项。

Parameters:

key_path (str) – 键路径,使用点号分隔多级键

Returns:

如果成功移除则返回True,否则返回False

Return type:

bool

get_processor_config(processor_name)[source]

获取特定处理器的配置。

Parameters:

processor_name (str) – 处理器名称

Returns:

处理器配置字典,如果不存在则返回空字典

Return type:

Dict[str, Any]

get_connector_config(connector_name)[source]

获取特定连接器的配置。

Parameters:

connector_name (str) – 连接器名称

Returns:

连接器配置字典,如果不存在则返回空字典

Return type:

Dict[str, Any]

reload_config()[source]

重新加载配置文件。

Returns:

如果成功重新加载配置则返回True,否则返回False

Return type:

bool

validate_current_config()[source]

验证当前配置。

Returns:

如果配置有效则返回True,否则返回False

Return type:

bool

get_validation_report()[source]

获取配置验证报告。

Returns:

包含验证结果的报告字典

Return type:

Dict[str, Any]

is_config_valid()[source]

检查配置是否有效。

Returns:

如果配置有效则返回True,否则返回False

Return type:

bool

fix_config_issues()[source]

尝试修复配置问题。

Returns:

如果成功修复则返回True,否则返回False

Return type:

bool