Logo Search packages:      
Sourcecode: jhbuild version File versions  Download package

jhbuild::cut_n_paste::optparse::HelpFormatter Class Reference

Inheritance diagram for jhbuild::cut_n_paste::optparse::HelpFormatter:

jhbuild::cut_n_paste::optparse::IndentedHelpFormatter jhbuild::cut_n_paste::optparse::TitledHelpFormatter

List of all members.


Detailed Description

Abstract base class for formatting option help.  OptionParser
instances should use one of the HelpFormatter subclasses for
formatting help; by default IndentedHelpFormatter is used.

Instance attributes:
  parser : OptionParser
    the controlling OptionParser instance
  indent_increment : int
    the number of columns to indent per nesting level
  max_help_position : int
    the maximum starting column for option help text
  help_position : int
    the calculated starting column for option help text;
    initially the same as the maximum
  width : int
    total number of columns for output (pass None to constructor for
    this value to be taken from the $COLUMNS environment variable)
  level : int
    current indentation level
  current_indent : int
    current indentation level (in columns)
  help_width : int
    number of columns available for option help text (calculated)
  default_tag : str
    text to replace with each option's default value, "%default"
    by default.  Set to false value to disable default value expansion.
  option_strings : { Option : str }
    maps Option instances to the snippet of help text explaining
    the syntax of that option, e.g. "-h, --help" or
    "-fFILE, --file=FILE"
  _short_opt_fmt : str
    format string controlling how short options with values are
    printed in help text.  Must be either "%s%s" ("-fFILE") or
    "%s %s" ("-f FILE"), because those are the two syntaxes that
    Optik supports.
  _long_opt_fmt : str
    similar but for long options; must be either "%s %s" ("--file FILE")
    or "%s=%s" ("--file=FILE").

Definition at line 149 of file optparse.py.


Public Member Functions

def __init__
def dedent
def expand_default
def format_description
def format_epilog
def format_heading
def format_option
def format_option_strings
def format_usage
def indent
def set_long_opt_delimiter
def set_parser
def set_short_opt_delimiter
def store_option_strings

Public Attributes

 current_indent
 default_tag
 help_position
 help_width
 indent_increment
 level
 max_help_position
 option_strings
 parser
 short_first
 width

Static Public Attributes

string NO_DEFAULT_VALUE = "none"

Private Member Functions

def _format_text

Private Attributes

 _long_opt_fmt
 _short_opt_fmt

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index