compass.utilities.parsing.load_config#

load_config(config_fp)[source]#

Load configuration data from JSON or JSON5 sources

Parameters:

config_fp (path-like) – Path to config file to open and load.

Returns:

dict – Parsed configuration object.

Raises:

COMPASSValueError – If the file path does not exist or the extension is not .json or .json5.

Notes

JSON5 enables comments and trailing commas, among other quality-of-life improvements over vanilla JSON.