Python模块学习系列（8）----argparse模块

boost库很好的支持C++的命令行解析，能使我们的程序用起来更酷。最近一直想Python里也用上命令行，这样就不用再IDE里修改输入参数了。记得前面介绍过使用os模块也能解析命令行，但是那个比较简单，今天我们介绍的argparse模块是python中专门用来解析命令行的。

首先给大家贴出一段代码及运行结果，让大家有一个直观的感受。

<span style="font-size:18px;">#!/usr/bin/env python
"""
Draw a graph of the net architecture.
"""
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
from google.protobuf import text_format

import caffe
import caffe.draw
from caffe.proto import caffe_pb2


def parse_args():
    """Parse input arguments
    """

    parser = ArgumentParser(description=__doc__,
                            formatter_class=ArgumentDefaultsHelpFormatter)

    parser.add_argument('input_net_proto_file',
                        help='Input network prototxt file')
    parser.add_argument('output_image_file',
                        help='Output image file')
    parser.add_argument('--rankdir',
                        help=('One of TB (top-bottom, i.e., vertical), '
                              'RL (right-left, i.e., horizontal), or another '
                              'valid dot option; see '
                              'http://www.graphviz.org/doc/info/'
                              'attrs.html#k:rankdir'),
                        default='LR')

    args = parser.parse_args()
    return args


def main():
    args = parse_args()
    net = caffe_pb2.NetParameter()
    text_format.Merge(open(args.input_net_proto_file).read(), net)
    print('Drawing net to %s' % args.output_image_file)
    caffe.draw.draw_net_to_file(net, args.output_image_file, args.rankdir)


if __name__ == '__main__':
    main()</span>

运行结果

上图是我没有输入任何参数时运行的结果。

下面的内容主要是参考了：http://www.2cto.com/kf/201412/363654.html和http://www.jb51.net/article/67158.htm

从上面的代码中我们可以总结出以下两点：

1、命令行解析一般是以函数的形式执行，也就是我们定义个子函数专门用来处理命令行。

2、使用的步骤：

（1）import argparse

（2）parser = argparse.ArgumentParser()

（3）parser.add_argument()

（4）args=parser.parse_args()

（5）return args

（6）args = parse_args()

如下所示：

<span style="font-size:18px;">import argparse
def parse_args():
{
    parser = argparse.ArgumentParser()#初始化一个对象
    parser.add_argument()
    args = parser.parse_args()
    return args
}
args = parse_args()</span>

下面我们一步步介绍：

1、方法ArgumentParser(prog=None, usage=None,description=None, epilog=None, parents=[],formatter_class=argparse.HelpFormatter, prefix_chars='-',fromfile_prefix_chars=None, argument_default=None,conflict_handler='error', add_help=True)

这些参数都有默认值，当调用parser.print_help()或者运行程序时由于参数不正确(此时python解释器其实也是调用了pring_help()方法)时，会打印这些描述信息，一般只需要传递description参数。这个方法相当于一个构造函数，初始化一个对象，里面使用最多的参数就是description。

我们可以按照上面代码的使用方式，用默认可是就可以了：

<span style="font-size:18px;">parser = ArgumentParser(description=__doc__,
                            formatter_class=ArgumentDefaultsHelpFormatter)</span>

我们自己也可以显示自己的信息：

<span style="font-size:18px;">def parse_args():
    description = usage: %prog [options] poetry-file</span>

或者：

<span style="font-size:18px;">parser = argparse.ArgumentParser(description="This is a description of %(prog)s", \</span>

<span style="font-size:18px;">					epilog="This is a epilog of %(prog)s", \</span>

<span style="font-size:18px;">				<span style="white-space:pre">	</span>prefix_chars="-+", fromfile_prefix_chars="@", \</span>

<span style="font-size:18px;">			<span style="white-space:pre">		</span>formatter_class=argparse.ArgumentDefaultsHelpFormatter)</span>

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

其中：

name or flags：命令行参数名或者选项，其中命令行参数如果没给定，且没有设置defualt，则出错。但是如果是选项的话，则设置为None

nargs：命令行参数的个数，一般使用通配符表示，其中，'?'表示只用一个，'*'表示0到多个，'+'表示至少一个

default：默认值

type：参数的类型，默认是字符串string类型，还有float、int等类型

help：和ArgumentParser方法中的参数作用相似，出现的场合也一致
下面举一些具体使用的例子：

例1：

<span style="font-size:18px;">parser = argparse.ArgumentParser(description = description)
    
help = The addresses to connect.#是对参数的说明信息
parser.add_argument('addresses',nargs = '*',help = help)#nargs='*' 说明这个参数是0到多个，也就是可选的</span>

例2：

<span style="font-size:18px;">help = The filename to operate on.Default is poetry/ecstasy.txt
parser.add_argument('filename',help=help)
</span>

例3：

<span style="font-size:18px;">help = The port to listen on. Default to a random available port.
parser.add_argument('-p',--port', type=int, help=help)#-p是--port的缩写形式，使用时用哪个都行，type=int说明这个参数</span>

<span style="font-size:18px;">						#是整数类型</span>

注意：例2和例3在使用时输入参数的格式有些不同，就像我们使用boost解析命令行时的格式也稍有不同，例2中直接输入参数，只要顺序对应就可以。例3中使用格式为  --port=参数

例4：

<span style="font-size:18px;">help = The interface to listen on. Default is localhost.
parser.add_argument('--iface', help=help, default='localhost')#带有字符串类型默认值</span>

例5：

<span style="font-size:18px;">help = The number of seconds between sending bytes.
parser.add_argument('--delay', type=float, help=help, default=.7)

help = The number of bytes to send at a time.
parser.add_argument('--bytes', type=int, help=help, default=10)</span>

我们怎样在程序中使用这些参数呢？我应该知道C++中使用argv[ ]按照顺序取出命令。而这里我们可以直接使用参数名字如args.filename

<span style="font-size:18px;">if __name__ == '__main__':
	args = parse_args()#获得命令行
	
	for address in args.addresses:#注意下面使用命令行参数的方法
		print 'The address is : %s .' % address
	
	print 'The filename is : %s .' % args.filename
	print 'The port is : %d.' % args.port
	print 'The interface is : %s.' % args.iface
	print 'The number of seconds between sending bytes : %f'% args.delay
	print 'The number of bytes to send at a time : %d.' % args.bytes</span>

OK！祝大家好运了！