boswatch.configYaml.ConfigYAML Class Reference

Public Member Functions
	__init__ (self, config=None)
	__iter__ (self)
	__len__ (self)
	returns the length of an config element
	__str__ (self)
	Returns the string representation of the internal config dict.
	loadConfigFile (self, configPath)
	loads a given configuration file
	get (self, *args, default=None)
	Get a single value from the config or a value set in a new configYAML class instance.

Protected Attributes
	_config

Constructor & Destructor Documentation

__init__()

boswatch.configYaml.ConfigYAML.__init__	(		self,
			config = None
	)

    def __init__(self, config=None):
        self._config = config
 

Member Function Documentation

__iter__()

boswatch.configYaml.ConfigYAML.__iter__

(

self

)

    def __iter__(self):
        for item in self._config:
            if type(item) is list or type(item) is dict:
                yield ConfigYAML(item)
            else:
                yield item
 

__len__()

boswatch.configYaml.ConfigYAML.__len__

(

self

)

returns the length of an config element

    def __len__(self):
        r"""!returns the length of an config element"""
        return len(self._config)
 

__str__()

boswatch.configYaml.ConfigYAML.__str__

(

self

)

Returns the string representation of the internal config dict.

    def __str__(self):
        r"""!Returns the string representation of the internal config dict"""
        return str(self._config)
 

loadConfigFile()

boswatch.configYaml.ConfigYAML.loadConfigFile	(		self,
			configPath
	)

loads a given configuration file

Parameters

configPath

Path to the config file

Returns

True or False

    def loadConfigFile(self, configPath):
        r"""!loads a given configuration file
 
        @param configPath: Path to the config file
        @return True or False"""
        logging.debug("load config file from: %s", configPath)
        try:
            with open(configPath) as file:
                # use safe_load instead load
                self._config = yaml.safe_load(file)
            return True
        except FileNotFoundError:
            logging.error("config file not found: %s", configPath)
        except yaml.parser.ParserError:
            logging.exception("syntax error in config file: %s", configPath)
        return False
 

get()

boswatch.configYaml.ConfigYAML.get	(		self,
		*	args,
			default = None
	)

Get a single value from the config or a value set in a new configYAML class instance.

Parameters

*args	Config section (one ore more strings)
default	Default value if section not found (None)

Returns

: A single value, a value set in an configYAML instance, the default value

    def get(self, *args, default=None):
        r"""!Get a single value from the config
        or a value set in a new configYAML class instance
 
        @param *args: Config section (one ore more strings)
        @param default: Default value if section not found (None)
        @return: A single value, a value set in an configYAML instance, the default value"""
        tmp = self._config
        try:
            for arg in args:
                tmp = tmp.get(arg, default)
            if type(tmp) is list or type(tmp) is dict:
                return ConfigYAML(tmp)
            else:
                return tmp
        except AttributeError:  # pragma: no cover
            return default

Field Documentation

_config

boswatch.configYaml.ConfigYAML._config

protected