Package logilab :: Package common :: Module clcommands :: Class Command
[frames] | no frames]

Class Command

source code

                        object --+            
                                 |            
 configuration.OptionsManagerMixIn --+        
                                     |        
                        object --+   |        
                                 |   |        
configuration.OptionsProviderMixIn --+        
                                     |        
      configuration.ConfigurationMixIn --+    
                                         |    
               configuration.Configuration --+
                                             |
                                            Command

Base class for command line commands.

Instance Methods
 
__init__(self, __doc__=None, version=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
check_args(self, args)
check command's arguments are provided
source code
 
run(self, args)
run the command with its specific arguments
source code

Inherited from configuration.ConfigurationMixIn: __getitem__, __iter__, __setitem__, get, load_defaults, register_options

Inherited from configuration.OptionsManagerMixIn: add_help_section, add_optik_option, add_option_group, cb_set_provider_option, generate_config, generate_manpage, global_set_option, help, input_config, load_command_line_configuration, load_config_file, load_configuration, load_file_configuration, load_provider_defaults, optik_option, read_config_file, register_options_provider, reset_parsers

Inherited from configuration.OptionsProviderMixIn: all_options, get_option_def, input_option, option_default, option_name, option_value, options_and_values, options_by_section, set_option

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

Class Variables
  arguments = ''
  name = ''
  hidden = False
  min_args = None
  max_args = None

Inherited from configuration.OptionsProviderMixIn: level, options, priority

Properties

Inherited from object: __class__

Method Details

__init__(self, __doc__=None, version=None)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)