update french translation
[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 time import time
21 from copy import copy
22 from tiramisu.error import ConfigError, SlaveError
23 from tiramisu.setting import owners, multitypes, expires_time
24 from tiramisu.autolib import carry_out_calculation
25 from tiramisu.i18n import _
26 from tiramisu.option import SymLinkOption
27
28
29 class Values(object):
30     """The `Config`'s root is indeed  in charge of the `Option()`'s values,
31     but the values are physicaly located here, in `Values`, wich is also
32     responsible of a caching utility.
33     """
34     __slots__ = ('context', '_values', '_cache')
35
36     def __init__(self, context):
37         """
38         Initializes the values's dict.
39
40         :param context: the context is the home config's values
41
42         """
43
44         self.context = context
45         self._values = {}
46         self._cache = {}
47         super(Values, self).__init__()
48
49     def _get_default(self, opt):
50         meta = self.context.cfgimpl_get_meta()
51         if meta is not None:
52             value = meta.cfgimpl_get_values()[opt]
53         else:
54             value = opt.impl_getdefault()
55         if opt.impl_is_multi():
56             return copy(value)
57         else:
58             return value
59
60     def _get_value(self, opt, validate=True):
61         "return value or default value if not set"
62         #if no value
63         if opt not in self._values:
64             value = self._get_default(opt)
65             if opt.impl_is_multi():
66                 value = Multi(value, self.context, opt, validate)
67         else:
68             #if value
69             value = self._values[opt][1]
70         return value
71
72     def __delitem__(self, opt):
73         self._reset(opt)
74
75     def _reset(self, opt):
76         if opt in self._values:
77             setting = self.context.cfgimpl_get_settings()
78             opt.impl_validate(opt.impl_getdefault(), self.context,
79                               'validator' in setting)
80             self.context.cfgimpl_reset_cache()
81             if opt.impl_is_multi() and opt.impl_get_multitype() == multitypes.master:
82                 for slave in opt.impl_get_master_slaves():
83                     self._reset(slave)
84             del(self._values[opt])
85
86     def _is_empty(self, opt, value):
87         "convenience method to know if an option is empty"
88         empty = opt._empty
89         if (not opt.impl_is_multi() and (value is None or value == empty)) or \
90            (opt.impl_is_multi() and (value == [] or
91                                      None in value or empty in value)):
92             return True
93         return False
94
95     def _getcallback_value(self, opt, index=None):
96         callback, callback_params = opt._callback
97         if callback_params is None:
98             callback_params = {}
99         return carry_out_calculation(opt._name, config=self.context,
100                                      callback=callback,
101                                      callback_params=callback_params,
102                                      index=index)
103
104     def __getitem__(self, opt):
105         return self.getitem(opt)
106
107     def get_modified_values(self):
108         return self._values
109
110     def getitem(self, opt, validate=True, force_permissive=False,
111                 force_properties=None, validate_properties=True):
112         if opt in self._cache:
113             exp = time()
114             value, created = self._cache[opt]
115             if exp < created:
116                 return value
117         val = self._getitem(opt, validate, force_permissive, force_properties,
118                             validate_properties)
119         if validate and validate_properties and force_permissive is False and \
120                 force_properties is None:
121             self._set_cache(opt, val)
122         return val
123
124     def _getitem(self, opt, validate, force_permissive, force_properties,
125                  validate_properties):
126         # options with callbacks
127         setting = self.context.cfgimpl_get_settings()
128         is_frozen = 'frozen' in setting[opt]
129         #if value is callback and is not set or frozen with force_default_on_freeze
130         if opt.impl_has_callback() and (self.is_default_owner(opt) or
131                                         (is_frozen and
132                                          'force_default_on_freeze' in setting[opt])):
133             no_value_slave = False
134             if opt.impl_is_multi() and opt.impl_get_multitype() == multitypes.slave:
135                 masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
136                     opt.impl_get_master_slaves())
137                 mastervalue = getattr(self.context, masterp)
138                 lenmaster = len(mastervalue)
139                 if lenmaster == 0:
140                     value = []
141                     no_value_slave = True
142
143             if not no_value_slave:
144                 value = self._getcallback_value(opt)
145                 if opt.impl_is_multi() and opt.impl_get_multitype() == multitypes.slave:
146                     if not isinstance(value, list):
147                         value = [value for i in range(lenmaster)]
148             if opt.impl_is_multi():
149                 value = Multi(value, self.context, opt, validate)
150             #suppress value if already set
151             self._reset(opt)
152         # frozen and force default
153         elif is_frozen and 'force_default_on_freeze' in setting[opt]:
154             value = self._get_default(opt)
155             if opt.impl_is_multi():
156                 value = Multi(value, self.context, opt, validate)
157         else:
158             value = self._get_value(opt, validate)
159         if validate:
160             opt.impl_validate(value, self.context, 'validator' in setting)
161         if self.is_default_owner(opt) and \
162                 'force_store_value' in setting[opt]:
163             self.setitem(opt, value, is_write=False)
164         if validate_properties:
165             setting.validate_properties(opt, False, False, value=value,
166                                         force_permissive=force_permissive,
167                                         force_properties=force_properties)
168         return value
169
170     def __setitem__(self, opt, value):
171         self.setitem(opt, value)
172
173     def setitem(self, opt, value, force_permissive=False, is_write=True):
174         #is_write is, for example, used with "force_store_value"
175         #user didn't change value, so not write
176         #valid opt
177         opt.impl_validate(value, self.context,
178                           'validator' in self.context.cfgimpl_get_settings())
179         if opt.impl_is_multi() and not isinstance(value, Multi):
180             value = Multi(value, self.context, opt)
181         self._setvalue(opt, value, force_permissive=force_permissive,
182                        is_write=is_write)
183
184     def _setvalue(self, opt, value, force_permissive=False, force_properties=None,
185                   is_write=True, validate_properties=True):
186         self.context.cfgimpl_reset_cache()
187         setting = self.context.cfgimpl_get_settings()
188         if validate_properties:
189             setting.validate_properties(opt, False, is_write,
190                                         value=value,
191                                         force_permissive=force_permissive,
192                                         force_properties=force_properties)
193         self._values[opt] = (setting.getowner(), value)
194
195     def getowner(self, opt):
196         if isinstance(opt, SymLinkOption):
197             opt = opt._opt
198         owner = self._values.get(opt, (owners.default, None))[0]
199         meta = self.context.cfgimpl_get_meta()
200         if owner is owners.default and meta is not None:
201             owner = meta.cfgimpl_get_values().getowner(opt)
202         return owner
203
204     def setowner(self, opt, owner):
205         if opt not in self._values:
206             raise ConfigError(_('no value for {0} cannot change owner to {1}').format(opt._name, owner))
207         if not isinstance(owner, owners.Owner):
208             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
209         self._values[opt] = (owner, self._values[opt][1])
210
211     def is_default_owner(self, opt):
212         """
213         :param config: *must* be only the **parent** config
214                        (not the toplevel config)
215         :return: boolean
216         """
217         return self.getowner(opt) == owners.default
218
219     def _set_cache(self, opt, val):
220         if 'expire' in self.context.cfgimpl_get_settings():
221             self._cache[opt] = (val, time() + expires_time)
222
223     def reset_cache(self, only_expired):
224         if only_expired:
225             exp = time()
226             keys = self._cache.keys()
227             for key in keys:
228                 val, created = self._cache[key]
229                 if exp > created:
230                     del(self._cache[key])
231         else:
232             self._cache.clear()
233
234     def __contains__(self, opt):
235         return opt in self._values
236
237 # ____________________________________________________________
238 # multi types
239
240
241 class Multi(list):
242     """multi options values container
243     that support item notation for the values of multi options"""
244     __slots__ = ('opt', 'context')
245
246     def __init__(self, value, context, opt, validate=True):
247         """
248         :param value: the Multi wraps a list value
249         :param context: the home config that has the values
250         :param opt: the option object that have this Multi value
251         """
252         self.opt = opt
253         self.context = context
254         if not isinstance(value, list):
255             value = [value]
256         if validate and self.opt.impl_get_multitype() == multitypes.slave:
257             value = self._valid_slave(value)
258         elif self.opt.impl_get_multitype() == multitypes.master:
259             self._valid_master(value)
260         super(Multi, self).__init__(value)
261
262     def _valid_slave(self, value):
263         #if slave, had values until master's one
264         masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
265             self.opt.impl_get_master_slaves())
266         mastervalue = getattr(self.context, masterp)
267         masterlen = len(mastervalue)
268         if len(value) > masterlen or (len(value) < masterlen and
269                                       not self.context.cfgimpl_get_values().is_default_owner(self.opt)):
270             raise SlaveError(_("invalid len for the slave: {0}"
271                                " which has {1} as master").format(
272                                    self.opt._name, masterp))
273         elif len(value) < masterlen:
274             for num in range(0, masterlen - len(value)):
275                 value.append(self.opt.impl_getdefault_multi())
276         #else: same len so do nothing
277         return value
278
279     def _valid_master(self, value):
280         masterlen = len(value)
281         values = self.context.cfgimpl_get_values()
282         for slave in self.opt._master_slaves:
283             if not values.is_default_owner(slave):
284                 value_slave = values._get_value(slave)
285                 if len(value_slave) > masterlen:
286                     raise SlaveError(_("invalid len for the master: {0}"
287                                        " which has {1} as slave with"
288                                        " greater len").format(
289                                            self.opt._name, slave._name))
290                 elif len(value_slave) < masterlen:
291                     for num in range(0, masterlen - len(value_slave)):
292                         value_slave.append(slave.impl_getdefault_multi(), force=True)
293
294     def __setitem__(self, key, value):
295         self._validate(value)
296         #assume not checking mandatory property
297         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
298         super(Multi, self).__setitem__(key, value)
299
300     def append(self, value, force=False):
301         """the list value can be updated (appened)
302         only if the option is a master
303         """
304         if not force:
305             if self.opt.impl_get_multitype() == multitypes.slave:
306                 raise SlaveError(_("cannot append a value on a multi option {0}"
307                                    " which is a slave").format(self.opt._name))
308             elif self.opt.impl_get_multitype() == multitypes.master:
309                 values = self.context.cfgimpl_get_values()
310                 if value is None and self.opt.impl_has_callback():
311                     value = values._getcallback_value(self.opt)
312                     #Force None il return a list
313                     if isinstance(value, list):
314                         value = None
315         self._validate(value)
316         #set value without valid properties
317         self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
318         super(Multi, self).append(value)
319         if not force and self.opt.impl_get_multitype() == multitypes.master:
320             for slave in self.opt.impl_get_master_slaves():
321                 if not values.is_default_owner(slave):
322                     if slave.impl_has_callback():
323                         index = self.__len__() - 1
324                         dvalue = values._getcallback_value(slave, index=index)
325                     else:
326                         dvalue = slave.impl_getdefault_multi()
327                     #get multi without valid properties
328                     values.getitem(slave, validate_properties=False).append(
329                         dvalue, force=True)
330
331     def sort(self, cmp=None, key=None, reverse=False):
332         if self.opt.impl_get_multitype() in [multitypes.slave,
333                                              multitypes.master]:
334             raise SlaveError(_("cannot sort multi option {0} if master or slave"
335                                "").format(self.opt._name))
336         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
337         super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
338
339     def reverse(self):
340         if self.opt.impl_get_multitype() in [multitypes.slave,
341                                              multitypes.master]:
342             raise SlaveError(_("cannot reverse multi option {0} if master or "
343                                "slave").format(self.opt._name))
344         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
345         super(Multi, self).reverse()
346
347     def insert(self, index, obj):
348         if self.opt.impl_get_multitype() in [multitypes.slave,
349                                              multitypes.master]:
350             raise SlaveError(_("cannot insert multi option {0} if master or "
351                                "slave").format(self.opt._name))
352         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
353         super(Multi, self).insert(index, obj)
354
355     def extend(self, iterable):
356         if self.opt.impl_get_multitype() in [multitypes.slave,
357                                              multitypes.master]:
358             raise SlaveError(_("cannot extend multi option {0} if master or "
359                                "slave").format(self.opt._name))
360         self.context.cfgimpl_get_values()._setvalue(self.opt, self)
361         super(Multi, self).extend(iterable)
362
363     def _validate(self, value):
364         if value is not None:
365             try:
366                 self.opt._validate(value)
367             except ValueError, err:
368                 raise ValueError(_("invalid value {0} "
369                                    "for option {1}: {2}").format(str(value),
370                                                                  self.opt._name, err))
371
372     def pop(self, key, force=False):
373         """the list value can be updated (poped)
374         only if the option is a master
375
376         :param key: index of the element to pop
377         :return: the requested element
378         """
379         if not force:
380             if self.opt.impl_get_multitype() == multitypes.slave:
381                 raise SlaveError(_("cannot pop a value on a multi option {0}"
382                                    " which is a slave").format(self.opt._name))
383             elif self.opt.impl_get_multitype() == multitypes.master:
384                 for slave in self.opt.impl_get_master_slaves():
385                     values = self.context.cfgimpl_get_values()
386                     if not values.is_default_owner(slave):
387                         #get multi without valid properties
388                         values.getitem(slave, validate_properties=False).pop(key, force=True)
389         #set value without valid properties
390         self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
391         return super(Multi, self).pop(key)