Class ListOption

source code

An option containing a list of strings.

Instance Methods

[hide private]

__init__(self, default=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

parse(self, s)
Converts a string from the config file to a workable list

source code

tostring(self, value)
Convert the Option's native value to a string value.

source code

Inherited from Option: __get__, __set__, clone, setup

Inherited from Option (private): _setattrname

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

Class Variables

[hide private]

Inherited from Option: __slotnames__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, default=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

parse(self, s)

source code

Converts a string from the config file to a workable list

Commas and spaces are used as separators for the list

Parameters:

s - Raw string value to parse.

Returns:

Validated native value.

Will raise ValueError if there was a problem parsing the string. Subclasses should override this.

Overrides: Option.parse

tostring(self, value)

source code

Convert the Option's native value to a string value.

Parameters:

value - Native option value.

Returns:

String representation of input.

This does the opposite of the parse() method above. Subclasses should override this.

Overrides: Option.tostring

(inherited documentation)

Class ListOption

__init__(self, default=None) (Constructor)

parse(self, s)

tostring(self, value)

init(self, default=None)
(Constructor)