pip.baseparser.PrettyHelpFormatter Class Reference

Inheritance diagram for pip.baseparser.PrettyHelpFormatter:

Public Member Functions
def	__init__
def	format_option_strings
def	format_heading
def	format_usage
def	format_description
def	format_epilog
def	indent_lines

Private Member Functions
def	_format_option_strings

Detailed Description

A prettier/less verbose help formatter for optparse.

Constructor & Destructor Documentation

def pip.baseparser.PrettyHelpFormatter.__init__	(		self,
			args,
			kwargs
	)

Member Function Documentation

def pip.baseparser.PrettyHelpFormatter._format_option_strings (   self,   option,   mvarfmt = ' <%s>',   optsep = '  )

private

Return a comma-separated list of option strings and metavars.

:param option:  tuple of (short opt, long opt), e.g: ('-f', '--format')
:param mvarfmt: metavar format string - evaluated as mvarfmt % metavar
:param optsep:  separator

def pip.baseparser.PrettyHelpFormatter.format_description	(		self,
			description
	)

def pip.baseparser.PrettyHelpFormatter.format_epilog	(		self,
			epilog
	)

def pip.baseparser.PrettyHelpFormatter.format_heading	(		self,
			heading
	)

def pip.baseparser.PrettyHelpFormatter.format_option_strings	(		self,
			option
	)

def pip.baseparser.PrettyHelpFormatter.format_usage	(		self,
			usage
	)

Ensure there is only one newline between usage and the first heading
if there is no description.

def pip.baseparser.PrettyHelpFormatter.indent_lines	(		self,
			text,
			indent
	)

---

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

• orbits/lib/python2.7/site-packages/pip/baseparser.py