argparse.ArgumentDefaultsHelpFormatter Class Reference

Inheritance diagram for argparse.ArgumentDefaultsHelpFormatter:

Private Member Functions
def	_get_help_string (self, action)

Additional Inherited Members
Public Member Functions inherited from argparse.HelpFormatter
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

Help message formatter which adds default values to argument help.

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 666 of file argparse.py.

Member Function Documentation

def argparse.ArgumentDefaultsHelpFormatter._get_help_string (   self,   action  )

private

Definition at line 673 of file argparse.py.

    def _get_help_string(self, action):
        help = action.help
        if '%(default)' not in action.help:
            if action.default is not SUPPRESS:
                defaulting_nargs = [OPTIONAL, ZERO_OR_MORE]
                if action.option_strings or action.nargs in defaulting_nargs:
                    help += ' (default: %(default)s)'
        return help


# =====================
# Options and Arguments
# =====================