Coverage for python/lsst/pex/config/rangeField.py: 48%

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

32 statements  

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 .config import Field, _typeStr 

31from .callStack import getStackFrame 

32 

33 

34class RangeField(Field): 

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.supportedTypes: 86 ↛ 87line 86 didn't jump to line 87, because the condition on line 86 was never true

87 raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype))) 

88 source = getStackFrame() 

89 if min is None and max is None: 89 ↛ 90line 89 didn't jump to line 90, because the condition on line 89 was never true

90 raise ValueError("min and max cannot both be None") 

91 

92 if min is not None and max is not None: 92 ↛ 93line 92 didn't jump to line 93, because the condition on line 92 was never true

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.min = 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.max = 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: 108 ↛ 109line 108 didn't jump to line 109, because the condition on line 108 was never true

109 self.maxCheck = lambda x, y: True if y is None else x <= y 

110 else: 

111 self.maxCheck = lambda x, y: True if y is None else x < y 111 ↛ exitline 111 didn't run the lambda on line 111

112 if inclusiveMin: 112 ↛ 115line 112 didn't jump to line 115, because the condition on line 112 was never false

113 self.minCheck = lambda x, y: True if y is None else x >= y 113 ↛ exitline 113 didn't run the lambda on line 113

114 else: 

115 self.minCheck = lambda x, y: True if y is None else x > y 

116 self._setup(doc, dtype=dtype, default=default, check=None, optional=optional, source=source, 

117 deprecated=deprecated) 

118 self.rangeString = "%s%s,%s%s" % \ 

119 (("[" if inclusiveMin else "("), 

120 ("-inf" if self.min is None else self.min), 

121 ("inf" if self.max is None else self.max), 

122 ("]" if inclusiveMax else ")")) 

123 """String representation of the field's allowed range (`str`). 

124 """ 

125 

126 self.__doc__ += "\n\nValid Range = " + self.rangeString 

127 

128 def _validateValue(self, value): 

129 Field._validateValue(self, value) 

130 if not self.minCheck(value, self.min) or \ 

131 not self.maxCheck(value, self.max): 

132 msg = "%s is outside of valid range %s" % (value, self.rangeString) 

133 raise ValueError(msg)