tiramisu/setting.py: _get_properties and validate_properties are now more easier...
[tiramisu.git] / tiramisu / setting.py
1 # -*- coding: utf-8 -*-
2 "sets the options of the configuration objects Config object itself"
3 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 #
19 # The original `Config` design model is unproudly borrowed from
20 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
21 # the whole pypy projet is under MIT licence
22 # ____________________________________________________________
23 from time import time
24 from tiramisu.error import RequirementRecursionError, PropertiesOptionError
25 from tiramisu.i18n import _
26
27
28 expires_time = 5
29 ro_remove = ('permissive', 'hidden')
30 ro_append = ('frozen', 'disabled', 'validator', 'everything_frozen', 'mandatory')
31 rw_remove = ('permissive', 'everything_frozen', 'mandatory')
32 rw_append = ('frozen', 'disabled', 'validator', 'hidden')
33
34
35 class _const:
36     """convenient class that emulates a module
37     and builds constants (that is, unique names)"""
38     class ConstError(TypeError):
39         pass
40
41     def __setattr__(self, name, value):
42         if name in self.__dict__:
43             raise self.ConstError, _("Can't rebind group ({})").format(name)
44         self.__dict__[name] = value
45
46     def __delattr__(self, name):
47         if name in self.__dict__:
48             raise self.ConstError, _("Can't unbind group ({})").format(name)
49         raise ValueError(name)
50
51
52 # ____________________________________________________________
53 class GroupModule(_const):
54     "emulates a module to manage unique group (OptionDescription) names"
55     class GroupType(str):
56         """allowed normal group (OptionDescription) names
57         *normal* means : groups that are not master
58         """
59         pass
60
61     class DefaultGroupType(GroupType):
62         """groups that are default (typically 'default')"""
63         pass
64
65     class MasterGroupType(GroupType):
66         """allowed normal group (OptionDescription) names
67         *master* means : groups that have the 'master' attribute set
68         """
69         pass
70 # setting.groups (emulates a module)
71 groups = GroupModule()
72
73
74 def populate_groups():
75     "populates the available groups in the appropriate namespaces"
76     groups.master = groups.MasterGroupType('master')
77     groups.default = groups.DefaultGroupType('default')
78     groups.family = groups.GroupType('family')
79
80 # names are in the module now
81 populate_groups()
82
83
84 # ____________________________________________________________
85 class OwnerModule(_const):
86     """emulates a module to manage unique owner names.
87
88     owners are living in `Config._cfgimpl_value_owners`
89     """
90     class Owner(str):
91         """allowed owner names
92         """
93         pass
94
95     class DefaultOwner(Owner):
96         """groups that are default (typically 'default')"""
97         pass
98 # setting.owners (emulates a module)
99 owners = OwnerModule()
100
101
102 def populate_owners():
103     """populates the available owners in the appropriate namespaces
104
105     - 'user' is the generic is the generic owner.
106     - 'default' is the config owner after init time
107     """
108     setattr(owners, 'default', owners.DefaultOwner('default'))
109     setattr(owners, 'user', owners.Owner('user'))
110
111     def add_owner(name):
112         """
113         :param name: the name of the new owner
114         """
115         setattr(owners, name, owners.Owner(name))
116     setattr(owners, 'add_owner', add_owner)
117
118 # names are in the module now
119 populate_owners()
120
121
122 class MultiTypeModule(_const):
123     class MultiType(str):
124         pass
125
126     class DefaultMultiType(MultiType):
127         pass
128
129     class MasterMultiType(MultiType):
130         pass
131
132     class SlaveMultiType(MultiType):
133         pass
134
135 multitypes = MultiTypeModule()
136
137
138 def populate_multitypes():
139     setattr(multitypes, 'default', multitypes.DefaultMultiType('default'))
140     setattr(multitypes, 'master', multitypes.MasterMultiType('master'))
141     setattr(multitypes, 'slave', multitypes.SlaveMultiType('slave'))
142
143 populate_multitypes()
144
145
146 class Property(object):
147     __slots__ = ('_setting', '_properties', '_opt')
148
149     def __init__(self, setting, prop, opt=None):
150         self._opt = opt
151         self._setting = setting
152         self._properties = prop
153
154     def append(self, propname):
155         if not propname in self._properties:
156             self._properties.append(propname)
157             self._setting._set_properties(self._properties, self._opt)
158         self._setting.context.cfgimpl_reset_cache()
159
160     def remove(self, propname):
161         if propname in self._properties:
162             self._properties.remove(propname)
163             self._setting._set_properties(self._properties, self._opt)
164         self._setting.context.cfgimpl_reset_cache()
165
166     def __contains__(self, propname):
167         return propname in self._properties
168
169     def __repr__(self):
170         return str(self._properties)
171
172
173 #____________________________________________________________
174 class Setting(object):
175     "``Config()``'s configuration options"
176     __slots__ = ('context', '_properties', '_permissives', '_owner', '_cache')
177
178     def __init__(self, context):
179         # properties attribute: the name of a property enables this property
180         # key is None for global properties
181         self._properties = {None: ['expire']}
182         # permissive properties
183         self._permissives = {}
184         # generic owner
185         self._owner = owners.user
186         self.context = context
187         self._cache = {}
188
189     #____________________________________________________________
190     # properties methods
191     def __contains__(self, propname):
192         return propname in self._get_properties()
193
194     def __repr__(self):
195         return str(self._get_properties())
196
197     def __getitem__(self, opt):
198         return Property(self, self._get_properties(opt), opt)
199
200     def __setitem__(self, opt, value):
201         raise ValueError('you must only append/remove properties')
202
203     def _get_properties(self, opt=None, is_apply_req=True):
204         if opt is None:
205             props = self._properties.get(opt, [])
206         else:
207             exp = None
208             if opt in self._cache:
209                 exp = time()
210                 props, created = self._cache[opt]
211                 if exp < created:
212                     return props
213             if is_apply_req:
214                 apply_requires(opt, self.context)
215             default = list(opt._properties)
216             props = self._properties.get(opt, default)
217             self._set_cache(opt, props, exp)
218         return props
219
220     def append(self, propname):
221         "puts property propname in the Config's properties attribute"
222         Property(self, self._get_properties()).append(propname)
223
224     def remove(self, propname):
225         "deletes property propname in the Config's properties attribute"
226         Property(self, self._get_properties()).remove(propname)
227
228     def _set_properties(self, properties, opt=None):
229         """save properties for specified opt
230         (never save properties if same has option properties)
231         """
232         if opt is None:
233             self._properties[opt] = properties
234         else:
235             if opt._properties == properties:
236                 if opt in self._properties:
237                     del(self._properties[opt])
238             else:
239                 self._properties[opt] = properties
240
241     #____________________________________________________________
242     def validate_properties(self, opt_or_descr, is_descr, is_write,
243                             value=None, force_permissive=False,
244                             force_properties=None):
245         #opt properties
246         properties = set(self._get_properties(opt_or_descr))
247         #remove opt permissive
248         properties -= frozenset(self._get_permissive(opt_or_descr))
249         #remove global permissive if need
250         self_properties = self._get_properties()
251         if force_permissive is True or 'permissive' in self_properties:
252             properties -= frozenset(self._get_permissive())
253
254         #global properties
255         set_properties = set(self_properties)
256         if force_properties is not None:
257             set_properties.update(frozenset(force_properties))
258
259         #calc properties
260         properties &= set_properties
261         #mandatory and frozen are special properties
262         if is_descr:
263             properties -= frozenset(['mandatory', 'frozen'])
264         else:
265             if 'mandatory' in properties and \
266                     not self.context.cfgimpl_get_values()._is_empty(opt_or_descr,
267                                                                     value):
268                 properties.remove('mandatory')
269             if is_write and 'everything_frozen' in self_properties:
270                 properties.add('frozen')
271             elif 'frozen' in properties and not is_write:
272                 properties.remove('frozen')
273
274         if properties != frozenset():
275             if 'frozen' in properties:
276                 raise_text = 'cannot change the value for option {0} this option is frozen'
277             else:
278                 raise_text = "trying to access to an option named: {0} with properties {1}"
279             raise PropertiesOptionError(_(raise_text).format(opt_or_descr._name,
280                                         str(properties)),
281                                         list(properties))
282
283     def _get_permissive(self, opt=None):
284         return self._permissives.get(opt, [])
285
286     def set_permissive(self, permissive, opt=None):
287         if not isinstance(permissive, tuple):
288             raise TypeError(_('permissive must be a tuple'))
289         self._permissives[opt] = permissive
290
291     #____________________________________________________________
292     def setowner(self, owner):
293         ":param owner: sets the default value for owner at the Config level"
294         if not isinstance(owner, owners.Owner):
295             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
296         self._owner = owner
297
298     def getowner(self):
299         return self._owner
300
301     #____________________________________________________________
302     def _read(self, remove, append):
303         for prop in remove:
304             self.remove(prop)
305         for prop in append:
306             self.append(prop)
307
308     def read_only(self):
309         "convenience method to freeze, hidde and disable"
310         self._read(ro_remove, ro_append)
311
312     def read_write(self):
313         "convenience method to freeze, hidde and disable"
314         self._read(rw_remove, rw_append)
315
316     def _set_cache(self, opt, props, exp):
317         if 'expire' in self:
318             if exp is None:
319                 exp = time()
320             self._cache[opt] = (props, time() + expires_time)
321
322     def reset_cache(self, only_expired):
323         if only_expired:
324             exp = time()
325             keys = self._cache.keys()
326             for key in keys:
327                 props, created = self._cache[key]
328                 if exp > created:
329                     del(self._cache[key])
330         else:
331             self._cache.clear()
332
333
334 def apply_requires(opt, config):
335     "carries out the jit (just in time requirements between options"
336     def build_actions(requires):
337         "action are hide, show, enable, disable..."
338         trigger_actions = {}
339         for require in requires:
340             action = require[2]
341             trigger_actions.setdefault(action, []).append(require)
342         return trigger_actions
343     #for symlink
344     if hasattr(opt, '_requires') and opt._requires is not None:
345         # filters the callbacks
346         settings = config.cfgimpl_get_settings()
347         setting = Property(settings, settings._get_properties(opt, False), opt)
348         trigger_actions = build_actions(opt._requires)
349         descr = config.cfgimpl_get_context().cfgimpl_get_description()
350         optpath = descr.optimpl_get_path_by_opt(opt)
351         for requires in trigger_actions.values():
352             matches = False
353             for require in requires:
354                 if len(require) == 3:
355                     option, expected, action = require
356                     inverse = False
357                 elif len(require) == 4:
358                     option, expected, action, inverse = require
359                 path = descr.optimpl_get_path_by_opt(option)
360                 if path == optpath or path.startswith(optpath + '.'):
361                     raise RequirementRecursionError(_("malformed requirements "
362                                                     "imbrication detected for option: '{0}' "
363                                                     "with requirement on: '{1}'").format(optpath, path))
364                 try:
365                     value = config.cfgimpl_get_context()._getattr(path, force_permissive=True)
366                 except PropertiesOptionError, err:
367                     properties = err.proptype
368                     raise PropertiesOptionError(_("option '{0}' has requirement's property error: "
369                                                   "{1} {2}").format(opt._name, path, properties), properties)
370                 except AttributeError:
371                     raise AttributeError(_("required option not found: "
372                                          "{0}").format(path))
373                 if value == expected:
374                     if inverse:
375                         setting.remove(action)
376                     else:
377                         setting.append(action)
378                     matches = True
379             # no requirement has been triggered, then just reverse the action
380             if not matches:
381                 if inverse:
382                     setting.append(action)
383                 else:
384                     setting.remove(action)