perun.configuration

Configuration module.

Attributes

log
config
globalConfigPath
localConfigPath

Functions

read_custom_config(→ None)	Read INI config file and save in global configuration objects.
save_to_config(→ None)	Save key and value to configuration.
read_environ(→ None)	Read perun environmental variables.
sanitize_config(→ configparser.ConfigParser)	Sanitize configuration values.

Module Contents

perun.configuration.log

perun.configuration.config: configparser.ConfigParser

perun.configuration.globalConfigPath

perun.configuration.localConfigPath

perun.configuration.read_custom_config(pathStr: str) → None

Read INI config file and save in global configuration objects.

Parameters:

pathStr (str) – Path to configuration file.

perun.configuration.save_to_config(key: str, value: Any) → None

Save key and value to configuration.

Parameters:

• key (str) – Option name

• value (Any) – Option value

perun.configuration.read_environ() → None

Read perun environmental variables.

perun.configuration.sanitize_config(config: configparser.ConfigParser) → configparser.ConfigParser

Sanitize configuration values.

Parameters:

config (configparser.ConfigParser) – Configuration object.

Returns:

Sanitized configuration object.

Return type:

configparser.ConfigParser