Hide keyboard shortcuts

Hot-keys 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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

# This file is part of pex_config. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

__all__ = ["RangeField"] 

 

from .config import Field, _typeStr 

from .callStack import getStackFrame 

 

 

class RangeField(Field): 

"""A configuration field (`lsst.pex.config.Field` subclass) that requires 

the value to be in a specific numeric range. 

 

Parameters 

---------- 

doc : `str` 

A description of the field. 

dtype : {`int`-type, `float`-type} 

The field's data type: either the `int` or `float` type. 

default : `int` or `float`, optional 

Default value for the field. 

optional : `bool`, optional 

When `False`, `lsst.pex.config.Config.validate` will fail if the 

field's value is `None`. 

min : int, float, or `None`, optional 

Minimum value accepted in the range. If `None`, the range has no 

lower bound (equivalent to negative infinity). 

max : `int`, `float`, or None, optional 

Maximum value accepted in the range. If `None`, the range has no 

upper bound (equivalent to positive infinity). 

inclusiveMin : `bool`, optional 

If `True` (default), the ``min`` value is included in the allowed 

range. 

inclusiveMax : `bool`, optional 

If `True` (default), the ``max`` value is included in the allowed 

range. 

deprecated : None or `str`, optional 

A description of why this Field is deprecated, including removal date. 

If not None, the string is appended to the docstring for this Field. 

 

See also 

-------- 

ChoiceField 

ConfigChoiceField 

ConfigDictField 

ConfigField 

ConfigurableField 

DictField 

Field 

ListField 

RegistryField 

""" 

 

supportedTypes = set((int, float)) 

"""The set of data types allowed by `RangeField` instances (`set` 

containing `int` and `float` types). 

""" 

 

def __init__(self, doc, dtype, default=None, optional=False, 

min=None, max=None, inclusiveMin=True, inclusiveMax=False, 

deprecated=None): 

80 ↛ 81line 80 didn't jump to line 81, because the condition on line 80 was never true if dtype not in self.supportedTypes: 

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

source = getStackFrame() 

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

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

 

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

if min > max: 

raise ValueError("min = %s > %s = max" % (min, max)) 

elif min == max and not (inclusiveMin and inclusiveMax): 

raise ValueError("min = max = %s and min and max not both inclusive" % (min,)) 

 

self.min = min 

"""Minimum value accepted in the range. If `None`, the range has no 

lower bound (equivalent to negative infinity). 

""" 

 

self.max = max 

"""Maximum value accepted in the range. If `None`, the range has no 

upper bound (equivalent to positive infinity). 

""" 

 

102 ↛ 103line 102 didn't jump to line 103, because the condition on line 102 was never true if inclusiveMax: 

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

else: 

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

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

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

else: 

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

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

deprecated=deprecated) 

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

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

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

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

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

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

""" 

 

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

 

def _validateValue(self, value): 

Field._validateValue(self, value) 

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

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

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

raise ValueError(msg)