3d172dcdc36c4761ecea61ca104b4677a3c4598b
[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         # if value is callback and is not set
181         # or frozen with force_default_on_freeze
182         config_error = None
183         if opt.impl_has_callback() and (
184                 self._is_default_owner(path) or
185                 (is_frozen and 'force_default_on_freeze' in setting[opt])):
186             no_value_slave = False
187             if (opt.impl_is_multi() and
188                     opt.impl_get_multitype() == multitypes.slave):
189                 masterp = self._get_opt_path(opt.impl_get_master_slaves())
190                 mastervalue = getattr(self.context(), masterp)
191                 lenmaster = len(mastervalue)
192                 if lenmaster == 0:
193                     value = []
194                     no_value_slave = True
195
196             if not no_value_slave:
197                 try:
198                     value = self._getcallback_value(opt)
199                 except ConfigError as config_error:
200                     value = None
201                 else:
202                     if (opt.impl_is_multi() and
203                             opt.impl_get_multitype() == multitypes.slave):
204                         if not isinstance(value, list):
205                             value = [value for i in range(lenmaster)]
206             if opt.impl_is_multi():
207                 value = Multi(value, self.context, opt, path, validate)
208             # suppress value if already set
209             self.reset(opt, path)
210         # frozen and force default
211         elif is_frozen and 'force_default_on_freeze' in setting[opt]:
212             value = self._getdefault(opt)
213             if opt.impl_is_multi():
214                 value = Multi(value, self.context, opt, path, validate)
215         else:
216             value = self._getvalue(opt, path, validate)
217         if validate:
218             opt.impl_validate(value, self.context(), 'validator' in setting)
219         if self._is_default_owner(path) and \
220                 'force_store_value' in setting[opt]:
221             self.setitem(opt, value, path, is_write=False)
222         if validate_properties:
223             setting.validate_properties(opt, False, False, value=value, path=path,
224                                         force_permissive=force_permissive,
225                                         force_properties=force_properties)
226         if config_error is not None:
227             raise ConfigError(config_error)
228         return value
229
230     def __setitem__(self, opt, value):
231         raise ValueError('you should only set value with config')
232
233     def setitem(self, opt, value, path, force_permissive=False,
234                 is_write=True):
235         # is_write is, for example, used with "force_store_value"
236         # user didn't change value, so not write
237         # valid opt
238         opt.impl_validate(value, self.context(),
239                           'validator' in self.context().cfgimpl_get_settings())
240         if opt.impl_is_multi() and not isinstance(value, Multi):
241             value = Multi(value, self.context, opt, path)
242         self._setvalue(opt, path, value, force_permissive=force_permissive,
243                        is_write=is_write)
244
245     def _setvalue(self, opt, path, value, force_permissive=False,
246                   force_properties=None,
247                   is_write=True, validate_properties=True):
248         self.context().cfgimpl_reset_cache()
249         if validate_properties:
250             setting = self.context().cfgimpl_get_settings()
251             setting.validate_properties(opt, False, is_write,
252                                         value=value, path=path,
253                                         force_permissive=force_permissive,
254                                         force_properties=force_properties)
255         owner = self.context().cfgimpl_get_settings().getowner()
256         self._p_.setvalue(path, value, owner)
257
258     def getowner(self, opt):
259         """
260         retrieves the option's owner
261
262         :param opt: the `option.Option` object
263         :returns: a `setting.owners.Owner` object
264         """
265         if isinstance(opt, SymLinkOption):
266             opt = opt._opt
267         path = self._get_opt_path(opt)
268         return self._getowner(path)
269
270     def _getowner(self, path):
271         owner = self._p_.getowner(path, owners.default)
272         meta = self.context().cfgimpl_get_meta()
273         if owner is owners.default and meta is not None:
274             owner = meta.cfgimpl_get_values()._getowner(path)
275         return owner
276
277     def setowner(self, opt, owner):
278         """
279         sets a owner to an option
280
281         :param opt: the `option.Option` object
282         :param owner: a valid owner, that is a `setting.owners.Owner` object
283         """
284         if not isinstance(owner, owners.Owner):
285             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
286
287         path = self._get_opt_path(opt)
288         self._setowner(path, owner)
289
290     def _setowner(self, path, owner):
291         if self._getowner(path) == owners.default:
292             raise ConfigError(_('no value for {0} cannot change owner to {1}'
293                                 '').format(path, owner))
294         self._p_.setowner(path, owner)
295
296     def is_default_owner(self, opt):
297         """
298         :param config: *must* be only the **parent** config
299                        (not the toplevel config)
300         :return: boolean
301         """
302         path = self._get_opt_path(opt)
303         return self._is_default_owner(path)
304
305     def _is_default_owner(self, path):
306         return self._getowner(path) == owners.default
307
308     def reset_cache(self, only_expired):
309         """
310         clears the cache if necessary
311         """
312         if only_expired:
313             self._p_.reset_expired_cache(int(time()))
314         else:
315             self._p_.reset_all_cache()
316
317     def _get_opt_path(self, opt):
318         """
319         retrieve the option's path in the config
320
321         :param opt: the `option.Option` object
322         :returns: a string with points like "gc.dummy.my_option"
323         """
324         return self.context().cfgimpl_get_description().impl_get_path_by_opt(opt)
325
326     # information
327     def set_information(self, key, value):
328         """updates the information's attribute
329
330         :param key: information's key (ex: "help", "doc"
331         :param value: information's value (ex: "the help string")
332         """
333         self._p_.set_information(key, value)
334
335     def get_information(self, key, default=None):
336         """retrieves one information's item
337
338         :param key: the item string (ex: "help")
339         """
340         try:
341             return self._p_.get_information(key)
342         except ValueError:
343             if default is not None:
344                 return default
345             else:
346                 raise ValueError(_("information's item"
347                                    " not found: {0}").format(key))
348
349
350 # ____________________________________________________________
351 # multi types
352
353
354 class Multi(list):
355     """multi options values container
356     that support item notation for the values of multi options"""
357     __slots__ = ('opt', 'path', 'context')
358
359     def __init__(self, value, context, opt, path, validate=True):
360         """
361         :param value: the Multi wraps a list value
362         :param context: the home config that has the values
363         :param opt: the option object that have this Multi value
364         """
365         self.opt = opt
366         self.path = path
367         if not isinstance(context, weakref.ReferenceType):
368             raise ValueError('context must be a Weakref')
369         self.context = context
370         if not isinstance(value, list):
371             value = [value]
372         if validate and self.opt.impl_get_multitype() == multitypes.slave:
373             value = self._valid_slave(value)
374         elif self.opt.impl_get_multitype() == multitypes.master:
375             self._valid_master(value)
376         super(Multi, self).__init__(value)
377
378     def _valid_slave(self, value):
379         #if slave, had values until master's one
380         masterp = self.context().cfgimpl_get_description().impl_get_path_by_opt(
381             self.opt.impl_get_master_slaves())
382         mastervalue = getattr(self.context(), masterp)
383         masterlen = len(mastervalue)
384         valuelen = len(value)
385         if valuelen > masterlen or (valuelen < masterlen and
386                                     not self.context().cfgimpl_get_values(
387                                     )._is_default_owner(self.path)):
388             raise SlaveError(_("invalid len for the slave: {0}"
389                                " which has {1} as master").format(
390                                    self.opt._name, masterp))
391         elif valuelen < masterlen:
392             for num in range(0, masterlen - valuelen):
393                 value.append(self.opt.impl_getdefault_multi())
394         #else: same len so do nothing
395         return value
396
397     def _valid_master(self, value):
398         masterlen = len(value)
399         values = self.context().cfgimpl_get_values()
400         for slave in self.opt._master_slaves:
401             path = values._get_opt_path(slave)
402             if not values._is_default_owner(path):
403                 value_slave = values._getvalue(slave, path)
404                 if len(value_slave) > masterlen:
405                     raise SlaveError(_("invalid len for the master: {0}"
406                                        " which has {1} as slave with"
407                                        " greater len").format(
408                                            self.opt._name, slave._name))
409                 elif len(value_slave) < masterlen:
410                     for num in range(0, masterlen - len(value_slave)):
411                         value_slave.append(slave.impl_getdefault_multi(),
412                                            force=True)
413
414     def __setitem__(self, key, value):
415         self._validate(value)
416         #assume not checking mandatory property
417         super(Multi, self).__setitem__(key, value)
418         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
419
420     def append(self, value, force=False):
421         """the list value can be updated (appened)
422         only if the option is a master
423         """
424         if not force:
425             if self.opt.impl_get_multitype() == multitypes.slave:
426                 raise SlaveError(_("cannot append a value on a multi option {0}"
427                                    " which is a slave").format(self.opt._name))
428             elif self.opt.impl_get_multitype() == multitypes.master:
429                 values = self.context().cfgimpl_get_values()
430                 if value is None and self.opt.impl_has_callback():
431                     value = values._getcallback_value(self.opt)
432                     #Force None il return a list
433                     if isinstance(value, list):
434                         value = None
435         self._validate(value)
436         super(Multi, self).append(value)
437         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
438         if not force and self.opt.impl_get_multitype() == multitypes.master:
439             for slave in self.opt.impl_get_master_slaves():
440                 path = values._get_opt_path(slave)
441                 if not values._is_default_owner(path):
442                     if slave.impl_has_callback():
443                         index = self.__len__() - 1
444                         dvalue = values._getcallback_value(slave, index=index)
445                     else:
446                         dvalue = slave.impl_getdefault_multi()
447                     old_value = values.getitem(slave, path,
448                                                validate_properties=False)
449                     if len(old_value) < self.__len__():
450                         values.getitem(slave, path,
451                                        validate_properties=False).append(
452                                            dvalue, force=True)
453                     else:
454                         values.getitem(slave, path,
455                                        validate_properties=False)[
456                                            index] = dvalue
457
458     def sort(self, cmp=None, key=None, reverse=False):
459         if self.opt.impl_get_multitype() in [multitypes.slave,
460                                              multitypes.master]:
461             raise SlaveError(_("cannot sort multi option {0} if master or slave"
462                                "").format(self.opt._name))
463         if sys.version_info[0] >= 3:
464             if cmp is not None:
465                 raise ValueError(_('cmp is not permitted in python v3 or greater'))
466             super(Multi, self).sort(key=key, reverse=reverse)
467         else:
468             super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
469         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
470
471     def reverse(self):
472         if self.opt.impl_get_multitype() in [multitypes.slave,
473                                              multitypes.master]:
474             raise SlaveError(_("cannot reverse multi option {0} if master or "
475                                "slave").format(self.opt._name))
476         super(Multi, self).reverse()
477         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
478
479     def insert(self, index, obj):
480         if self.opt.impl_get_multitype() in [multitypes.slave,
481                                              multitypes.master]:
482             raise SlaveError(_("cannot insert multi option {0} if master or "
483                                "slave").format(self.opt._name))
484         super(Multi, self).insert(index, obj)
485         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
486
487     def extend(self, iterable):
488         if self.opt.impl_get_multitype() in [multitypes.slave,
489                                              multitypes.master]:
490             raise SlaveError(_("cannot extend multi option {0} if master or "
491                                "slave").format(self.opt._name))
492         super(Multi, self).extend(iterable)
493         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self)
494
495     def _validate(self, value):
496         if value is not None:
497             try:
498                 self.opt._validate(value)
499             except ValueError as err:
500                 raise ValueError(_("invalid value {0} "
501                                    "for option {1}: {2}"
502                                    "").format(str(value),
503                                               self.opt._name, err))
504
505     def pop(self, key, force=False):
506         """the list value can be updated (poped)
507         only if the option is a master
508
509         :param key: index of the element to pop
510         :return: the requested element
511         """
512         if not force:
513             if self.opt.impl_get_multitype() == multitypes.slave:
514                 raise SlaveError(_("cannot pop a value on a multi option {0}"
515                                    " which is a slave").format(self.opt._name))
516             elif self.opt.impl_get_multitype() == multitypes.master:
517                 for slave in self.opt.impl_get_master_slaves():
518                     values = self.context().cfgimpl_get_values()
519                     if not values.is_default_owner(slave):
520                         #get multi without valid properties
521                         values.getitem(slave,
522                                        validate_properties=False
523                                        ).pop(key, force=True)
524         #set value without valid properties
525         ret = super(Multi, self).pop(key)
526         self.context().cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
527         return ret