key is now always path and change opt by path dictionary storage
[tiramisu.git] / tiramisu / setting.py
index f2210e0..0b87fbe 100644 (file)
@@ -26,11 +26,15 @@ from tiramisu.error import RequirementError, PropertiesOptionError
 from tiramisu.i18n import _
 
 
+default_encoding = 'utf-8'
 expires_time = 5
 ro_remove = ('permissive', 'hidden')
-ro_append = ('frozen', 'disabled', 'validator', 'everything_frozen', 'mandatory')
+ro_append = ('frozen', 'disabled', 'validator', 'everything_frozen',
+             'mandatory')
 rw_remove = ('permissive', 'everything_frozen', 'mandatory')
 rw_append = ('frozen', 'disabled', 'validator', 'hidden')
+default_properties = ('expire', 'validator')
+storage_type = 'dictionary'
 
 
 class _const:
@@ -41,12 +45,12 @@ class _const:
 
     def __setattr__(self, name, value):
         if name in self.__dict__:
-            raise self.ConstError, _("Can't rebind group ({})").format(name)
+            raise self.ConstError, _("can't rebind group ({})").format(name)
         self.__dict__[name] = value
 
     def __delattr__(self, name):
         if name in self.__dict__:
-            raise self.ConstError, _("Can't unbind group ({})").format(name)
+            raise self.ConstError, _("can't unbind group ({})").format(name)
         raise ValueError(name)
 
 
@@ -148,23 +152,25 @@ populate_multitypes()
 
 class Property(object):
     "a property is responsible of the option's value access rules"
-    __slots__ = ('_setting', '_properties', '_opt')
+    __slots__ = ('_setting', '_properties', '_opt', '_path')
 
-    def __init__(self, setting, prop, opt=None):
+    def __init__(self, setting, prop, opt=None, path=None):
         self._opt = opt
+        self._path = path
         self._setting = setting
         self._properties = prop
 
     def append(self, propname):
         self._properties.add(propname)
-        self._setting._set_properties(self._properties, self._opt)
-        self._setting.context.cfgimpl_reset_cache()
+        self._setting._setproperties(self._properties, self._opt, self._path)
 
     def remove(self, propname):
         if propname in self._properties:
             self._properties.remove(propname)
-            self._setting._set_properties(self._properties, self._opt)
-            self._setting.context.cfgimpl_reset_cache()
+            self._setting._setproperties(self._properties, self._opt, self._path)
+
+    def reset(self):
+        self._setting.reset(path=self._path)
 
     def __contains__(self, propname):
         return propname in self._properties
@@ -174,120 +180,167 @@ class Property(object):
 
 
 #____________________________________________________________
-class Setting(object):
+class Settings(object):
     "``Config()``'s configuration options"
-    __slots__ = ('context', '_properties', '_permissives', '_owner', '_cache')
-
-    def __init__(self, context):
-        # properties attribute: the name of a property enables this property
-        # key is None for global properties
-        self._properties = {None: set(('expire', 'validator'))}
-        # permissive properties
-        self._permissives = {}
+    __slots__ = ('context', '_owner', '_p_')
+
+    def __init__(self, context, storage):
+        """
+        initializer
+
+        :param context: the root config
+        :param storage: the storage type
+
+                        - dictionnary -> in memory
+                        - sqlite3 -> persistent
+        """
         # generic owner
         self._owner = owners.user
         self.context = context
-        self._cache = {}
+        import_lib = 'tiramisu.storage.{0}.setting'.format(storage_type)
+        self._p_ = __import__(import_lib, globals(), locals(), ['Settings'],
+                              -1).Settings(storage)
 
     #____________________________________________________________
     # properties methods
     def __contains__(self, propname):
-        return propname in self._get_properties()
+        "enables the pythonic 'in' syntaxic sugar"
+        return propname in self._getproperties()
 
     def __repr__(self):
-        return str(list(self._get_properties()))
+        return str(list(self._getproperties()))
 
     def __getitem__(self, opt):
-        return Property(self, self._get_properties(opt), opt)
+        if opt is None:
+            path = None
+        else:
+            path = self._get_opt_path(opt)
+        return self._getitem(opt, path)
+
+    def _getitem(self, opt, path):
+        return Property(self, self._getproperties(opt, path), opt, path)
 
     def __setitem__(self, opt, value):
         raise ValueError('you must only append/remove properties')
 
