Module optparse

optparse - a powerful, extensible, and easy-to-use option parser.

By Greg Ward <gward@python.net>

Originally distributed as Optik; see http://optik.sourceforge.net/ .

If you have problems with this module, please do not file bugs,
patches, or feature requests with Python; instead, use Optik's
SourceForge project page:
  http://sourceforge.net/projects/optik

For support, use the optik-users@lists.sourceforge.net mailing list
(http://lists.sourceforge.net/lists/listinfo/optik-users).

Version: 1.5.3

Copyright: Copyright (c) 2001-2006 Gregory P. Ward. All rights reserved. Copyright (c) 2002-2006 Python Software Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Classes

[hide private]

OptParseError

OptionError
Raised if an Option instance is created with invalid or inconsistent arguments.

OptionConflictError
Raised if conflicting options are added to an OptionParser.

OptionValueError
Raised if an invalid option value is encountered on the command line.

BadOptionError
Raised if an invalid option is seen on the command line.

AmbiguousOptionError
Raised if an ambiguous option is seen on the command line.

HelpFormatter
Abstract base class for formatting option help.

IndentedHelpFormatter
Format help with indented section bodies.

TitledHelpFormatter
Format help with underlined section headers.

Option
Instance attributes: _short_opts : [string] _long_opts : [string]

Values

OptionContainer
Abstract base class.

OptionGroup

OptionParser
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).

make_option
Instance attributes: _short_opts : [string] _long_opts : [string]

Functions

[hide private]

_repr(self)

_parse_num(val, type)

_parse_int(val)

_parse_long(val)

check_builtin(option, opt, value)

check_choice(option, opt, value)

isbasestring(x)

_match_abbrev(s, wordmap)
_match_abbrev(s : string, wordmap : {string : Option}) -> string

Variables

[hide private]

_builtin_cvt = {'complex': (<type 'complex'>, 'complex'), 'flo...

NO_DEFAULT = ('NO', 'DEFAULT')

SUPPRESS_HELP = 'SUPPRESSHELP'

SUPPRESS_USAGE = 'SUPPRESSUSAGE'

Imports: sys, os, types, textwrap, gettext, _

Function Details

[hide private]

_match_abbrev(s, wordmap)

_match_abbrev(s : string, wordmap : {string : Option}) -> string

Return the string key in 'wordmap' for which 's' is an unambiguous abbreviation. If 's' is found to be ambiguous or doesn't match any of 'words', raise BadOptionError.

Variables Details

[hide private]

_builtin_cvt

Value:

{'complex': (<type 'complex'>, 'complex'),
 'float': (<type 'float'>, 'floating-point'),
 'int': (<function _parse_int at 0x404c209c>, 'integer'),
 'long': (<function _parse_long at 0x404c20d4>, 'long integer')}