perun.configuration

Configuration module.

Attributes

Functions

read_custom_config(pathStr) → None

Read INI config file and save in global configuration objects.

save_to_config(key, value) → None

Save key and value to configuration.

read_environ() → None

Read perun environmental variables.

sanitize_config(config) → configparser.ConfigParser

Sanitize configuration values.

Module Contents

perun.configuration.log[source]
perun.configuration.config: configparser.ConfigParser
perun.configuration.globalConfigPath
perun.configuration.localConfigPath
perun.configuration.read_custom_config(pathStr: str) → None[source]

Read INI config file and save in global configuration objects.

Parameters:

pathStr (str) – Path to configuration file.

Return type:

None

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

Save key and value to configuration.

Parameters:
  • key (str) – Option name

  • value (Any) – Option value

Return type:

None

perun.configuration.read_environ() → None[source]

Read perun environmental variables.

Return type:

None

perun.configuration.sanitize_config(config: configparser.ConfigParser) → configparser.ConfigParser[source]

Sanitize configuration values.

Parameters:

config (configparser.ConfigParser) – Configuration object.

Returns:

Sanitized configuration object.

Return type:

configparser.ConfigParser