use polymorphism
[tiramisu.git] / tiramisu / autolib.py
index de8a8c5..503bcdd 100644 (file)
 # ____________________________________________________________
 "enables us to carry out a calculation and return an option's value"
 from tiramisu.error import PropertiesOptionError, ConfigError
+from tiramisu.setting import multitypes
 from tiramisu.i18n import _
 # ____________________________________________________________
 
 
-def carry_out_calculation(name, config, callback, callback_params,
+def carry_out_calculation(option, config, callback, callback_params,
                           index=None, max_len=None):
     """a function that carries out a calculation for an option's value
 
-    :param name: the option name (`opt._name`)
+    :param name: the option name (`opt.impl_getname()`)
+    :param name: the option
     :param config: the context config in order to have
                    the whole options available
     :param callback: the name of the callback function
@@ -41,14 +43,21 @@ def carry_out_calculation(name, config, callback, callback_params,
     :param max_len: max length for a multi
     :type max_len: int
 
+    The callback_params is a dict. Key is used to build args (if key is '')
+    and kwargs (otherwise). Values are tuple of:
+    - values
+    - tuple with option and boolean's force_permissive (True when don't raise
+    if PropertiesOptionError)
+    Values could have multiple values only when key is ''.
+
     * if no callback_params:
-      => calculate()
+      => calculate(<function func at 0x2092320>, [], {})
 
     * if callback_params={'': ('yes',)}
-      => calculate('yes')
+      => calculate(<function func at 0x2092320>, ['yes'], {})
 
     * if callback_params={'value': ('yes',)}
-      => calculate(value='yes')
+      => calculate(<function func at 0x165b320>, [], {'value': 'yes'})
 
     * if callback_params={'': ('yes', 'no')}
       => calculate('yes', 'no')
@@ -56,55 +65,71 @@ def carry_out_calculation(name, config, callback, callback_params,
     * if callback_params={'value': ('yes', 'no')}
       => ValueError()
 
+    * if callback_params={'': (['yes', 'no'],)}
+      => calculate(<function func at 0x176b320>, ['yes', 'no'], {})
+
+    * if callback_params={'value': ('yes', 'no')}
+      => raises ValueError()
+
     * if callback_params={'': ((opt1, False),)}
 
        - a simple option:
          opt1 == 11
-         => calculate(11)
+         => calculate(<function func at 0x1cea320>, [11], {})
 
-       - a multi option:
+       - a multi option and not master/slave:
          opt1 == [1, 2, 3]
-         => calculate(1)
-         => calculate(2)
-         => calculate(3)
+         => calculate(<function func at 0x223c320>, [[1, 2, 3]], {})
+
+       - option is master or slave of opt1:
+         opt1 == [1, 2, 3]
+         => calculate(<function func at 0x223c320>, [1], {})
+         => calculate(<function func at 0x223c320>, [2], {})
+         => calculate(<function func at 0x223c320>, [3], {})
+
+      - opt is a master or slave but not related to option:
+        opt1 == [1, 2, 3]
+        => calculate(<function func at 0x11b0320>, [[1, 2, 3]], {})
 
     * if callback_params={'value': ((opt1, False),)}
 
        - a simple option:
          opt1 == 11
-         => calculate(value=11)
+         => calculate(<function func at 0x17ff320>, [], {'value': 11})
 
        - a multi option:
          opt1 == [1, 2, 3]
-         => calculate(value=1)
-         => calculate(value=2)
-         => calculate(value=3)
+         => calculate(<function func at 0x1262320>, [], {'value': [1, 2, 3]})
 
     * if callback_params={'': ((opt1, False), (opt2, False))}
 
+      - two single options
+          opt1 = 11
+          opt2 = 12
+          => calculate(<function func at 0x217a320>, [11, 12], {})
+
       - a multi option with a simple option
           opt1 == [1, 2, 3]
-          opt2 == 11
-          => calculate(1, 11)
-          => calculate(2, 11)
-          => calculate(3, 11)
+          opt2 == 12
+          => calculate(<function func at 0x2153320>, [[1, 2, 3], 12], {})
 
       - a multi option with an other multi option but with same length
           opt1 == [1, 2, 3]
           opt2 == [11, 12, 13]
-          callback_params={'': ((opt1, False), (opt2, False))}
-          => calculate(1, 11)
-          => calculate(2, 12)
-          => calculate(3, 13)
+          => calculate(<function func at 0x1981320>, [[1, 2, 3], [11, 12, 13]], {})
 
       - a multi option with an other multi option but with different length
           opt1 == [1, 2, 3]
           opt2 == [11, 12]
-          callback_params={'': ((opt1, False), (opt2, False))}
-          => ConfigError()
+          => calculate(<function func at 0x2384320>, [[1, 2, 3], [11, 12]], {})
+
+      - a multi option without value with a simple option
+          opt1 == []
+          opt2 == 11
+          => calculate(<function func at 0xb65320>, [[], 12], {})
 
     * if callback_params={'value': ((opt1, False), (opt2, False))}
-      => ConfigError()
+      => raises ValueError()
 
     If index is not None, return a value, otherwise return:
 
@@ -114,93 +139,110 @@ def carry_out_calculation(name, config, callback, callback_params,
     If calculate return list, this list is extend to return value.
     """
     tcparams = {}
+    # if callback_params has a callback, launch several time calculate()
     one_is_multi = False
-    len_multi = 0
-
-    for key, callbacks in callback_params.items():
-        for callbk in callbacks:
-            if isinstance(callbk, tuple):
-                option, force_permissive = callbk
+    # multi's option should have same value for all option
+    len_multi = None
+    for callbacks in callback_params:
+        key = callbacks.name
+        for callbk in callbacks.params:
+            if callbk.option is not None:
+                # callbk is something link (opt, True|False)
+                opt = callbk.get_option(config)
+                force_permissive = callbk.force_permissive
+                path = config.cfgimpl_get_description().impl_get_path_by_opt(
+                    opt)
                 # get value
                 try:
-                    path = config.cfgimpl_get_description().impl_get_path_by_opt(option)
                     value = config._getattr(path, force_permissive=True)
                 except PropertiesOptionError as err:
                     if force_permissive:
                         continue
                     raise ConfigError(_('unable to carry out a calculation, '
                                         'option {0} has properties: {1} for: '
-                                        '{2}').format(option._name, err.proptype,
-                                                      name))
-                is_multi = option.impl_is_multi()
+                                        '{2}').format(option.impl_getname(),
+                                                      err.proptype,
+                                                      option._name))
+
+                is_multi = False
+                if opt.impl_is_multi():
+                    #opt is master, search if option is a slave
+                    if opt.impl_get_multitype() == multitypes.master:
+                        if option in opt.impl_get_master_slaves():
+                            is_multi = True
+                    #opt is slave, search if option is an other slaves
+                    elif opt.impl_get_multitype() == multitypes.slave:
+                        if option in opt.impl_get_master_slaves().impl_get_master_slaves():
+                            is_multi = True
                 if is_multi:
