ctdclient.configurationhandler module

class ctdclient.configurationhandler.ConfigurationFile(path_to_config)

Bases: object

A python representation of the configuration file, ctdclient.toml . The individual key value pairs can be targeted via basic dict-like chaining of keys, e.g.: config[‘user’][‘processing’][‘psas’]

read_config(ctd_type=None)

read_ctd_config(ctd_type)

set_config(ctd_type)

write(current_platform=None, use_internal_values=True, path_to_write=None)

Writes changes to the configuration file to the disk.

Parameters:

path_to_write – (Default value = None)

modify(key, value)

Modifies the configuration values inside of this python representation. Does not write anything to disk.

Parameters:

• key

• value

reload()

Reopens the configuration file.

exception ctdclient.configurationhandler.InvalidConfigFile(message)

Bases: Exception

Raise when config is missing a critical value