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

# 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 software is dual licensed under the GNU General Public License and also 

# under a 3-clause BSD license. Recipients may choose which of these licenses 

# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

# respectively. If you choose the GPL option then the following text applies 

# (but note that there is still no warranty even if you opt for BSD instead): 

# 

# 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__ = ["ChoiceField"] 

 

from .config import Field, _typeStr 

from .callStack import getStackFrame 

 

 

class ChoiceField(Field): 

"""A configuration field (`~lsst.pex.config.Field` subclass) that allows a 

user to select from a predefined set of values. 

 

Use ``ChoiceField`` when a configuration can only take one of a predefined 

set of values. Each choice must be of the same type. 

 

Parameters 

---------- 

doc : `str` 

Documentation string that describes the configuration field. 

dtype : class 

The type of the field's choices. For example, `str` or `int`. 

allowed : `dict` 

The allowed values. Keys are the allowed choices (of ``dtype``-type). 

Values are descriptions (`str`-type) of each choice. 

default : ``dtype``-type, optional 

The default value, which is of type ``dtype`` and one of the allowed 

choices. 

optional : `bool`, optional 

If `True`, this configuration field is *optional*. Default is `True`. 

 

See also 

-------- 

ConfigChoiceField 

ConfigDictField 

ConfigField 

ConfigurableField 

DictField 

Field 

ListField 

RangeField 

RegistryField 

""" 

def __init__(self, doc, dtype, allowed, default=None, optional=True): 

self.allowed = dict(allowed) 

70 ↛ 73line 70 didn't jump to line 73, because the condition on line 70 was never false if optional and None not in self.allowed: 

self.allowed[None] = "Field is optional" 

 

73 ↛ 74line 73 didn't jump to line 74, because the condition on line 73 was never true if len(self.allowed) == 0: 

raise ValueError("ChoiceFields must allow at least one choice") 

 

Field.__init__(self, doc=doc, dtype=dtype, default=default, 

check=None, optional=optional) 

 

self.__doc__ += "\n\nAllowed values:\n\n" 

for choice, choiceDoc in self.allowed.items(): 

81 ↛ 82line 81 didn't jump to line 82, because the condition on line 81 was never true if choice is not None and not isinstance(choice, dtype): 

raise ValueError("ChoiceField's allowed choice %s is of incorrect type %s. Expected %s" % 

(choice, _typeStr(choice), _typeStr(dtype))) 

self.__doc__ += "%s\n %s\n" % ('``{0!r}``'.format(str(choice)), choiceDoc) 

 

self.source = getStackFrame() 

 

def _validateValue(self, value): 

Field._validateValue(self, value) 

if value not in self.allowed: 

msg = "Value {} is not allowed.\n" \ 

"\tAllowed values: [{}]".format(value, ", ".join(str(key) for key in self.allowed)) 

raise ValueError(msg)