Inheritance diagram for basis.argparse.Action:
Collaboration diagram for basis.argparse.Action:
Public Member Functions | |
| def | __call__ (self, parser, namespace, values, option_string=None) |
| def | __init__ (self, option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) |
| Public Member Functions inherited from basis.argparse._AttributeHolder | |
| def | __repr__ (self) |
Public Attributes | |
| choices | |
| const | |
| default | |
| dest | |
| help | |
| metavar | |
| nargs | |
| option_strings | |
| required | |
| type | |
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 739 of file argparse.py.
Constructor & Destructor Documentation
§ __init__()
| def basis.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 800 of file argparse.py.
Member Function Documentation
§ __call__()
| def basis.argparse.Action.__call__ | ( | self, | |
| parser, | |||
| namespace, | |||
| values, | |||
option_string = None |
|||
| ) |
Definition at line 826 of file argparse.py.
Member Data Documentation
§ choices
| basis.argparse.Action.choices |
Definition at line 807 of file argparse.py.
§ const
| basis.argparse.Action.const |
Definition at line 804 of file argparse.py.
§ default
| basis.argparse.Action.default |
Definition at line 805 of file argparse.py.
§ dest
| basis.argparse.Action.dest |
Definition at line 802 of file argparse.py.
§ help
| basis.argparse.Action.help |
Definition at line 809 of file argparse.py.
§ metavar
| basis.argparse.Action.metavar |
Definition at line 810 of file argparse.py.
§ nargs
| basis.argparse.Action.nargs |
Definition at line 803 of file argparse.py.
§ option_strings
| basis.argparse.Action.option_strings |
Definition at line 801 of file argparse.py.
§ required
| basis.argparse.Action.required |
Definition at line 808 of file argparse.py.
§ type
| basis.argparse.Action.type |
Definition at line 806 of file argparse.py.
The documentation for this class was generated from the following file: