preffect_cli.py module

preffect_cli.read_config_file(file_path)

Reads and parses a configuration file.

Parameters:

file_path (str) -- The path to the configuration file (_config.py) to be read.

Returns:

A ConfigParser object containing the data from the configuration file.

Return type:

configparser.ConfigParser

preffect_cli.str2bool(v)

Converts a string representation of truth to a boolean.

Parameters:

v (str or bool) -- The value to convert into a boolean. Accepts 'yes', 'true', 't', 'y', '1', and their respective false values 'no', 'false', 'f', 'n', '0'. Also accepts and returns a boolean value directly if v is already of type boolean.

Returns:

The boolean value corresponding to the input.

Return type:

bool

Raises:

argparse.ArgumentTypeError -- If the input string does not correspond to expected true or false values.