Configuration Module

Configuration module.

exception pepperpy.config.ConfigError(message, details=None, cause=None)[source]

Bases: PepperpyError

Configuration error.

Parameters:
Return type:

None

class pepperpy.config.ConfigManager(config=None)[source]

Bases: BaseModule[ConfigManagerConfig]

Configuration manager.

Parameters:

config (ConfigManagerConfig | None)

__init__(config=None)[source]

Initialize configuration manager.

Parameters:

config (Optional[ConfigManagerConfig]) – Configuration manager configuration

Return type:

None

get(key)[source]

Get configuration value.

Parameters:

key (str) – Configuration key

Return type:

Any

Returns:

Configuration value

Raises:

ConfigError – If value is not found

set(key, value)[source]

Set configuration value.

Parameters:
  • key (str) – Configuration key

  • value (Any) – Configuration value

Raises:

ConfigError – If value cannot be set

Return type:

None

delete(key)[source]

Delete configuration value.

Parameters:

key (str) – Configuration key

Raises:

ConfigError – If value cannot be deleted

Return type:

None

clear()[source]

Clear configuration store.

Raises:

ConfigError – If store cannot be cleared

Return type:

None

class pepperpy.config.ConfigManagerConfig(name='config_manager', metadata=<factory>)[source]

Bases: ModuleConfig

Configuration manager configuration.

Parameters:
name: str = 'config_manager'
metadata: Dict[str, Any]