pip._internal.cli.parser.PrettyHelpFormatter Class Reference

Inheritance diagram for pip._internal.cli.parser.PrettyHelpFormatter:

Collaboration diagram for pip._internal.cli.parser.PrettyHelpFormatter:

Public Member Functions
None	__init__ (self, *Any args, **Any kwargs)
str	format_option_strings (self, optparse.Option option)
str	format_heading (self, str heading)
str	format_usage (self, str usage)
str	format_description (self, str description)
str	format_epilog (self, str epilog)
str	indent_lines (self, str text, str indent)

Public Attributes
	parser

Protected Member Functions
str	_format_option_strings (self, optparse.Option option, str mvarfmt=" <{}>", str optsep=", ")

Detailed Description

A prettier/less verbose help formatter for optparse.

Member Function Documentation

_format_option_strings()

str pip._internal.cli.parser.PrettyHelpFormatter._format_option_strings (   self, optparse.Option  option, str   mvarfmt = " <{}>", str   optsep = ", "  )

protected

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
:param optsep:  separator

format_usage()

str pip._internal.cli.parser.PrettyHelpFormatter.format_usage	(		self,
		str	usage
	)

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

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/cli/parser.py