Python 命令行解析工具 Argparse介绍

最近在研究pathon的命令行解析工具，argparse，它是Python标准库中推荐使用的编写命令行程序的工具。

argparse与sys.argv中的区别：

argparse模块可以轻松编写用户友好的命令行界面。该程序定义了它需要什么参数，而argparse将会找出如何解析出sys.argv中的那些该程序定义了它需要什么参数，而argparse将会找出如何解析出sys.argv中的那些。当用户给出程序无效的参数时，argparse模块还会自动生成帮助和使用信息并发出错误。

如果想对python脚本传参数，python中对应的argc, argv(c语言的命令行参数)是什么呢？
需要模块：sys
参数个数：len(sys.argv)
脚本名：    sys.argv[0]
参数1：     sys.argv[1]
参数2：     sys.argv[2]

test.py

1 import sys
2 print "脚本名：", sys.argv[0]
3 for i in range(1, len(sys.argv)):
4     print "参数", i, sys.argv[i]

>>>python test.py hello world
脚本名：test.py
参数 1 hello
参数 2 world

关于argparse，在官方文档中找到一篇toturial，简单翻译了下。

http://docs.python.org/2/howto/argparse.html#id1

Argparse Tutorial

这篇教程简明地介绍了Python标准库推荐使用的命令行参数解析模块——Argparse的使用。

基本认识

   首先，给一个例子：

import argparse                  //argparse即含描述的参数（arg）
parser = argparse.ArgumentParser()   //创建说明描述类
parser.add_argument("echo")     //描述类增加具体说明："echo"
args = parser.parse_args()      //从描述类中获取含说明的args（参数）
print args.echo                 //打印args中的说明为echo的参数

运行结果:

$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py foo
foo

结果分析：

• 这次，我们增加了一个add_argument()方法，用来设置程序可接受的命令行参数。
• 现在要运行程序，就必须设置一个参数。
• parse_args()方法实际上从我们的命令行参数中返回了一些数据，在上面的例子中是echo
• 这个像“魔法”一样的过程，是argparse自动完成的。

    我们从一个基本的程序开始（它什么也不做）

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

运行结果：

$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

结果分析：

• 若不给参数而运行这个程序，将不会得到任何结果。
• 第二条命名显示了使用的argparse的好处，你什么也没做，却得到了一个很好的帮助信息。
• 我们无需人为设置--help参数，就能得到一个良好的帮助信息。但是若给其他参数（比如foo）就会产生一个错误。

尽管自动产生的帮助信息展示地很美观，但是我们仍然无法只根据echo这个参数知道它是做什么的。所以，我们增加了一些东西，使得它变得更有用。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print args.echo

运行结果：

$ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

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

在此基础上，我们再多改变一点：（计算输入参数square的平方）

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

下面是运行结果：

$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 5, in 
    print args.square**2
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

这个程序并不能正确运行，因为argparse会将输入当作字符串处理，所以我们需要设置它的类型：（type=int）

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 prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

现在，这个程序能够顺利运行，而且能够处理一些错误输入。