Classes | Public Member Functions | List of all members
basis.argparse.HelpFormatter Class Reference
+ Inheritance diagram for basis.argparse.HelpFormatter:
+ Collaboration diagram for basis.argparse.HelpFormatter:

Classes

class  _Section
 

Public Member Functions

def __init__ (self, prog, indent_increment=2, max_help_position=24, width=None)
 
def add_argument (self, action)
 
def add_arguments (self, actions)
 
def add_text (self, text)
 
def add_usage (self, usage, actions, groups, prefix=None)
 
def end_section (self)
 
def format_help (self)
 
def start_section (self, heading)
 

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.

Definition at line 174 of file argparse.py.

Constructor & Destructor Documentation

§ __init__()

def basis.argparse.HelpFormatter.__init__ (   self,
  prog,
  indent_increment = 2,
  max_help_position = 24,
  width = None 
)

Definition at line 185 of file argparse.py.

Member Function Documentation

§ add_argument()

def basis.argparse.HelpFormatter.add_argument (   self,
  action 
)

Definition at line 280 of file argparse.py.

§ add_arguments()

def basis.argparse.HelpFormatter.add_arguments (   self,
  actions 
)

Definition at line 298 of file argparse.py.

§ add_text()

def basis.argparse.HelpFormatter.add_text (   self,
  text 
)

Definition at line 271 of file argparse.py.

§ add_usage()

def basis.argparse.HelpFormatter.add_usage (   self,
  usage,
  actions,
  groups,
  prefix = None 
)

Definition at line 275 of file argparse.py.

§ end_section()

def basis.argparse.HelpFormatter.end_section (   self)

Definition at line 267 of file argparse.py.

§ format_help()

def basis.argparse.HelpFormatter.format_help (   self)

Definition at line 305 of file argparse.py.

§ start_section()

def basis.argparse.HelpFormatter.start_section (   self,
  heading 
)

Definition at line 261 of file argparse.py.


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