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