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