python之argparse

argparse是python内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse将会从sys.argv中解析出这些参数，并自动生成帮助和使用信息

此外python中海油第三方的库可用于命令行解析，而且功能也比较强大，比如docopt，Click

argparse使用：

创建ArgumentParser()对象  //Argument内容摘要 Parser 分析程序，语法剖析式

调用ass_argument（）方法参数

使用parse_args()解析添加的参数

# -*- coding:utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('integer',type = int,help = 'display an integer')
args = parser.parse_args()

print(args.integer)

C:\pytest> python argparse_usage.py
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: the following arguments are required: integer

C:\pytest> python argparse_usage.py abcd
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: argument integer: invalid int value: 'abcd'

C:\pytest> python argparse_usage.py abcd -h
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: argument integer: invalid int value: 'abcd'

C:\pytest> python argparse_usage.py -h
usage: argparse_usage.py [-h] integer

positional arguments:
  integer     display an integer

optional arguments:
  -h, --help  show this help message and exit

  C:\pytest> python argparse_usage.py 132
  132

上面的例子，展示了定位参数的使用

--计算一个数的平方

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number", type=int)
args = parser.parse_args()
print args.square**2

python argparse——usage.py 9
81

可选参数，命令行参数是可选的

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)

args = parser.parse_args()

if args.square:
    print args.square**2

if args.cubic:
    print args.cubic**3

$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]

optional arguments:
  -h, --help       show this help message and exit
  --square SQUARE  display a square of a given number
  --cubic CUBIC    display a cubic of a given number

$ python argparse_usage.py --square 8
64

$ python argparse_usage.py --cubic 8
512

$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8

$ python argparse_usage.py  # 没有输出

混合使用

# -*- coding:utf-8 -*-

import argparse

parser = argparse.ArgumentParser(description = 'Process some integers.')
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)')

args = parser.parse_args()

print(args.accumulate(args.integers))

C:\pytest> python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: the following arguments are required: N

C:\pytest> python argparse_usage.py -h
usage: argparse_usage.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
  N           an integer for the accumulator

optional arguments:
  -h, --help  show this help message and exit
  --sum       sum the integers(default: find the max)

C:\pytest> python argparse_usage.py 1 2 3 4 5 --sum
15

add_argument()方法

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

参数解释如下：

name or flag 选项字符串的名字或者列表

action 命令行遇到参数时的动作，默认值时store

　　store_const 表示赋值为const

　　append 将遇到的赋值存储成列表，也就是如果参数重复则会保存多个值

　　append_const 将参数规范中定义的一个值保存到一个列表

　　const 遇到的存储此时；此外，也可以继承argparse.Action 自定义参数解析

• nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• const - action 和 nargs 所需要的常量值。
• default - 不指定参数时的默认值。
• type - 命令行参数应该被转换成的类型。
• choices - 参数可允许的值的一个容器。
• required - 可选参数是否可以省略 (仅针对可选参数)。
• help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
• metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
• dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

参考http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html