argparse.Action Class Reference

Inheritance diagram for argparse.Action:

Public Member Functions
def	__call__
def	__call__
def	__init__
def	__init__
Public Member Functions inherited from argparse._AttributeHolder
def	__repr__
def	__repr__

Public Attributes
	choices
	const
	default
	dest
	help
	metavar
	nargs
	option_strings
	required
	type

Private Member Functions
def	_get_kwargs
def	_get_kwargs

Detailed Description

Information about how to convert command line strings to Python objects.

Action objects are used by an ArgumentParser to represent the information
needed to parse a single argument from one or more strings from the
command line. The keyword arguments to the Action constructor are also
all attributes of Action instances.

Keyword Arguments:

    - option_strings -- A list of command-line option strings which
        should be associated with this action.

    - dest -- The name of the attribute to hold the created object(s)

    - nargs -- The number of command-line arguments that should be
        consumed. By default, one argument will be consumed and a single
        value will be produced.  Other values include:
            - N (an integer) consumes N arguments (and produces a list)
            - '?' consumes zero or one arguments
            - '*' consumes zero or more arguments (and produces a list)
            - '+' consumes one or more arguments (and produces a list)
        Note that the difference between the default and nargs=1 is that
        with the default, a single value will be produced, while with
        nargs=1, a list containing a single value will be produced.

    - const -- The value to be produced if the option is specified and the
        option uses an action that takes no values.

    - default -- The value to be produced if the option is not specified.

    - type -- The type which the command-line arguments should be converted
        to, should be one of 'string', 'int', 'float', 'complex' or a
        callable object that accepts a single string argument. If None,
        'string' is assumed.

    - choices -- A container of values that should be allowed. If not None,
        after a command-line argument has been converted to the appropriate
        type, an exception will be raised if it is not a member of this
        collection.

    - required -- True if the action must always be specified at the
        command line. This is only meaningful for optional command-line
        arguments.

    - help -- The help string describing the argument.

    - metavar -- The name to be used for the option's argument with the
        help string. If None, the 'dest' value will be used as the name.

Definition at line 712 of file argparse.py.

Constructor & Destructor Documentation

def argparse.Action.__init__	(		self,
			option_strings,
			dest,
			nargs = None,
			const = None,
			default = None,
			type = None,
			choices = None,
			required = False,
			help = None,
			metavar = None
	)

Definition at line 773 of file argparse.py.

Referenced by argparse.Action.__call__().

                 metavar=None):
        self.option_strings = option_strings
        self.dest = dest
        self.nargs = nargs
        self.const = const
        self.default = default
        self.type = type
        self.choices = choices
        self.required = required
        self.help = help
        self.metavar = metavar