private method _get_multitype()
[tiramisu.git] / tiramisu / value.py
1 # -*- coding: utf-8 -*-
2 "takes care of the option's values and multi values"
3 # Copyright (C) 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 tiramisu.error import NoValueReturned, MandatoryError, MultiTypeError
24 from tiramisu.setting import owners, multitypes
25
26 class Values(object):
27     def __init__(self, context):
28         """
29         Initializes the values's dict.
30
31         :param context: the context is the home config's values and properties
32         """
33         self.owners = {}
34         "Config's root indeed is in charge of the `Option()`'s values"
35         self.values = {}
36         self.previous_values = {}
37         self.masters = {}
38         self.slaves = {}
39         self.context = context
40
41     def _get_multitype(self):
42         if opt in self.slaves:
43             # slave
44             multitype = multitypes.slave
45         elif opt in self.masters:
46             # master
47             multitype = multitypes.master
48         # FIXME : default value for a multi, we shall work on groups
49         else:
50             multitype = multitypes.default
51         return multitype
52
53     def _get_value(self, opt):
54         "special case for the multis: they never return None"
55         if opt not in self.values:
56             if opt.is_multi():
57                 multitype = self._get_multitype()
58                 return Multi(opt.getdefault(), self.context, opt, multitype)
59             else:
60                 return opt.getdefault()
61         return self.values[opt]
62
63     def reset(self, opt):
64         if opt in self.values:
65             self.set_previous_value(opt)
66             del(self.values[opt])
67         self.setowner(opt, owners.default)
68
69     def set_previous_value(self, opt):
70         if opt in self.values:
71             old_value = self.values[opt]
72         else:
73             old_value = None
74         if type(old_value) == Multi:
75            self.previous_values[opt] = list(old_value)
76         else:
77            self.previous_values[opt] = old_value
78
79     def _is_empty(self, opt, value=None):
80         "convenience method to know if an option is empty"
81         if value is not None:
82             return False
83         if (not opt.is_multi() and self._get_value(opt) == None) or \
84             (opt.is_multi() and (self._get_value(opt) == [] or \
85                 None in self._get_value(opt))):
86             return True
87         return False
88
89     def _test_mandatory(self, opt, value=None):
90         # mandatory options
91         mandatory = self.context._cfgimpl_settings.mandatory
92         if opt.is_mandatory() and mandatory:
93             if self._is_empty(opt, value) and \
94                     opt.is_empty_by_default():
95                 raise MandatoryError("option: {0} is mandatory "
96                                       "and shall have a value".format(opt._name))
97
98     def fill_multi(self, opt, result):
99         """fills a multi option with default and calculated values
100         """
101         value = self._get_value(opt)
102         if not isinstance(result, list):
103             _result = [result]
104         else:
105             _result = result
106         multitype = self._get_multitype()
107         return Multi(_result, self.context, opt, multitype)
108
109     def __getitem__(self, opt):
110         # options with callbacks
111         value = self._get_value(opt)
112         if opt.has_callback():
113             if (not opt.is_frozen() or \
114                     not opt.is_forced_on_freeze()) and \
115                     not opt.is_default_owner(self.context):
116                 return self._get_value(opt)
117             try:
118                 result = opt.getcallback_value(
119                         self.context)
120             except NoValueReturned, err:
121                 pass
122             else:
123                 if opt.is_multi():
124                     value = self.fill_multi(opt, result)
125                 else:
126                     # this result **shall not** be a list
127                     if isinstance(result, list):
128                         raise ConfigError('invalid calculated value returned '
129                             'for option {0} : shall not be a list'.format(name))
130                     value = result
131                 if value != None and not opt.validate(value,
132                             self.context._cfgimpl_settings.validator):
133                     raise ConfigError('invalid calculated value returned'
134                         ' for option {0}'.format(name))
135         # frozen and force default
136         if not opt.has_callback() and opt.is_forced_on_freeze():
137             value = opt.getdefault()
138             if opt.is_multi():
139                 value = self.fill_multi(opt, value)
140         self._test_mandatory(opt, value)
141         return value
142
143     def __setitem__(self, opt, value):
144         if opt in self.masters:
145             masterlen = len(value)
146             for slave in self.masters[opt]:
147                 if len(self._get_value(slave)) != masterlen:
148                     raise MultiTypeError("invalid len for the slave: {0}"
149                     " which has {1} as master".format(slave._name,
150                                                       opt._name))
151         elif opt in self.slaves:
152             if len(self._get_value(self.slaves[opt])) != len(value):
153                    raise MultiTypeError("invalid len for the slave: {0}"
154                     " which has {1} as master".format(opt._name,
155                                                       self.slaves[opt]._name))
156         self.setitem(opt, value)
157
158     def setitem(self, opt, value):
159         self.set_previous_value(opt)
160         self.values[opt] = value
161         self.setowner(opt, self.context._cfgimpl_settings.getowner())
162
163     def __contains__(self, opt):
164         return opt in self.values
165     #____________________________________________________________
166     def setowner(self, opt, owner):
167         if isinstance(owner, owners.Owner):
168             self.owners[opt] = owner
169         else:
170             raise OptionValueError("Bad owner: " + str(owner))
171
172     def getowner(self, opt):
173         return self.owners.get(opt, owners.default)
174
175 # ____________________________________________________________
176 # multi types
177 class Multi(list):
178     """multi options values container
179     that support item notation for the values of multi options"""
180     def __init__(self, lst, context, opt, multitype):
181         """
182         :param lst: the Multi wraps a list value
183         :param context: the home config that has the settings and the values
184         :param opt: the option object that have this Multi value
185         """
186         self.settings = context._cfgimpl_settings
187         self.opt = opt
188         self.values = context._cfgimpl_values
189         self.multitype = multitype
190         super(Multi, self).__init__(lst)
191         if multitype == multitypes.master:
192             self.slaves = context._cfgimpl_values.masters[opt]
193         else:
194             self.slaves = None
195     def __setitem__(self, key, value):
196         self._validate(value)
197         self.values[self.opt] = self
198         super(Multi, self).__setitem__(key, value)
199
200     def append(self, value, force=False):
201         """the list value can be updated (appened)
202         only if the option is a master
203         """
204         if not force:
205             if self.multitype == multitypes.slave:
206                 raise MultiTypeError("cannot append a value on a multi option {0}"
207                         " wich is a slave".format(self.opt._name))
208             elif self.multitype == multitypes.master:
209                 for slave in self.slaves:
210                     self.values[slave].append(None, force=True)
211         self._validate(value)
212         self.values.setitem(self.opt, self)
213         super(Multi, self).append(value)
214
215     def _validate(self, value):
216         if value != None and not self.opt._validate(value):
217             raise ConfigError("invalid value {0} "
218                     "for option {1}".format(str(value), self.opt._name))
219
220     def pop(self, key, force=False):
221         """the list value can be updated (poped)
222         only if the option is a master
223
224         :param key: index of the element to pop
225         :return: the requested element
226         """
227         if not force:
228             if self.multitype == multitypes.slave:
229                 raise MultiTypeError("cannot append a value on a multi option {0}"
230                         " wich is a slave".format(self.opt._name))
231             elif self.multitype == multitypes.master:
232                 for slave in self.slaves:
233                     self.values[slave].pop(key, force=True)
234         self.values.setitem(self.opt, self)
235         return super(Multi, self).pop(key)