b4883a2b96c2a81acc51a62ca72cddf5b9be9d09
[tiramisu.git] / tiramisu / option / baseoption.py
1 # -*- coding: utf-8 -*-
2 # Copyright (C) 2014 Team tiramisu (see AUTHORS for all contributors)
3 #
4 # This program is free software: you can redistribute it and/or modify it
5 # under the terms of the GNU Lesser General Public License as published by the
6 # Free Software Foundation, either version 3 of the License, or (at your
7 # option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful, but WITHOUT
10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
12 # details.
13 #
14 # You should have received a copy of the GNU Lesser General Public License
15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 #
17 # The original `Config` design model is unproudly borrowed from
18 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
19 # the whole pypy projet is under MIT licence
20 # ____________________________________________________________
21 import re
22 from types import FunctionType
23 import warnings
24 import sys
25 from inspect import getargspec
26
27 from ..i18n import _
28 from ..setting import log, undefined, debug
29 from ..autolib import carry_out_calculation
30 from ..error import (ConfigError, ValueWarning, PropertiesOptionError,
31                      display_list)
32 from ..storage import get_storages_option
33 from . import MasterSlaves
34
35 if sys.version_info[0] >= 3:  # pragma: no cover
36     xrange = range
37
38
39 StorageBase = get_storages_option('base')
40 submulti = 2
41 name_regexp = re.compile(r'^[a-z][a-zA-Z\d\-_]*$')
42 forbidden_names = frozenset(['iter_all', 'iter_group', 'find', 'find_first',
43                              'make_dict', 'unwrap_from_path', 'read_only',
44                              'read_write', 'getowner', 'set_contexts'])
45 allowed_const_list = ['_cons_not_equal']
46
47
48 def valid_name(name):
49     "an option's name is a str and does not start with 'impl' or 'cfgimpl'"
50     if not isinstance(name, str):
51         return False
52     if re.match(name_regexp, name) is not None and \
53             name not in forbidden_names and \
54             not name.startswith('impl_') and \
55             not name.startswith('cfgimpl_'):
56         return True
57     else:
58         return False
59
60
61 def validate_callback(callback, callback_params, type_):
62     if not isinstance(callback, FunctionType):
63         raise ValueError(_('{0} must be a function').format(type_))
64     if callback_params is not None:
65         if not isinstance(callback_params, dict):
66             raise ValueError(_('{0}_params must be a dict').format(type_))
67         for key, callbacks in callback_params.items():
68             if key != '' and len(callbacks) != 1:
69                 raise ValueError(_("{0}_params with key {1} mustn't have "
70                                    "length different to 1").format(type_,
71                                                                    key))
72             if not isinstance(callbacks, tuple):
73                 raise ValueError(_('{0}_params must be tuple for key "{1}"'
74                                   ).format(type_, key))
75             for callbk in callbacks:
76                 if isinstance(callbk, tuple):
77                     if len(callbk) == 1:
78                         if callbk not in  ((None,), ('index',)):
79                             raise ValueError(_('{0}_params with length of '
80                                                'tuple as 1 must only have '
81                                                'None as first value'))
82                     elif len(callbk) != 2:
83                         raise ValueError(_('{0}_params must only have 1 or 2 '
84                                            'as length'))
85                     else:
86                         option, force_permissive = callbk
87                         if not isinstance(option, Option) and not \
88                                 isinstance(option, SymLinkOption):
89                             raise ValueError(_('{}_params must have an option'
90                                                ' not a {} for first argument'
91                                               ).format(type_, type(option)))
92                         if force_permissive not in [True, False]:
93                             raise ValueError(_('{}_params must have a boolean'
94                                                ' not a {} for second argument'
95                                               ).format(type_, type(
96                                                   force_permissive)))
97 #____________________________________________________________
98 #
99
100
101 class Base(StorageBase):
102     __slots__ = tuple()
103
104     def __init__(self, name, doc, default=None, default_multi=None,
105                  requires=None, multi=False, unique=undefined, callback=None,
106                  callback_params=None, validator=None, validator_params=None,
107                  properties=None, warnings_only=False, extra=None,
108                  allow_empty_list=undefined, session=None):
109         if not valid_name(name):
110             raise ValueError(_("invalid name: {0} for option").format(name))
111         if not multi and default_multi is not None:
112             raise ValueError(_("default_multi is set whereas multi is False"
113                              " in option: {0}").format(name))
114         if multi is True:
115             is_multi = True
116             _multi = 0
117         elif multi is False:
118             is_multi = False
119             _multi = 1
120         elif multi is submulti:
121             is_multi = True
122             _multi = submulti
123         else:
124             raise ValueError(_('invalid multi value'))
125         if unique != undefined and not isinstance(unique, bool):
126             raise ValueError(_('unique must be a boolean'))
127         if not is_multi and unique is True:
128             raise ValueError(_('unique must be set only with multi value'))
129         if requires is not None:
130             calc_properties, requires = validate_requires_arg(is_multi,
131                                                               requires, name)
132         else:
133             calc_properties = frozenset()
134             requires = undefined
135         if properties is None:
136             properties = tuple()
137         if not isinstance(properties, tuple):
138             raise TypeError(_('invalid properties type {0} for {1},'
139                               ' must be a tuple').format(
140                                   type(properties),
141                                   name))
142         if validator is not None:
143             if multi:  # and validator_params is None:
144                 validator_params = self._build_validator_params(validator, validator_params)
145
146             validate_callback(validator, validator_params, 'validator')
147             self._set_validator(validator, validator_params)
148             self._set_has_dependency()
149         if calc_properties != frozenset([]) and properties is not tuple():
150             set_forbidden_properties = calc_properties & set(properties)
151             if set_forbidden_properties != frozenset():
152                 raise ValueError('conflict: properties already set in '
153                                  'requirement {0}'.format(
154                                      list(set_forbidden_properties)))
155         if session is None:
156             session = self.getsession()
157         StorageBase.__init__(self, name, _multi, warnings_only, doc, extra,
158                              calc_properties, requires, properties,
159                              allow_empty_list, unique, session=session)
160         if multi is not False and default is None:
161             default = []
162         err = self.impl_validate(default, is_multi=is_multi)
163         if err:
164             raise err
165         self._set_default_values(default, default_multi, is_multi)
166         ##callback is False in optiondescription
167         if callback is not False:
168             self.impl_set_callback(callback, callback_params, _init=True)
169         self.commit(session)
170
171     def _build_validator_params(self, validator, validator_params):
172         func_args = getargspec(validator)
173         defaults = func_args.defaults
174         if defaults is None:
175             defaults = []
176         args = func_args.args[0:len(func_args.args)-len(defaults)]
177         if validator_params is not None:
178             kwargs = validator_params.keys()
179             if '' in kwargs:
180                 kwargs.remove('')
181             for kwarg in kwargs:
182                 if kwarg in args:
183                     args = args[0:args.index(kwarg)]
184             len_args = len(validator_params.get('', []))
185             if len_args != 0 and len(args) >= len_args:
186                 args = args[0:len(args)-len_args]
187         if len(args) >= 2:
188             if validator_params is not None and '' in validator_params:
189                 params = list(validator_params[''])
190                 params.append((self, False))
191                 validator_params[''] = tuple(params)
192             else:
193                 if validator_params is None:
194                     validator_params = {}
195                 validator_params[''] = ((self, False),)
196         if len(args) == 3 and args[2] not in validator_params:
197             params = list(validator_params[''])
198             params.append(('index',))
199             validator_params[''] = tuple(params)
200         return validator_params
201
202     def _set_has_dependency(self):
203         if not isinstance(self, SymLinkOption):
204             self._has_dependency = True
205
206     def impl_has_dependency(self):
207         return getattr(self, '_has_dependency', False)
208
209     def impl_set_callback(self, callback, callback_params=None, _init=False):
210         if callback is None and callback_params is not None:
211                 raise ValueError(_("params defined for a callback function but "
212                                    "no callback defined"
213                                    " yet for option {0}").format(
214                                        self.impl_getname()))
215         if not _init and self.impl_get_callback()[0] is not None:
216             raise ConfigError(_("a callback is already set for {0}, "
217                                 "cannot set another one's").format(self.impl_getname()))
218         self._validate_callback(callback, callback_params)
219         if callback is not None:
220             validate_callback(callback, callback_params, 'callback')
221             self._set_callback(callback, callback_params)
222
223     def impl_is_optiondescription(self):
224         return self.__class__.__name__ in ['OptionDescription',
225                                            'DynOptionDescription',
226                                            'SynDynOptionDescription']
227
228     def impl_is_dynoptiondescription(self):
229         return self.__class__.__name__ in ['DynOptionDescription',
230                                            'SynDynOptionDescription']
231
232
233 class BaseOption(Base):
234     """This abstract base class stands for attribute access
235     in options that have to be set only once, it is of course done in the
236     __setattr__ method
237     """
238     __slots__ = tuple()
239
240     # ____________________________________________________________
241     # serialize object
242     def _impl_convert_requires(self, descr, load=False):
243         """export of the requires during the serialization process
244
245         :type descr: :class:`tiramisu.option.OptionDescription`
246         :param load: `True` if we are at the init of the option description
247         :type load: bool
248         """
249         if not load and self.impl_getrequires() == []:
250             self._state_requires = None
251         elif load and self._state_requires is None:
252             del(self._state_requires)
253         else:
254             if load:
255                 _requires = self._state_requires
256             else:
257                 _requires = self.impl_getrequires()
258             new_value = []
259             for requires in _requires:
260                 new_requires = []
261                 for require in requires:
262                     if load:
263                         new_require = [descr.impl_get_opt_by_path(require[0])]
264                     else:
265                         new_require = [descr.impl_get_path_by_opt(require[0])]
266                     new_require.extend(require[1:])
267                     new_requires.append(tuple(new_require))
268                 new_value.append(tuple(new_requires))
269             if load:
270                 del(self._state_requires)
271                 if new_value != []:
272                     self._requires = new_value
273             else:
274                 self._state_requires = new_value
275
276     # serialize
277     def _impl_getstate(self, descr):
278         """the under the hood stuff that need to be done
279         before the serialization.
280
281         :param descr: the parent :class:`tiramisu.option.OptionDescription`
282         """
283         self._stated = True
284         for func in dir(self):
285             if func.startswith('_impl_convert_'):
286                 getattr(self, func)(descr)
287
288     def __getstate__(self, stated=True):
289         """special method to enable the serialization with pickle
290         Usualy, a `__getstate__` method does'nt need any parameter,
291         but somme under the hood stuff need to be done before this action
292
293         :parameter stated: if stated is `True`, the serialization protocol
294                            can be performed, not ready yet otherwise
295         :parameter type: bool
296         """
297         try:
298             self._stated
299         except AttributeError:
300             raise SystemError(_('cannot serialize Option, '
301                                 'only in OptionDescription'))
302         if isinstance(self, SymLinkOption):
303             slots = frozenset(['_name', '_state_opt', '_stated'])
304         else:
305             slots = self._impl_getattributes()
306             slots -= frozenset(['_cache_paths', '_cache_consistencies',
307                                 '__weakref__'])
308         states = {}
309         for slot in slots:
310             # remove variable if save variable converted
311             # in _state_xxxx variable
312             if '_state' + slot not in slots:
313                 try:
314                     if slot.startswith('_state'):
315                         states[slot] = getattr(self, slot)
316                         # remove _state_xxx variable
317                         self.__delattr__(slot)
318                     else:
319                         states[slot] = getattr(self, slot)
320                 except AttributeError:
321                     pass
322         if not stated:
323             del(states['_stated'])
324         return states
325
326     # unserialize
327     def _impl_setstate(self, descr):
328         """the under the hood stuff that need to be done
329         before the serialization.
330
331         :type descr: :class:`tiramisu.option.OptionDescription`
332         """
333         for func in dir(self):
334             if func.startswith('_impl_convert_'):
335                 getattr(self, func)(descr, load=True)
336         try:
337             del(self._stated)
338         except AttributeError:
339             pass
340
341     def __setstate__(self, state):
342         """special method that enables us to serialize (pickle)
343
344         Usualy, a `__setstate__` method does'nt need any parameter,
345         but somme under the hood stuff need to be done before this action
346
347         :parameter state: a dict is passed to the loads, it is the attributes
348                           of the options object
349         :type state: dict
350         """
351         for key, value in state.items():
352             setattr(self, key, value)
353
354     def __setattr__(self, name, value):
355         """set once and only once some attributes in the option,
356         like `_name`. `_name` cannot be changed one the option and
357         pushed in the :class:`tiramisu.option.OptionDescription`.
358
359         if the attribute `_readonly` is set to `True`, the option is
360         "frozen" (which has noting to do with the high level "freeze"
361         propertie or "read_only" property)
362         """
363         if name != '_option' and \
364                 not isinstance(value, tuple) and \
365                 not name.startswith('_state') and \
366                 not name == '_sa_instance_state':
367             is_readonly = False
368             # never change _name dans _opt
369             if name == '_name':
370                 try:
371                     if self.impl_getname() is not None:
372                         #so _name is already set
373                         is_readonly = True
374                 except (KeyError, AttributeError):
375                     pass
376             elif name == '_opt':
377                 pass
378             elif name != '_readonly':
379                 is_readonly = self.impl_is_readonly()
380             if is_readonly:
381                 raise AttributeError(_("'{0}' ({1}) object attribute '{2}' is"
382                                        " read-only").format(
383                                            self.__class__.__name__,
384                                            self,
385                                            #self.impl_getname(),
386                                            name))
387         super(BaseOption, self).__setattr__(name, value)
388
389     def impl_getpath(self, context):
390         return context.cfgimpl_get_description().impl_get_path_by_opt(self)
391
392     def impl_has_callback(self):
393         "to know if a callback has been defined or not"
394         return self.impl_get_callback()[0] is not None
395
396     def _is_subdyn(self):
397         return getattr(self, '_subdyn', None) is not None
398
399     def _impl_valid_unicode(self, value):
400         if sys.version_info[0] >= 3:  # pragma: no cover
401             if not isinstance(value, str):
402                 return ValueError(_('invalid string'))
403         else:
404             if not isinstance(value, unicode) and not isinstance(value, str):
405                 return ValueError(_('invalid unicode or string'))
406
407     def impl_get_display_name(self):
408         name = self.impl_getdoc()
409         if name is None or name == '':
410             name = self.impl_getname()
411         if isinstance(name, unicode):
412             name = name.encode('utf8')
413         return name
414
415
416 class OnlyOption(BaseOption):
417     __slots__ = tuple()
418
419
420 class Option(OnlyOption):
421     """
422     Abstract base class for configuration option's.
423
424     Reminder: an Option object is **not** a container for the value.
425     """
426     __slots__ = tuple()
427     _empty = ''
428
429     def _launch_consistency(self, current_opt, func, option, value, context,
430                             index, submulti_index, opts, warnings_only,
431                             transitive):
432         """Launch consistency now
433
434         :param func: function name, this name should start with _cons_
435         :type func: `str`
436         :param option: option that value is changing
437         :type option: `tiramisu.option.Option`
438         :param value: new value of this option
439         :param context: Config's context, if None, check default value instead
440         :type context: `tiramisu.config.Config`
441         :param index: only for multi option, consistency should be launch for
442                       specified index
443         :type index: `int`
444         :param opts: all options concerne by this consistency
445         :type opts: `list` of `tiramisu.option.Option`
446         :param warnings_only: specific raise error for warning
447         :type warnings_only: `boolean`
448         :param transitive: propertyerror is transitive
449         :type transitive: `boolean`
450         """
451         if context is not undefined:
452             descr = context.cfgimpl_get_description()
453
454         all_cons_vals = []
455         all_cons_opts = []
456         val_consistencies = True
457         for opt in opts:
458             if (isinstance(opt, DynSymLinkOption) and option._dyn == opt._dyn) or \
459                     option == opt:
460                 # option is current option
461                 # we have already value, so use it
462                 all_cons_vals.append(value)
463                 all_cons_opts.append(opt)
464             else:
465                 #if context, calculate value, otherwise get default value
466                 path = None
467                 is_multi = opt.impl_is_multi() and not opt.impl_is_master_slaves()
468                 if context is not undefined:
469                     if isinstance(opt, DynSymLinkOption):
470                         path = opt.impl_getpath(context)
471                     else:
472                         path = descr.impl_get_path_by_opt(opt)
473                     if is_multi:
474                         _index = None
475                     else:
476                         _index = index
477                     opt_value = context.getattr(path, validate=False,
478                                                 index=_index,
479                                                 force_permissive=True,
480                                                 returns_raise=True)
481                     if isinstance(opt_value, Exception):
482                         if isinstance(opt_value, PropertiesOptionError):
483                             if debug:  # pragma: no cover
484                                 log.debug('propertyerror in _launch_consistency: {0}'.format(opt_value))
485                             if transitive:
486                                 return opt_value
487                             else:
488                                 opt_value = None
489                         else:
490                             return opt_value
491                 elif index is None:
492                     opt_value = opt.impl_getdefault()
493                 else:
494                     opt_value = opt.impl_getdefault()[index]
495
496                 if self.impl_is_multi() and index is None:
497                     # only check propertyerror for master/slaves is transitive
498                     val_consistencies = False
499                 if is_multi and isinstance(opt_value, list):
500                     all_cons_vals.extend(opt_value)
501                     for len_ in xrange(len(opt_value)):
502                         all_cons_opts.append(opt)
503                 else:
504                     all_cons_vals.append(opt_value)
505                     all_cons_opts.append(opt)
506
507         if val_consistencies:
508             err = getattr(self, func)(current_opt, all_cons_opts, all_cons_vals, warnings_only)
509             if err:
510                 if warnings_only:
511                     msg = _('attention, "{0}" could be an invalid {1} for "{2}", {3}').format(
512                         value, self._display_name, current_opt.impl_get_display_name(), err)
513                     warnings.warn_explicit(ValueWarning(msg, self),
514                                            ValueWarning,
515                                            self.__class__.__name__, 0)
516                 else:
517                     return err
518
519     def impl_validate(self, value, context=undefined, validate=True,
520                       force_index=None, force_submulti_index=None,
521                       current_opt=undefined, is_multi=None,
522                       display_error=True, display_warnings=True, multi=None):
523         """
524         :param value: the option's value
525         :param context: Config's context
526         :type context: :class:`tiramisu.config.Config`
527         :param validate: if true enables ``self._validator`` validation
528         :type validate: boolean
529         :param force_index: if multi, value has to be a list
530                             not if force_index is not None
531         :type force_index: integer
532         :param force_submulti_index: if submulti, value has to be a list
533                                      not if force_submulti_index is not None
534         :type force_submulti_index: integer
535         """
536         if not validate:
537             return
538         if current_opt is undefined:
539             current_opt = self
540
541         display_warnings = display_warnings and (context is undefined or
542                                                  'warnings' in context.cfgimpl_get_settings())
543         def _is_not_unique(value):
544             if display_error and self.impl_is_unique() and len(set(value)) != len(value):
545                 for idx, val in enumerate(value):
546                     if val in value[idx+1:]:
547                         return ValueError(_('invalid value "{}", this value is already in "{}"').format(
548                                             val, self.impl_get_display_name()))
549
550         def calculation_validator(val, _index):
551             validator, validator_params = self.impl_get_validator()
552             if validator is not None:
553                 if validator_params != {}:
554                     validator_params_ = {}
555                     for val_param, values in validator_params.items():
556                         validator_params_[val_param] = values
557                     #inject value in calculation
558                     if '' in validator_params_:
559                         lst = list(validator_params_[''])
560                         lst.insert(0, val)
561                         validator_params_[''] = tuple(lst)
562                     else:
563                         validator_params_[''] = (val,)
564                 else:
565                     validator_params_ = {'': (val,)}
566                 # Raise ValueError if not valid
567                 value = carry_out_calculation(current_opt, context=context,
568                                               callback=validator,
569                                               callback_params=validator_params_,
570                                               index=_index)
571                 if isinstance(value, Exception):
572                     return value
573
574         def do_validation(_value, _index, submulti_index):
575             if _value is None:
576                 error = warning = None
577             else:
578                 if display_error:
579                     # option validation
580                     err = self._validate(_value, context, current_opt)
581                     if err:
582                         if debug:  # pragma: no cover
583                             log.debug('do_validation: value: {0}, index: {1}, '
584                                       'submulti_index: {2}'.format(_value, _index,
585                                                                    submulti_index),
586                                       exc_info=True)
587                         err_msg = '{0}'.format(err)
588                         if err_msg:
589                             msg = _('"{0}" is an invalid {1} for "{2}", {3}'
590                                     '').format(_value, self._display_name,
591                                                self.impl_get_display_name(), err_msg)
592                         else:
593                             msg = _('"{0}" is an invalid {1} for "{2}"'
594                                     '').format(_value, self._display_name,
595                                                self.impl_get_display_name())
596                         return ValueError(msg)
597                 error = None
598                 if ((display_error and not self._is_warnings_only()) or
599                         (display_warnings and self._is_warnings_only())):
600                     error = calculation_validator(_value, _index)
601                     if not error:
602                         error = self._second_level_validation(_value, self._is_warnings_only())
603                     if error:
604                         if debug:  # pragma: no cover
605                             log.debug(_('do_validation for {0}: error in value').format(
606                                 self.impl_getname()), exc_info=True)
607                         if self._is_warnings_only():
608                             msg = _('attention, "{0}" could be an invalid {1} for "{2}", {3}').format(
609                                 _value, self._display_name, self.impl_get_display_name(), error)
610                             warnings.warn_explicit(ValueWarning(msg, self),
611                                                    ValueWarning,
612                                                    self.__class__.__name__, 0)
613                             error = None
614             if error is None:
615                 # if context launch consistency validation
616                 #if context is not undefined:
617                 ret = self._valid_consistency(current_opt, _value, context,
618                                               _index, submulti_index, display_warnings,
619                                               display_error)
620                 if isinstance(ret, ValueError):
621                     error = ret
622                 elif ret:
623                     return ret
624             if error:
625                 err_msg = '{0}'.format(error)
626                 if err_msg:
627                     msg = _('"{0}" is an invalid {1} for "{2}", {3}'
628                             '').format(_value, self._display_name,
629                                        self.impl_get_display_name(), err_msg)
630                 else:
631                     msg = _('"{0}" is an invalid {1} for "{2}"'
632                             '').format(_value, self._display_name,
633                                        self.impl_get_display_name())
634                 return ValueError(msg)
635
636         if is_multi is None:
637             is_multi = self.impl_is_multi()
638
639         if not is_multi:
640             return do_validation(value, None, None)
641         elif force_index is not None:
642             if self.impl_is_submulti() and force_submulti_index is None:
643                 err = _is_not_unique(value)
644                 if err:
645                     return err
646                 if not isinstance(value, list):
647                     return ValueError(_('invalid value "{0}" for "{1}" which'
648                                         ' must be a list').format(
649                                            value, self.impl_get_display_name()))
650                 for idx, val in enumerate(value):
651                     if isinstance(val, list):
652                         return ValueError(_('invalid value "{}" for "{}" '
653                                             'which must not be a list').format(val,
654                                                                               self.impl_get_display_name()))
655                     err = do_validation(val, force_index, idx)
656                     if err:
657                         return err
658             else:
659                 if self.impl_is_unique() and value in multi:
660                     return ValueError(_('invalid value "{}", this value is already'
661                                         ' in "{}"').format(value,
662                                                            self.impl_get_display_name()))
663                 return do_validation(value, force_index, force_submulti_index)
664         elif not isinstance(value, list):
665             return ValueError(_('invalid value "{0}" for "{1}" which '
666                                 'must be a list').format(value,
667                                                          self.impl_getname()))
668         elif self.impl_is_submulti() and force_submulti_index is None:
669             for idx, val in enumerate(value):
670                 err = _is_not_unique(val)
671                 if err:
672                     return err
673                 if not isinstance(val, list):
674                     return ValueError(_('invalid value "{0}" for "{1}" '
675                                         'which must be a list of list'
676                                         '').format(val,
677                                                    self.impl_getname()))
678                 for slave_idx, slave_val in enumerate(val):
679                     err = do_validation(slave_val, idx, slave_idx)
680                     if err:
681                         return err
682         else:
683             err = _is_not_unique(value)
684             if err:
685                 return err
686             for idx, val in enumerate(value):
687                 err = do_validation(val, idx, force_submulti_index)
688                 if err:
689                     return err
690             return self._valid_consistency(current_opt, None, context,
691                                            None, None, display_warnings, display_error)
692
693     def impl_is_dynsymlinkoption(self):
694         return False
695
696     def impl_is_master_slaves(self, type_='both'):
697         """FIXME
698         """
699         master_slaves = self.impl_get_master_slaves()
700         if master_slaves is not None:
701             if type_ in ('both', 'master') and \
702                     master_slaves.is_master(self):
703                 return True
704             if type_ in ('both', 'slave') and \
705                     not master_slaves.is_master(self):
706                 return True
707         return False
708
709     def impl_get_master_slaves(self):
710         masterslaves = self._get_master_slave()
711         if masterslaves is None:
712             return None
713         if not isinstance(masterslaves, MasterSlaves):
714             return MasterSlaves(masterslaves)
715         return masterslaves
716
717     def impl_getdoc(self):
718         "accesses the Option's doc"
719         return self.impl_get_information('doc')
720
721     def _valid_consistencies(self, other_opts, init=True):
722         if self._is_subdyn():
723             dynod = self._impl_getsubdyn()
724         else:
725             dynod = None
726         if self.impl_is_submulti():
727             raise ConfigError(_('cannot add consistency with submulti option'))
728         is_multi = self.impl_is_multi()
729         for opt in other_opts:
730             if opt.impl_is_submulti():
731                 raise ConfigError(_('cannot add consistency with submulti option'))
732             if not isinstance(opt, Option):
733                 raise ConfigError(_('consistency must be set with an option'))
734             if opt._is_subdyn():
735                 if dynod is None:
736                     raise ConfigError(_('almost one option in consistency is '
737                                         'in a dynoptiondescription but not all'))
738                 if dynod != opt._impl_getsubdyn():
739                     raise ConfigError(_('option in consistency must be in same'
740                                         ' dynoptiondescription'))
741                 dynod = opt._impl_getsubdyn()
742             elif dynod is not None:
743                 raise ConfigError(_('almost one option in consistency is in a '
744                                     'dynoptiondescription but not all'))
745             if self is opt:
746                 raise ConfigError(_('cannot add consistency with itself'))
747             if is_multi != opt.impl_is_multi():
748                 raise ConfigError(_('every options in consistency must be '
749                                     'multi or none'))
750             if init:
751                 #consistency could generate warnings or errors
752                 opt._set_has_dependency()
753
754     def impl_add_consistency(self, func, *other_opts, **params):
755         """Add consistency means that value will be validate with other_opts
756         option's values.
757
758         :param func: function's name
759         :type func: `str`
760         :param other_opts: options used to validate value
761         :type other_opts: `list` of `tiramisu.option.Option`
762         :param params: extra params (warnings_only and transitive are allowed)
763         """
764         if self.impl_is_readonly(): 
765             raise AttributeError(_("'{0}' ({1}) cannot add consistency, option is"
766                                    " read-only").format(
767                                        self.__class__.__name__,
768                                        self.impl_getname()))
769         self._valid_consistencies(other_opts)
770         func = '_cons_{0}'.format(func)
771         if func not in dir(self):
772             raise ConfigError(_('consistency {0} not available for this option').format(func))
773         all_cons_opts = tuple([self] + list(other_opts))
774         unknown_params = set(params.keys()) - set(['warnings_only', 'transitive'])
775         if unknown_params != set():
776             raise ValueError(_('unknow parameter {0} in consistency').format(unknown_params))
777         self._add_consistency(func, all_cons_opts, params)
778         #validate default value when add consistency
779         err = self.impl_validate(self.impl_getdefault())
780         if err:
781             self._del_consistency()
782             raise err
783         if func in allowed_const_list:
784             for opt in all_cons_opts:
785                 if getattr(opt, '_unique', undefined) == undefined:
786                     opt._unique = True
787         #consistency could generate warnings or errors
788         self._set_has_dependency()
789
790     def _valid_consistency(self, option, value, context, index, submulti_idx,
791                            display_warnings, display_error):
792         if context is not undefined:
793             descr = context.cfgimpl_get_description()
794             if descr._cache_consistencies is None:
795                 return
796             #consistencies is something like [('_cons_not_equal', (opt1, opt2))]
797             if isinstance(option, DynSymLinkOption):
798                 consistencies = descr._cache_consistencies.get(option._impl_getopt())
799             else:
800                 consistencies = descr._cache_consistencies.get(option)
801         else:
802             consistencies = option._get_consistencies()
803         if consistencies is not None:
804             for func, all_cons_opts, params in consistencies:
805                 warnings_only = params.get('warnings_only', False)
806                 if (warnings_only and display_warnings) or (not warnings_only and display_error):
807                     transitive = params.get('transitive', True)
808                     #all_cons_opts[0] is the option where func is set
809                     if isinstance(option, DynSymLinkOption):
810                         subpath = '.'.join(option._dyn.split('.')[:-1])
811                         namelen = len(option._impl_getopt().impl_getname())
812                         suffix = option.impl_getname()[namelen:]
813                         opts = []
814                         for opt in all_cons_opts:
815                             name = opt.impl_getname() + suffix
816                             path = subpath + '.' + name
817                             opts.append(opt._impl_to_dyn(name, path))
818                     else:
819                         opts = all_cons_opts
820                     err = opts[0]._launch_consistency(self, func, option, value,
821                                                       context, index, submulti_idx,
822                                                       opts, warnings_only,
823                                                       transitive)
824                     if err:
825                         return err
826
827     def _cons_not_equal(self, current_opt, opts, vals, warnings_only):
828         equal = set()
829         is_current = False
830         for idx_inf, val_inf in enumerate(vals):
831             for idx_sup, val_sup in enumerate(vals[idx_inf + 1:]):
832                 if val_inf == val_sup is not None:
833                     for opt_ in [opts[idx_inf], opts[idx_inf + idx_sup + 1]]:
834                         if opt_ == current_opt:
835                             is_current = True
836                         else:
837                             equal.add(opt_)
838         if equal:
839             if debug:  # pragma: no cover
840                 log.debug(_('_cons_not_equal: {} are not different').format(display_list(list(equal))))
841             if is_current:
842                 if warnings_only:
843                     msg = _('should be different from the value of {}')
844                 else:
845                     msg = _('must be different from the value of {}')
846             else:
847                 if warnings_only:
848                     msg = _('value for {} should be different')
849                 else:
850                     msg = _('value for {} must be different')
851             equal_name = []
852             for opt in equal:
853                 equal_name.append(opt.impl_get_display_name())
854             return ValueError(msg.format(display_list(list(equal_name))))
855
856     # serialize/unserialize
857     def _impl_convert_consistencies(self, descr, load=False):
858         """during serialization process, many things have to be done.
859         one of them is the localisation of the options.
860         The paths are set once for all.
861
862         :type descr: :class:`tiramisu.option.OptionDescription`
863         :param load: `True` if we are at the init of the option description
864         :type load: bool
865         """
866         if not load and self._get_consistencies() == ():
867             self._state_consistencies = None
868         elif load and self._state_consistencies is None:
869             del(self._state_consistencies)
870         else:
871             if load:
872                 consistencies = self._state_consistencies
873             else:
874                 consistencies = self._get_consistencies()
875             new_value = []
876             for consistency in consistencies:
877                 values = []
878                 for obj in consistency[1]:
879                     if load:
880                         values.append(descr.impl_get_opt_by_path(obj))
881                     else:
882                         values.append(descr.impl_get_path_by_opt(obj))
883                 new_value.append((consistency[0], tuple(values), consistency[2]))
884             if load:
885                 del(self._state_consistencies)
886                 for new_val in new_value:
887                     self._add_consistency(new_val[0], new_val[1], new_val[2])
888             else:
889                 self._state_consistencies = new_value
890
891     def _second_level_validation(self, value, warnings_only):
892         pass
893
894     def _impl_to_dyn(self, name, path):
895         return DynSymLinkOption(name, self, dyn=path)
896
897     def _validate_callback(self, callback, callback_params):
898         """callback_params:
899         * None
900         * {'': ((option, permissive),), 'ip': ((None,), (option, permissive))
901         """
902         if callback is None:
903             return
904         default_multi = self.impl_getdefault_multi()
905         is_multi = self.impl_is_multi()
906         default = self.impl_getdefault()
907         if (not is_multi and (default is not None or default_multi is not None)) or \
908                 (is_multi and (default != [] or default_multi is not None)):
909             raise ValueError(_("default value not allowed if option: {0} "
910                              "is calculated").format(self.impl_getname()))
911
912
913 def validate_requires_arg(multi, requires, name):
914     """check malformed requirements
915     and tranform dict to internal tuple
916
917     :param requires: have a look at the
918                      :meth:`tiramisu.setting.Settings.apply_requires` method to
919                      know more about
920                      the description of the requires dictionary
921     """
922     ret_requires = {}
923     config_action = set()
924
925     # start parsing all requires given by user (has dict)
926     # transforme it to a tuple
927     for require in requires:
928         if not isinstance(require, dict):
929             raise ValueError(_("malformed requirements type for option:"
930                                " {0}, must be a dict").format(name))
931         valid_keys = ('option', 'expected', 'action', 'inverse', 'transitive',
932                       'same_action')
933         unknown_keys = frozenset(require.keys()) - frozenset(valid_keys)
934         if unknown_keys != frozenset():
935             raise ValueError(_('malformed requirements for option: {0}'
936                              ' unknown keys {1}, must only '
937                              '{2}').format(name,
938                                            unknown_keys,
939                                            valid_keys))
940         # prepare all attributes
941         if 'option' not in require or 'expected' not in require or \
942                 'action' not in require:
943             raise ValueError(_("malformed requirements for option: {0}"
944                                " require must have option, expected and"
945                                " action keys").format(name))
946         option = require['option']
947         expected = require['expected']
948         action = require['action']
949         if action == 'force_store_value':
950             raise ValueError(_("malformed requirements for option: {0}"
951                                " action cannot be force_store_value"
952                                ).format(name))
953         inverse = require.get('inverse', False)
954         if inverse not in [True, False]:
955             raise ValueError(_('malformed requirements for option: {0}'
956                                ' inverse must be boolean'))
957         transitive = require.get('transitive', True)
958         if transitive not in [True, False]:
959             raise ValueError(_('malformed requirements for option: {0}'
960                                ' transitive must be boolean'))
961         same_action = require.get('same_action', True)
962         if same_action not in [True, False]:
963             raise ValueError(_('malformed requirements for option: {0}'
964                                ' same_action must be boolean'))
965
966         if not isinstance(option, Option):
967             raise ValueError(_('malformed requirements '
968                                'must be an option in option {0}').format(name))
969         if not multi and option.impl_is_multi():
970             raise ValueError(_('malformed requirements '
971                                'multi option must not set '
972                                'as requires of non multi option {0}').format(name))
973         if expected is not None:
974             err = option._validate(expected)
975             if err:
976                 raise ValueError(_('malformed requirements expected value '
977                                    'must be valid for option {0}'
978                                    ': {1}').format(name, err))
979         config_action.add(action)
980         if action not in ret_requires:
981             ret_requires[action] = {}
982         if option not in ret_requires[action]:
983             ret_requires[action][option] = {}
984         if inverse not in ret_requires[action][option]:
985             ret_requires[action][option][inverse] = (option, [expected], action,
986                                                      inverse, transitive, same_action)
987         else:
988             ret_requires[action][option][inverse][1].append(expected)
989     # transform dict to tuple
990     ret = []
991     for opt_requires in ret_requires.values():
992         ret_action = []
993         for requires in opt_requires.values():
994             for require in requires.values():
995                 ret_action.append((require[0], tuple(require[1]), require[2],
996                                    require[3], require[4], require[5]))
997         ret.append(tuple(ret_action))
998     return frozenset(config_action), tuple(ret)
999
1000
1001 class SymLinkOption(OnlyOption):
1002 #    __slots__ = ('_opt', '_state_opt')
1003
1004     def __init__(self, name, opt):
1005         if not isinstance(opt, Option):
1006             raise ValueError(_('malformed symlinkoption '
1007                                'must be an option '
1008                                'for symlink {0}').format(name))
1009         session = self.getsession()
1010         super(Base, self).__init__(name, undefined, undefined, undefined,
1011                                    undefined, undefined, undefined, undefined,
1012                                    undefined, undefined, opt=opt, session=session)
1013         opt._set_has_dependency()
1014         self.commit(session)
1015
1016     def __getattr__(self, name, context=undefined):
1017         if name in ('_opt', '_readonly', 'impl_getpath', '_name',
1018                     '_state_opt', '_impl_setopt'):
1019             return object.__getattr__(self, name)
1020         else:
1021             return getattr(self._impl_getopt(), name)
1022
1023     def _impl_getstate(self, descr):
1024         self._stated = True
1025         self._state_opt = descr.impl_get_path_by_opt(self._impl_getopt())
1026
1027     def _impl_setstate(self, descr):
1028         self._impl_setopt(descr.impl_get_opt_by_path(self._state_opt))
1029         del(self._state_opt)
1030         del(self._stated)
1031         self._set_readonly(True)
1032
1033     def impl_get_information(self, key, default=undefined):
1034         return self._impl_getopt().impl_get_information(key, default)
1035
1036     def impl_is_readonly(self):
1037         return True
1038
1039     def impl_getproperties(self):
1040         return self._impl_getopt()._properties
1041
1042     def impl_get_callback(self):
1043         return self._impl_getopt().impl_get_callback()
1044
1045     def impl_has_callback(self):
1046         "to know if a callback has been defined or not"
1047         return self._impl_getopt().impl_has_callback()
1048
1049     def impl_is_multi(self):
1050         return self._impl_getopt().impl_is_multi()
1051
1052     def _is_subdyn(self):
1053         return getattr(self._impl_getopt(), '_subdyn', None) is not None
1054
1055     def _get_consistencies(self):
1056         return ()
1057
1058
1059 class DynSymLinkOption(object):
1060     __slots__ = ('_dyn', '_opt', '_name')
1061
1062     def __init__(self, name, opt, dyn):
1063         self._name = name
1064         self._dyn = dyn
1065         self._opt = opt
1066
1067     def __getattr__(self, name, context=undefined):
1068         if name in ('_opt', '_readonly', 'impl_getpath', '_name', '_state_opt'):
1069             return object.__getattr__(self, name)
1070         else:
1071             return getattr(self._impl_getopt(), name)
1072
1073     def impl_getname(self):
1074         return self._name
1075
1076     def _impl_getopt(self):
1077         return self._opt
1078
1079     def impl_getsuffix(self):
1080         return self._dyn.split('.')[-1][len(self._impl_getopt().impl_getname()):]
1081
1082     def impl_getpath(self, context):
1083         path = self._impl_getopt().impl_getpath(context)
1084         base_path = '.'.join(path.split('.')[:-2])
1085         if self.impl_is_master_slaves() and base_path is not '':
1086             base_path = base_path + self.impl_getsuffix()
1087         if base_path == '':
1088             return self._dyn
1089         else:
1090             return base_path + '.' + self._dyn
1091
1092     def impl_validate(self, value, context=undefined, validate=True,
1093                       force_index=None, force_submulti_index=None, is_multi=None,
1094                       display_error=True, display_warnings=True, multi=None):
1095         return self._impl_getopt().impl_validate(value, context, validate,
1096                                                  force_index,
1097                                                  force_submulti_index,
1098                                                  current_opt=self,
1099                                                  is_multi=is_multi,
1100                                                  display_error=display_error,
1101                                                  display_warnings=display_warnings,
1102                                                  multi=multi)
1103
1104     def impl_is_dynsymlinkoption(self):
1105         return True