add some tests for values
[tiramisu.git] / tiramisu / value.py
index bfa79ac..fb62698 100644 (file)
 #
 # ____________________________________________________________
 from time import time
+from copy import copy
 from tiramisu.error import ConfigError, SlaveError
-from tiramisu.setting import owners, multitypes, expires_time
+from tiramisu.setting import owners, multitypes, expires_time, storage_type
 from tiramisu.autolib import carry_out_calculation
 from tiramisu.i18n import _
+from tiramisu.option import SymLinkOption
 
 
 class Values(object):
-    __slots__ = ('context', '_values', '_cache')
+    """The `Config`'s root is indeed  in charge of the `Option()`'s values,
+    but the values are physicaly located here, in `Values`, wich is also
+    responsible of a caching utility.
+    """
+    __slots__ = ('context', '_p_')
 
-    def __init__(self, context):
+    def __init__(self, context, storage):
         """
         Initializes the values's dict.
 
         :param context: the context is the home config's values
+
         """
-        "Config's root indeed is in charge of the `Option()`'s values"
         self.context = context
-        self._values = {}
-        self._cache = {}
-        super(Values, self).__init__()
-
-    def _get_value(self, opt):
-        "return value or default value if not set"
-        #if no value
-        if opt not in self._values:
-            value = opt.getdefault()
-            if opt.is_multi():
-                value = Multi(value, self.context, opt)
+        # the storage type is dictionary or sqlite3
+        import_lib = 'tiramisu.storage.{0}.value'.format(storage_type)
+        self._p_ = __import__(import_lib, globals(), locals(), ['Values'],
+                              -1).Values(storage)
+
+    def _getdefault(self, opt):
+        """
+        actually retrieves the default value
+
+        :param opt: the `option.Option()` object
+        """
+        meta = self.context.cfgimpl_get_meta()
+        if meta is not None:
+            value = meta.cfgimpl_get_values()[opt]
+        else:
+            value = opt.impl_getdefault()
+        if opt.impl_is_multi():
+            return copy(value)
         else:
-            #if value
-            value = self._values[opt][1]
+            return value
+
+    def _getvalue(self, opt, path, validate=True):
+        """actually retrieves the value
+
+        :param opt: the `option.Option()` object
+        :returns: the option's value (or the default value if not set)
+        """
+        if not self._p_.hasvalue(path):
+            # if there is no value
+            value = self._getdefault(opt)
+            if opt.impl_is_multi():
+                value = Multi(value, self.context, opt, path, validate)
+        else:
+            # if there is a value
+            value = self._p_.getvalue(path)
+            if opt.impl_is_multi() and not isinstance(value, Multi):
+                # load value so don't need to validate if is not a Multi
+                value = Multi(value, self.context, opt, path, validate=False)
         return value
 
-    def __delitem__(self, opt):
-        self._reset(opt)
+    def get_modified_values(self):
+        return self._p_.get_modified_values()
 
-    def _reset(self, opt):
-        if opt in self._values:
+    def __contains__(self, opt):
+        """
+        implements the 'in' keyword syntax in order provide a pythonic way
+        to kow if an option have a value
+
+        :param opt: the `option.Option()` object
+        """
+        path = self._get_opt_path(opt)
+        return self._contains(path)
+
+    def _contains(self, path):
+        return self._p_.hasvalue(path)
+
+    def __delitem__(self, opt):
+        """overrides the builtins `del()` instructions"""
+        self.reset(opt)
+
+    def reset(self, opt, path=None):
+        if path is None:
+            path = self._get_opt_path(opt)
+        if self._p_.hasvalue(path):
+            setting = self.context.cfgimpl_get_settings()
+            opt.impl_validate(opt.impl_getdefault(), self.context,
+                              'validator' in setting)
             self.context.cfgimpl_reset_cache()
-            del(self._values[opt])
+            if (opt.impl_is_multi() and
+                    opt.impl_get_multitype() == multitypes.master):
+                for slave in opt.impl_get_master_slaves():
+                    self.reset(slave)
+            self._p_.resetvalue(path)
 
-    def _is_empty(self, opt, value):
+    def _isempty(self, opt, value):
         "convenience method to know if an option is empty"
         empty = opt._empty
-        if (not opt.is_multi() and (value is None or value == empty)) or \
-           (opt.is_multi() and (value == [] or
-                                None in value or empty in value)):
-            return True
-        if self.is_default_owner(opt) and opt.is_empty_by_default():
+        if (not opt.impl_is_multi() and (value is None or value == empty)) or \
+           (opt.impl_is_multi() and (value == [] or
+                                     None in value or empty in value)):
             return True
         return False
 
