review exception
[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 # ____________________________________________________________
20 from tiramisu.error import MandatoryError, MultiTypeError, ConfigError
21 from tiramisu.setting import owners, multitypes
22 from tiramisu.autolib import carry_out_calculation
23 from tiramisu.i18n import _
24
25
26 class Values(object):
27     __slots__ = ('values', 'context')
28
29     def __init__(self, context):
30         """
31         Initializes the values's dict.
32
33         :param context: the context is the home config's values
34         """
35         "Config's root indeed is in charge of the `Option()`'s values"
36         self.values = {}
37         self.context = context
38
39     def _get_value(self, opt):
40         "return value or default value if not set"
41         #if no value
42         if opt not in self.values:
43             value = opt.getdefault()
44             if opt.is_multi():
45                 value = Multi(value, self.context, opt)
46                 #if slave, had values until master's one
47                 if opt.get_multitype() == multitypes.slave:
48                     masterpath = self.context.cfgimpl_get_description().get_path_by_opt(opt.get_master_slaves())
49                     mastervalue = getattr(self.context, masterpath)
50                     masterlen = len(mastervalue)
51                     if len(value) > masterlen:
52                         raise MultiTypeError(_("invalid len for the slave: {0}"
53                                              " which has {1} as master").format(
54                                                  opt._name, masterpath))
55                     if len(value) < masterlen:
56                         for num in range(0, masterlen - len(value)):
57                             value.append(opt.getdefault_multi(), force=True)
58                     #FIXME si inferieur ??
59         else:
60             #if value
61             value = self.values[opt][1]
62         return value
63
64     def reset(self, opt):
65         if opt in self.values:
66             del(self.values[opt])
67
68     def _is_empty(self, opt, value):
69         "convenience method to know if an option is empty"
70         #FIXME: buggy ?
71         #if value is not None:
72         #    return False
73         if (not opt.is_multi() and value is None) or \
74            (opt.is_multi() and (value == [] or
75                                 None in self._get_value(opt))):
76             return True
77         return False
78
79     def _test_mandatory(self, opt, value, force_properties=None):
80         setting = self.context.cfgimpl_get_settings()
81         if force_properties is None:
82             set_mandatory = setting.has_property('mandatory')
83         else:
84             set_mandatory = ('mandatory' in force_properties or
85                              setting.has_property('mandatory'))
86         if setting.has_property('mandatory', opt, False) and set_mandatory:
87             if self._is_empty(opt, value) and opt.is_empty_by_default():
88                 raise MandatoryError(_("option: {0} is mandatory "
89                                      "and shall have a value").format(opt._name))
90             #empty value
91             if opt.is_multi():
92                 for val in value:
93                     if val == '':
94                         raise MandatoryError(_("option: {0} is mandatory "
95                                              "and shall have not empty value").format(opt._name))
96             else:
97                 if value == '':
98                     raise MandatoryError(_("option: {0} is mandatory "
99                                          "and shall have not empty value").format(opt._name))
100
101     def fill_multi(self, opt, result):
102         """fills a multi option with default and calculated values
103         """
104         if not isinstance(result, list):
105             _result = [result]
106         else:
107             _result = result
108         return Multi(_result, self.context, opt)  # , multitype)
109
110     def _getcallback_value(self, opt):
111         callback, callback_params = opt.callback
112         if callback_params is None:
113             callback_params = {}
114         return carry_out_calculation(opt._name, config=self.context,
115                                      callback=callback,
116                                      callback_params=callback_params)
117
118     def __getitem__(self, opt):
119         return self._getitem(opt)
120
121     def _getitem(self, opt, force_properties=None, validate=True):
122         # options with callbacks
123         value = self._get_value(opt)
124         setting = self.context.cfgimpl_get_settings()
125         is_frozen = setting.has_property('frozen', opt, False)
126         if opt.has_callback():
127             #if value is set and :
128             # - not frozen
129             # - frozen and not force_default_on_freeze
130             if not self.is_default_owner(opt) and (
131                     not is_frozen or (is_frozen and
132                                       not setting.has_property('force_default_on_freeze', opt, False))):
133                 pass
134             else:
135                 value = self._getcallback_value(opt)
136                 if opt.is_multi():
137                     value = self.fill_multi(opt, value)
138                 #suppress value if already set
139                 self.reset(opt)
140         # frozen and force default
141         elif is_frozen and setting.has_property('force_default_on_freeze', opt, False):
142             value = opt.getdefault()
143             if opt.is_multi():
144                 value = self.fill_multi(opt, value)
145         self._test_mandatory(opt, value, force_properties)
146         if validate and not opt.validate(value, self.context, setting.has_property('validator')):
147             raise ValueError(_('invalid calculated value returned'
148                              ' for option {0}: {1}').format(opt._name, value))
149         return value
150
151     def __setitem__(self, opt, value):
152         if not opt.validate(value, self.context,
153                             self.context.cfgimpl_get_settings().has_property('validator')):
154             raise ValueError(_('invalid value {}'
155                              ' for option {}').format(value, opt._name))
156         if opt.is_multi():
157             if opt.get_multitype() == multitypes.master:
158                 masterlen = len(value)
159                 for slave in opt.master_slaves:
160                     value_slave = self._get_value(slave)
161                     if len(value_slave) > masterlen:
162                         raise MultiTypeError(_("invalid len for the slave: {0}"
163                                              " which has {1} as master").format(
164                                                  slave._name, opt._name))
165                     elif len(value_slave) < masterlen:
166                         for num in range(0, masterlen - len(value_slave)):
167                             value_slave.append(slave.getdefault_multi(), force=True)
168
169             elif opt.get_multitype() == multitypes.slave:
170                 if len(self._get_value(opt.master_slaves)) != len(value):
171                     raise MultiTypeError(_("invalid len for the slave: {0}"
172                                          " which has {1} as master").format(
173                                              opt._name, opt.master_slaves._name))
174             if not isinstance(value, Multi):
175                 value = Multi(value, self.context, opt)
176         self.setitem(opt, value)
177
178     def setitem(self, opt, value):
179         if type(value) == list:
180             raise MultiTypeError(_("the type of the value {0} which is multi shall "
181                                  "be Multi and not list").format(str(value)))
182         self._test_mandatory(opt, value)
183         self.values[opt] = (self.context.cfgimpl_get_settings().getowner(), value)
184
185     def __contains__(self, opt):
186         return opt in self.values
187
188     def getowner(self, opt):
189         return self.values.get(opt, (owners.default, None))[0]
190
191     def setowner(self, opt, owner):
192         if opt not in self.values:
193             raise ConfigError(_('no value for {1} cannot change owner to {2}').format(opt))
194         if not isinstance(owner, owners.Owner):
195             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
196         self.values[opt] = (owner, self.values[opt][1])
197
198     def is_default_owner(self, opt):
199         """
200         :param config: *must* be only the **parent** config
201                        (not the toplevel config)
202         :return: boolean
203         """
204         return self.getowner(opt) == owners.default
205
206 # ____________________________________________________________
207 # multi types
208
209
210 class Multi(list):
211     """multi options values container
212     that support item notation for the values of multi options"""
213     __slots__ = ('opt', 'context')
214
215     def __init__(self, lst, context, opt):
216         """
217         :param lst: the Multi wraps a list value
218         :param context: the home config that has the values
219         :param opt: the option object that have this Multi value
220         """
221         self.opt = opt
222         self.context = context
223         super(Multi, self).__init__(lst)
224
225     def __setitem__(self, key, value):
226         self._validate(value)
227         self.context.cfgimpl_get_values()[self.opt] = self
228         super(Multi, self).__setitem__(key, value)
229
230     def append(self, value, force=False):
231         """the list value can be updated (appened)
232         only if the option is a master
233         """
234         if not force:
235             if self.opt.get_multitype() == multitypes.slave:
236                 raise MultiTypeError(_("cannot append a value on a multi option {0}"
237                                      " which is a slave").format(self.opt._name))
238             elif self.opt.get_multitype() == multitypes.master:
239                 for slave in self.opt.get_master_slaves():
240                     self.context.cfgimpl_get_values()[slave].append(slave.getdefault_multi(), force=True)
241         self._validate(value)
242         self.context.cfgimpl_get_values().setitem(self.opt, self)
243         super(Multi, self).append(value)
244
245     def _validate(self, value):
246         if value is not None and not self.opt._validate(value):
247             raise ValueError(_("invalid value {0} "
248                               "for option {1}").format(str(value),
249                                                        self.opt._name))
250
251     def pop(self, key, force=False):
252         """the list value can be updated (poped)
253         only if the option is a master
254
255         :param key: index of the element to pop
256         :return: the requested element
257         """
258         if not force:
259             if self.opt.multitype == multitypes.slave:
260                 raise MultiTypeError(_("cannot append a value on a multi option {0}"
261                                      " which is a slave").format(self.opt._name))
262             elif self.opt.multitype == multitypes.master:
263                 for slave in self.opt.get_master_slaves():
264                     self.context.cfgimpl_get_values()[slave].pop(key, force=True)
265         self.context.cfgimpl_get_values().setitem(self.opt, self)
266         return super(Multi, self).pop(key)