Package trac :: Module config :: Class ListOption

Class ListOption

object --+    
         |    
    Option --+
             |
            ListOption

Known Subclasses:

OrderedExtensionsOption

Descriptor for configuration options that contain multiple values separated by a specific character.

Instance Methods

__init__(self, section, name, default=None, sep=',', keep_empty=False, doc='')
Create the configuration option. source code

accessor(self, section, name, default)
Return the value of the specified option.

source code

Inherited from Option: __get__, __repr__, __set__

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, default=None, sep=`','`, keep_empty=False, doc=`''`)
(Constructor)

source code

Create the configuration option.

@param section: the name of the configuration section this option: belongs to

@param name: the name of the option @param default: the default value for the option @param doc: documentation of the option

Overrides: object.__init__: (inherited documentation)

accessor(self, section, name, default)

source code

Return the value of the specified option.

Valid default input is a string. Returns a string.

Overrides: Section.get: (inherited documentation)

Class ListOption

__init__(self, section, name, default=None, sep=',', keep_empty=False, doc='') (Constructor)

accessor(self, section, name, default)

init(self, section, name, default=None, sep=`','`, keep_empty=False, doc=`''`)
(Constructor)