lsst.pex.config  18.0.0-1-gc037db8
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  """A configuration field (`lsst.pex.config.Field` subclass) that requires
31  the value to be in a specific numeric range.
32 
33  Parameters
34  ----------
35  doc : `str`
36  A description of the field.
37  dtype : {`int`-type, `float`-type}
38  The field's data type: either the `int` or `float` type.
39  default : `int` or `float`, optional
40  Default value for the field.
41  optional : `bool`, optional
42  When `False`, `lsst.pex.config.Config.validate` will fail if the
43  field's value is `None`.
44  min : int, float, or `None`, optional
45  Minimum value accepted in the range. If `None`, the range has no
46  lower bound (equivalent to negative infinity).
47  max : `int`, `float`, or None, optional
48  Maximum value accepted in the range. If `None`, the range has no
49  upper bound (equivalent to positive infinity).
50  inclusiveMin : `bool`, optional
51  If `True` (default), the ``min`` value is included in the allowed
52  range.
53  inclusiveMax : `bool`, optional
54  If `True` (default), the ``max`` value is included in the allowed
55  range.
56  deprecated : None or `str`, optional
57  A description of why this Field is deprecated, including removal date.
58  If not None, the string is appended to the docstring for this Field.
59 
60  See also
61  --------
62  ChoiceField
63  ConfigChoiceField
64  ConfigDictField
65  ConfigField
66  ConfigurableField
67  DictField
68  Field
69  ListField
70  RegistryField
71  """
72 
73  supportedTypes = set((int, float))
74  """The set of data types allowed by `RangeField` instances (`set`
75  containing `int` and `float` types).
76  """
77 
78  def __init__(self, doc, dtype, default=None, optional=False,
79  min=None, max=None, inclusiveMin=True, inclusiveMax=False,
80  deprecated=None):
81  if dtype not in self.supportedTypes:
82  raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
83  source = getStackFrame()
84  if min is None and max is None:
85  raise ValueError("min and max cannot both be None")
86 
87  if min is not None and max is not None:
88  if min > max:
89  raise ValueError("min = %s > %s = max" % (min, max))
90  elif min == max and not (inclusiveMin and inclusiveMax):
91  raise ValueError("min = max = %s and min and max not both inclusive" % (min,))
92 
93  self.min = min
94  """Minimum value accepted in the range. If `None`, the range has no
95  lower bound (equivalent to negative infinity).
96  """
97 
98  self.max = max
99  """Maximum value accepted in the range. If `None`, the range has no
100  upper bound (equivalent to positive infinity).
101  """
102 
103  if inclusiveMax:
104  self.maxCheck = lambda x, y: True if y is None else x <= y
105  else:
106  self.maxCheck = lambda x, y: True if y is None else x < y
107  if inclusiveMin:
108  self.minCheck = lambda x, y: True if y is None else x >= y
109  else:
110  self.minCheck = lambda x, y: True if y is None else x > y
111  self._setup(doc, dtype=dtype, default=default, check=None, optional=optional, source=source,
112  deprecated=deprecated)
113  self.rangeString = "%s%s,%s%s" % \
114  (("[" if inclusiveMin else "("),
115  ("-inf" if self.min is None else self.min),
116  ("inf" if self.max is None else self.max),
117  ("]" if inclusiveMax else ")"))
118  """String representation of the field's allowed range (`str`).
119  """
120 
121  self.__doc__ += "\n\nValid Range = " + self.rangeString
122 
123  def _validateValue(self, value):
124  Field._validateValue(self, value)
125  if not self.minCheck(value, self.min) or \
126  not self.maxCheck(value, self.max):
127  msg = "%s is outside of valid range %s" % (value, self.rangeString)
128  raise ValueError(msg)
def getStackFrame(relative=0)
Definition: callStack.py:52
def __init__(self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)
Definition: rangeField.py:80
def _setup(self, doc, dtype, default, check, optional, source, deprecated)
Definition: config.py:278