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: usage : string a usage string for your program. Before it is displayed to the user, "%prog" will be expanded to the name of your program (self.prog or os.path.basename(sys.argv[0])). prog : string the name of the current program (to override os.path.basename(sys.argv[0])).

option_groups : [OptionGroup] list of option groups in this parser (option groups are irrelevant for parsing the command-line, but very useful for generating help)

allow_interspersed_args : bool = true if true, positional arguments may be interspersed with options. Assuming -a and -b each take a single argument, the command-line -ablah foo bar -bboo baz will be interpreted the same as -ablah -bboo -- foo bar baz If this flag were false, that command line would be interpreted as -ablah -- foo bar -bboo baz -- ie. we stop processing options as soon as we see the first non-option argument. (This is the tradition followed by Python's getopt module, Perl's Getopt::Std, and other argument- parsing libraries, but it is generally annoying to users.)

process_default_values : bool = true if true, option default values are processed similarly to option values from the command line: that is, they are passed to the type-checking function for the option's type (as long as the default value is a string). (This really only matters if you have defined custom types; see SF bug #955889.) Set it to false to restore the behaviour of Optik 1.4.1 and earlier.

rargs : [string] the argument list currently being parsed. Only set when parse_args() is active, and continually trimmed down as we consume arguments. Mainly there for the benefit of callback options. largs : [string] the list of leftover arguments that we have skipped while parsing options. If allow_interspersed_args is false, this list is always empty. values : Values the set of option values currently being accumulated. Only set when parse_args() is active. Also mainly for callbacks.

Because of the rargs, largs, and values attributes, OptionParser is not thread-safe. If, for some perverse reason, you need to parse command-line arguments simultaneously in different threads, use different OptionParser instances.

__init__ (
        self,
        usage=None,
        option_list=None,
        option_class=Option,
        version=None,
        conflict_handler="error",
        description=None,
        formatter=None,
        add_help_option=True,
        prog=None,
        )

_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 )

_populate_option_list (
        self,
        option_list,
        add_help=True,
        )

_process_args (
        self,
        largs,
        rargs,
        values,
        )

_process_long_opt (
        self,
        rargs,
        values,
        )

_process_short_opts (
        self,
        rargs,
        values,
        )

add_option_group (
        self,
        *args,
        *kwargs,
        )

check_values (
        self,
        values,
        args,
        )

disable_interspersed_args ( self )

enable_interspersed_args ( self )

error ( self,  msg )

exit (
        self,
        status=0,
        msg=None,
        )

expand_prog_name ( self,  s )

format_help ( self,  formatter=None )

format_option_help ( self,  formatter=None )

get_default_values ( self )

get_description ( self )

get_option_group ( self,  opt_str )

get_prog_name ( self )

get_usage ( self )

get_version ( self )

parse_args (
        self,
        args=None,
        values=None,
        )

print_help ( self,  file=None )

print_usage ( self,  file=None )

print_version ( self,  file=None )

set_default (
        self,
        dest,
        value,
        )

set_defaults ( self,  **kwargs )

set_process_default_values ( self,  process )

set_usage ( self,  usage )