Package svnmailer :: Module cli :: Class SvnmailerOptionParser
[show private | hide private]
[frames | no frames]

Class SvnmailerOptionParser

OptionContainer --+    
                  |    
       OptionParser --+
                      |
                     SvnmailerOptionParser


Fully initialized option parser
Method Summary
  __init__(self, *args, **kwargs)
Initialization
  _addSvnmailerBehaviourOptions(self)
Adds the behaviour options group
  _addSvnmailerCommonOptions(self)
Adds the common options group
  _addSvnmailerSupplementalOptions(self)
Adds the supplemental options
int _getTerminalWidth(self)
Returns terminal width if determined, None otherwise
  _initSvnmailer(self)
Builds the options from option groups
list _transformSvnmailerOldStyle(self, argv)
Parses the command line according to old style rules
  error(self, msg)
We raise an exception instead of exiting
  format_help(self, formatter)
Adds a description of the old style options
  get_prog_name(self)
Returns the program name
  get_version(self)
Returns the version string
  parse_args(self, args, *other_args, **kwargs)
Accepts also the old command line
    Inherited from OptionParser
  add_option_group(self, *args, **kwargs)
  check_values(self, values, args)
check_values(values : Values, args : [string]) -> (values : Values, args : [string]) Check that the supplied option values and leftover arguments are valid.
  disable_interspersed_args(self)
  enable_interspersed_args(self)
  exit(self, status, msg)
  expand_prog_name(self, s)
  format_option_help(self, formatter)
  get_default_values(self)
  get_description(self)
  get_option_group(self, opt_str)
  get_usage(self)
  print_help(self, file)
print_help(file : file = stdout) Print an extended help message, listing all options and any help text provided with them, to 'file' (default stdout).
  print_usage(self, file)
print_usage(file : file = stdout) Print the usage message for the current program (self.usage) to 'file' (default stdout).
  print_version(self, file)
print_version(file : file = stdout) Print the version message for this program (self.version) to 'file' (default stdout).
  set_default(self, dest, value)
  set_defaults(self, **kwargs)
  set_process_default_values(self, process)
  set_usage(self, usage)
  _add_help_option(self)
  _add_version_option(self)
  _create_option_list(self)
  _get_all_options(self)
  _get_args(self, args)
  _init_parsing_state(self)
  _match_long_opt(self, opt)
_match_long_opt(opt : string) -> string Determine which long option string 'opt' matches, ie.
  _populate_option_list(self, option_list, add_help)
  _process_args(self, largs, rargs, values)
_process_args(largs : [string], rargs : [string], values : Values) Process command-line arguments and populate 'values', consuming options and arguments from 'rargs'.
  _process_long_opt(self, rargs, values)
  _process_short_opts(self, rargs, values)
    Inherited from OptionContainer
  add_option(self, *args, **kwargs)
add_option(Option)...
  add_options(self, option_list)
  format_description(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)

Instance Variable Summary
tuple _svn: The svn version

Class Variable Summary
    Inherited from OptionParser
list standard_option_list = []

Method Details

__init__(self, *args, **kwargs)
(Constructor)

Initialization
Overrides:
optparse.OptionParser.__init__

_addSvnmailerBehaviourOptions(self)

Adds the behaviour options group

_addSvnmailerCommonOptions(self)

Adds the common options group

_addSvnmailerSupplementalOptions(self)

Adds the supplemental options

_getTerminalWidth(self)

Returns terminal width if determined, None otherwise
Returns:
The width
           (type=int)

_initSvnmailer(self)

Builds the options from option groups

_transformSvnmailerOldStyle(self, argv)

Parses the command line according to old style rules
Parameters:
argv - Command line list. If argv is None, sys.argv[1:] is evaluated instead
           (type=list)
Returns:
The commandline, possibly transformed to new style
           (type=list)

error(self, msg)

We raise an exception instead of exiting
Parameters:
msg - The error message
           (type=str)
Raises:
CommandlineError - command line error
Overrides:
optparse.OptionParser.error

format_help(self, formatter=None)

Adds a description of the old style options
Overrides:
optparse.OptionParser.format_help

get_prog_name(self)

Returns the program name
Overrides:
optparse.OptionParser.get_prog_name

get_version(self)

Returns the version string
Overrides:
optparse.OptionParser.get_version

parse_args(self, args=None, *other_args, **kwargs)

Accepts also the old command line
Overrides:
optparse.OptionParser.parse_args

Instance Variable Details

_svn

The svn version
Type:
tuple

Generated by Epydoc 2.1 on Mon Apr 17 12:39:11 2006 http://epydoc.sf.net