Argparse模块:python快捷实现命令行操作

python中的argparse模块可以方便地实现命令行解释操作，从而实现丰富的功能接口。

首先我们来看一段Shell代码：

$ lscpython  devguide  prog.py  pypy  rm-unused-function.patch$ ls pypyctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...$ ls -ltotal 20drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpythondrwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.pydrwxr-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 --helpUsage: ls [OPTION]... [FILE]...List information about the FILEs (the current directory by default).Sort entries alphabetically if none of -cftuvSUX nor --sort is specified....

接触过linux的人都知道，上面的一段代码中使用了‘ls’这个命令行参数，这个‘ls’命令对于linux使用者是经常使用的。
从中上面的使用中我们可以看到：
1、如果我们只使用‘ls’这个命令，则默认显示当前目录中的内容；
2、如果你想要执行这个命令行的其他功能，比如你要显示另一个目录pypy。这里我们要注意的就是“位置参数”（positional argument）。正如第二个命令显示，‘ls pypy’，‘pypy’是‘ls’命令的位置参数，用于告诉这个命令具体要做什么；
3、现在我们想要显示更多的信息，而不是光光显示内容的名字，于是我们在后面加了一个‘-l’，这个参数则称为“可选参数”；
4、‘–help’则帮助你了解这个命令怎么使用。

---

好了，回到python来吧，首先我们导入模块。

基本操作

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

写好上面的程序后，在终端中输入：

$ python3 prog.py$ python3 prog.py --helpusage: prog.py [-h]optional arguments:  -h, --help  show this help message and exit$ python3 prog.py --verboseusage: prog.py [-h]prog.py: error: unrecognized arguments: --verbose$ python3 prog.py foousage: prog.py [-h]prog.py: error: unrecognized arguments: fooHere is what is happening:

第一行，仅仅运行这个脚本没有什么实质用处。
第二行就展示了argparse module的作用，我们得到了一个不错的帮助信息。
很容易知道“–help”和’-h’功能相同，这个可选参数在初始化后就存在，不用自个儿写。
第三个和第四个命令显然是错的，因为啥也没写，故会报错。

现在进行修改：

import argparseparser = argparse.ArgumentParser()parser.add_argument("echo")args = parser.parse_args()print(args.echo)            #执行该脚本时前台显示代码

执行以下命令：

$ python3 prog.pyusage: prog.py [-h] echoprog.py: error: the following arguments are required: echo$ python3 prog.py --helpusage: prog.py [-h] echopositional arguments:  echooptional arguments:  -h, --help  show this help message and exit$ python3 prog.py foofoo

上面程序中，加入了 add_argument() 方法，用来确认我们想使用什么样的命令行可选参数。上面程序中加入了“echo”参数，另外parse_args()方法一般用于从确定使用的“可选参数”功能中返回数据，在这个例子中是返回echo。

再次修改，

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

然后得到：

$ python3 prog.py -husage: prog.py [-h] echopositional arguments:  echo        echo the string you use hereoptional arguments:  -h, --help  show this help message and exit

再加进一步：

