key is now always path and change opt by path dictionary storage
[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, storage_type
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', '_p_')
35
36     def __init__(self, context, storage):
37         """
38         Initializes the values's dict.
39
40         :param context: the context is the home config's values
41
42         """
43         self.context = context
44         # the storage type is dictionary or sqlite3
45         import_lib = 'tiramisu.storage.{0}.value'.format(storage_type)
46         self._p_ = __import__(import_lib, globals(), locals(), ['Values'],
47                               -1).Values(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         self._contains(path)
96
97     def _contains(self, path):
98         return self._p_.hasvalue('value', 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 dictionnary-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         ntime = None
151         if path is None:
152             path = self._get_opt_path(opt)
153         if self._p_.hascache('value', path):
154             ntime = time()
155             is_cached, value = self._p_.getcache('value', path, ntime)
156             if is_cached:
157                 if opt.impl_is_multi() and not isinstance(value, Multi):
158                     #load value so don't need to validate if is not a Multi
159                     value = Multi(value, self.context, opt, path, validate=False)
160                 return value
161         val = self._getitem(opt, path, validate, force_permissive, force_properties,
162                             validate_properties)
163         if 'expire' in self.context.cfgimpl_get_settings() and validate and \
164                 validate_properties and force_permissive is False and \
165                 force_properties is None:
166             if ntime is None:
167                 ntime = time()
168             self._p_.setcache('value', path, val, ntime + expires_time)
169
170         return val
171
172     def _getitem(self, opt, path, validate, force_permissive, force_properties,
173                  validate_properties):
174         # options with callbacks
175         setting = self.context.cfgimpl_get_settings()
176         is_frozen = 'frozen' in setting[opt]
177         # if value is callback and is not set
178         # or frozen with force_default_on_freeze
179         if opt.impl_has_callback() and (
180                 self._is_default_owner(path) or
181                 (is_frozen and 'force_default_on_freeze' in setting[opt])):
182             no_value_slave = False
183             if (opt.impl_is_multi() and
184                     opt.impl_get_multitype() == multitypes.slave):
185                 masterp = self._get_opt_path(opt.impl_get_master_slaves())
186                 mastervalue = getattr(self.context, masterp)
187                 lenmaster = len(mastervalue)
188                 if lenmaster == 0:
189                     value = []
190                     no_value_slave = True
191
192             if not no_value_slave:
193                 value = self._getcallback_value(opt)
194                 if (opt.impl_is_multi() and
195                         opt.impl_get_multitype() == multitypes.slave):
196                     if not isinstance(value, list):
197                         value = [value for i in range(lenmaster)]
198             if opt.impl_is_multi():
199                 value = Multi(value, self.context, opt, path, validate)
200             # suppress value if already set
201             self.reset(opt, path)
202         # frozen and force default
203         elif is_frozen and 'force_default_on_freeze' in setting[opt]:
204             value = self._getdefault(opt)
205             if opt.impl_is_multi():
206                 value = Multi(value, self.context, opt, path, validate)
207         else:
208             value = self._getvalue(opt, path, validate)
209         if validate:
210             opt.impl_validate(value, self.context, 'validator' in setting)
211         if self._is_default_owner(path) and \
212                 'force_store_value' in setting[opt]:
213             self.setitem(opt, value, path, is_write=False)
214         if validate_properties:
215             setting.validate_properties(opt, False, False, value=value, path=path,
216                                         force_permissive=force_permissive,
217                                         force_properties=force_properties)
218         return value
219
220     def __setitem__(self, opt, value):
221         path = self._get_opt_path(opt)
222         self.setitem(opt, value, path)
223
224     def setitem(self, opt, value, path, force_permissive=False,
225                 is_write=True):
226         # is_write is, for example, used with "force_store_value"
227         # user didn't change value, so not write
228         # valid opt
229         opt.impl_validate(value, self.context,
230                           'validator' in self.context.cfgimpl_get_settings())
231         if opt.impl_is_multi() and not isinstance(value, Multi):
232             value = Multi(value, self.context, opt, path)
233         self._setvalue(opt, path, value, force_permissive=force_permissive,
234                        is_write=is_write)
235
236     def _setvalue(self, opt, path, value, force_permissive=False,
237                   force_properties=None,
238                   is_write=True, validate_properties=True):
239         self.context.cfgimpl_reset_cache()
240         if validate_properties:
241             setting = self.context.cfgimpl_get_settings()
242             setting.validate_properties(opt, False, is_write,
243                                         value=value, path=path,
244                                         force_permissive=force_permissive,
245                                         force_properties=force_properties)
246         owner = self.context.cfgimpl_get_settings().getowner()
247         self._p_.setvalue(path, value, owner)
248
249     def getowner(self, opt):
250         """
251         retrieves the option's owner
252
253         :param opt: the `option.Option` object
254         :returns: a `setting.owners.Owner` object
255         """
256         if isinstance(opt, SymLinkOption):
257             opt = opt._opt
258         path = self._get_opt_path(opt)
259         return self._getowner(path)
260
261     def _getowner(self, path):
262         owner = self._p_.getowner(path, owners.default)
263         meta = self.context.cfgimpl_get_meta()
264         if owner is owners.default and meta is not None:
265             owner = meta.cfgimpl_get_values()._getowner(path)
266         return owner
267
268     def setowner(self, opt, owner):
269         """
270         sets a owner to an option
271
272         :param opt: the `option.Option` object
273         :param owner: a valid owner, that is a `setting.owners.Owner` object
274         """
275         if not isinstance(owner, owners.Owner):
276             raise TypeError(_("invalid generic owner {0}").format(str(owner)))
277
278         path = self._get_opt_path(opt)
279         self._setowner(path, owner)
280
281     def _setowner(self, path, owner):
282         if self._getowner(path) == owners.default:
283             raise ConfigError(_('no value for {0} cannot change owner to {1}'
284                                 '').format(path, owner))
285         self._p_.setowner(path, owner)
286
287     def is_default_owner(self, opt):
288         """
289         :param config: *must* be only the **parent** config
290                        (not the toplevel config)
291         :return: boolean
292         """
293         path = self._get_opt_path(opt)
294         return self._is_default_owner(path)
295
296     def _is_default_owner(self, path):
297         return self._getowner(path) == owners.default
298
299     def reset_cache(self, only_expired):
300         """
301         clears the cache if necessary
302         """
303         if only_expired:
304             self._p_.reset_expired_cache('value', time())
305         else:
306             self._p_.reset_all_cache('value')
307
308     def _get_opt_path(self, opt):
309         """
310         retrieve the option's path in the config
311
312         :param opt: the `option.Option` object
313         :returns: a string with points like "gc.dummy.my_option"
314         """
315         return self.context.cfgimpl_get_description().impl_get_path_by_opt(opt)
316
317 # ____________________________________________________________
318 # multi types
319
320
321 class Multi(list):
322     """multi options values container
323     that support item notation for the values of multi options"""
324     __slots__ = ('opt', 'path', 'context')
325
326     def __init__(self, value, context, opt, path, validate=True):
327         """
328         :param value: the Multi wraps a list value
329         :param context: the home config that has the values
330         :param opt: the option object that have this Multi value
331         """
332         self.opt = opt
333         self.path = path
334         self.context = context
335         if not isinstance(value, list):
336             value = [value]
337         if validate and self.opt.impl_get_multitype() == multitypes.slave:
338             value = self._valid_slave(value)
339         elif self.opt.impl_get_multitype() == multitypes.master:
340             self._valid_master(value)
341         super(Multi, self).__init__(value)
342
343     def _valid_slave(self, value):
344         #if slave, had values until master's one
345         masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
346             self.opt.impl_get_master_slaves())
347         mastervalue = getattr(self.context, masterp)
348         masterlen = len(mastervalue)
349         valuelen = len(value)
350         if valuelen > masterlen or (valuelen < masterlen and
351                                     not self.context.cfgimpl_get_values(
352                                     )._is_default_owner(self.path)):
353             raise SlaveError(_("invalid len for the slave: {0}"
354                                " which has {1} as master").format(
355                                    self.opt._name, masterp))
356         elif valuelen < masterlen:
357             for num in range(0, masterlen - valuelen):
358                 value.append(self.opt.impl_getdefault_multi())
359         #else: same len so do nothing
360         return value
361
362     def _valid_master(self, value):
363         masterlen = len(value)
364         values = self.context.cfgimpl_get_values()
365         for slave in self.opt._master_slaves:
366             path = values._get_opt_path(slave)
367             if not values._is_default_owner(path):
368                 value_slave = values._getvalue(slave, path)
369                 if len(value_slave) > masterlen:
370                     raise SlaveError(_("invalid len for the master: {0}"
371                                        " which has {1} as slave with"
372                                        " greater len").format(
373                                            self.opt._name, slave._name))
374                 elif len(value_slave) < masterlen:
375                     for num in range(0, masterlen - len(value_slave)):
376                         value_slave.append(slave.impl_getdefault_multi(),
377                                            force=True)
378
379     def __setitem__(self, path, value):
380         self._validate(value)
381         #assume not checking mandatory property
382         super(Multi, self).__setitem__(path, value)
383         self.context.cfgimpl_get_values()._setvalue(self.opt, path, self)
384
385     def append(self, value, force=False):
386         """the list value can be updated (appened)
387         only if the option is a master
388         """
389         if not force:
390             if self.opt.impl_get_multitype() == multitypes.slave:
391                 raise SlaveError(_("cannot append a value on a multi option {0}"
392                                    " which is a slave").format(self.opt._name))
393             elif self.opt.impl_get_multitype() == multitypes.master:
394                 values = self.context.cfgimpl_get_values()
395                 if value is None and self.opt.impl_has_callback():
396                     value = values._getcallback_value(self.opt)
397                     #Force None il return a list
398                     if isinstance(value, list):
399                         value = None
400         self._validate(value)
401         super(Multi, self).append(value)
402         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
403         if not force and self.opt.impl_get_multitype() == multitypes.master:
404             for slave in self.opt.impl_get_master_slaves():
405                 path = values._get_opt_path(slave)
406                 if not values._is_default_owner(path):
407                     if slave.impl_has_callback():
408                         index = self.__len__() - 1
409                         dvalue = values._getcallback_value(slave, index=index)
410                     else:
411                         dvalue = slave.impl_getdefault_multi()
412                     old_value = values.getitem(slave, path,
413                                                validate_properties=False)
414                     if len(old_value) < self.__len__():
415                         values.getitem(slave, path,
416                                        validate_properties=False).append(
417                                            dvalue, force=True)
418                     else:
419                         values.getitem(slave, path,
420                                        validate_properties=False)[
421                                            index] = dvalue
422
423     def sort(self, cmp=None, key=None, reverse=False):
424         if self.opt.impl_get_multitype() in [multitypes.slave,
425                                              multitypes.master]:
426             raise SlaveError(_("cannot sort multi option {0} if master or slave"
427                                "").format(self.opt._name))
428         super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
429         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
430
431     def reverse(self):
432         if self.opt.impl_get_multitype() in [multitypes.slave,
433                                              multitypes.master]:
434             raise SlaveError(_("cannot reverse multi option {0} if master or "
435                                "slave").format(self.opt._name))
436         super(Multi, self).reverse()
437         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
438
439     def insert(self, index, obj):
440         if self.opt.impl_get_multitype() in [multitypes.slave,
441                                              multitypes.master]:
442             raise SlaveError(_("cannot insert multi option {0} if master or "
443                                "slave").format(self.opt._name))
444         super(Multi, self).insert(index, obj)
445         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
446
447     def extend(self, iterable):
448         if self.opt.impl_get_multitype() in [multitypes.slave,
449                                              multitypes.master]:
450             raise SlaveError(_("cannot extend multi option {0} if master or "
451                                "slave").format(self.opt._name))
452         super(Multi, self).extend(iterable)
453         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self)
454
455     def _validate(self, value):
456         if value is not None:
457             try:
458                 self.opt._validate(value)
459             except ValueError, err:
460                 raise ValueError(_("invalid value {0} "
461                                    "for option {1}: {2}"
462                                    "").format(str(value),
463                                               self.opt._name, err))
464
465     def pop(self, key, force=False):
466         """the list value can be updated (poped)
467         only if the option is a master
468
469         :param key: index of the element to pop
470         :return: the requested element
471         """
472         if not force:
473             if self.opt.impl_get_multitype() == multitypes.slave:
474                 raise SlaveError(_("cannot pop a value on a multi option {0}"
475                                    " which is a slave").format(self.opt._name))
476             elif self.opt.impl_get_multitype() == multitypes.master:
477                 for slave in self.opt.impl_get_master_slaves():
478                     values = self.context.cfgimpl_get_values()
479                     if not values.is_default_owner(slave):
480                         #get multi without valid properties
481                         values.getitem(slave,
482                                        validate_properties=False
483                                        ).pop(key, force=True)
484         #set value without valid properties
485         ret = super(Multi, self).pop(key)
486         self.context.cfgimpl_get_values()._setvalue(self.opt, self.path, self, validate_properties=not force)
487         return ret