-                    if value is not None:
-                        len_value = len(value)
-                        if len_multi != 0 and len_multi != len_value:
-                            raise ConfigError(_('unable to carry out a '
-                                              'calculation, option value with'
-                                              ' multi types must have same '
-                                              'length for: {0}').format(name))
-                        len_multi = len_value
+                    len_multi = len(value)
                     one_is_multi = True
                 tcparams.setdefault(key, []).append((value, is_multi))
             else:
-                tcparams.setdefault(key, []).append((callbk, False))
+                # callbk is a value and not a multi
+                tcparams.setdefault(key, []).append((callbk.value, False))
 
+    # if one value is a multi, launch several time calculate
+    # if index is set, return a value
+    # if no index, return a list
     if one_is_multi:
         ret = []
         if index:
-            if index < len_multi:
-                range_ = [index]
-            else:
-                range_ = []
-                ret = None
+            range_ = [index]
         else:
-            if max_len and max_len < len_multi:
-                range_ = range(max_len)
-            else:
-                range_ = range(len_multi)
+            range_ = range(len_multi)
         for incr in range_:
-            tcp = {}
-            params = []
+            args = []
+            kwargs = {}
             for key, couples in tcparams.items():
                 for couple in couples:
                     value, ismulti = couple
-                    if ismulti and value is not None:
-                        if key == '':
-                            params.append(value[incr])
-                        else:
-                            tcp[key] = value[incr]
+                    if ismulti:
+                        val = value[incr]
                     else:
-                        params.append(value)
-            calc = calculate(name, callback, params, tcp)
+                        val = value
+                    if key == '':
+                        args.append(val)
+                    else:
+                        kwargs[key] = val
+            calc = calculate(callback, args, kwargs)
             if index:
                 ret = calc
             else:
-                if isinstance(calc, list):
-                    ret.extend(calc)
-                else:
-                    ret.append(calc)
+                ret.append(calc)
         return ret
     else:
-        tcp = {}
-        params = []
+        # no value is multi
+        # return a single value
+        args = []
+        kwargs = {}
         for key, couples in tcparams.items():
             for couple in couples:
+                # couple[1] (ismulti) is always False
                 if key == '':
-                    value = couple[0]
-                    params.append(value)
+                    args.append(couple[0])
                 else:
-                    tcp[key] = couple[0]
-        return calculate(name, callback, params, tcp)
+                    kwargs[key] = couple[0]
+        ret = calculate(callback, args, kwargs)
+        if callback_params != {}:
+            if isinstance(ret, list) and max_len:
+                ret = ret[:max_len]
+                if len(ret) < max_len:
+                    ret = ret + [None] * (max_len - len(ret))
+            if isinstance(ret, list) and index:
+                if len(ret) < index + 1:
+                    ret = None
+                else:
+                    ret = ret[index]
+        return ret
 
 
-def calculate(name, callback, params, tcparams):
+def calculate(callback, args, kwargs):
     """wrapper that launches the 'callback'
 
-    :param callback: callback name
-    :param params: in the callback's arity, the unnamed parameters
-    :param tcparams: in the callback's arity, the named parameters
+    :param callback: callback function
+    :param args: in the callback's arity, the unnamed parameters
+    :param kwargs: in the callback's arity, the named parameters
 
     """
-    return callback(*params, **tcparams)
+    return callback(*args, **kwargs)