separate baseoption and option
[tiramisu.git] / tiramisu / option / choiceoption.py
1 # -*- coding: utf-8 -*-
2 # Copyright (C) 2017 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 from types import FunctionType
22
23 from ..setting import undefined
24 from ..i18n import _
25 from .baseoption import validate_callback
26 from .option import Option
27 from ..autolib import carry_out_calculation
28 from ..error import ConfigError, display_list
29
30
31 class ChoiceOption(Option):
32     """represents a choice out of several objects.
33
34     The option can also have the value ``None``
35     """
36     __slots__ = tuple()
37     _display_name = _('choice')
38
39     def __init__(self, name, doc, values, default=None,
40                  values_params=None, default_multi=None, requires=None,
41                  multi=False, callback=None, callback_params=None,
42                  validator=None, validator_params=None,
43                  properties=None, warnings_only=False):
44         """
45         :param values: is a list of values the option can possibly take
46         """
47         if isinstance(values, FunctionType):
48             validate_callback(values, values_params, 'values', self)
49         else:
50             if values_params is not None:
51                 raise ValueError(_('values is not a function, so values_params must be None'))
52             if not isinstance(values, tuple):
53                 raise TypeError(_('values must be a tuple or a function for {0}'
54                                  ).format(name))
55         self._choice_values = values
56         if values_params is not None:
57             self._choice_values_params = values_params
58         super(ChoiceOption, self).__init__(name, doc, default=default,
59                                            default_multi=default_multi,
60                                            callback=callback,
61                                            callback_params=callback_params,
62                                            requires=requires,
63                                            multi=multi,
64                                            validator=validator,
65                                            validator_params=validator_params,
66                                            properties=properties,
67                                            warnings_only=warnings_only)
68
69     def impl_get_values(self, context, current_opt=undefined):
70         if current_opt is undefined:
71             current_opt = self
72         #FIXME cache? but in context...
73         values = self._choice_values
74         if isinstance(values, FunctionType):
75             if context is None:
76                 values = []
77             else:
78                 values = carry_out_calculation(current_opt, context=context,
79                                                callback=values,
80                                                callback_params=getattr(self, '_choice_values_params', {}))
81                 if isinstance(values, Exception):
82                     return values
83                 if values is not undefined and not isinstance(values, list):
84                     raise ConfigError(_('calculated values for {0} is not a list'
85                                         '').format(self.impl_getname()))
86         return values
87
88
89     def _validate(self, value, context=undefined, current_opt=undefined):
90         values = self.impl_get_values(context, current_opt=current_opt)
91         if isinstance(values, Exception):
92             return values
93         if values is not undefined and not value in values:
94             if len(values) == 1:
95                 return ValueError(_('only {0} is allowed'
96                                     '').format(values[0]))
97             else:
98                 return ValueError(_('only {0} are allowed'
99                                     '').format(display_list(values)))