Package logilab :: Package common :: Module configuration :: Class OptionsProviderMixIn
[frames] | no frames]

Class OptionsProviderMixIn

source code

object --+
         |
        OptionsProviderMixIn
Known Subclasses:

Mixin to provide options to an OptionsManager

Instance Methods
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
all_options(self)
return an iterator on available options for this provider...
source code
 
get_option_def(self, opt_name)
return the dictionary defining an option given it's name
source code
 
input_option(self, option, optdict, inputlevel=99) source code
 
load_defaults(self)
initialize the provider using default values
source code
 
option_default(self, opt_name, opt_dict=None)
return the default value for an option
source code
 
option_name(self, opt_name, opt_dict=None)
get the config attribute corresponding to opt_name...
source code
 
option_value(self, opt_name)
get the current value for the given option
source code
 
options_by_section(self)
return an iterator on options grouped by section
source code
 
set_option(self, opt_name, value, action=None, opt_dict=None)
method called to set an option (registered in the options list)...
source code

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

Class Variables
  name = 'default'
  options = ()
  priority = -1
Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

all_options(self)

source code 
return an iterator on available options for this provider
option are actually described by a 3-uple:
(section, option name, option dictionary)

option_name(self, opt_name, opt_dict=None)

source code 
get the config attribute corresponding to opt_name
        

options_by_section(self)

source code 
return an iterator on options grouped by section

(section, [list of (optname, optdict, optvalue)])

set_option(self, opt_name, value, action=None, opt_dict=None)

source code 
method called to set an option (registered in the options list)