Package gavo :: Package utils :: Module fancyconfig :: Class EnumeratedConfigItem
[frames] | no frames]

Class EnumeratedConfigItem

source code

  object --+        
           |        
  ConfigItem --+    
               |    
StringConfigItem --+
                   |
                  EnumeratedConfigItem

A ConfigItem taking string values out of a set of possible strings.

Use the keyword argument options to pass in the possible strings. The first item becomes the default unless you give a default. You must give a non-empty list of strings as options.

Instance Methods
 
__init__(self, name, default=None, description='Undocumented', options=[])
x.__init__(...) initializes x; see help(type(x)) for signature
source code

Inherited from ConfigItem: getAsString, set

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  typedesc = 'value from a defined set'

Inherited from StringConfigItem: default

Properties

Inherited from object: __class__

Method Details

__init__(self, name, default=None, description='Undocumented', options=[])
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)