Python 命令行解析工具 Argparse介绍

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

之前总是作UI程序，今天试了下命令行程序，感受至关好，不用再花大把时间去研究界面问题，尤为是vc++中尤为繁琐。

如今用python来实现命令行，核心计算模块能够用c本身写扩展库，效果挺好。

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

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

Argparse Tutorial

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

基本概念

  在这篇教程中咱们经过一个常见的ls命令来展现argparse的功能。

$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

从以上的四个命令中，咱们可以了解如下几个基本概念：

• ls命令在没有参数的状况下也是能够运行的，默认打印出当前目录下的全部内容。
• 若是咱们想让它展现更多内容，那么咱们须要给它多一点参数。在这种状况下，咱们想显示一个不一样的目录，pypy。咱们所作的就是明确了常见的定位参数（positional argument），这样命名是由于须要程序根据参数在命令行中的位置而决定作什么。这个概念与命令cp更为接近，它的用法是cp src dest，src表示的是你想要拷贝的文件，dest表示你想要将文件拷贝到哪里。
• 如今，我想要改变程序的行为。在咱们的例子中，我想显示文件的向西信息而不单单是文件名，参数-l 则是咱们所知道的可选参数(optinal argument)
• 最后一句是显示帮助的文档的一个片断，当你遇到你从未使用过的命令时，你能够经过它学习怎么使用。

基本认识

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

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）就会产生一个错误。

位置参数

   首先，给一个例子：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print 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自动完成的。

尽管自动产生的帮助信息展现地很美观，可是咱们仍然没法只根据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 <module>
    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'

如今，这个程序可以顺利运行，并且可以处理一些错误输入。

From: http://www.cnblogs.com/jianboqi/archive/2013/01/10/2854726.html