xoa.cfgm.ConfigManager.load

ConfigManager.load(cfgfile='config.cfg', patch=None, validate=True, force=True, cfgfilter=False, **kwpatch)

Get a ConfigObj instance loaded from a file

Parameters:

• cfgfile (optional) –

  config file

  • a config file name

  • a ConfigObj instance

  • None: defaults to "config.cfg"

• patch – A ConfigObj instance, a config file or a dictionary, used for patching.

• validate (optional) –

  Type of validation

  • False: no validation

  • "fix": validation fixes and reports errors

  • "report": validation reports errors

  • "raise": validation raises errors

• force (optional) – Force re-instantiation of cfgfile when it is already a ConfigObj instance.

Returns:

tuple, ConfigObj – Depends on geterr

• if True: (cfg, err) where is the result of validate()

• else: cfg (ConfigObj instance)