BigBrotherBot v1.9.0
System Development Information for the BigBrotherBot project.

b3::lib::argparse::HelpFormatter Class Reference

Inheritance diagram for b3::lib::argparse::HelpFormatter:
b3::lib::argparse::ArgumentDefaultsHelpFormatter b3::lib::argparse::RawDescriptionHelpFormatter b3::lib::argparse::RawTextHelpFormatter

List of all members.

Classes

class  _Section

Public Member Functions

def __init__
def start_section
def end_section
def add_text
def add_usage
def add_argument
def add_arguments
def format_help

Private Member Functions

def _indent
def _dedent
def _add_item
def _join_parts
def _format_usage
def _format_actions_usage
def _format_text
def _format_action
def _format_action_invocation
def _metavar_formatter
def _format_args
def _expand_help
def _iter_indented_subactions
def _split_lines
def _fill_text
def _get_help_string

Private Attributes

 _prog
 _indent_increment
 _max_help_position
 _width
 _current_indent
 _level
 _action_max_length
 _root_section
 _current_section
 _whitespace_matcher
 _long_break_matcher

Detailed Description

Formatter for generating usage messages and argument help strings.

Only the name of this class is considered a public API. All the methods
provided by the class are considered an implementation detail.

Constructor & Destructor Documentation

def b3::lib::argparse::HelpFormatter::__init__ (   self,
  prog,
  indent_increment = 2,
  max_help_position = 24,
  width = None 
)

Member Function Documentation

def b3::lib::argparse::HelpFormatter::_add_item (   self,
  func,
  args 
) [private]
def b3::lib::argparse::HelpFormatter::_dedent (   self) [private]
def b3::lib::argparse::HelpFormatter::_expand_help (   self,
  action 
) [private]
def b3::lib::argparse::HelpFormatter::_fill_text (   self,
  text,
  width,
  indent 
) [private]
def b3::lib::argparse::HelpFormatter::_format_action (   self,
  action 
) [private]
def b3::lib::argparse::HelpFormatter::_format_action_invocation (   self,
  action 
) [private]
def b3::lib::argparse::HelpFormatter::_format_actions_usage (   self,
  actions,
  groups 
) [private]
def b3::lib::argparse::HelpFormatter::_format_args (   self,
  action,
  default_metavar 
) [private]
def b3::lib::argparse::HelpFormatter::_format_text (   self,
  text 
) [private]
def b3::lib::argparse::HelpFormatter::_format_usage (   self,
  usage,
  actions,
  groups,
  prefix 
) [private]
def b3::lib::argparse::HelpFormatter::_get_help_string (   self,
  action 
) [private]
def b3::lib::argparse::HelpFormatter::_indent (   self) [private]
def b3::lib::argparse::HelpFormatter::_iter_indented_subactions (   self,
  action 
) [private]
def b3::lib::argparse::HelpFormatter::_join_parts (   self,
  part_strings 
) [private]
def b3::lib::argparse::HelpFormatter::_metavar_formatter (   self,
  action,
  default_metavar 
) [private]
def b3::lib::argparse::HelpFormatter::_split_lines (   self,
  text,
  width 
) [private]
def b3::lib::argparse::HelpFormatter::add_argument (   self,
  action 
)
def b3::lib::argparse::HelpFormatter::add_arguments (   self,
  actions 
)
def b3::lib::argparse::HelpFormatter::add_text (   self,
  text 
)
def b3::lib::argparse::HelpFormatter::add_usage (   self,
  usage,
  actions,
  groups,
  prefix = None 
)
def b3::lib::argparse::HelpFormatter::end_section (   self)
def b3::lib::argparse::HelpFormatter::format_help (   self)
def b3::lib::argparse::HelpFormatter::start_section (   self,
  heading 
)

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties