Infra/tiramisu
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Manipulate properties is now more convenient:

Browse Source 
c.cfgimpl_get_settings().has_property('hidden') => 'hidden' in c.cfgimpl_get_settings()
c.cfgimpl_get_settings().has_property('hidden', option1) => 'frozen' in c.cfgimpl_get_settings()[opt]

c.cfgimpl_get_settings().get_properties(option1) => c.cfgimpl_get_settings()[option1]
c.cfgimpl_get_settings().get_properties(option1) => c.cfgimpl_get_settings()[option1]

c.cfgimpl_get_settings().add_property('hidden', option1) => c.cfgimpl_get_settings()[optiont1].append('hidden')
c.cfgimpl_get_settings().del_property('hidden', option1) => c.cfgimpl_get_settings()[optiont1].remove('hidden')

c.cfgimpl_get_settings().enable_property('hidden') => c.cfgimpl_get_settings().append('hidden')
c.cfgimpl_get_settings().disable_property('hidden') => c.cfgimpl_get_settings().remove('hidden')
This commit is contained in:
Emmanuel Garette
2013-04-20 17:30:05 +02:00
parent 54fe8d0f4b
commit d4ef47759e
11 changed files with 443 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
tiramisu/setting.py
View File

@ -139,29 +139,58 @@ def populate_multitypes():
populate_multitypes()
class Property(object):
__slots__ = ('_setting', '_properties', '_opt')
def __init__(self, setting, prop, opt=None):
self._opt = opt
self._setting = setting
self._properties = prop
def append(self, propname):
if not propname in self._properties:
self._properties.append(propname)
self._setting._set_properties(self._properties, self._opt)
self._setting.context.cfgimpl_reset_cache()
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()
def __contains__(self, propname):
return propname in self._properties
#____________________________________________________________
class Setting(object):
"``Config()``'s configuration options"
__slots__ = ('properties', 'permissives', 'owner', 'context', '_cache')
__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: ['expire']}
self._properties = {None: ['expire']}
# permissive properties
self.permissives = {}
self._permissives = {}
# generic owner
self.owner = owners.user
self._owner = owners.user
self.context = context
self._cache = {}
#____________________________________________________________
# properties methods
def has_properties(self, opt=None):
"has properties means the Config's properties attribute is not empty"
return bool(len(self.get_properties(opt)))
def __contains__(self, propname):
return propname in self._get_properties()
def get_properties(self, opt=None, is_apply_req=True):
def __getitem__(self, opt):
return Property(self, self._get_properties(opt), opt)
def __setitem__(self, opt, value):
raise ValueError('you must only append/remove properties')
def _get_properties(self, opt=None, is_apply_req=True):
if opt is not None and opt in self._cache:
exp = time()
props, created = self._cache[opt]
@ -173,84 +202,65 @@ class Setting(object):
if is_apply_req:
apply_requires(opt, self.context)
default = list(opt._properties)
props = self.properties.get(opt, default)
props = self._properties.get(opt, default)
if opt is not None:
self._set_cache(opt, props)
return props
def has_property(self, propname, opt=None):
"""has property propname in the Config's properties attribute
:param property: string wich is the name of the property"""
return propname in self.get_properties(opt)
def enable_property(self, propname):
def append(self, propname):
"puts property propname in the Config's properties attribute"
props = self.get_properties()
if propname not in props:
props.append(propname)
self.set_properties(props)
self.context.cfgimpl_reset_cache()
Property(self, self._get_properties()).append(propname)
def disable_property(self, propname):
def remove(self, propname):
"deletes property propname in the Config's properties attribute"
props = self.get_properties()
if propname in props:
props.remove(propname)
self.set_properties(props)
self.context.cfgimpl_reset_cache()
Property(self, self._get_properties()).remove(propname)
def set_properties(self, properties, opt=None):
def _set_properties(self, properties, opt=None):
"""save properties for specified opt
(never save properties if same has option properties)
"""
if opt is None:
self.properties[opt] = properties
self._properties[opt] = properties
else:
if opt._properties == properties:
if opt in self.properties:
del(self.properties[opt])
if opt in self._properties:
del(self._properties[opt])
else:
self.properties[opt] = properties
self._properties[opt] = properties
def add_property(self, propname, opt, is_apply_req=True):
if opt is None:
raise ValueError("option must not be None in add_property")
properties = self.get_properties(opt, is_apply_req)
if not propname in properties:
properties.append(propname)
self.set_properties(properties, opt)
self.context.cfgimpl_reset_cache()
def _validate_frozen(self, opt, value, is_write):
if not is_write:
return False
if 'permissive' in self and 'frozen' in self._get_permissive():
return False
if 'everything_frozen' in self or (
'frozen' in self and 'frozen' in self[opt]):
return True
return False
def del_property(self, propname, opt, is_apply_req=True):
if opt is None:
raise ValueError("option must not be None in del_property")
properties = self.get_properties(opt, is_apply_req)
if propname in properties:
properties.remove(propname)
self.set_properties(properties, opt)
self.context.cfgimpl_reset_cache()
def _validate_mandatory(self, opt, value, force_properties=None):
set_mandatory = self.has_property('mandatory')
def _validate_mandatory(self, opt, value, force_properties):
if 'permissive' in self and 'mandatory' in self._get_permissive():
return False
check_mandatory = 'mandatory' in self
if force_properties is not None:
set_mandatory = ('mandatory' in force_properties or
set_mandatory)
if set_mandatory and self.has_property('mandatory', opt) and \
check_mandatory = ('mandatory' in force_properties or
check_mandatory)
if check_mandatory and 'mandatory' in self[opt] and \
self.context.cfgimpl_get_values()._is_empty(opt, value):
return True
return False
def _calc_properties(self, opt_or_descr, force_permissive, force_properties):
properties = set(self.get_properties(opt_or_descr))
properties = set(self._get_properties(opt_or_descr))
#remove this properties, those properties are validate in after
properties = properties - set(['mandatory', 'frozen'])
set_properties = set(self.get_properties())
set_properties = set(self._get_properties())
if force_properties is not None:
set_properties.update(set(force_properties))
properties = properties & set_properties
if force_permissive is True or self.has_property('permissive'):
properties = properties - set(self.get_permissive())
properties = properties - set(self.get_permissive(opt_or_descr))
if force_permissive is True or 'permissive' in self:
properties = properties - set(self._get_permissive())
properties = properties - set(self._get_permissive(opt_or_descr))
return list(properties)
#____________________________________________________________
@ -263,13 +273,9 @@ class Setting(object):
" to an option named: {0} with properties"
" {1}")
if not is_descr:
if self._validate_mandatory(opt_or_descr, value,
force_properties=force_properties):
if self._validate_mandatory(opt_or_descr, value, force_properties):
properties.append('mandatory')
#frozen
if is_write and (self.has_property('everything_frozen') or (
self.has_property('frozen') and
self.has_property('frozen', opt_or_descr))):
if self._validate_frozen(opt_or_descr, value, is_write):
properties.append('frozen')
raise_text = _('cannot change the value to {0} for '
'option {1} this option is frozen')
@ -278,47 +284,47 @@ class Setting(object):
str(properties)),
properties)
def get_permissive(self, opt=None):
return self.permissives.get(opt, [])
def _get_permissive(self, opt=None):
return self._permissives.get(opt, [])
def set_permissive(self, permissive, opt=None):
if not isinstance(permissive, list):
raise TypeError(_('permissive must be a list'))
self.permissives[opt] = permissive
if not isinstance(permissive, tuple):
raise TypeError(_('permissive must be a tuple'))
self._permissives[opt] = permissive
#____________________________________________________________
def setowner(self, owner):
":param owner: sets the default value for owner at the Config level"
if not isinstance(owner, owners.Owner):
raise TypeError(_("invalid generic owner {0}").format(str(owner)))
self.owner = owner
self._owner = owner
def getowner(self):
return self.owner
return self._owner
#____________________________________________________________
def read_only(self):
"convenience method to freeze, hidde and disable"
self.enable_property('everything_frozen')
self.enable_property('frozen') # can be usefull...
self.disable_property('hidden')
self.enable_property('disabled')
self.enable_property('mandatory')
self.enable_property('validator')
self.disable_property('permissive')
self.append('everything_frozen')
self.append('frozen') # can be usefull...
self.remove('hidden')
self.append('disabled')
self.append('mandatory')
self.append('validator')
self.remove('permissive')
def read_write(self):
"convenience method to freeze, hidde and disable"
self.disable_property('everything_frozen')
self.enable_property('frozen') # can be usefull...
self.enable_property('hidden')
self.enable_property('disabled')
self.disable_property('mandatory')
self.enable_property('validator')
self.disable_property('permissive')
self.remove('everything_frozen')
self.append('frozen') # can be usefull...
self.append('hidden')
self.append('disabled')
self.remove('mandatory')
self.append('validator')
self.remove('permissive')
def _set_cache(self, opt, props):
if self.has_property('expire'):
if 'expire' in self:
self._cache[opt] = (props, time() + expires_time)
pass
@ -346,7 +352,8 @@ def apply_requires(opt, config):
#for symlink
if hasattr(opt, '_requires') and opt._requires is not None:
# filters the callbacks
setting = config.cfgimpl_get_settings()
settings = config.cfgimpl_get_settings()
setting = Property(settings, settings._get_properties(opt, False), opt)
trigger_actions = build_actions(opt._requires)
optpath = config.cfgimpl_get_context().cfgimpl_get_description().get_path_by_opt(opt)
for requires in trigger_actions.values():
@ -365,22 +372,20 @@ def apply_requires(opt, config):
value = config.cfgimpl_get_context()._getattr(path, force_permissive=True)
except PropertiesOptionError, err:
properties = err.proptype
#FIXME: AttributeError or PropertiesOptionError ?
raise AttributeError(_("option '{0}' has requirement's property error: "
"{1} {2}").format(opt._name, path, properties))
raise PropertiesOptionError(_("option '{0}' has requirement's property error: "
"{1} {2}").format(opt._name, path, properties))
except AttributeError:
raise AttributeError(_("required option not found: "
"{0}").format(path))
if value == expected:
if inverse:
setting.del_property(action, opt, False)
setting.remove(action)
else:
setting.add_property(action, opt, False)
setting.append(action)
matches = True
#FIXME optimisation : fait un double break non ? voire un return
# no requirement has been triggered, then just reverse the action
if not matches:
if inverse:
setting.add_property(action, opt, False)
setting.append(action)
else:
setting.del_property(action, opt, False)
setting.remove(action)