-    def _getcallback_value(self, opt):
+    def _getcallback_value(self, opt, index=None):
+        """
+        retrieves a value for the options that have a callback
+
+        :param opt: the `option.Option()` object
+        :param index: if an option is multi, only calculates the nth value
+        :type index: int
+        :returns: a calculated value
+        """
         callback, callback_params = opt._callback
         if callback_params is None:
             callback_params = {}
         return carry_out_calculation(opt._name, config=self.context,
                                      callback=callback,
-                                     callback_params=callback_params)
+                                     callback_params=callback_params,
+                                     index=index)
 
     def __getitem__(self, opt):
+        "enables us to use the pythonic dictionnary-like access to values"
         return self.getitem(opt)
 
-    def getitem(self, opt, validate=True, force_permissive=False,
-                force_properties=None):
-        if opt in self._cache:
-            exp = time()
-            value, created = self._cache[opt]
-            if exp < created:
+    def getitem(self, opt, path=None, validate=True, force_permissive=False,
+                force_properties=None, validate_properties=True):
+        ntime = None
+        if path is None:
+            path = self._get_opt_path(opt)
+        if self._p_.hascache('value', path):
+            ntime = time()
+            is_cached, value = self._p_.getcache('value', path, ntime)
+            if is_cached:
+                if opt.impl_is_multi() and not isinstance(value, Multi):
+                    #load value so don't need to validate if is not a Multi
+                    value = Multi(value, self.context, opt, path, validate=False)
                 return value
-        val = self._getitem(opt, validate, force_permissive, force_properties)
-        self._set_cache(opt, val)
+        val = self._getitem(opt, path, validate, force_permissive, force_properties,
+                            validate_properties)
+        if 'expire' in self.context.cfgimpl_get_settings() and validate and \
+                validate_properties and force_permissive is False and \
+                force_properties is None:
+            if ntime is None:
+                ntime = time()
+            self._p_.setcache('value', path, val, ntime + expires_time)
+
         return val
 
-    def _getitem(self, opt, validate, force_permissive, force_properties):
+    def _getitem(self, opt, path, validate, force_permissive, force_properties,
+                 validate_properties):
         # options with callbacks
         setting = self.context.cfgimpl_get_settings()
-        value = self._get_value(opt)
-        is_frozen = setting.has_property('frozen', opt)
-        if opt.has_callback():
-            #if value is set and :
-            # - not frozen
-            # - frozen and not force_default_on_freeze
-            if not self.is_default_owner(opt) and (
-                    not is_frozen or (is_frozen and
-                                      not setting.has_property('force_default_on_freeze', opt))):
-                pass
-            else:
+        is_frozen = 'frozen' in setting[opt]
+        # if value is callback and is not set
+        # or frozen with force_default_on_freeze
+        if opt.impl_has_callback() and (
+                self._is_default_owner(path) or
+                (is_frozen and 'force_default_on_freeze' in setting[opt])):
+            no_value_slave = False
+            if (opt.impl_is_multi() and
+                    opt.impl_get_multitype() == multitypes.slave):
+                masterp = self._get_opt_path(opt.impl_get_master_slaves())
+                mastervalue = getattr(self.context, masterp)
+                lenmaster = len(mastervalue)
+                if lenmaster == 0:
+                    value = []
+                    no_value_slave = True
+
+            if not no_value_slave:
                 value = self._getcallback_value(opt)
-                if opt.is_multi():
-                    value = Multi(value, self.context, opt)
-                #suppress value if already set
-                self._reset(opt)
+                if (opt.impl_is_multi() and
+                        opt.impl_get_multitype() == multitypes.slave):
+                    if not isinstance(value, list):
+                        value = [value for i in range(lenmaster)]
+            if opt.impl_is_multi():
+                value = Multi(value, self.context, opt, path, validate)
+            # suppress value if already set
+            self.reset(opt, path)
         # frozen and force default
