dont change anything if config_error
[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 import sys
23 import weakref
24 from tiramisu.error import ConfigError, SlaveError
25 from tiramisu.setting import owners, multitypes, expires_time
26 from tiramisu.autolib import carry_out_calculation
27 from tiramisu.i18n import _
28 from tiramisu.option import SymLinkOption
29
30
31 class Values(object):
32     """The `Config`'s root is indeed  in charge of the `Option()`'s values,
33     but the values are physicaly located here, in `Values`, wich is also
34     responsible of a caching utility.
35     """
36     __slots__ = ('context', '_p_', '__weakref__')
37
38     def __init__(self, context, storage):
39         """
40         Initializes the values's dict.
41
42         :param context: the context is the home config's values
43
44         """
45         self.context = weakref.ref(context)
46         # the storage type is dictionary or sqlite3
47         self._p_ = storage
48
49     def _getdefault(self, opt):
50         """
51         actually retrieves the default value
52
53         :param opt: the `option.Option()` object
54         """
55         meta = self.context().cfgimpl_get_meta()
56         if meta is not None:
57             value = meta.cfgimpl_get_values()[opt]
58         else:
59             value = opt.impl_getdefault()
60         if opt.impl_is_multi():
61             return copy(value)
62         else:
63             return value
64
65     def _getvalue(self, opt, path, validate=True):
66         """actually retrieves the value
67
68         :param opt: the `option.Option()` object
69         :returns: the option's value (or the default value if not set)
70         """
71         if not self._p_.hasvalue(path):
72             # if there is no value
73             value = self._getdefault(opt)
74             if opt.impl_is_multi():
75                 value = Multi(value, self.context, opt, path, validate)
76         else:
77             # if there is a value
78             value = self._p_.getvalue(path)
79             if opt.impl_is_multi() and not isinstance(value, Multi):
80                 # load value so don't need to validate if is not a Multi
81                 value = Multi(value, self.context, opt, path, validate=False)
82         return value
83
84     def get_modified_values(self):
85         return self._p_.get_modified_values()
86
87     def __contains__(self, opt):
88         """
89         implements the 'in' keyword syntax in order provide a pythonic way
90         to kow if an option have a value
91
92         :param opt: the `option.Option()` object
93         """
94         path = self._get_opt_path(opt)
95         return self._contains(path)
96
97     def _contains(self, path):
98         return self._p_.hasvalue(path)
99
100     def __delitem__(self, opt):
101         """overrides the builtins `del()` instructions"""
102         self.reset(opt)
103
104     def reset(self, opt, path=None):
105         if path is None:
106             path = self._get_opt_path(opt)
107         if self._p_.hasvalue(path):
108             setting = self.context().cfgimpl_get_settings()
109             opt.impl_validate(opt.impl_getdefault(), self.context(),
110                               'validator' in setting)
111             self.context().cfgimpl_reset_cache()
112             if (opt.impl_is_multi() and
113                     opt.impl_get_multitype() == multitypes.master):
114                 for slave in opt.impl_get_master_slaves():
115                     self.reset(slave)
116             self._p_.resetvalue(path)
117
118     def _isempty(self, opt, value):
119         "convenience method to know if an option is empty"
120         empty = opt._empty
121         if (not opt.impl_is_multi() and (value is None or value == empty)) or \
122            (opt.impl_is_multi() and (value == [] or
123                                      None in value or empty in value)):
124             return True
125         return False
126
127     def _getcallback_value(self, opt, index=None):
128         """
129         retrieves a value for the options that have a callback
130
131         :param opt: the `option.Option()` object
132         :param index: if an option is multi, only calculates the nth value
133         :type index: int
134         :returns: a calculated value
135         """
136         callback, callback_params = opt._callback
137         if callback_params is None:
138             callback_params = {}
139         return carry_out_calculation(opt._name, config=self.context(),
140                                      callback=callback,
141                                      callback_params=callback_params,
142                                      index=index)
143
144     def __getitem__(self, opt):
145         "enables us to use the pythonic dictionary-like access to values"
146         return self.getitem(opt)
147
148     def getitem(self, opt, path=None, validate=True, force_permissive=False,
149                 force_properties=None, validate_properties=True):
150         if path is None:
151             path = self._get_opt_path(opt)
152         ntime = None
153         setting = self.context().cfgimpl_get_settings()
154         if 'cache' in setting and self._p_.hascache(path):
155             if 'expire' in setting:
156                 ntime = int(time())
157             is_cached, value = self._p_.getcache(path, ntime)
158             if is_cached:
159                 if opt.impl_is_multi() and not isinstance(value, Multi):
160                     #load value so don't need to validate if is not a Multi
161                     value = Multi(value, self.context, opt, path, validate=False)
162                 return value
163         val = self._getitem(opt, path, validate, force_permissive,
164                             force_properties, validate_properties)
165         if 'cache' in setting and validate and validate_properties and \
166                 force_permissive is False and force_properties is None:
167             if 'expire' in setting:
168                 if ntime is None:
169                     ntime = int(time())
170                 ntime = ntime + expires_time
171             self._p_.setcache(path, val, ntime)
172
173         return val
174
175     def _getitem(self, opt, path, validate, force_permissive, force_properties,
176                  validate_properties):
177         # options with callbacks
178         setting = self.context().cfgimpl_get_settings()
179         is_frozen = 'frozen' in setting[opt]
180         # For calculating properties, we need value (ie for mandatory value).
181         # If value is calculating with a PropertiesOptionError's option
182         # _getcallback_value raise a ConfigError.
183         # We can not raise ConfigError if this option should raise
184         # PropertiesOptionError too. So we get config_error and raise
185         # ConfigError if properties did not raise.
186         config_error = None
187         force_permissives = None
188         # if value is callback and is not set
189         # or frozen with force_default_on_freeze
190         if opt.impl_has_callback() and (
191                 self._is_default_owner(path) or
192                 (is_frozen and 'force_default_on_freeze' in setting[opt])):
193             no_value_slave = False
194             if (opt.impl_is_multi() and
195                     opt.impl_get_multitype() == multitypes.slave):
196                 masterp = self._get_opt_path(opt.impl_get_master_slaves())
197                 mastervalue = getattr(self.context(), masterp)
198                 lenmaster = len(mastervalue)
199                 if lenmaster == 0:
200                     value = []
201                     no_value_slave = True
202
203             if not no_value_slave:
204                 try:
205                     value = self._getcallback_value(opt)
206                 except ConfigError as config_error:
207                     value = None
208                     # should not raise PropertiesOptionError if option is
209                     # mandatory
210                     force_permissives = set(['mandatory'])
211                 else:
212                     if (opt.impl_is_multi() and
213                             opt.impl_get_multitype() == multitypes.slave):
214                         if not isinstance(value, list):
215                             value = [value for i in range(lenmaster)]
216             if config_error is None:
217                 if opt.impl_is_multi():
218                     value = Multi(value, self.context, opt, path, validate)
219                 # suppress value if already set
220                 self.reset(opt, path)
221         # frozen and force default
222         elif is_frozen and 'force_default_on_freeze' in setting[opt]:
223             value = self._getdefault(opt)
224             if opt.impl_is_multi():
225                 value = Multi(value, self.context, opt, path, validate)
226         else:
227             value = self._getvalue(opt, path, validate)
228         if config_error is None and validate:
229             opt.impl_validate(value, self.context(), 'validator' in setting)
230         if config_error is None and self._is_default_owner(path) and \
231                 'force_store_value' in setting[opt]:
232             self.setitem(opt, value, path, is_write=False)
233         if validate_properties:
234             setting.validate_properties(opt, False, False, value=value, path=path,
235                                         force_permissive=force_permissive,
236                                         force_properties=force_properties,
237                                         force_permissives=force_permissives)
238         if config_error is not None:
239             raise ConfigError(config_error)
240         return value
241
242     def __setitem__(self, opt, value):
243         raise ValueError('you should only set value with config')
244
245     def setitem(self, opt, value, path, force_permissive=False,
246                 is_write=True):
247         # is_write is, for example, used with "force_store_value"
248         # user didn't change value, so not write
249         # valid opt
250         opt.impl_validate(value, self.context(),
251                           'validator' in self.context().cfgimpl_get_settings())
252         if opt.impl_is_multi() and not isinstance(value, Multi):
253             value = Multi(value, self.context, opt, path)
254         self._setvalue(opt, path, value, force_permissive=force_permissive,
255                        is_write=is_write)
256
257     def _setvalue(self, opt, path, value, force_permissive=False,
258                   force_properties=None,
259                   is_write=True, validate_properties=True):
260         self.context().cfgimpl_reset_cache()
261         if validate_properties:
262             setting = self.context().cfgimpl_get_settings()
263             setting.validate_properties(opt, False, is_write,
264                                         value=value, path=path,
265                                         force_permissive=force_permissive,
266                                         force_properties=force_properties)
267         owner = self.context().cfgimpl_get_settings().getowner()
268         self._p_.setvalue(path, value, owner)
269
270     def getowner(self, opt):
271         """
272         retrieves the option's owner
273
274         :param opt: the `option.Option` object
275         :returns: a `setting.owners.Owner` object
276         """
277         if isinstance(opt, SymLinkOption):
278             opt = opt._opt
279         path = self._get_opt_path(opt)
280         return self._getowner(path)
281
282     def _getowner(self, path):
283         owner = self._p_.getowner(path, owners.default)
284         meta = self.context().cfgimpl_get_meta()
285         if owner is owners.default and meta is not None:
286             owner = meta.cfgimpl_get_values()._getowner(path)
287         return owner
288
289     def setowner(self, opt, owner):
290         """
291         sets a owner to an option
292
293         :param opt: the `option.Option` object
294         :param owner: a valid owner, that is a `setting.owners.Owner` object
295         """
296         if not isinstance(owner, owners.Owner):
297             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
298
299         path = self._get_opt_path(opt)
300         self._setowner(path, owner)
301
302     def _setowner(self, path, owner):
303         if self._getowner(path) == owners.default:
304             raise ConfigError(_('no value for {0} cannot change owner to {1}'
305                                 '').format(path, owner))
306         self._p_.setowner(path, owner)
307
308     def is_default_owner(self, opt):
309         """
310         :param config: *must* be only the **parent** config
311                        (not the toplevel config)
312         :return: boolean
313         """
314         path = self._get_opt_path(opt)
315         return self._is_default_owner(path)
316
317     def _is_default_owner(self, path):
318         return self._getowner(path) == owners.default
319
320     def reset_cache(self, only_expired):
321         """
322         clears the cache if necessary
323         """
324         if only_expired:
325             self._p_.reset_expired_cache(int(time()))
326         else:
327             self._p_.reset_all_cache()
328
329     def _get_opt_path(self, opt):
330         """
331         retrieve the option's path in the config
332
333         :param opt: the `option.Option` object
334         :returns: a string with points like "gc.dummy.my_option"
335         """
336         return self.context().cfgimpl_get_description().impl_get_path_by_opt(opt)
337
338     # information
339     def set_information(self, key, value):
340         """updates the information's attribute
341
342         :param key: information's key (ex: "help", "doc"
343         :param value: information's value (ex: "the help string")
344         """
345         self._p_.set_information(key, value)
346
347     def get_information(self, key, default=None):
348         """retrieves one information's item
349
350         :param key: the item string (ex: "help")
351         """
352         try:
353             return self._p_.get_information(key)
354         except ValueError:
355             if default is not None:
356                 return default
357             else:
358                 raise ValueError(_("information's item"
359                                    " not found: {0}").format(key))
360
361
362 # ____________________________________________________________
363 # multi types
364
365
366 class Multi(list):
367     """multi options values container
368     that support item notation for the values of multi options"""
369     __slots__ = ('opt', 'path', 'context')
370
371     def __init__(self, value, context, opt, path, validate=True):
372         """
373         :param value: the Multi wraps a list value
374         :param context: the home config that has the values
375         :param opt: the option object that have this Multi value
376         """
377         self.opt = opt
378         self.path = path
379         if not isinstance(context, weakref.ReferenceType):
380             raise ValueError('context must be a Weakref')
381         self.context = context
382         if not isinstance(value, list):
383             value = [value]
384         if validate and self.opt.impl_get_multitype() == multitypes.slave:
385             value = self._valid_slave(value)
386         elif self.opt.impl_get_multitype() == multitypes.master:
387             self._valid_master(value)
388         super(Multi, self).__init__(value)
389
390     def _valid_slave(self, value):
391         #if slave, had values until master's one
392         masterp = self.context().cfgimpl_get_description().impl_get_path_by_opt(
393             self.opt.impl_get_master_slaves())
394         mastervalue = getattr(self.context(), masterp)
395         masterlen = len(mastervalue)
396         valuelen = len(value)
397         if valuelen > masterlen or (valuelen < masterlen and
398                                     not self.context().cfgimpl_get_values(
399                                     )._is_default_owner(self.path)):
400             raise SlaveError(_("invalid len for the slave: {0}"
401                                " which has {1} as master").format(
402                                    self.opt._name, masterp))
403         elif valuelen < masterlen:
404             for num in range(0, masterlen - valuelen):
405                 value.append(self.opt.impl_getdefault_multi())
406         #else: same len so do nothing
407         return value
408
409     def _valid_master(self, value):
410         masterlen = len(value)
411         values = self.context().cfgimpl_get_values()
412         for slave in self.opt._master_slaves:
413             path = values._get_opt_path(slave)
414             if not values._is_default_owner(path):
415                 value_slave = values._getvalue(slave, path)
416                 if len(value_slave) > masterlen:
417                     raise SlaveError(_("invalid len for the master: {0}"
418                                        " which has {1} as slave with"
419                                        " greater len").format(
420                                            self.opt._name, slave._name))
421                 elif len(value_slave) < masterlen:
422                     for num in range(0, masterlen - len(value_slave)):
423                         value_slave.append(slave.impl_getdefault_multi(),
424                                            force=True)
425
426     def __setitem__(self, key, value):
427         self._validate(value)
428         #assume not checking mandatory property
429         super(Multi, self).__setitem__(key, value)
430         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
431
432     def append(self, value, force=False):
433         """the list value can be updated (appened)
434         only if the option is a master
435         """
436         if not force:
437             if self.opt.impl_get_multitype() == multitypes.slave:
438                 raise SlaveError(_("cannot append a value on a multi option {0}"
439                                    " which is a slave").format(self.opt._name))
440             elif self.opt.impl_get_multitype() == multitypes.master:
441                 values = self.context().cfgimpl_get_values()
442                 if value is None and self.opt.impl_has_callback():
443                     value = values._getcallback_value(self.opt)
444                     #Force None il return a list
445                     if isinstance(value, list):
446                         value = None
447         self._validate(value)
448         super(Multi, self).append(value)
449         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
450         if not force and self.opt.impl_get_multitype() == multitypes.master:
451             for slave in self.opt.impl_get_master_slaves():
452                 path = values._get_opt_path(slave)
453                 if not values._is_default_owner(path):
454                     if slave.impl_has_callback():
455                         index = self.__len__() - 1
456                         dvalue = values._getcallback_value(slave, index=index)
457                     else:
458                         dvalue = slave.impl_getdefault_multi()
459                     old_value = values.getitem(slave, path,
460                                                validate_properties=False)
461                     if len(old_value) < self.__len__():
462                         values.getitem(slave, path,
463                                        validate_properties=False).append(
464                                            dvalue, force=True)
465                     else:
466                         values.getitem(slave, path,
467                                        validate_properties=False)[
468                                            index] = dvalue
469
470     def sort(self, cmp=None, key=None, reverse=False):
471         if self.opt.impl_get_multitype() in [multitypes.slave,
472                                              multitypes.master]:
473             raise SlaveError(_("cannot sort multi option {0} if master or slave"
474                                "").format(self.opt._name))
475         if sys.version_info[0] >= 3:
476             if cmp is not None:
477                 raise ValueError(_('cmp is not permitted in python v3 or greater'))
478             super(Multi, self).sort(key=key, reverse=reverse)
479         else:
480             super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
481         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
482
483     def reverse(self):
484         if self.opt.impl_get_multitype() in [multitypes.slave,
485                                              multitypes.master]:
486             raise SlaveError(_("cannot reverse multi option {0} if master or "
487                                "slave").format(self.opt._name))
488         super(Multi, self).reverse()
489         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
490
491     def insert(self, index, obj):
492         if self.opt.impl_get_multitype() in [multitypes.slave,
493                                              multitypes.master]:
494             raise SlaveError(_("cannot insert multi option {0} if master or "
495                                "slave").format(self.opt._name))
496         super(Multi, self).insert(index, obj)
497         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
498
499     def extend(self, iterable):
500         if self.opt.impl_get_multitype() in [multitypes.slave,
501                                              multitypes.master]:
502             raise SlaveError(_("cannot extend multi option {0} if master or "
503                                "slave").format(self.opt._name))
504         super(Multi, self).extend(iterable)
505         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
506
507     def _validate(self, value):
508         if value is not None:
509             try:
510                 self.opt._validate(value)
511             except ValueError as err:
512                 raise ValueError(_("invalid value {0} "
513                                    "for option {1}: {2}"
514                                    "").format(str(value),
515                                               self.opt._name, err))
516
517     def pop(self, key, force=False):
518         """the list value can be updated (poped)
519         only if the option is a master
520
521         :param key: index of the element to pop
522         :return: the requested element
523         """
524         if not force:
525             if self.opt.impl_get_multitype() == multitypes.slave:
526                 raise SlaveError(_("cannot pop a value on a multi option {0}"
527                                    " which is a slave").format(self.opt._name))
528             elif self.opt.impl_get_multitype() == multitypes.master:
529                 for slave in self.opt.impl_get_master_slaves():
530                     values = self.context().cfgimpl_get_values()
531                     if not values.is_default_owner(slave):
532                         #get multi without valid properties
533                         values.getitem(slave,
534                                        validate_properties=False
535                                        ).pop(key, force=True)
536         #set value without valid properties
537         ret = super(Multi, self).pop(key)
538         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
539         return ret