tiramisu/tiramisu/value.py

470 lines
20 KiB
Python
Raw Normal View History

2013-02-07 16:20:21 +01:00
# -*- coding: utf-8 -*-
"takes care of the option's values and multi values"
2013-02-21 17:07:00 +01:00
# Copyright (C) 2013 Team tiramisu (see AUTHORS for all contributors)
2013-02-07 16:20:21 +01:00
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# ____________________________________________________________
from time import time
from copy import copy
2013-04-19 20:10:55 +02:00
from tiramisu.error import ConfigError, SlaveError
2013-08-20 22:45:11 +02:00
from tiramisu.setting import owners, multitypes, expires_time, storage_type
from tiramisu.autolib import carry_out_calculation
2013-04-13 23:09:05 +02:00
from tiramisu.i18n import _
from tiramisu.option import SymLinkOption
2013-02-07 16:20:21 +01:00
2013-04-03 12:20:26 +02:00
2013-08-20 09:47:12 +02:00
class Values(object):
2013-05-23 17:51:50 +02:00
"""The `Config`'s root is indeed in charge of the `Option()`'s values,
but the values are physicaly located here, in `Values`, wich is also
responsible of a caching utility.
2013-05-23 14:55:52 +02:00
"""
2013-08-20 09:47:12 +02:00
__slots__ = ('context', '_p_')
2013-04-03 12:20:26 +02:00
2013-08-20 22:45:11 +02:00
def __init__(self, context, storage):
2013-02-21 17:07:00 +01:00
"""
Initializes the values's dict.
2013-04-03 12:20:26 +02:00
:param context: the context is the home config's values
2013-05-23 14:55:52 +02:00
2013-02-21 17:07:00 +01:00
"""
self.context = context
2013-08-21 14:52:48 +02:00
# the storage type is dictionary or sqlite3
2013-08-20 22:45:11 +02:00
import_lib = 'tiramisu.storage.{0}.value'.format(storage_type)
2013-08-20 09:47:12 +02:00
self._p_ = __import__(import_lib, globals(), locals(), ['Values'],
2013-08-20 22:45:11 +02:00
-1).Values(storage)
2013-08-20 09:47:12 +02:00
def _getkey(self, opt):
2013-08-21 14:52:48 +02:00
"""depends on the storage utility.
typically, the option's path in the parent `Config` or `SubConfig`
"""
2013-08-20 09:47:12 +02:00
if self._p_.key_is_path:
return self._get_opt_path(opt)
else:
return opt
2013-02-07 16:20:21 +01:00
2013-08-14 23:06:31 +02:00
def _getdefault(self, opt):
2013-08-21 14:52:48 +02:00
"""
actually retrieves the default value
:param opt: the `option.Option()` object
"""
2013-05-02 11:34:57 +02:00
meta = self.context.cfgimpl_get_meta()
if meta is not None:
value = meta.cfgimpl_get_values()[opt]
2013-05-02 11:34:57 +02:00
else:
value = opt.impl_getdefault()
if opt.impl_is_multi():
return copy(value)
else:
return value
2013-05-02 11:34:57 +02:00
2013-08-14 23:06:31 +02:00
def _getvalue(self, opt, validate=True):
2013-08-21 14:52:48 +02:00
"""actually retrieves the value
:param opt: the `option.Option()` object
:returns: the option's value (or the default value if not set)
"""
2013-08-20 09:47:12 +02:00
key = self._getkey(opt)
if not self._p_.hasvalue(key):
2013-08-21 11:09:11 +02:00
# if no value
2013-08-14 23:06:31 +02:00
value = self._getdefault(opt)
if opt.impl_is_multi():
2013-05-10 22:32:42 +02:00
value = Multi(value, self.context, opt, validate)
else:
#if value
2013-08-20 09:47:12 +02:00
value = self._p_.getvalue(key)
2013-08-14 23:06:31 +02:00
if opt.impl_is_multi() and not isinstance(value, Multi):
2013-08-21 11:09:11 +02:00
# load value so don't need to validate if is not a Multi
2013-08-14 23:06:31 +02:00
value = Multi(value, self.context, opt, validate=False)
return value
2013-02-07 16:20:21 +01:00
2013-08-14 23:06:31 +02:00
def get_modified_values(self):
2013-08-20 09:47:12 +02:00
return self._p_.get_modified_values()
2013-08-14 23:06:31 +02:00
def __contains__(self, opt):
2013-08-21 14:52:48 +02:00
"""
implements the 'in' keyword syntax in order provide a pythonic way
to kow if an option have a value
:param opt: the `option.Option()` object
"""
2013-08-20 09:47:12 +02:00
return self._p_.hasvalue('value', self._getkey(opt))
2013-08-14 23:06:31 +02:00
2013-04-18 23:06:14 +02:00
def __delitem__(self, opt):
2013-08-21 14:52:48 +02:00
"""overrides the builtins `del()` instructions"""
2013-08-14 23:06:31 +02:00
self.reset(opt)
2013-04-18 23:06:14 +02:00
2013-08-14 23:06:31 +02:00
def reset(self, opt):
2013-08-20 09:47:12 +02:00
key = self._getkey(opt)
if self._p_.hasvalue(key):
setting = self.context.cfgimpl_get_settings()
2013-05-10 22:32:42 +02:00
opt.impl_validate(opt.impl_getdefault(), self.context,
'validator' in setting)
self.context.cfgimpl_reset_cache()
2013-08-20 12:08:02 +02:00
if (opt.impl_is_multi() and
2013-08-20 16:33:32 +02:00
opt.impl_get_multitype() == multitypes.master):
for slave in opt.impl_get_master_slaves():
2013-08-14 23:06:31 +02:00
self.reset(slave)
2013-08-20 09:47:12 +02:00
self._p_.resetvalue(key)
2013-02-26 14:56:15 +01:00
2013-08-14 23:06:31 +02:00
def _isempty(self, opt, value):
"convenience method to know if an option is empty"
empty = opt._empty
if (not opt.impl_is_multi() and (value is None or value == empty)) or \
(opt.impl_is_multi() and (value == [] or
None in value or empty in value)):
return True
return False
2013-02-07 16:20:21 +01:00
def _getcallback_value(self, opt, index=None):
2013-08-21 14:52:48 +02:00
"""
retrieves a value for the options that have a callback
:param opt: the `option.Option()` object
:param index: if an option is multi, only calculates the nth value
:type index: int
:returns: a calculated value
"""
2013-04-16 12:04:20 +02:00
callback, callback_params = opt._callback
if callback_params is None:
callback_params = {}
return carry_out_calculation(opt._name, config=self.context,
callback=callback,
callback_params=callback_params,
index=index)
2013-04-18 23:06:14 +02:00
def __getitem__(self, opt):
2013-08-21 14:52:48 +02:00
"enables us to use the pythonic dictionnary-like access to values"
2013-04-18 23:06:14 +02:00
return self.getitem(opt)
def getitem(self, opt, validate=True, force_permissive=False,
force_properties=None, validate_properties=True):
2013-08-14 23:06:31 +02:00
ntime = None
2013-08-20 09:47:12 +02:00
key = self._getkey(opt)
if self._p_.hascache('value', self._getkey(opt)):
2013-08-14 23:06:31 +02:00
ntime = time()
2013-08-20 09:47:12 +02:00
is_cached, value = self._p_.getcache('value', key, ntime)
2013-08-14 23:06:31 +02:00
if is_cached:
2013-08-19 11:01:21 +02:00
if opt.impl_is_multi() and not isinstance(value, Multi):
#load value so don't need to validate if is not a Multi
value = Multi(value, self.context, opt, validate=False)
2013-04-18 23:06:14 +02:00
return value
val = self._getitem(opt, validate, force_permissive, force_properties,
validate_properties)
2013-08-14 23:06:31 +02:00
if 'expire' in self.context.cfgimpl_get_settings() and validate and \
validate_properties and force_permissive is False and \
force_properties is None:
2013-08-14 23:06:31 +02:00
if ntime is None:
ntime = time()
2013-08-20 09:47:12 +02:00
self._p_.setcache('value', key, val, ntime + expires_time)
2013-08-14 23:06:31 +02:00
2013-04-18 23:06:14 +02:00
return val
def _getitem(self, opt, validate, force_permissive, force_properties,
validate_properties):
# options with callbacks
2013-04-04 11:24:00 +02:00
setting = self.context.cfgimpl_get_settings()
is_frozen = 'frozen' in setting[opt]
2013-08-20 12:08:02 +02:00
# if value is callback and is not set
# or frozen with force_default_on_freeze
if opt.impl_has_callback() and (
2013-08-20 16:33:32 +02:00
self.is_default_owner(opt) or
(is_frozen and 'force_default_on_freeze' in setting[opt])):
no_value_slave = False
2013-08-20 12:08:02 +02:00
if (opt.impl_is_multi() and
2013-08-20 16:33:32 +02:00
opt.impl_get_multitype() == multitypes.slave):
masterp = self._get_opt_path(opt.impl_get_master_slaves())
mastervalue = getattr(self.context, masterp)
lenmaster = len(mastervalue)
if lenmaster == 0:
value = []
no_value_slave = True
if not no_value_slave:
value = self._getcallback_value(opt)
2013-08-20 12:08:02 +02:00
if (opt.impl_is_multi() and
2013-08-20 16:33:32 +02:00
opt.impl_get_multitype() == multitypes.slave):
if not isinstance(value, list):
value = [value for i in range(lenmaster)]
if opt.impl_is_multi():
value = Multi(value, self.context, opt, validate)
2013-08-21 11:09:11 +02:00
# suppress value if already set
2013-08-14 23:06:31 +02:00
self.reset(opt)
# frozen and force default
elif is_frozen and 'force_default_on_freeze' in setting[opt]:
2013-08-14 23:06:31 +02:00
value = self._getdefault(opt)
if opt.impl_is_multi():
value = Multi(value, self.context, opt, validate)
else:
2013-08-14 23:06:31 +02:00
value = self._getvalue(opt, validate)
if validate:
opt.impl_validate(value, self.context, 'validator' in setting)
if self.is_default_owner(opt) and \
'force_store_value' in setting[opt]:
self.setitem(opt, value, is_write=False)
if validate_properties:
setting.validate_properties(opt, False, False, value=value,
force_permissive=force_permissive,
force_properties=force_properties)
return value
2013-04-18 23:06:14 +02:00
def __setitem__(self, opt, value):
self.setitem(opt, value)
def setitem(self, opt, value, force_permissive=False, is_write=True):
2013-08-21 11:09:11 +02:00
# is_write is, for example, used with "force_store_value"
# user didn't change value, so not write
# valid opt
opt.impl_validate(value, self.context,
'validator' in self.context.cfgimpl_get_settings())
if opt.impl_is_multi() and not isinstance(value, Multi):
2013-04-18 23:06:14 +02:00
value = Multi(value, self.context, opt)
self._setvalue(opt, value, force_permissive=force_permissive,
is_write=is_write)
2013-08-20 12:08:02 +02:00
def _setvalue(self, opt, value, force_permissive=False,
force_properties=None,
is_write=True, validate_properties=True):
self.context.cfgimpl_reset_cache()
if validate_properties:
2013-08-14 23:06:31 +02:00
setting = self.context.cfgimpl_get_settings()
setting.validate_properties(opt, False, is_write,
value=value,
force_permissive=force_permissive,
force_properties=force_properties)
2013-08-20 09:47:12 +02:00
owner = self.context.cfgimpl_get_settings().getowner()
self._p_.setvalue(self._getkey(opt), value, owner)
def getowner(self, opt):
2013-08-21 11:09:11 +02:00
"""
retrieves the option's owner
2013-08-21 14:52:48 +02:00
:param opt: the `option.Option` object
2013-08-21 11:09:11 +02:00
:returns: a `setting.owners.Owner` object
"""
if isinstance(opt, SymLinkOption):
opt = opt._opt
2013-08-20 09:47:12 +02:00
owner = self._p_.getowner(self._getkey(opt), owners.default)
2013-05-02 11:34:57 +02:00
meta = self.context.cfgimpl_get_meta()
if owner is owners.default and meta is not None:
owner = meta.cfgimpl_get_values().getowner(opt)
return owner
2013-04-03 12:20:26 +02:00
def setowner(self, opt, owner):
2013-08-21 11:09:11 +02:00
"""
sets a owner to an option
2013-08-21 14:52:48 +02:00
:param opt: the `option.Option` object
2013-08-21 11:09:11 +02:00
:param owner: a valid owner, that is a `setting.owners.Owner` object
"""
2013-04-03 12:20:26 +02:00
if not isinstance(owner, owners.Owner):
2013-04-13 23:09:05 +02:00
raise TypeError(_("invalid generic owner {0}").format(str(owner)))
2013-08-14 23:06:31 +02:00
if self.getowner(opt) == owners.default:
raise ConfigError(_('no value for {0} cannot change owner to {1}'
'').format(opt._name, owner))
2013-08-20 09:47:12 +02:00
self._p_.setowner(self._getkey(opt), owner)
2013-04-03 12:20:26 +02:00
def is_default_owner(self, opt):
"""
:param config: *must* be only the **parent** config
(not the toplevel config)
:return: boolean
"""
return self.getowner(opt) == owners.default
2013-02-21 17:07:00 +01:00
def reset_cache(self, only_expired):
2013-08-21 11:09:11 +02:00
"""
clears the cache if necessary
"""
if only_expired:
2013-08-20 09:47:12 +02:00
self._p_.reset_expired_cache('value', time())
else:
2013-08-20 09:47:12 +02:00
self._p_.reset_all_cache('value')
2013-04-18 23:06:14 +02:00
2013-08-14 23:06:31 +02:00
def _get_opt_path(self, opt):
2013-08-21 11:09:11 +02:00
"""
2013-08-21 14:52:48 +02:00
retrieve the option's path in the config
:param opt: the `option.Option` object
2013-08-21 11:09:11 +02:00
:returns: a string with points like "gc.dummy.my_option"
"""
2013-08-14 23:06:31 +02:00
return self.context.cfgimpl_get_description().impl_get_path_by_opt(opt)
# ____________________________________________________________
# multi types
2013-04-03 12:20:26 +02:00
class Multi(list):
"""multi options values container
that support item notation for the values of multi options"""
2013-04-03 12:20:26 +02:00
__slots__ = ('opt', 'context')
def __init__(self, value, context, opt, validate=True):
"""
2013-04-18 23:06:14 +02:00
:param value: the Multi wraps a list value
2013-04-03 12:20:26 +02:00
:param context: the home config that has the values
:param opt: the option object that have this Multi value
"""
self.opt = opt
2013-04-03 12:20:26 +02:00
self.context = context
2013-04-18 23:06:14 +02:00
if not isinstance(value, list):
value = [value]
if validate and self.opt.impl_get_multitype() == multitypes.slave:
2013-04-18 23:06:14 +02:00
value = self._valid_slave(value)
elif self.opt.impl_get_multitype() == multitypes.master:
2013-04-18 23:06:14 +02:00
self._valid_master(value)
super(Multi, self).__init__(value)
def _valid_slave(self, value):
#if slave, had values until master's one
masterp = self.context.cfgimpl_get_description().impl_get_path_by_opt(
self.opt.impl_get_master_slaves())
2013-04-18 23:06:14 +02:00
mastervalue = getattr(self.context, masterp)
masterlen = len(mastervalue)
2013-08-20 16:33:32 +02:00
valuelen = len(value)
if valuelen > masterlen or (valuelen < masterlen and
not self.context.cfgimpl_get_values(
).is_default_owner(self.opt)):
2013-04-19 20:10:55 +02:00
raise SlaveError(_("invalid len for the slave: {0}"
2013-04-18 23:06:14 +02:00
" which has {1} as master").format(
self.opt._name, masterp))
2013-08-20 16:33:32 +02:00
elif valuelen < masterlen:
for num in range(0, masterlen - valuelen):
value.append(self.opt.impl_getdefault_multi())
2013-04-18 23:06:14 +02:00
#else: same len so do nothing
return value
def _valid_master(self, value):
masterlen = len(value)
values = self.context.cfgimpl_get_values()
for slave in self.opt._master_slaves:
if not values.is_default_owner(slave):
2013-08-14 23:06:31 +02:00
value_slave = values._getvalue(slave)
2013-04-18 23:06:14 +02:00
if len(value_slave) > masterlen:
2013-04-19 20:10:55 +02:00
raise SlaveError(_("invalid len for the master: {0}"
2013-04-18 23:06:14 +02:00
" which has {1} as slave with"
" greater len").format(
self.opt._name, slave._name))
elif len(value_slave) < masterlen:
for num in range(0, masterlen - len(value_slave)):
2013-08-20 12:08:02 +02:00
value_slave.append(slave.impl_getdefault_multi(),
force=True)
2013-04-03 12:20:26 +02:00
def __setitem__(self, key, value):
2013-02-22 11:09:17 +01:00
self._validate(value)
#assume not checking mandatory property
2013-02-22 11:09:17 +01:00
super(Multi, self).__setitem__(key, value)
2013-08-14 23:06:31 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self)
2013-02-22 11:09:17 +01:00
def append(self, value, force=False):
"""the list value can be updated (appened)
only if the option is a master
"""
2013-02-22 11:09:17 +01:00
if not force:
if self.opt.impl_get_multitype() == multitypes.slave:
2013-04-19 20:10:55 +02:00
raise SlaveError(_("cannot append a value on a multi option {0}"
2013-04-17 21:57:06 +02:00
" which is a slave").format(self.opt._name))
elif self.opt.impl_get_multitype() == multitypes.master:
values = self.context.cfgimpl_get_values()
if value is None and self.opt.impl_has_callback():
value = values._getcallback_value(self.opt)
#Force None il return a list
if isinstance(value, list):
value = None
2013-02-22 11:09:17 +01:00
self._validate(value)
super(Multi, self).append(value)
2013-08-19 11:01:21 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
if not force and self.opt.impl_get_multitype() == multitypes.master:
for slave in self.opt.impl_get_master_slaves():
if not values.is_default_owner(slave):
if slave.impl_has_callback():
index = self.__len__() - 1
dvalue = values._getcallback_value(slave, index=index)
else:
dvalue = slave.impl_getdefault_multi()
2013-08-19 11:01:21 +02:00
old_value = values.getitem(slave, validate_properties=False)
if len(old_value) < self.__len__():
values.getitem(slave, validate_properties=False).append(
dvalue, force=True)
else:
values.getitem(slave, validate_properties=False)[index] = dvalue
2013-02-22 11:09:17 +01:00
def sort(self, cmp=None, key=None, reverse=False):
if self.opt.impl_get_multitype() in [multitypes.slave,
multitypes.master]:
raise SlaveError(_("cannot sort multi option {0} if master or slave"
"").format(self.opt._name))
super(Multi, self).sort(cmp=cmp, key=key, reverse=reverse)
2013-08-14 23:06:31 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self)
def reverse(self):
if self.opt.impl_get_multitype() in [multitypes.slave,
multitypes.master]:
raise SlaveError(_("cannot reverse multi option {0} if master or "
"slave").format(self.opt._name))
super(Multi, self).reverse()
2013-08-14 23:06:31 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self)
def insert(self, index, obj):
if self.opt.impl_get_multitype() in [multitypes.slave,
multitypes.master]:
raise SlaveError(_("cannot insert multi option {0} if master or "
"slave").format(self.opt._name))
super(Multi, self).insert(index, obj)
2013-08-14 23:06:31 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self)
def extend(self, iterable):
if self.opt.impl_get_multitype() in [multitypes.slave,
multitypes.master]:
raise SlaveError(_("cannot extend multi option {0} if master or "
"slave").format(self.opt._name))
super(Multi, self).extend(iterable)
2013-08-14 23:06:31 +02:00
self.context.cfgimpl_get_values()._setvalue(self.opt, self)
2013-02-22 11:09:17 +01:00
def _validate(self, value):
if value is not None:
try:
self.opt._validate(value)
except ValueError, err:
raise ValueError(_("invalid value {0} "
2013-08-20 16:33:32 +02:00
"for option {1}: {2}"
"").format(str(value),
self.opt._name, err))
2013-02-22 11:09:17 +01:00
def pop(self, key, force=False):
"""the list value can be updated (poped)
only if the option is a master
:param key: index of the element to pop
:return: the requested element
"""
2013-02-22 11:09:17 +01:00
if not force:
if self.opt.impl_get_multitype() == multitypes.slave:
2013-04-19 20:10:55 +02:00
raise SlaveError(_("cannot pop a value on a multi option {0}"
2013-04-17 21:57:06 +02:00
" which is a slave").format(self.opt._name))
elif self.opt.impl_get_multitype() == multitypes.master:
for slave in self.opt.impl_get_master_slaves():
values = self.context.cfgimpl_get_values()
if not values.is_default_owner(slave):
#get multi without valid properties
2013-08-20 12:08:02 +02:00
values.getitem(slave,
validate_properties=False
).pop(key, force=True)
#set value without valid properties
2013-08-14 23:06:31 +02:00
ret = super(Multi, self).pop(key)
self.context.cfgimpl_get_values()._setvalue(self.opt, self, validate_properties=not force)
2013-08-14 23:06:31 +02:00
return ret