urclib.settings

Module for loading and saving user-defined runtime settings.

Module Contents

Functions

save_settings(path, out_dict)	Save run configuration settings to disk.
load_settings(path)	Load saved settings from a file.
default_settings()	Retrieve default user settings for an initial state.

Attributes

SETTINGS_VERSION

urclib.settings.SETTINGS_VERSION = [0, 0, 1]

urclib.settings.save_settings(path, out_dict)

Save run configuration settings to disk.

Parameters:

• path (str) – The path to the (*.json) file to write.

• out_dict (dict) – Dict of settings to save.

urclib.settings.load_settings(path)

Load saved settings from a file.

Parameters:

path (str) – The path to the (*.json) file to load.

Returns:

The settings found in the file at path.

Return type:

dict

urclib.settings.default_settings()

Retrieve default user settings for an initial state.

Returns:

The default values for various settings.

Return type:

dict