Coverage for python/lsst/pex/config/rangeField.py: 50%
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
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/>.
28__all__ = ["RangeField"]
30from .callStack import getStackFrame
31from .config import Field, _typeStr
34class RangeField(Field):
35 """A configuration field (`lsst.pex.config.Field` subclass) that requires
36 the value to be in a specific numeric range.
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.
65 See also
66 --------
67 ChoiceField
68 ConfigChoiceField
69 ConfigDictField
70 ConfigField
71 ConfigurableField
72 DictField
73 Field
74 ListField
75 RegistryField
76 """
78 supportedTypes = set((int, float))
79 """The set of data types allowed by `RangeField` instances (`set`
80 containing `int` and `float` types).
81 """
83 def __init__(
84 self,
85 doc,
86 dtype,
87 default=None,
88 optional=False,
89 min=None,
90 max=None,
91 inclusiveMin=True,
92 inclusiveMax=False,
93 deprecated=None,
94 ):
95 if dtype not in self.supportedTypes: 95 ↛ 96line 95 didn't jump to line 96, because the condition on line 95 was never true
96 raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
97 source = getStackFrame()
98 if min is None and max is None: 98 ↛ 99line 98 didn't jump to line 99, because the condition on line 98 was never true
99 raise ValueError("min and max cannot both be None")
101 if min is not None and max is not None: 101 ↛ 102line 101 didn't jump to line 102, because the condition on line 101 was never true
102 if min > max:
103 raise ValueError("min = %s > %s = max" % (min, max))
104 elif min == max and not (inclusiveMin and inclusiveMax):
105 raise ValueError("min = max = %s and min and max not both inclusive" % (min,))
107 self.min = min
108 """Minimum value accepted in the range. If `None`, the range has no
109 lower bound (equivalent to negative infinity).
110 """
112 self.max = max
113 """Maximum value accepted in the range. If `None`, the range has no
114 upper bound (equivalent to positive infinity).
115 """
117 if inclusiveMax: 117 ↛ 118line 117 didn't jump to line 118, because the condition on line 117 was never true
118 self.maxCheck = lambda x, y: True if y is None else x <= y
119 else:
120 self.maxCheck = lambda x, y: True if y is None else x < y 120 ↛ exitline 120 didn't run the lambda on line 120
121 if inclusiveMin: 121 ↛ 124line 121 didn't jump to line 124, because the condition on line 121 was never false
122 self.minCheck = lambda x, y: True if y is None else x >= y 122 ↛ exitline 122 didn't run the lambda on line 122
123 else:
124 self.minCheck = lambda x, y: True if y is None else x > y
125 self._setup(
126 doc,
127 dtype=dtype,
128 default=default,
129 check=None,
130 optional=optional,
131 source=source,
132 deprecated=deprecated,
133 )
134 self.rangeString = "%s%s,%s%s" % (
135 ("[" if inclusiveMin else "("),
136 ("-inf" if self.min is None else self.min),
137 ("inf" if self.max is None else self.max),
138 ("]" if inclusiveMax else ")"),
139 )
140 """String representation of the field's allowed range (`str`).
141 """
143 self.__doc__ += "\n\nValid Range = " + self.rangeString
145 def _validateValue(self, value):
146 Field._validateValue(self, value)
147 if not self.minCheck(value, self.min) or not self.maxCheck(value, self.max):
148 msg = "%s is outside of valid range %s" % (value, self.rangeString)
149 raise ValueError(msg)