optparse.OptionContainer

Module optparse :: Class OptionContainer

[show private | hide private]

Class OptionContainer

Known Subclasses:: OptionParser

Abstract base class.

Class attributes:
  standard_option_list : [Option]
    list of standard options that will be accepted by all instances
    of this parser class (intended to be overridden by subclasses).

Instance attributes:
  option_list : [Option]
    the list of Option objects contained by this OptionContainer
  _short_opt : { string : Option }
    dictionary mapping short option strings, eg. "-f" or "-X",
    to the Option instances that implement them.  If an Option
    has multiple short option strings, it will appears in this
    dictionary multiple times. [1]
  _long_opt : { string : Option }
    dictionary mapping long option strings, eg. "--file" or
    "--exclude", to the Option instances that implement them.
    Again, a given Option can occur multiple times in this
    dictionary. [1]
  defaults : { string : any }
    dictionary mapping option destination names to default
    values for each destination [1]

[1] These mappings are common to (shared by) all components of the
    controlling OptionParser, where they are initially created.

Method Summary
	`__init__(self, option_class, conflict_handler, description)`
	`add_option(self, args, *kwargs)` add_option(Option)...
	`add_options(self, option_list)`
	`format_description(self, formatter)`
	`format_help(self, formatter)`
	`format_option_help(self, formatter)`
	`get_option(self, opt_str)`
	`has_option(self, opt_str)`
	`remove_option(self, opt_str)`
	`set_conflict_handler(self, handler)`
	`set_description(self, description)`
	`_check_conflict(self, option)`
	`_create_option_mappings(self)`
	`_share_option_mappings(self, parser)`

Method Details

add_option(self, *args, **kwargs)

add_option(Option)
add_option(opt_str, ..., kwarg=val, ...)

Generated by Epydoc 2.0 on Sun Sep 25 20:49:16 2005

http://epydoc.sf.net