Back to index

python3.2  3.2.2
Public Member Functions | Public Attributes | Private Member Functions
argparse.Action Class Reference
Inheritance diagram for argparse.Action:
Inheritance graph
Collaboration diagram for argparse.Action:
Collaboration graph

List of all members.

Public Member Functions

def __init__
def __call__
def __repr__

Public Attributes

_PyObject_HEAD_EXTRA Py_ssize_t ob_refcnt
struct _typeobjectob_type

Private Member Functions

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

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

    - 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

Constructor & Destructor Documentation

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

Reimplemented in argparse._AppendAction, and argparse._StoreAction.

Definition at line 773 of file

00774                  metavar=None):
00775         self.option_strings = option_strings
00776         self.dest = dest
00777         self.nargs = nargs
00778         self.const = const
00779         self.default = default
00780         self.type = type
00781         self.choices = choices
00782         self.required = required
00783 = help
00784         self.metavar = metavar

Here is the caller graph for this function:

Member Function Documentation

def argparse.Action.__call__ (   self,
  option_string = None 
def argparse._AttributeHolder.__repr__ (   self) [inherited]

Definition at line 121 of file

00122     def __repr__(self):
00123         type_name = type(self).__name__
00124         arg_strings = []
00125         for arg in self._get_args():
00126             arg_strings.append(repr(arg))
00127         for name, value in self._get_kwargs():
00128             arg_strings.append('%s=%r' % (name, value))
00129         return '%s(%s)' % (type_name, ', '.join(arg_strings))

Here is the call graph for this function:

def argparse.Action._get_kwargs (   self) [private]

Reimplemented from argparse._AttributeHolder.

Definition at line 785 of file

00786     def _get_kwargs(self):
00787         names = [
00788             'option_strings',
00789             'dest',
00790             'nargs',
00791             'const',
00792             'default',
00793             'type',
00794             'choices',
00795             'help',
00796             'metavar',
00797         ]
00798         return [(name, getattr(self, name)) for name in names]

Here is the call graph for this function:

Member Data Documentation

Definition at line 780 of file

Definition at line 777 of file

Definition at line 778 of file

Definition at line 782 of file

Definition at line 783 of file

Definition at line 776 of file

Definition at line 107 of file object.h.

struct _typeobject* _object::ob_type [inherited]

Definition at line 108 of file object.h.

Definition at line 774 of file

Definition at line 781 of file

Definition at line 779 of file

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