NoValueReturn is not needed now + apply_requires is now in settings
[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
24 from tiramisu.error import (RequirementRecursionError, PropertiesOptionError,
25                             NotFoundError)
26
27
28 class _const:
29     """convenient class that emulates a module
30     and builds constants (that is, unique names)"""
31     class ConstError(TypeError):
32         pass
33
34     def __setattr__(self, name, value):
35         if name in self.__dict__:
36             raise self.ConstError, "Can't rebind group ({})".format(name)
37         self.__dict__[name] = value
38
39     def __delattr__(self, name):
40         if name in self.__dict__:
41             raise self.ConstError, "Can't unbind group ({})".format(name)
42         raise NameError(name)
43
44
45 # ____________________________________________________________
46 class GroupModule(_const):
47     "emulates a module to manage unique group (OptionDescription) names"
48     class GroupType(str):
49         """allowed normal group (OptionDescription) names
50         *normal* means : groups that are not master
51         """
52         pass
53
54     class DefaultGroupType(GroupType):
55         """groups that are default (typically 'default')"""
56         pass
57
58     class MasterGroupType(GroupType):
59         """allowed normal group (OptionDescription) names
60         *master* means : groups that have the 'master' attribute set
61         """
62         pass
63 # setting.groups (emulates a module)
64 groups = GroupModule()
65
66
67 def populate_groups():
68     "populates the available groups in the appropriate namespaces"
69     groups.master = groups.MasterGroupType('master')
70     groups.default = groups.DefaultGroupType('default')
71     groups.family = groups.GroupType('family')
72
73 # names are in the module now
74 populate_groups()
75
76
77 # ____________________________________________________________
78 class OwnerModule(_const):
79     """emulates a module to manage unique owner names.
80
81     owners are living in `Config._cfgimpl_value_owners`
82     """
83     class Owner(str):
84         """allowed owner names
85         """
86         pass
87
88     class DefaultOwner(Owner):
89         """groups that are default (typically 'default')"""
90         pass
91 # setting.owners (emulates a module)
92 owners = OwnerModule()
93
94
95 def populate_owners():
96     """populates the available owners in the appropriate namespaces
97
98     - 'user' is the generic is the generic owner.
99     - 'default' is the config owner after init time
100     """
101     setattr(owners, 'default', owners.DefaultOwner('default'))
102     setattr(owners, 'user', owners.Owner('user'))
103
104     def add_owner(name):
105         """
106         :param name: the name of the new owner
107         """
108         setattr(owners, name, owners.Owner(name))
109     setattr(owners, 'add_owner', add_owner)
110
111 # names are in the module now
112 populate_owners()
113
114
115 class MultiTypeModule(_const):
116     class MultiType(str):
117         pass
118
119     class DefaultMultiType(MultiType):
120         pass
121
122     class MasterMultiType(MultiType):
123         pass
124
125     class SlaveMultiType(MultiType):
126         pass
127
128 multitypes = MultiTypeModule()
129
130
131 def populate_multitypes():
132     setattr(multitypes, 'default', multitypes.DefaultMultiType('default'))
133     setattr(multitypes, 'master', multitypes.MasterMultiType('master'))
134     setattr(multitypes, 'slave', multitypes.SlaveMultiType('slave'))
135
136 populate_multitypes()
137
138
139 #____________________________________________________________
140 class Setting(object):
141     "``Config()``'s configuration options"
142     __slots__ = ('properties', 'permissives', 'owner', 'context')
143
144     def __init__(self, context):
145         # properties attribute: the name of a property enables this property
146         # key is None for global properties
147         self.properties = {None: []}  # ['hidden', 'disabled', 'mandatory', 'frozen', 'validator']}
148         # permissive properties
149         self.permissives = {}
150         # generic owner
151         self.owner = owners.user
152         self.context = context
153
154     #____________________________________________________________
155     # properties methods
156     def has_properties(self, opt=None, is_apply_req=True):
157         "has properties means the Config's properties attribute is not empty"
158         return bool(len(self.get_properties(opt, is_apply_req)))
159
160     def get_properties(self, opt=None, is_apply_req=True):
161         if opt is None:
162             default = []
163         else:
164             if is_apply_req:
165                 apply_requires(opt, self.context)
166             default = list(opt._properties)
167         return self.properties.get(opt, default)
168
169     def has_property(self, propname, opt=None, is_apply_req=True):
170         """has property propname in the Config's properties attribute
171         :param property: string wich is the name of the property"""
172         return propname in self.get_properties(opt, is_apply_req)
173
174     def enable_property(self, propname):
175         "puts property propname in the Config's properties attribute"
176         props = self.get_properties()
177         if propname not in props:
178             props.append(propname)
179         self.set_properties(props)
180
181     def disable_property(self, propname):
182         "deletes property propname in the Config's properties attribute"
183         props = self.get_properties()
184         if propname in props:
185             props.remove(propname)
186         self.set_properties(props)
187
188     def set_properties(self, properties, opt=None):
189         """save properties for specified opt
190         (never save properties if same has option properties)
191         """
192         if opt is None:
193             self.properties[opt] = properties
194         else:
195             if opt._properties == properties:
196                 if opt in self.properties:
197                     del(self.properties[opt])
198             else:
199                 self.properties[opt] = properties
200
201     def add_property(self, propname, opt, is_apply_req=True):
202         properties = self.get_properties(opt, is_apply_req)
203         if not propname in properties:
204             properties.append(propname)
205             self.set_properties(properties, opt)
206
207     def del_property(self, propname, opt, is_apply_req=True):
208         properties = self.get_properties(opt, is_apply_req)
209         if propname in properties:
210             properties.remove(propname)
211             self.set_properties(properties, opt)
212
213     #____________________________________________________________
214     def get_permissive(self, opt=None):
215         return self.permissives.get(opt, [])
216
217     def set_permissive(self, permissive, opt=None):
218         if not isinstance(permissive, list):
219             raise TypeError('permissive must be a list')
220         self.permissives[opt] = permissive
221
222     #____________________________________________________________
223     def setowner(self, owner):
224         ":param owner: sets the default value for owner at the Config level"
225         if not isinstance(owner, owners.Owner):
226             raise TypeError("invalid generic owner {0}".format(str(owner)))
227         self.owner = owner
228
229     def getowner(self):
230         return self.owner
231
232     #____________________________________________________________
233     def read_only(self):
234         "convenience method to freeze, hidde and disable"
235         self.enable_property('everything_frozen')
236         self.enable_property('frozen')  # can be usefull...
237         self.disable_property('hidden')
238         self.enable_property('disabled')
239         self.enable_property('mandatory')
240         self.enable_property('validator')
241         self.disable_property('permissive')
242
243     def read_write(self):
244         "convenience method to freeze, hidde and disable"
245         self.disable_property('everything_frozen')
246         self.enable_property('frozen')  # can be usefull...
247         self.enable_property('hidden')
248         self.enable_property('disabled')
249         self.disable_property('mandatory')
250         self.enable_property('validator')
251         self.disable_property('permissive')
252
253
254 def apply_requires(opt, config):
255     "carries out the jit (just in time requirements between options"
256     def build_actions(requires):
257         "action are hide, show, enable, disable..."
258         trigger_actions = {}
259         for require in requires:
260             action = require[2]
261             trigger_actions.setdefault(action, []).append(require)
262         return trigger_actions
263     #for symlink
264     if hasattr(opt, '_requires') and opt._requires is not None:
265         # filters the callbacks
266         setting = config.cfgimpl_get_settings()
267         trigger_actions = build_actions(opt._requires)
268         optpath = config.cfgimpl_get_context().cfgimpl_get_description().get_path_by_opt(opt)
269         for requires in trigger_actions.values():
270             matches = False
271             for require in requires:
272                 if len(require) == 3:
273                     path, expected, action = require
274                     inverse = False
275                 elif len(require) == 4:
276                     path, expected, action, inverse = require
277                 if path == optpath or path.startswith(optpath + '.'):
278                     raise RequirementRecursionError("malformed requirements "
279                                                     "imbrication detected for option: '{0}' "
280                                                     "with requirement on: '{1}'".format(optpath, path))
281                 try:
282                     value = config.cfgimpl_get_context()._getattr(path, force_permissive=True)
283                 except PropertiesOptionError, err:
284                     properties = err.proptype
285                     raise NotFoundError("option '{0}' has requirement's property error: "
286                                         "{1} {2}".format(opt._name, path, properties))
287                 except AttributeError:
288                     raise NotFoundError("required option not found: "
289                                         "{0}".format(path))
290                 if value == expected:
291                     if inverse:
292                         setting.del_property(action, opt, False)
293                     else:
294                         setting.add_property(action, opt, False)
295                     matches = True
296                     #FIXME optimisation : fait un double break non ? voire un return
297             # no requirement has been triggered, then just reverse the action
298             if not matches:
299                 if inverse:
300                     setting.add_property(action, opt, False)
301                 else:
302                     setting.del_property(action, opt, False)