-        elif is_frozen and setting.has_property('force_default_on_freeze', opt):
-            value = opt.getdefault()
-            if opt.is_multi():
-                value = Multi(value, self.context, opt)
-        if validate and not opt.validate(value, self.context, setting.has_property('validator')):
-            raise ValueError(_('invalid calculated value returned'
-                             ' for option {0}: {1}').format(opt._name, value))
-        if self.is_default_owner(opt) and \
-                setting.has_property('force_store_value', opt):
-            self.setitem(opt, value)
-        setting.validate_properties(opt, False, False, value=value,
-                                    force_permissive=force_permissive,
-                                    force_properties=force_properties)
+        elif is_frozen and 'force_default_on_freeze' in setting[opt]:
+            value = self._getdefault(opt)
+            if opt.impl_is_multi():
+                value = Multi(value, self.context, opt, path, validate)
+        else:
+            value = self._getvalue(opt, path, validate)
+        if validate:
+            opt.impl_validate(value, self.context, 'validator' in setting)
+        if self._is_default_owner(path) and \
+                'force_store_value' in setting[opt]:
+            self.setitem(opt, value, path, is_write=False)
+        if validate_properties:
+            setting.validate_properties(opt, False, False, value=value, path=path,
+                                        force_permissive=force_permissive,
+                                        force_properties=force_properties)
         return value
 
     def __setitem__(self, opt, value):
-        self.setitem(opt, value)
-
-    def setitem(self, opt, value, force_permissive=False):
-        self._setitem(opt, value, force_permissive)
-
-    def _setitem(self, opt, value, force_permissive=False, force_properties=None):
-        #valid opt
-        if not opt.validate(value, self.context,
-                            self.context.cfgimpl_get_settings().has_property('validator')):
-            raise ValueError(_('invalid value {}'
-                             ' for option {}').format(value, opt._name))
-        if opt.is_multi() and not isinstance(value, Multi):
-            value = Multi(value, self.context, opt)
-        self._setvalue(opt, value, force_permissive=force_permissive,
-                       force_properties=force_properties)
-
-    def _setvalue(self, opt, value, force_permissive=False, force_properties=None):
+        raise ValueError('you should only set value with config')
+
+    def setitem(self, opt, value, path, force_permissive=False,
+                is_write=True):
+        # is_write is, for example, used with "force_store_value"
+        # user didn't change value, so not write
+        # valid opt
+        opt.impl_validate(value, self.context,
+                          'validator' in self.context.cfgimpl_get_settings())
+        if opt.impl_is_multi() and not isinstance(value, Multi):
+            value = Multi(value, self.context, opt, path)
+        self._setvalue(opt, path, value, force_permissive=force_permissive,
+                       is_write=is_write)
+
+    def _setvalue(self, opt, path, value, force_permissive=False,
+                  force_properties=None,
+                  is_write=True, validate_properties=True):
         self.context.cfgimpl_reset_cache()
-        setting = self.context.cfgimpl_get_settings()
-        setting.validate_properties(opt, False, True,
-                                    value=value,
-                                    force_permissive=force_permissive,
-                                    force_properties=force_properties)
-        self._values[opt] = (setting.getowner(), value)
+        if validate_properties:
+            setting = self.context.cfgimpl_get_settings()
+            setting.validate_properties(opt, False, is_write,
+                                        value=value, path=path,
+                                        force_permissive=force_permissive,
+                                        force_properties=force_properties)
+        owner = self.context.cfgimpl_get_settings().getowner()
+        self._p_.setvalue(path, value, owner)
 
     def getowner(self, opt):
-        return self._values.get(opt, (owners.default, None))[0]
+        """
+        retrieves the option's owner
+
+        :param opt: the `option.Option` object
+        :returns: a `setting.owners.Owner` object
+        """
+        if isinstance(opt, SymLinkOption):
+            opt = opt._opt
+        path = self._get_opt_path(opt)
+        return self._getowner(path)
+
+    def _getowner(self, path):
+        owner = self._p_.getowner(path, owners.default)
+        meta = self.context.cfgimpl_get_meta()
+        if owner is owners.default and meta is not None:
+            owner = meta.cfgimpl_get_values()._getowner(path)
+        return owner
 
     def setowner(self, opt, owner):
-        if opt not in self._values:
-            raise ConfigError(_('no value for {1} cannot change owner to {2}').format(opt))
+        """
+        sets a owner to an option
+
+        :param opt: the `option.Option` object
+        :param owner: a valid owner, that is a `setting.owners.Owner` object
+        """
         if not isinstance(owner, owners.Owner):
             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
-        self._values[opt] = (owner, self._values[opt][1])
+
+        path = self._get_opt_path(opt)
+        self._setowner(path, owner)
+
+    def _setowner(self, path, owner):
+        if self._getowner(path) == owners.default:
+            raise ConfigError(_('no value for {0} cannot change owner to {1}'
+                                '').format(path, owner))
+        self._p_.setowner(path, owner)
 
     def is_default_owner(self, opt):
         """
@@ -169,25 +289,29 @@ class Values(object):
                        (not the toplevel config)
         :return: boolean
         """
