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='', doc_domain='tracini', doc_args=None)
Create the configuration option. source code

accessor(self, section, name, default)

source code

dumps(self, value)
Return the value as a string to write to a trac.ini file

source code

normalize(self, value)
Normalize the given value to write to a trac.ini file

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 Option: doc

Inherited from object: __class__

Method Details

init(self, section, name, default=None, sep=`','`, keep_empty=False, doc=`''`, doc_domain=`'tracini'`, doc_args=None)
(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

dumps(self, value)

source code

Return the value as a string to write to a trac.ini file

Overrides: Option.dumps: (inherited documentation)

normalize(self, value)

source code

Normalize the given value to write to a trac.ini file

Overrides: Option.normalize: (inherited documentation)

Class ListOption

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

accessor(self, section, name, default)

dumps(self, value)

normalize(self, value)

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