config.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
from .utils import is_bytes, secs_to_timestr, timestr_to_secs
 
 
 
class ConfigurationException(Exception):
    pass
 
 
 
class Configuration():
    def __init__(self, **entries):
        self._config_config = entries
 
    def __str__(self):
        return '\n'.join('%s=%s' % (k, v) for k, v in self._config_config.items())
 
    
    def update(self, **entries):
        for name, value in entries.items():
            if value is not None:
                self._config_config[name].set(value)
 
    
    def get(self, name):
        return self._config_config[name]
 
    def __getattr__(self, name):
        if name in self._config_config:
            return self._config_config[name].value
        msg = "Configuration parameter '%s' is not defined." % name
        raise ConfigurationException(msg)
 
 
 
class Entry():
 
    def __init__(self, initial=None):
        self._value_value = self._create_value_create_value(initial)
 
    def __str__(self):
        return str(self._value_value)
 
    @property
    value = property
    
    def value(self):
        return self._value_value
 
    def set(self, value):
        self._value_value = self._parse_value_parse_value(value)
 
    def _parse_value(self, value):
        raise NotImplementedError
 
    def _create_value(self, value):
        if value is None:
            return None
        return self._parse_value_parse_value(value)
 
 
 
class StringEntry(Entry):
 
    def _parse_value(self, value):
        return str(value)
 
 
 
class IntegerEntry(Entry):
    def _parse_value(self, value):
        return int(value)
 
 
 
class TimeEntry(Entry):
    def _parse_value(self, value):
        value = str(value)
        return timestr_to_secs(value) if value else None
 
    def __str__(self):
        return secs_to_timestr(self._value_value)
 
 
 
class LogLevelEntry(Entry):
    LEVELS = ('TRACE', 'DEBUG', 'INFO', 'WARN', 'NONE')
 
    def _parse_value(self, value):
        value = str(value).upper()
        if value not in self.LEVELSLEVELS:
            raise ConfigurationException("Invalid log level '%s'." % value)
        return value
 
 
 
class NewlineEntry(Entry):
 
    def _parse_value(self, value):
        if is_bytes(value):
            value = value.decode('ASCII')
        value = value.upper()
        return value.replace('LF', '\n').replace('CR', '\r')