import argparseparser = argparse.ArgumentParser()parser.add_argument("square", help="display a square of a given number")args = parser.parse_args()print(args.square**2)Following is a result of running the code:$ python3 prog.py 4Traceback (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'

这样直接进行操作会发生错误，因为模块默认将输入的参数识别为string类型，我们只有明确表明为int型才可以进行**操作。

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

然后看结果：

$ python3 prog.py 416$ python3 prog.py fourusage: prog.py [-h] squareprog.py: error: argument square: invalid int value: 'four'

接下来介绍“可选”参数：

import argparseparser = argparse.ArgumentParser()parser.add_argument("--verbosity", help="increase output verbosity")args = parser.parse_args()if args.verbosity:     #当不使用--verbosity时，该参数为None    print("verbosity turned on"）

输出：

$ python3 prog.py --verbosity 1verbosity turned on$ python3 prog.py$ python3 prog.py --helpusage: prog.py [-h] [--verbosity VERBOSITY]optional arguments:  -h, --help            show this help message and exit  --verbosity VERBOSITY                        increase output verbosity$ python3 prog.py --verbosityusage: prog.py [-h] [--verbosity VERBOSITY]prog.py: error: argument --verbosity: expected one argument

上面的一段程序用来展示一些东西，当–verbosity被确定时就会打印出信息，如果没有则什么也不显示，另外要有些需要修改的地方：1、程序的帮助信息有些歧义，2、verbosity只需要两个状态就可以工作了：Ture和False。

进行修改：

import argparseparser = argparse.ArgumentParser()parser.add_argument("--verbose", help="increase output verbosity",                    action="store_true")args = parser.parse_args()if args.verbose:    print("verbosity turned on")

输出：

$ python3 prog.py --verboseverbosity turned on$ python3 prog.py --verbose 1usage: prog.py [-h] [--verbose]prog.py: error: unrecognized arguments: 1$ python3 prog.py --helpusage: prog.py [-h] [--verbose]optional arguments:  -h, --help  show this help message and exit  --verbose   increase output verbosity

修改后，这个选项更像一个标志而不是获取一个值了。注意我们加了一个新的关键字：action，然后给了它一个参数”store_true”。这样的话，当选项被确定的时候，args.verbose被确定为True。不使用选项则为False。

当然也可以使用短的选项参数：

import argparseparser = argparse.ArgumentParser()parser.add_argument("-v", "--verbose", help="increase output verbosity",                    action="store_true")args = parser.parse_args()if args.verbose:    print("verbosity turned on")

输出：

$ python3 prog.py -vverbosity turned on$ python3 prog.py --helpusage: prog.py [-h] [-v]optional arguments:  -h, --help     show this help message and exit  -v, --verbose  increase output verbosity

将位置参数和可选参数进行结合：

i

mport argparseparser = argparse.ArgumentParser()parser.add_argument("square", type=int,                    help="display a square of a given number")parser.add_argument("-v", "--verbose", action="store_true",                    help="increase output verbosity")args = parser.parse_args()answer = args.square**2if args.verbose:    print("the square of {} equals {}".format(args.square, answer))else:    print(answer)

输出：

$ python3 prog.pyusage: prog.py [-h] [-v] squareprog.py: error: the following arguments are required: square$ python3 prog.py 416$ python3 prog.py 4 --verbosethe square of 4 equals 16$ python3 prog.py --verbose 4the square of 4 equals 16

上面程序中重新加上了位置参数，如果使用时不明确使用位置参数则会出现错误。
下面则使用了多可选参数的设置。

import argparseparser = argparse.ArgumentParser()parser.add_argument("square", type=int,                    help="display a square of a given number")parser.add_argument("-v", "--verbosity", type=int,                    help="increase output verbosity")args = parser.parse_args()answer = args.square**2if args.verbosity == 2:    print("the square of {} equals {}".format(args.square, answer))elif args.verbosity == 1:    print("{}^2 == {}".format(args.square, answer))else:    print(answer)

输出：

$ python3 prog.py 416$ python3 prog.py 4 -vusage: prog.py [-h] [-v VERBOSITY] squareprog.py: error: argument -v/--verbosity: expected one argument$ python3 prog.py 4 -v 14^2 == 16$ python3 prog.py 4 -v 2the square of 4 equals 16$ python3 prog.py 4 -v 316

上面输出中最后一行有点小问题，修改一下：

import argparseparser = argparse.ArgumentParser()parser.add_argument("square", type=int,                    help="display a square of a given number")parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],                    help="increase output verbosity")args = parser.parse_args()answer = args.square**2if args.verbosity == 2:    print("the square of {} equals {}".format(args.square, answer))elif args.verbosity == 1:    print("{}^2 == {}".format(args.square, answer))else:    print(answer)

输出：

$ python3 prog.py 4 -v 3usage: prog.py [-h] [-v {0,1,2}] squareprog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)$ python3 prog.py 4 -husage: prog.py [-h] [-v {0,1,2}] squarepositional arguments:  square                display a square of a given numberoptional arguments:  -h, --help            show this help message and exit  -v {0,1,2}, --verbosity {0,1,2}                        increase output verbosity

参考资料：https://docs.python.org/3/howto/argparse.html#id1