lsst.pex.config  16.0-5-gd0f1235+5
choiceField.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 __all__ = ["ChoiceField"]
23 
24 from .config import Field, _typeStr
25 from .callStack import getStackFrame
26 
27 
29  """
30  Defines a Config Field which allows only a set of values
31  All allowed must be of the same type.
32  Allowed values should be provided as a dict of value, doc string pairs
33 
34  """
35  def __init__(self, doc, dtype, allowed, default=None, optional=True):
36  self.allowed = dict(allowed)
37  if optional and None not in self.allowed:
38  self.allowed[None] = "Field is optional"
39 
40  if len(self.allowed) == 0:
41  raise ValueError("ChoiceFields must allow at least one choice")
42 
43  Field.__init__(self, doc=doc, dtype=dtype, default=default,
44  check=None, optional=optional)
45 
46  self.__doc__ += "\n\nAllowed values:\n\n"
47  for choice, choiceDoc in self.allowed.items():
48  if choice is not None and not isinstance(choice, dtype):
49  raise ValueError("ChoiceField's allowed choice %s is of incorrect type %s. Expected %s" %
50  (choice, _typeStr(choice), _typeStr(dtype)))
51  self.__doc__ += "%s\n %s\n" % ('``{0!r}``'.format(str(choice)), choiceDoc)
52 
54 
55  def _validateValue(self, value):
56  Field._validateValue(self, value)
57  if value not in self.allowed:
58  msg = "Value {} is not allowed.\n" \
59  "\tAllowed values: [{}]".format(value, ", ".join(str(key) for key in self.allowed))
60  raise ValueError(msg)
def getStackFrame(relative=0)
Definition: callStack.py:50
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:129
def __init__(self, doc, dtype, allowed, default=None, optional=True)
Definition: choiceField.py:35