-        return self.getowner(opt) == owners.default
+        path = self._get_opt_path(opt)
+        return self._is_default_owner(path)
 
-    def _set_cache(self, opt, val):
-        if self.context.cfgimpl_get_settings().has_property('expire'):
-            self._cache[opt] = (val, time() + expires_time)
+    def _is_default_owner(self, path):
+        return self._getowner(path) == owners.default
 
     def reset_cache(self, only_expired):
+        """
+        clears the cache if necessary
+        """
         if only_expired:
-            exp = time()
-            keys = self._cache.keys()
-            for key in keys:
-                val, created = self._cache[key]
-                if exp > created:
-                    del(self._cache[key])
+            self._p_.reset_expired_cache('value', time())
         else:
-            self._cache.clear()
+            self._p_.reset_all_cache('value')
 
-    def __contains__(self, opt):
-        return opt in self._values
+    def _get_opt_path(self, opt):
+        """
+        retrieve the option's path in the config
+
+        :param opt: the `option.Option` object
+        :returns: a string with points like "gc.dummy.my_option"
+        """
+        return self.context.cfgimpl_get_description().impl_get_path_by_opt(opt)
 
 # ____________________________________________________________
 # multi types
@@ -196,38 +320,41 @@ class Values(object):
 class Multi(list):
     """multi options values container
     that support item notation for the values of multi options"""
-    __slots__ = ('opt', 'context')
+    __slots__ = ('opt', 'path', 'context')
 
-    def __init__(self, value, context, opt):
+    def __init__(self, value, context, opt, path, validate=True):
         """
         :param value: the Multi wraps a list value
         :param context: the home config that has the values
         :param opt: the option object that have this Multi value
         """
         self.opt = opt
+        self.path = path
         self.context = context
         if not isinstance(value, list):
             value = [value]
-        if self.opt.get_multitype() == multitypes.slave:
+        if validate and self.opt.impl_get_multitype() == multitypes.slave:
             value = self._valid_slave(value)
-        elif self.opt.get_multitype() == multitypes.master:
+        elif self.opt.impl_get_multitype() == multitypes.master:
             self._valid_master(value)
         super(Multi, self).__init__(value)
 
     def _valid_slave(self, value):
         #if slave, had values until master's one
-        masterp = self.context.cfgimpl_get_description().get_path_by_opt(
-            self.opt.get_master_slaves())
+        masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
+            self.opt.impl_get_master_slaves())
         mastervalue = getattr(self.context, masterp)
         masterlen = len(mastervalue)
-        if len(value) > masterlen or (len(value) < masterlen and
-                                      not self.context.cfgimpl_get_values().is_default_owner(self.opt)):
+        valuelen = len(value)
+        if valuelen > masterlen or (valuelen < masterlen and
+                                    not self.context.cfgimpl_get_values(
+                                    )._is_default_owner(self.path)):
             raise SlaveError(_("invalid len for the slave: {0}"
                                " which has {1} as master").format(
                                    self.opt._name, masterp))
-        elif len(value) < masterlen:
-            for num in range(0, masterlen - len(value)):
-                value.append(self.opt.getdefault_multi())
+        elif valuelen < masterlen:
+            for num in range(0, masterlen - valuelen):
+                value.append(self.opt.impl_getdefault_multi())
         #else: same len so do nothing
         return value
 
@@ -235,8 +362,9 @@ class Multi(list):
         masterlen = len(value)
         values = self.context.cfgimpl_get_values()
         for slave in self.opt._master_slaves:
-            if not values.is_default_owner(slave):
-                value_slave = values._get_value(slave)
+            path = values._get_opt_path(slave)
+            if not values._is_default_owner(path):
+                value_slave = values._getvalue(slave, path)
                 if len(value_slave) > masterlen:
                     raise SlaveError(_("invalid len for the master: {0}"
                                        " which has {1} as slave with"
@@ -244,38 +372,87 @@ class Multi(list):
                                            self.opt._name, slave._name))
                 elif len(value_slave) < masterlen:
                     for num in range(0, masterlen - len(value_slave)):
-                        value_slave.append(slave.getdefault_multi(), force=True)
+                        value_slave.append(slave.impl_getdefault_multi(),
+                                           force=True)
 
     def __setitem__(self, key, value):
         self._validate(value)
         #assume not checking mandatory property
-        self.context.cfgimpl_get_values()._setvalue(self.opt, self)
         super(Multi, self).__setitem__(key, value)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
 
     def append(self, value, force=False):
         """the list value can be updated (appened)
         only if the option is a master
         """
         if not force:
