argparse.HelpFormatter

class documentation

class HelpFormatter(object): (source)

Known subclasses: argparse.ArgumentDefaultsHelpFormatter, argparse.MetavarTypeHelpFormatter, argparse.RawDescriptionHelpFormatter

Constructor: HelpFormatter(prog, indent_increment, max_help_position, width)

View In Hierarchy

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.

Method __init__ Undocumented
Method add_argument Undocumented
Method add_arguments Undocumented
Method add_text Undocumented
Method add_usage Undocumented
Method end_section Undocumented
Method format_help Undocumented
Method start_section Undocumented
Class _Section Undocumented
Method _add_item Undocumented
Method _dedent Undocumented
Method _expand_help Undocumented
Method _fill_text Undocumented
Method _format_action Undocumented
Method _format_action_invocation Undocumented
Method _format_actions_usage Undocumented
Method _format_args Undocumented
Method _format_text Undocumented
Method _format_usage Undocumented
Method _get_default_metavar_for_optional Undocumented
Method _get_default_metavar_for_positional Undocumented
Method _get_help_string Undocumented
Method _indent Undocumented
Method _iter_indented_subactions Undocumented
Method _join_parts Undocumented
Method _metavar_formatter Undocumented
Method _split_lines Undocumented
Instance Variable _action_max_length Undocumented
Instance Variable _current_indent Undocumented
Instance Variable _current_section Undocumented
Instance Variable _indent_increment Undocumented
Instance Variable _level Undocumented
Instance Variable _long_break_matcher Undocumented
Instance Variable _max_help_position Undocumented
Instance Variable _prog Undocumented
Instance Variable _root_section Undocumented
Instance Variable _whitespace_matcher Undocumented
Instance Variable _width Undocumented
def __init__(self, prog, indent_increment=2, max_help_position=24, width=None): (source)

Undocumented

def add_argument(self, action): (source)

Undocumented

def add_arguments(self, actions): (source)

Undocumented

def add_text(self, text): (source)

Undocumented

def add_usage(self, usage, actions, groups, prefix=None): (source)

Undocumented

def end_section(self): (source)

Undocumented

def format_help(self): (source)

Undocumented

def start_section(self, heading): (source)

Undocumented

def _add_item(self, func, args): (source)

Undocumented

def _dedent(self): (source)

Undocumented

def _expand_help(self, action): (source)

Undocumented

def _fill_text(self, text, width, indent): (source)
overridden in argparse.RawDescriptionHelpFormatter

Undocumented

def _format_action(self, action): (source)

Undocumented

def _format_action_invocation(self, action): (source)

Undocumented

def _format_actions_usage(self, actions, groups): (source)

Undocumented

def _format_args(self, action, default_metavar): (source)

Undocumented

def _format_text(self, text): (source)

Undocumented

def _format_usage(self, usage, actions, groups, prefix): (source)

Undocumented

def _get_default_metavar_for_optional(self, action): (source)
overridden in argparse.MetavarTypeHelpFormatter

Undocumented

def _get_default_metavar_for_positional(self, action): (source)
overridden in argparse.MetavarTypeHelpFormatter

Undocumented

def _get_help_string(self, action): (source)
overridden in argparse.ArgumentDefaultsHelpFormatter

Undocumented

def _indent(self): (source)

Undocumented

def _iter_indented_subactions(self, action): (source)

Undocumented

def _join_parts(self, part_strings): (source)

Undocumented

def _metavar_formatter(self, action, default_metavar): (source)

Undocumented

def _split_lines(self, text, width): (source)
overridden in argparse.RawTextHelpFormatter

Undocumented

_action_max_length = (source)

Undocumented

_current_indent: int = (source)

Undocumented

_current_section = (source)

Undocumented

_indent_increment = (source)

Undocumented

_level: int = (source)

Undocumented

_long_break_matcher = (source)

Undocumented

_max_help_position = (source)

Undocumented

_prog = (source)

Undocumented

_root_section = (source)

Undocumented

_whitespace_matcher = (source)

Undocumented

_width = (source)

Undocumented