-    def _get_properties(self, opt=None, is_apply_req=True):
+    def reset(self, opt=None, all_properties=False):
+        if all_properties and opt:
+            raise ValueError(_('opt and all_properties must not be set '
+                               'together in reset'))
+        if all_properties:
+            self._p_.reset_all_propertives()
+        else:
+            if opt is None:
+                path = None
+            else:
+                path = self._get_opt_path(opt)
+            self._p_.reset_properties(path)
+        self.context.cfgimpl_reset_cache()
+
+    def _getproperties(self, opt=None, path=None, is_apply_req=True):
         if opt is None:
-            props = self._properties.get(opt, set())
+            props = self._p_.getproperties(path, default_properties)
         else:
-            exp = None
-            if opt in self._cache:
-                exp = time()
-                props, created = self._cache[opt]
-                if exp < created:
+            if path is None:
+                raise ValueError(_('if opt is not None, path should not be None in _getproperties'))
+            ntime = None
+            if self._p_.hascache('property', path):
+                ntime = time()
+                is_cached, props = self._p_.getcache('property', path, ntime)
+                if is_cached:
                     return props
             if is_apply_req:
-                self.apply_requires(opt)
-            props = self._properties.get(opt, opt._properties)
-            self._set_cache(opt, props, exp)
+                self.apply_requires(opt, path)
+            props = self._p_.getproperties(path, opt._properties)
+            if 'expire' in self:
+                if ntime is None:
+                    ntime = time()
+                self._p_.setcache('property', path, props, ntime + expires_time)
         return props
 
     def append(self, propname):
         "puts property propname in the Config's properties attribute"
-        Property(self, self._get_properties()).append(propname)
+        Property(self, self._getproperties()).append(propname)
 
     def remove(self, propname):
         "deletes property propname in the Config's properties attribute"
-        Property(self, self._get_properties()).remove(propname)
+        Property(self, self._getproperties()).remove(propname)
 
-    def _set_properties(self, properties, opt=None):
+    def _setproperties(self, properties, opt, path):
         """save properties for specified opt
         (never save properties if same has option properties)
         """
         if opt is None:
-            self._properties[opt] = properties
+            self._p_.setproperties(path, properties)
         else:
-            if opt._properties == properties:
-                if opt in self._properties:
-                    del(self._properties[opt])
+            if set(opt._properties) == properties:
+                self._p_.reset_properties(path)
             else:
-                self._properties[opt] = properties
+                self._p_.setproperties(path, properties)
+        self.context.cfgimpl_reset_cache()
 
     #____________________________________________________________
