Config

APIs to process config files

exception nest.config.NestConfigInitializationError

Bases: NestBaseException

Exception related to error in Initializaton of NeST config from config file.

nest.config.get_value(parameter)

Returns the default value of the parameter

nest.config.parameter

The parameter whose value is to be returned

Type:

str

Returns:

The value of the parameter

Return type:

str

nest.config.import_custom_config(path: str)

Overwrites the current value of config parameters with the values from the JSON in the given path

nest.config.path

The path in which the json file

Type:

str

nest.config.import_default_config()

Reads config.json file from necessary specified file locations and converts it into a string

Returns:

The information in the default config file as a python dictionary

Return type:

dict

nest.config.search_config_files()

Searches a few predifined locations for a config files

nest.config.set_value(parameter: str, value)

Changes the default values only for that program

nest.config.parameter

The parameter’s value which has to be changed

Type:

str

nest.config.value

The value to which the parameter has to be changed to

Type:

str