Package trac :: Module config :: Class ChoiceOption

Class ChoiceOption

source code

object --+    
         |    
    Option --+
             |
            ChoiceOption

Descriptor for configuration options providing a choice among a list of items.

The default value is the first choice in the list.

Instance Methods
 
__init__(self, section, name, choices, doc='', doc_domain='tracini')
Create the configuration option.
source code
 
accessor(self, section, name, default) source code

Inherited from Option: __get__, __repr__, __set__, dumps

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

Static Methods

Inherited from Option: get_registry

Class Variables

Inherited from Option: registry

Properties

Inherited from object: __class__

Method Details

__init__(self, section, name, choices, doc='', doc_domain='tracini')
(Constructor)

source code 
Create the configuration option.
Parameters:
  • section - the name of the configuration section this option belongs to
  • name - the name of the option
  • default - the default value for the option
  • doc - documentation of the option
Overrides: object.__init__
(inherited documentation)

accessor(self, section, name, default)

source code 
Overrides: Option.accessor