Package VMBuilder :: Package plugins :: Class Plugin :: Class Setting

Class Setting

object --+
         |
        Plugin.Setting

Known Subclasses:

Instance Methods

__init__(self, setting_group, name, metavar=None, help=None, extra_args=None, valid_options=None, action=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

get_value(self)
If a value has previously been set, return it.

source code

do_check_value(self, value)
Checks the value's validity.

source code

get_valid_options(self)

source code

set_valid_options(self, valid_options)
Set the list of valid options for this setting.

source code

get_default(self)
Return the default value.

source code

set_default(self, value)
Set a new default value.

source code

set_value_fuzzy(self, value)
Set new value.

source code

set_value(self, value)
Set a new value.

source code

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

Class Variables
	default = `None`

Properties
Inherited from `object`: `__class__`

Method Details

init(self, setting_group, name, metavar=None, help=None, extra_args=None, valid_options=None, action=None, **kwargs)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

get_value(self)

source code

If a value has previously been set, return it. If not, return the default value.

set_value_fuzzy(self, value)

source code

Set new value.

Contrary to set_value, set_value_fuzzy will attempt to turn value into the target type. E.g. turning '10' into 10, "main,universe,multiverse" into ['main', 'universe', 'multiverse']

Class Setting

__init__(self, setting_group, name, metavar=None, help=None, extra_args=None, valid_options=None, action=None, **kwargs) (Constructor)

get_value(self)

set_value_fuzzy(self, value)

init(self, setting_group, name, metavar=None, help=None, extra_args=None, valid_options=None, action=None, **kwargs)
(Constructor)