LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
rangeField.py
Go to the documentation of this file.
1 # This file is part of pex_config.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This software is dual licensed under the GNU General Public License and also
10 # under a 3-clause BSD license. Recipients may choose which of these licenses
11 # to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12 # respectively. If you choose the GPL option then the following text applies
13 # (but note that there is still no warranty even if you opt for BSD instead):
14 #
15 # This program is free software: you can redistribute it and/or modify
16 # it under the terms of the GNU General Public License as published by
17 # the Free Software Foundation, either version 3 of the License, or
18 # (at your option) any later version.
19 #
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
24 #
25 # You should have received a copy of the GNU General Public License
26 # along with this program. If not, see <http://www.gnu.org/licenses/>.
27 
28 __all__ = ["RangeField"]
29 
30 from .config import Field, _typeStr
31 from .callStack import getStackFrame
32 
33 
35  """A configuration field (`lsst.pex.config.Field` subclass) that requires
36  the value to be in a specific numeric range.
37 
38  Parameters
39  ----------
40  doc : `str`
41  A description of the field.
42  dtype : {`int`-type, `float`-type}
43  The field's data type: either the `int` or `float` type.
44  default : `int` or `float`, optional
45  Default value for the field.
46  optional : `bool`, optional
47  When `False`, `lsst.pex.config.Config.validate` will fail if the
48  field's value is `None`.
49  min : int, float, or `None`, optional
50  Minimum value accepted in the range. If `None`, the range has no
51  lower bound (equivalent to negative infinity).
52  max : `int`, `float`, or None, optional
53  Maximum value accepted in the range. If `None`, the range has no
54  upper bound (equivalent to positive infinity).
55  inclusiveMin : `bool`, optional
56  If `True` (default), the ``min`` value is included in the allowed
57  range.
58  inclusiveMax : `bool`, optional
59  If `True` (default), the ``max`` value is included in the allowed
60  range.
61  deprecated : None or `str`, optional
62  A description of why this Field is deprecated, including removal date.
63  If not None, the string is appended to the docstring for this Field.
64 
65  See also
66  --------
67  ChoiceField
68  ConfigChoiceField
69  ConfigDictField
70  ConfigField
71  ConfigurableField
72  DictField
73  Field
74  ListField
75  RegistryField
76  """
77 
78  supportedTypes = set((int, float))
79  """The set of data types allowed by `RangeField` instances (`set`
80  containing `int` and `float` types).
81  """
82 
83  def __init__(self, doc, dtype, default=None, optional=False,
84  min=None, max=None, inclusiveMin=True, inclusiveMax=False,
85  deprecated=None):
86  if dtype not in self.supportedTypessupportedTypessupportedTypes:
87  raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
88  source = getStackFrame()
89  if min is None and max is None:
90  raise ValueError("min and max cannot both be None")
91 
92  if min is not None and max is not None:
93  if min > max:
94  raise ValueError("min = %s > %s = max" % (min, max))
95  elif min == max and not (inclusiveMin and inclusiveMax):
96  raise ValueError("min = max = %s and min and max not both inclusive" % (min,))
97 
98  self.minmin = min
99  """Minimum value accepted in the range. If `None`, the range has no
100  lower bound (equivalent to negative infinity).
101  """
102 
103  self.maxmax = max
104  """Maximum value accepted in the range. If `None`, the range has no
105  upper bound (equivalent to positive infinity).
106  """
107 
108  if inclusiveMax:
109  self.maxCheckmaxCheck = lambda x, y: True if y is None else x <= y
110  else:
111  self.maxCheckmaxCheck = lambda x, y: True if y is None else x < y
112  if inclusiveMin:
113  self.minCheckminCheck = lambda x, y: True if y is None else x >= y
114  else:
115  self.minCheckminCheck = lambda x, y: True if y is None else x > y
116  self._setup_setup(doc, dtype=dtype, default=default, check=None, optional=optional, source=source,
117  deprecated=deprecated)
118  self.rangeStringrangeString = "%s%s,%s%s" % \
119  (("[" if inclusiveMin else "("),
120  ("-inf" if self.minmin is None else self.minmin),
121  ("inf" if self.maxmax is None else self.maxmax),
122  ("]" if inclusiveMax else ")"))
123  """String representation of the field's allowed range (`str`).
124  """
125 
126  self.__doc____doc__ += "\n\nValid Range = " + self.rangeStringrangeString
127 
128  def _validateValue(self, value):
129  Field._validateValue(self, value)
130  if not self.minCheckminCheck(value, self.minmin) or \
131  not self.maxCheckmaxCheck(value, self.maxmax):
132  msg = "%s is outside of valid range %s" % (value, self.rangeStringrangeString)
133  raise ValueError(msg)
def _setup(self, doc, dtype, default, check, optional, source, deprecated)
Definition: config.py:336
def __init__(self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)
Definition: rangeField.py:85
daf::base::PropertySet * set
Definition: fits.cc:912
def getStackFrame(relative=0)
Definition: callStack.py:58