refactor validation
[tiramisu.git] / tiramisu / autolib.py
1 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
2 #
3 # This program is free software: you can redistribute it and/or modify it
4 # under the terms of the GNU Lesser General Public License as published by the
5 # Free Software Foundation, either version 3 of the License, or (at your
6 # option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful, but WITHOUT
9 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
11 # details.
12 #
13 # You should have received a copy of the GNU Lesser General Public License
14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
15 #
16 # The original `Config` design model is unproudly borrowed from
17 # the rough gus of pypy: pypy: http://codespeak.net/svn/pypy/dist/pypy/config/
18 # the whole pypy projet is under MIT licence
19 # ____________________________________________________________
20 "enables us to carry out a calculation and return an option's value"
21 from tiramisu.error import PropertiesOptionError, ConfigError, ContextError
22 from tiramisu.i18n import _
23 from tiramisu.setting import undefined
24 # ____________________________________________________________
25
26
27 def carry_out_calculation(option, context, callback, callback_params,
28                           index=undefined):
29     """a function that carries out a calculation for an option's value
30
31     :param option: the option
32     :param context: the context config in order to have
33                    the whole options available
34     :param callback: the name of the callback function
35     :type callback: str
36     :param callback_params: the callback's parameters
37                             (only keyword parameters are allowed)
38     :type callback_params: dict
39     :param index: if an option is multi, only calculates the nth value
40     :type index: int
41
42     The callback_params is a dict. Key is used to build args (if key is '')
43     and kwargs (otherwise). Values are tuple of:
44     - values
45     - tuple with option and boolean's force_permissive (True when don't raise
46     if PropertiesOptionError)
47     Values could have multiple values only when key is ''.
48
49     * if no callback_params:
50       => calculate(<function func at 0x2092320>, [], {})
51
52     * if callback_params={'': ('yes',)}
53       => calculate(<function func at 0x2092320>, ['yes'], {})
54
55     * if callback_params={'value': ('yes',)}
56       => calculate(<function func at 0x165b320>, [], {'value': 'yes'})
57
58     * if callback_params={'': ('yes', 'no')}
59       => calculate('yes', 'no')
60
61     * if callback_params={'value': ('yes', 'no')}
62       => ValueError()
63
64     * if callback_params={'': (['yes', 'no'],)}
65       => calculate(<function func at 0x176b320>, ['yes', 'no'], {})
66
67     * if callback_params={'value': ('yes', 'no')}
68       => raises ValueError()
69
70     * if callback_params={'': ((opt1, False),)}
71
72        - a simple option:
73          opt1 == 11
74          => calculate(<function func at 0x1cea320>, [11], {})
75
76        - a multi option and not master/slave:
77          opt1 == [1, 2, 3]
78          => calculate(<function func at 0x223c320>, [[1, 2, 3]], {})
79
80        - option is master or slave of opt1:
81          opt1 == [1, 2, 3]
82          => calculate(<function func at 0x223c320>, [1], {})
83          => calculate(<function func at 0x223c320>, [2], {})
84          => calculate(<function func at 0x223c320>, [3], {})
85
86       - opt is a master or slave but not related to option:
87         opt1 == [1, 2, 3]
88         => calculate(<function func at 0x11b0320>, [[1, 2, 3]], {})
89
90     * if callback_params={'value': ((opt1, False),)}
91
92        - a simple option:
93          opt1 == 11
94          => calculate(<function func at 0x17ff320>, [], {'value': 11})
95
96        - a multi option:
97          opt1 == [1, 2, 3]
98          => calculate(<function func at 0x1262320>, [], {'value': [1, 2, 3]})
99
100     * if callback_params={'': ((opt1, False), (opt2, False))}
101
102       - two single options
103           opt1 = 11
104           opt2 = 12
105           => calculate(<function func at 0x217a320>, [11, 12], {})
106
107       - a multi option with a simple option
108           opt1 == [1, 2, 3]
109           opt2 == 12
110           => calculate(<function func at 0x2153320>, [[1, 2, 3], 12], {})
111
112       - a multi option with an other multi option but with same length
113           opt1 == [1, 2, 3]
114           opt2 == [11, 12, 13]
115           => calculate(<function func at 0x1981320>, [[1, 2, 3], [11, 12, 13]], {})
116
117       - a multi option with an other multi option but with different length
118           opt1 == [1, 2, 3]
119           opt2 == [11, 12]
120           => calculate(<function func at 0x2384320>, [[1, 2, 3], [11, 12]], {})
121
122       - a multi option without value with a simple option
123           opt1 == []
124           opt2 == 11
125           => calculate(<function func at 0xb65320>, [[], 12], {})
126
127     * if callback_params={'value': ((opt1, False), (opt2, False))}
128       => raises ValueError()
129
130     If index is not undefined, return a value, otherwise return:
131
132     * a list if one parameters have multi option
133     * a value otherwise
134
135     If calculate return list, this list is extend to return value.
136     """
137     tcparams = {}
138     # if callback_params has a callback, launch several time calculate()
139     master_slave = False
140     # multi's option should have same value for all option
141     len_multi = None
142     try:
143         if option._is_subdyn():
144             tcparams[''] = [(option.impl_getsuffix(), False)]
145     except AttributeError:
146         pass
147     for key, callbacks in callback_params.items():
148         for callbk in callbacks:
149             if isinstance(callbk, tuple):
150                 if context is undefined:
151                     raise ContextError()  # pragma: optional cover
152                 if callbk[0] is None:  # pragma: optional cover
153                     #Not an option, set full context
154                     tcparams.setdefault(key, []).append((context, False))
155                 else:
156                     # callbk is something link (opt, True|False)
157                     opt, force_permissive = callbk
158                     if opt._is_subdyn():
159                         root = '.'.join(option.impl_getpath(context).split('.')[:-1])
160                         name = opt.impl_getname() + option.impl_getsuffix()
161                         path = root + '.' + name
162                         opt = opt._impl_to_dyn(name, path)
163                     else:
164                         path = context.cfgimpl_get_description(
165                         ).impl_get_path_by_opt(opt)
166                     # get value
167                     try:
168                         value = context.getattr(path, force_permissive=True,
169                                                 validate=False)
170                         # convert to list, not modifie this multi
171                         if value.__class__.__name__ == 'Multi':
172                             value = list(value)
173                     except PropertiesOptionError as err:  # pragma: optional cover
174                         if force_permissive:
175                             continue
176                         raise ConfigError(_('unable to carry out a calculation'
177                                             ', option {0} has properties: {1} '
178                                             'for: {2}').format(opt.impl_getname(),
179                                                                err.proptype,
180                                                                option.impl_getname()))
181
182                     if opt.impl_is_master_slaves() and \
183                             opt.impl_get_master_slaves().in_same_group(option):
184                         len_multi = len(value)
185                         master_slave = True
186                         is_multi = True
187                     else:
188                         is_multi = False
189                     tcparams.setdefault(key, []).append((value, is_multi))
190             else:
191                 # callbk is a value and not a multi
192                 tcparams.setdefault(key, []).append((callbk, False))
193
194     # if one value is a multi, launch several time calculate
195     # if index is set, return a value
196     # if no index, return a list
197     if master_slave:
198         ret = []
199         if index is not undefined:
200             # for example if append master and get a no default slave without
201             # getting master
202             range_ = [index]
203         else:
204             range_ = range(len_multi)
205         for incr in range_:
206             args = []
207             kwargs = {}
208             for key, couples in tcparams.items():
209                 for couple in couples:
210                     value, ismulti = couple
211                     if ismulti:
212                         val = value[incr]
213                     else:
214                         val = value
215                     if key == '':
216                         args.append(val)
217                     else:
218                         kwargs[key] = val
219             calc = calculate(callback, args, kwargs)
220             if index is not undefined:
221                 ret = calc
222             else:
223                 ret.append(calc)
224         return ret
225     else:
226         # no value is multi
227         # return a single value
228         args = []
229         kwargs = {}
230         for key, couples in tcparams.items():
231             for couple in couples:
232                 # couple[1] (ismulti) is always False
233                 if key == '':
234                     args.append(couple[0])
235                 else:
236                     kwargs[key] = couple[0]
237         ret = calculate(callback, args, kwargs)
238         if callback_params != {}:
239             if isinstance(ret, list) and index is not undefined:
240                 if len(ret) < index + 1:
241                     ret = None
242                 else:
243                     ret = ret[index]
244         return ret
245
246
247 def calculate(callback, args, kwargs):
248     """wrapper that launches the 'callback'
249
250     :param callback: callback function
251     :param args: in the callback's arity, the unnamed parameters
252     :param kwargs: in the callback's arity, the named parameters
253
254     """
255     return callback(*args, **kwargs)