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