1. parser generates
import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
2. Add parameter settings
parser.add_argument('integers', metavar='N', type=int, nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate',
action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')
3. analytical parameters
args = parser.parse_args()
# args is the populated namespace.
print(args.accumulate(args.integers))
Note: Reference official website
- action 可取'store'(默认), 'store_const' , 'store_true' and 'store_false', 'append', 'append_const', 'count', 'help', 'version'
- nargs 可取N (an integer), '?', '+', '*', argparse.REMAINDER
- type specifies the type of the corresponding parameter values
- choices to choose from a range of designated
- required to specify whether you must provide
- metavar parameters for tips
- dest specifies the parameters corresponding to the namespace key
which is:
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
Define how a single command-line argument should be parsed. Each parameter has its own more detailed description below, but in short they are:
name or flags - Either a name or a list of option strings, e.g. foo or -f, --foo.
action - The basic type of action to be taken when this argument is encountered at the command line.
nargs - The number of command-line arguments that should be consumed.
const - A constant value required by some action and nargs selections.
default - The value produced if the argument is absent from the command line.
type - The type to which the command-line argument should be converted.
choices - A container of the allowable values for the argument.
required - Whether or not the command-line option may be omitted (optionals only).
help - A brief description of what the argument does.
metavar - A name for the argument in usage messages.
dest - The name of the attribute to be added to the object returned by parse_args().