Remove 'build_actions' in 'apply_requires', now 'validate_requires_arg' build require...
[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 copy import copy
25 from tiramisu.error import RequirementError, PropertiesOptionError
26 from tiramisu.i18n import _
27
28
29 expires_time = 5
30 ro_remove = ('permissive', 'hidden')
31 ro_append = ('frozen', 'disabled', 'validator', 'everything_frozen', 'mandatory')
32 rw_remove = ('permissive', 'everything_frozen', 'mandatory')
33 rw_append = ('frozen', 'disabled', 'validator', 'hidden')
34
35
36 class _const:
37     """convenient class that emulates a module
38     and builds constants (that is, unique names)"""
39     class ConstError(TypeError):
40         pass
41
42     def __setattr__(self, name, value):
43         if name in self.__dict__:
44             raise self.ConstError, _("Can't rebind group ({})").format(name)
45         self.__dict__[name] = value
46
47     def __delattr__(self, name):
48         if name in self.__dict__:
49             raise self.ConstError, _("Can't unbind group ({})").format(name)
50         raise ValueError(name)
51
52
53 # ____________________________________________________________
54 class GroupModule(_const):
55     "emulates a module to manage unique group (OptionDescription) names"
56     class GroupType(str):
57         """allowed normal group (OptionDescription) names
58         *normal* means : groups that are not master
59         """
60         pass
61
62     class DefaultGroupType(GroupType):
63         """groups that are default (typically 'default')"""
64         pass
65
66     class MasterGroupType(GroupType):
67         """allowed normal group (OptionDescription) names
68         *master* means : groups that have the 'master' attribute set
69         """
70         pass
71 # setting.groups (emulates a module)
72 groups = GroupModule()
73
74
75 def populate_groups():
76     "populates the available groups in the appropriate namespaces"
77     groups.master = groups.MasterGroupType('master')
78     groups.default = groups.DefaultGroupType('default')
79     groups.family = groups.GroupType('family')
80
81 # names are in the module now
82 populate_groups()
83
84
85 # ____________________________________________________________
86 class OwnerModule(_const):
87     """emulates a module to manage unique owner names.
88
89     owners are living in `Config._cfgimpl_value_owners`
90     """
91     class Owner(str):
92         """allowed owner names
93         """
94         pass
95
96     class DefaultOwner(Owner):
97         """groups that are default (typically 'default')"""
98         pass
99 # setting.owners (emulates a module)
100 owners = OwnerModule()
101
102
103 def populate_owners():
104     """populates the available owners in the appropriate namespaces
105
106     - 'user' is the generic is the generic owner.
107     - 'default' is the config owner after init time
108     """
109     setattr(owners, 'default', owners.DefaultOwner('default'))
110     setattr(owners, 'user', owners.Owner('user'))
111
112     def add_owner(name):
113         """
114         :param name: the name of the new owner
115         """
116         setattr(owners, name, owners.Owner(name))
117     setattr(owners, 'add_owner', add_owner)
118
119 # names are in the module now
120 populate_owners()
121
122
123 class MultiTypeModule(_const):
124     "namespace for the master/slaves"
125     class MultiType(str):
126         pass
127
128     class DefaultMultiType(MultiType):
129         pass
130
131     class MasterMultiType(MultiType):
132         pass
133
134     class SlaveMultiType(MultiType):
135         pass
136
137 multitypes = MultiTypeModule()
138
139
140 def populate_multitypes():
141     "populates the master/slave namespace"
142     setattr(multitypes, 'default', multitypes.DefaultMultiType('default'))
143     setattr(multitypes, 'master', multitypes.MasterMultiType('master'))
144     setattr(multitypes, 'slave', multitypes.SlaveMultiType('slave'))
145
146 populate_multitypes()
147
148
149 class Property(object):
150     "a property is responsible of the option's value access rules"
151     __slots__ = ('_setting', '_properties', '_opt')
152
153     def __init__(self, setting, prop, opt=None):
154         self._opt = opt
155         self._setting = setting
156         self._properties = prop
157
158     def append(self, propname):
159         self._properties.add(propname)
160         self._setting._set_properties(self._properties, self._opt)
161         self._setting.context.cfgimpl_reset_cache()
162
163     def remove(self, propname):
164         if propname in self._properties:
165             self._properties.remove(propname)
166             self._setting._set_properties(self._properties, self._opt)
167             self._setting.context.cfgimpl_reset_cache()
168
169     def __contains__(self, propname):
170         return propname in self._properties
171
172     def __repr__(self):
173         return str(list(self._properties))
174
175
176 #____________________________________________________________
177 class Setting(object):
178     "``Config()``'s configuration options"
179     __slots__ = ('context', '_properties', '_permissives', '_owner', '_cache')
180
181     def __init__(self, context):
182         # properties attribute: the name of a property enables this property
183         # key is None for global properties
184         self._properties = {None: set(('expire', 'validator'))}
185         # permissive properties
186         self._permissives = {}
187         # generic owner
188         self._owner = owners.user
189         self.context = context
190         self._cache = {}
191
192     #____________________________________________________________
193     # properties methods
194     def __contains__(self, propname):
195         return propname in self._get_properties()
196
197     def __repr__(self):
198         return str(list(self._get_properties()))
199
200     def __getitem__(self, opt):
201         return Property(self, self._get_properties(opt), opt)
202
203     def __setitem__(self, opt, value):
204         raise ValueError('you must only append/remove properties')
205
206     def _get_properties(self, opt=None, is_apply_req=True):
207         if opt is None:
208             props = self._properties.get(opt, set())
209         else:
210             exp = None
211             if opt in self._cache:
212                 exp = time()
213                 props, created = self._cache[opt]
214                 if exp < created:
215                     return props
216             if is_apply_req:
217                 self.apply_requires(opt)
218             props = self._properties.get(opt, opt._properties)
219             self._set_cache(opt, props, exp)
220         return props
221
222     def append(self, propname):
223         "puts property propname in the Config's properties attribute"
224         Property(self, self._get_properties()).append(propname)
225
226     def remove(self, propname):
227         "deletes property propname in the Config's properties attribute"
228         Property(self, self._get_properties()).remove(propname)
229
230     def _set_properties(self, properties, opt=None):
231         """save properties for specified opt
232         (never save properties if same has option properties)
233         """
234         if opt is None:
235             self._properties[opt] = properties
236         else:
237             if opt._properties == properties:
238                 if opt in self._properties:
239                     del(self._properties[opt])
240             else:
241                 self._properties[opt] = properties
242
243     #____________________________________________________________
244     def validate_properties(self, opt_or_descr, is_descr, is_write,
245                             value=None, force_permissive=False,
246                             force_properties=None):
247         #opt properties
248         properties = copy(self._get_properties(opt_or_descr))
249         #remove opt permissive
250         properties -= self._get_permissive(opt_or_descr)
251         #remove global permissive if need
252         self_properties = copy(self._get_properties())
253         if force_permissive is True or 'permissive' in self_properties:
254             properties -= self._get_permissive()
255
256         #global properties
257         if force_properties is not None:
258             self_properties.update(force_properties)
259
260         #calc properties
261         properties &= self_properties
262         #mandatory and frozen are special properties
263         if is_descr:
264             properties -= frozenset(('mandatory', 'frozen'))
265         else:
266             if 'mandatory' in properties and \
267                     not self.context.cfgimpl_get_values()._is_empty(opt_or_descr,
268                                                                     value):
269                 properties.remove('mandatory')
270             if is_write and 'everything_frozen' in self_properties:
271                 properties.add('frozen')
272             elif 'frozen' in properties and not is_write:
273                 properties.remove('frozen')
274
275         if properties != frozenset():
276             if 'frozen' in properties:
277                 raise_text = 'cannot change the value for option {0} this option is frozen'
278             else:
279                 raise_text = "trying to access to an option named: {0} with properties {1}"
280             raise PropertiesOptionError(_(raise_text).format(opt_or_descr._name,
281                                         str(list(properties))),
282                                         list(properties))
283
284     def _get_permissive(self, opt=None):
285         return self._permissives.get(opt, frozenset())
286
287     def set_permissive(self, permissive, opt=None):
288         if not isinstance(permissive, tuple):
289             raise TypeError(_('permissive must be a tuple'))
290         self._permissives[opt] = frozenset(permissive)
291
292     #____________________________________________________________
293     def setowner(self, owner):
294         ":param owner: sets the default value for owner at the Config level"
295         if not isinstance(owner, owners.Owner):
296             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
297         self._owner = owner
298
299     def getowner(self):
300         return self._owner
301
302     #____________________________________________________________
303     def _read(self, remove, append):
304         for prop in remove:
305             self.remove(prop)
306         for prop in append:
307             self.append(prop)
308
309     def read_only(self):
310         "convenience method to freeze, hidde and disable"
311         self._read(ro_remove, ro_append)
312
313     def read_write(self):
314         "convenience method to freeze, hidde and disable"
315         self._read(rw_remove, rw_append)
316
317     def _set_cache(self, opt, props, exp):
318         if 'expire' in self:
319             if exp is None:
320                 exp = time()
321             self._cache[opt] = (props, time() + expires_time)
322
323     def reset_cache(self, only_expired):
324         if only_expired:
325             exp = time()
326             keys = self._cache.keys()
327             for key in keys:
328                 props, created = self._cache[key]
329                 if exp > created:
330                     del(self._cache[key])
331         else:
332             self._cache.clear()
333
334     def apply_requires(self, opt):
335         "carries out the jit (just in time requirements between options"
336         if opt._requires is None:
337             return
338
339         # filters the callbacks
340         setting = Property(self, self._get_properties(opt, False), opt)
341         descr = self.context.cfgimpl_get_description()
342         optpath = descr.impl_get_path_by_opt(opt)
343         for requires in opt._requires:
344             matches = False
345             for require in requires:
346                 option, expected, action, inverse, transitive, same_action = require
347                 path = descr.impl_get_path_by_opt(option)
348                 if path == optpath or path.startswith(optpath + '.'):
349                     raise RequirementError(_("malformed requirements "
350                                              "imbrication detected for option: '{0}' "
351                                              "with requirement on: '{1}'").format(optpath, path))
352                 try:
353                     value = self.context._getattr(path, force_permissive=True)
354                 except PropertiesOptionError, err:
355                     if not transitive:
356                         continue
357                     properties = err.proptype
358                     if same_action and action not in properties:
359                         raise RequirementError(_("option '{0}' has requirement's property error: "
360                                                  "{1} {2}").format(opt._name, path, properties))
361                     #transitive action, force expected
362                     value = expected
363                     inverse = False
364                 except AttributeError:
365                     raise AttributeError(_("required option not found: "
366                                            "{0}").format(path))
367                 if not inverse and value == expected or inverse and value != expected:
368                     matches = True
369                     setting.append(action)
370                     ## the calculation cannot be carried out
371                     break
372             # no requirement has been triggered, then just reverse the action
373             if not matches:
374                 setting.remove(action)