lsst.pex.config  13.0-1-g41367f3+6
 All Classes Namespaces Files Functions Variables Properties Macros Pages
rangeField.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 import traceback
23 
24 from .config import Field, _typeStr
25 
26 
27 __all__ = ["RangeField"]
28 
29 
30 class RangeField(Field):
31  """
32  Defines a Config Field which allows only a range of values.
33  The range is defined by providing min and/or max values.
34  If min or max is None, the range will be open in that direction
35  If inclusive[Min|Max] is True the range will include the [min|max] value
36 
37  """
38 
39  supportedTypes = set((int, float))
40 
41  def __init__(self, doc, dtype, default=None, optional=False,
42  min=None, max=None, inclusiveMin=True, inclusiveMax=False):
43  if dtype not in self.supportedTypes:
44  raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
45  source = traceback.extract_stack(limit=2)[0]
46  if min is None and max is None:
47  raise ValueError("min and max cannot both be None")
48 
49  if min is not None and max is not None:
50  if min > max:
51  raise ValueError("min = %s > %s = max" % (min, max))
52  elif min == max and not (inclusiveMin and inclusiveMax):
53  raise ValueError("min = max = %s and min and max not both inclusive" % (min,))
54 
55  self.min = min
56  self.max = max
57 
58  self.rangeString = "%s%s,%s%s" % \
59  (("[" if inclusiveMin else "("),
60  ("-inf" if self.min is None else self.min),
61  ("inf" if self.max is None else self.max),
62  ("]" if inclusiveMax else ")"))
63  doc += "\n\tValid Range = " + self.rangeString
64  if inclusiveMax:
65  self.maxCheck = lambda x, y: True if y is None else x <= y
66  else:
67  self.maxCheck = lambda x, y: True if y is None else x < y
68  if inclusiveMin:
69  self.minCheck = lambda x, y: True if y is None else x >= y
70  else:
71  self.minCheck = lambda x, y: True if y is None else x > y
72  self._setup(doc, dtype=dtype, default=default, check=None, optional=optional, source=source)
73 
74  def _validateValue(self, value):
75  Field._validateValue(self, value)
76  if not self.minCheck(value, self.min) or \
77  not self.maxCheck(value, self.max):
78  msg = "%s is outside of valid range %s" % (value, self.rangeString)
79  raise ValueError(msg)