Coverage for python/lsst/pex/config/rangeField.py: 52%
36 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 03:53 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 03:53 -0700
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`, the ``min`` value is included in the allowed range.
57 inclusiveMax : `bool`, optional
58 If `True`, the ``max`` value is included in the allowed range.
59 deprecated : None or `str`, optional
60 A description of why this Field is deprecated, including removal date.
61 If not None, the string is appended to the docstring for this Field.
63 See Also
64 --------
65 ChoiceField
66 ConfigChoiceField
67 ConfigDictField
68 ConfigField
69 ConfigurableField
70 DictField
71 Field
72 ListField
73 RegistryField
74 """
76 supportedTypes = {int, float}
77 """The set of data types allowed by `RangeField` instances (`set`
78 containing `int` and `float` types).
79 """
81 def __init__(
82 self,
83 doc,
84 dtype,
85 default=None,
86 optional=False,
87 min=None,
88 max=None,
89 inclusiveMin=True,
90 inclusiveMax=False,
91 deprecated=None,
92 ):
93 if dtype not in self.supportedTypes: 93 ↛ 94line 93 didn't jump to line 94, because the condition on line 93 was never true
94 raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
95 source = getStackFrame()
96 if min is None and max is None: 96 ↛ 97line 96 didn't jump to line 97, because the condition on line 96 was never true
97 raise ValueError("min and max cannot both be None")
99 if min is not None and max is not None: 99 ↛ 100line 99 didn't jump to line 100, because the condition on line 99 was never true
100 if min > max:
101 raise ValueError(f"min = {min} > {max} = max")
102 elif min == max and not (inclusiveMin and inclusiveMax):
103 raise ValueError(f"min = max = {min} and min and max not both inclusive")
105 self.min = min
106 """Minimum value accepted in the range. If `None`, the range has no
107 lower bound (equivalent to negative infinity).
108 """
110 self.max = max
111 """Maximum value accepted in the range. If `None`, the range has no
112 upper bound (equivalent to positive infinity).
113 """
115 if inclusiveMax: 115 ↛ 116line 115 didn't jump to line 116, because the condition on line 115 was never true
116 self.maxCheck = lambda x, y: True if y is None else x <= y
117 else:
118 self.maxCheck = lambda x, y: True if y is None else x < y 118 ↛ exitline 118 didn't run the lambda on line 118
119 if inclusiveMin: 119 ↛ 122line 119 didn't jump to line 122, because the condition on line 119 was never false
120 self.minCheck = lambda x, y: True if y is None else x >= y 120 ↛ exitline 120 didn't run the lambda on line 120
121 else:
122 self.minCheck = lambda x, y: True if y is None else x > y
123 self._setup(
124 doc,
125 dtype=dtype,
126 default=default,
127 check=None,
128 optional=optional,
129 source=source,
130 deprecated=deprecated,
131 )
132 self.rangeString = "{}{},{}{}".format(
133 ("[" if inclusiveMin else "("),
134 ("-inf" if self.min is None else self.min),
135 ("inf" if self.max is None else self.max),
136 ("]" if inclusiveMax else ")"),
137 )
138 """String representation of the field's allowed range (`str`).
139 """
141 self.__doc__ += "\n\nValid Range = " + self.rangeString
143 def _validateValue(self, value):
144 Field._validateValue(self, value)
145 if not self.minCheck(value, self.min) or not self.maxCheck(value, self.max):
146 msg = f"{value} is outside of valid range {self.rangeString}"
147 raise ValueError(msg)