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

# 

# LSST Data Management System 

# Copyright 2008, 2009, 2010 LSST Corporation. 

# 

# This product includes software developed by the 

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

# 

# 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 LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

__all__ = ["ChoiceField"] 

 

from .config import Field, _typeStr 

from .callStack import getStackFrame 

 

 

class ChoiceField(Field): 

""" 

Defines a Config Field which allows only a set of values 

All allowed must be of the same type. 

Allowed values should be provided as a dict of value, doc string pairs 

 

""" 

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

self.allowed = dict(allowed) 

if optional and None not in self.allowed: 

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

 

40 ↛ 41line 40 didn't jump to line 41, because the condition on line 40 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(): 

48 ↛ 49line 48 didn't jump to line 49, because the condition on line 48 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) 

57 ↛ 58line 57 didn't jump to line 58, because the condition on line 57 was never true 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)