Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+83433b07ee,g16d25e1f1b+23bc9e47ac,g1ec0fe41b4+3ea9d11450,g1fd858c14a+9be2b0f3b9,g2440f9efcc+8c5ae1fdc5,g35bb328faa+8c5ae1fdc5,g4a4af6cd76+d25431c27e,g4d2262a081+c74e83464e,g53246c7159+8c5ae1fdc5,g55585698de+1e04e59700,g56a49b3a55+92a7603e7a,g60b5630c4e+1e04e59700,g67b6fd64d1+3fc8cb0b9e,g78460c75b0+7e33a9eb6d,g786e29fd12+668abc6043,g8352419a5c+8c5ae1fdc5,g8852436030+60e38ee5ff,g89139ef638+3fc8cb0b9e,g94187f82dc+1e04e59700,g989de1cb63+3fc8cb0b9e,g9d31334357+1e04e59700,g9f33ca652e+0a83e03614,gabe3b4be73+8856018cbb,gabf8522325+977d9fabaf,gb1101e3267+8b4b9c8ed7,gb89ab40317+3fc8cb0b9e,gc0af124501+57ccba3ad1,gcf25f946ba+60e38ee5ff,gd6cbbdb0b4+1cc2750d2e,gd794735e4e+7be992507c,gdb1c4ca869+be65c9c1d7,gde0f65d7ad+c7f52e58fe,ge278dab8ac+6b863515ed,ge410e46f29+3fc8cb0b9e,gf35d7ec915+97dd712d81,gf5e32f922b+8c5ae1fdc5,gf618743f1b+747388abfa,gf67bdafdda+3fc8cb0b9e,w.2025.18
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
30from .callStack import getStackFrame
31from .config import Field, _typeStr
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`, 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.
62
63 See Also
64 --------
65 ChoiceField
66 ConfigChoiceField
67 ConfigDictField
68 ConfigField
69 ConfigurableField
70 DictField
71 Field
72 ListField
73 RegistryField
74 """
75
76 supportedTypes = {int, float}
77 """The set of data types allowed by `RangeField` instances (`set`
78 containing `int` and `float` types).
79 """
80
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:
94 raise ValueError(f"Unsupported RangeField dtype {_typeStr(dtype)}")
95 source = getStackFrame()
96 if min is None and max is None:
97 raise ValueError("min and max cannot both be None")
98
99 if min is not None and max is not None:
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")
104
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 """
109
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 """
114
115 if inclusiveMax:
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
119 if inclusiveMin:
120 self.minCheck = lambda x, y: True if y is None else x >= y
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 """
140
141 self.__doc__ += "\n\nValid Range = " + self.rangeString
142
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)
_setup(self, doc, dtype, default, check, optional, source, deprecated)
Definition config.py:486
__init__(self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None)
Definition rangeField.py:92