-            if self.opt.get_multitype() == multitypes.slave:
+            if self.opt.impl_get_multitype() == multitypes.slave:
                 raise SlaveError(_("cannot append a value on a multi option {0}"
                                    " which is a slave").format(self.opt._name))
-            elif self.opt.get_multitype() == multitypes.master:
-                for slave in self.opt.get_master_slaves():
-                    values = self.context.cfgimpl_get_values()
-                    if not values.is_default_owner(slave):
-                        values[slave].append(slave.getdefault_multi(),
-                                             force=True)
+            elif self.opt.impl_get_multitype() == multitypes.master:
+                values = self.context.cfgimpl_get_values()
+                if value is None and self.opt.impl_has_callback():
+                    value = values._getcallback_value(self.opt)
+                    #Force None il return a list
+                    if isinstance(value, list):
+                        value = None
         self._validate(value)
-        #assume not checking mandatory property
-        self.context.cfgimpl_get_values()._setvalue(self.opt, self)
         super(Multi, self).append(value)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
+        if not force and self.opt.impl_get_multitype() == multitypes.master:
+            for slave in self.opt.impl_get_master_slaves():
+                path = values._get_opt_path(slave)
+                if not values._is_default_owner(path):
+                    if slave.impl_has_callback():
+                        index = self.__len__() - 1
+                        dvalue = values._getcallback_value(slave, index=index)
+                    else:
+                        dvalue = slave.impl_getdefault_multi()
+                    values.getitem(slave, path,
+                                   validate_properties=False).append(
+                                       dvalue, force=True)
+
+    def sort(self, cmp=None, key=None, reverse=False):
+        if self.opt.impl_get_multitype() in [multitypes.slave,
+                                             multitypes.master]:
+            raise SlaveError(_("cannot sort multi option {0} if master or slave"
+                               "").format(self.opt._name))
+        super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
+
+    def reverse(self):
+        if self.opt.impl_get_multitype() in [multitypes.slave,
+                                             multitypes.master]:
+            raise SlaveError(_("cannot reverse multi option {0} if master or "
+                               "slave").format(self.opt._name))
+        super(Multi, self).reverse()
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
+
+    def insert(self, index, obj):
+        if self.opt.impl_get_multitype() in [multitypes.slave,
+                                             multitypes.master]:
+            raise SlaveError(_("cannot insert multi option {0} if master or "
+                               "slave").format(self.opt._name))
+        super(Multi, self).insert(index, obj)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
+
+    def extend(self, iterable):
+        if self.opt.impl_get_multitype() in [multitypes.slave,
+                                             multitypes.master]:
+            raise SlaveError(_("cannot extend multi option {0} if master or "
+                               "slave").format(self.opt._name))
+        super(Multi, self).extend(iterable)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
 
     def _validate(self, value):
-        if value is not None and not self.opt._validate(value):
-            raise ValueError(_("invalid value {0} "
-                             "for option {1}").format(str(value),
-                                                      self.opt._name))
+        if value is not None:
+            try:
+                self.opt._validate(value)
+            except ValueError, err:
+                raise ValueError(_("invalid value {0} "
+                                   "for option {1}: {2}"
+                                   "").format(str(value),
+                                              self.opt._name, err))
 
     def pop(self, key, force=False):
         """the list value can be updated (poped)
@@ -285,11 +462,18 @@ class Multi(list):
         :return: the requested element
         """
         if not force:
-            if self.opt.get_multitype() == multitypes.slave:
+            if self.opt.impl_get_multitype() == multitypes.slave:
                 raise SlaveError(_("cannot pop a value on a multi option {0}"
                                    " which is a slave").format(self.opt._name))
-            elif self.opt.get_multitype() == multitypes.master:
-                for slave in self.opt.get_master_slaves():
-                    self.context.cfgimpl_get_values()[slave].pop(key, force=True)
-        self.context.cfgimpl_get_values()._setvalue(self.opt, self)
-        return super(Multi, self).pop(key)
+            elif self.opt.impl_get_multitype() == multitypes.master:
+                for slave in self.opt.impl_get_master_slaves():
+                    values = self.context.cfgimpl_get_values()
+                    if not values.is_default_owner(slave):
+                        #get multi without valid properties
+                        values.getitem(slave,
+                                       validate_properties=False
+                                       ).pop(key, force=True)
+        #set value without valid properties
+        ret = super(Multi, self).pop(key)
+        self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
+        return ret