-    def validate_properties(self, opt_or_descr, is_descr, is_write,
+    def validate_properties(self, opt_or_descr, is_descr, is_write, path,
                             value=None, force_permissive=False,
                             force_properties=None):
-        #opt properties
-        properties = copy(self._get_properties(opt_or_descr))
-        #remove opt permissive
-        properties -= self._get_permissive(opt_or_descr)
-        #remove global permissive if need
-        self_properties = copy(self._get_properties())
+        """
+        validation upon the properties related to `opt_or_descr`
+
+        :param opt_or_descr: an option or an option description object
+        :param force_permissive: behaves as if the permissive property was present
+        :param is_descr: we have to know if we are in an option description,
+                         just because the mandatory property doesn't exist there
+
+        :param is_write: in the validation process, an option is to be modified,
+                         the behavior can be different (typically with the `frozen`
+                         property)
+        """
+        # opt properties
+        properties = copy(self._getproperties(opt_or_descr, path))
+        # remove opt permissive
+        properties -= self._p_.getpermissive(path)
+        # remove global permissive if need
+        self_properties = copy(self._getproperties())
         if force_permissive is True or 'permissive' in self_properties:
-            properties -= self._get_permissive()
+            properties -= self._p_.getpermissive()
 
-        #global properties
+        # global properties
         if force_properties is not None:
             self_properties.update(force_properties)
 
-        #calc properties
+        # calc properties
         properties &= self_properties
-        #mandatory and frozen are special properties
+        # mandatory and frozen are special properties
         if is_descr:
             properties -= frozenset(('mandatory', 'frozen'))
         else:
             if 'mandatory' in properties and \
-                    not self.context.cfgimpl_get_values()._is_empty(opt_or_descr,
-                                                                    value):
+                    not self.context.cfgimpl_get_values()._isempty(
+                        opt_or_descr, value):
                 properties.remove('mandatory')
             if is_write and 'everything_frozen' in self_properties:
                 properties.add('frozen')
             elif 'frozen' in properties and not is_write:
                 properties.remove('frozen')
-
+        # at this point an option should not remain in properties
         if properties != frozenset():
+            props = list(properties)
             if 'frozen' in properties:
-                raise_text = 'cannot change the value for option {0} this option is frozen'
+                raise PropertiesOptionError(_('cannot change the value for '
+                                              'option {0} this option is'
+                                              ' frozen').format(
+                                                  opt_or_descr._name),
+                                            props)
             else:
-                raise_text = "trying to access to an option named: {0} with properties {1}"
-            raise PropertiesOptionError(_(raise_text).format(opt_or_descr._name,
-                                        str(list(properties))),
-                                        list(properties))
-
-    def _get_permissive(self, opt=None):
-        return self._permissives.get(opt, frozenset())
+                raise PropertiesOptionError(_("trying to access to an option "
+                                              "named: {0} with properties {1}"
+                                              "").format(opt_or_descr._name,
+                                                         str(props)), props)
 
-    def set_permissive(self, permissive, opt=None):
+    def setpermissive(self, permissive, path=None):
         if not isinstance(permissive, tuple):
             raise TypeError(_('permissive must be a tuple'))
-        self._permissives[opt] = frozenset(permissive)
+        self._p_.setpermissive(path, permissive)
 
     #____________________________________________________________
     def setowner(self, owner):
@@ -314,61 +367,60 @@ class Setting(object):
         "convenience method to freeze, hidde and disable"
         self._read(rw_remove, rw_append)
 
-    def _set_cache(self, opt, props, exp):
-        if 'expire' in self:
-            if exp is None:
-                exp = time()
-            self._cache[opt] = (props, time() + expires_time)
-
     def reset_cache(self, only_expired):
         if only_expired:
-            exp = time()
-            keys = self._cache.keys()
-            for key in keys:
-                props, created = self._cache[key]
-                if exp > created:
-                    del(self._cache[key])
+            self._p_.reset_expired_cache('property', time())
         else:
-            self._cache.clear()
+            self._p_.reset_all_cache('property')
 
-    def apply_requires(self, opt):
+    def apply_requires(self, opt, path):
         "carries out the jit (just in time requirements between options"
         if opt._requires is None:
             return
 
         # filters the callbacks
-        setting = Property(self, self._get_properties(opt, False), opt)
+        setting = Property(self, self._getproperties(opt, path, False), opt, path=path)
         descr = self.context.cfgimpl_get_description()
-        optpath = descr.impl_get_path_by_opt(opt)
         for requires in opt._requires:
             matches = False
             for require in requires:
-                option, expected, action, inverse, transitive, same_action = require
-                path = descr.impl_get_path_by_opt(option)
-                if path == optpath or path.startswith(optpath + '.'):
+                option, expected, action, inverse, \
+                    transitive, same_action = require
+                reqpath = self._get_opt_path(option)
+                if reqpath == path or reqpath.startswith(path + '.'):
                     raise RequirementError(_("malformed requirements "
-                                             "imbrication detected for option: '{0}' "
-                                             "with requirement on: '{1}'").format(optpath, path))
+                                             "imbrication detected for option:"
+                                             " '{0}' with requirement on: "
+                                             "'{1}'").format(path, reqpath))
                 try:
-                    value = self.context._getattr(path, force_permissive=True)
+                    value = self.context._getattr(reqpath, force_permissive=True)
                 except PropertiesOptionError, err:
                     if not transitive:
                         continue
                     properties = err.proptype
                     if same_action and action not in properties:
-                        raise RequirementError(_("option '{0}' has requirement's property error: "
-                                                 "{1} {2}").format(opt._name, path, properties))
-                    #transitive action, force expected
-                    value = expected
+                        raise RequirementError(_("option '{0}' has "
+                                                 "requirement's property "
+                                                 "error: "
+                                                 "{1} {2}").format(opt._name,
+                                                                   reqpath,
+                                                                   properties))
+                    # transitive action, force expected
+                    value = expected[0]
                     inverse = False
                 except AttributeError:
                     raise AttributeError(_("required option not found: "
-                                           "{0}").format(path))
-                if not inverse and value == expected or inverse and value != expected:
+                                           "{0}").format(reqpath))
+                if (not inverse and
+                        value in expected or
+                        inverse and value not in expected):
                     matches = True
                     setting.append(action)
-                    ## the calculation cannot be carried out
+                    # the calculation cannot be carried out
                     break
             # no requirement has been triggered, then just reverse the action
             if not matches:
                 setting.remove(action)
+
+    def _get_opt_path(self, opt):
+        return self.context.cfgimpl_get_description().impl_get_path_by_opt(opt)