Python 中最好用的命令行参数解析工具，你知道吗？

Python 中最好用的命令行参数解析工具，你知道吗？

Python作为一种脚本语言，可以轻松编写各种工具。当你想在服务器上运行一个工具或者服务的时候，刚需就是输入参数(当然也可以通过配置文件来实现)。

如果你想在命令行上执行，你需要一个命令行参数分析模块来帮你做这个苦力。

 

Python原本就提供了三个命令行参数解析模块，我在这里列出来让大家知道。

• getopt，简单的处理命令行参数

• optparse，功能强大且易于使用，它可以轻松生成符合Unix/Posix规范的标准命令行指令。（Python2.7之后弃用，不会继续发展）

• argparse，更容易编写用户友好的命令行界面。它需要的程序定义了参数，argparse会更好的解析sys.argv，同时argparse模块还可以在用户输入错误参数时自动生成帮助和提示信息。

大多数的初学者可能会使用getopt，它上手简单，功能简单。例如，optget不能解析一个参数的多个值，比如- file file1 file2 file3 3，而optparse实际上并没有被我使用，但是考虑到在Python2.7之后不再维护，我们通常也不会使用它。

再接下来，只有工件argparse，它可以满足我对命令解析器的几乎所有要求。它支持解析一个参数的多个值，自动生成帮助命令和帮助文档，支持子解析器，限制参数值的范围等等。

HelloWorld

无论学什么，第一步都要掌握它的大致框架。在使用argparse之前，框架非常简单，只需要记住这三行。

# mytest.py
import argparse
parser = argparse.ArgumentParser(description="used for test")

args = parser.parse_args()

现在可尝试

[root@localhost ~]# python mytest.py -h
usage: mytest.py [-h]

used for test

optional arguments:
-h, --help show this help message and exit
[root@localhost ~]#
[root@localhost ~]#
[root@localhost ~]# python mytest.py
[root@localhost ~]#

可以使用了。

1. 入门配置

比较常用的参数配置：

• 调试：debug

• 版本号：version

import argparse
parser = argparse.ArgumentParser()

parser.add_argument('--version', '-v', action='version',
version='%(prog)s version : v 0.01',
help='show the version')

parser.add_argument('--debug', '-d',
action='store_true',
help='show the version',
default=False)

args = parser.parse_args()
print("=== end ===")

debug处的配置，需要讲的是 action='store_true' 和 default = False 的作用、区别

• store_true：一旦指定了 -d 或者 --debug ，其值就为 True，store_false则相反

• default=False：未指定 -d 或者 --debug，其值就默认为False

执行 python mytest.py -v，就会打印 version 里的内容。

[root@localhost ~]# python mytest.py -v
mytest.py version : v 0.01
[root@localhost ~]#

一旦执行时，指定了参数 -v ，执行到 parser.parse_args() 就会退出程序，不会打印最后的=== end ===

2. 参数种类

参数分为 必选参数（positional arguments） 、 可选参数（optional arguments）。

在argsparse 里怎么实现？

必选参数

用单词做参数，默认为必选参数

# mytest.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("name")

args = parser.parse_args()

print(args.name)

不指定name参数运行：python mytest.py

[root@localhost ~]# python mytest.py
usage: mytest.py [-h] name
mytest.py: error: too few arguments
[root@localhost ~]#

不出所料，报告了一个错误，称参数丢失。就让我们指定:pythonmytest.pynamewangbm。

[root@localhost ~]# python mytest.py wangbm
wangbm
[root@localhost ~]#

可选参数

有两种方法:

单下划线-指定短参数，如-h；

双下划线-指定长参数，如- help。

# mytest.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbosity",
help="increase output verbosity")

args = parser.parse_args()

if args.verbosity:
print("verbosity turned on")
else:
print("verbosity turned off")

运行 python mytest.py，不会报错。

[root@localhost ~]# python mytest.py
verbosity turned off
[root@localhost ~]#

3. 参数类型

有些参数是字符串，有些参数是数值。

为了有效地约束命令行中的参数，我们可以提前声明参数的类型。Argparse将检查参数。如果失败，会直接抛出错误。

# mytest.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("age", type=int)

args = parser.parse_args()

print(args.name)
print(args.age)

测试一下

[root@localhost ~]# python mytest.py wangbm eighteen
usage: mytest.py [-h] name age
mytest.py: error: argument age: invalid int value: 'eighteen'
[root@localhost ~]#
[root@localhost ~]# python mytest.py wangbm 18
wangbm
18
[root@localhost ~]#

写 eighteen 提示类型不合法，只有写 18 才行。

4 互斥参数

有些参数是互斥的，有你没有我。比如性别。

如何在argparse中实现？

import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-m", "--male", action="store_true")
group.add_argument("-f", "--female", action="store_true")
args = parser.parse_args()

如果指定了这两个参数，将会报告错误。

[root@localhost ~]# python mytest.py -f
[root@localhost ~]# python mytest.py -m
[root@localhost ~]# python mytest.py -m -f
usage: mytest.py [-h] [-m | -f]
mytest.py: error: argument -f/--female: not allowed with argument -m/--male
[root@localhost ~]#

5 可选值

如果是性别，可以如上放入两个参数，然后由互斥组限制，也可以放入一个参数，在argparse限制里，再外层判断。

# mytest.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-g", "--gender", default='male',
choices=['male', 'female'])

args = parser.parse_args()
print(args.gender)

试着去执行，发现性别只能是男的或者女的，不能是“不男不女”。

[root@localhost ~]# python mytest.py --gender male
male
[root@localhost ~]# python mytest.py --gender female
female
[root@localhost ~]#
[root@localhost ~]#
[root@localhost ~]# python mytest.py --gender other
usage: mytest.py [-h] [-g {male,female}]
mytest.py: error: argument -g/--gender: invalid choice: 'other' (choose from 'male', 'female')
[root@localhost ~]#

6. 指定文件

通常需要在脚本中指定配置文件或其他文件。可以使用下面的配置

import argparse
parser = argparse.ArgumentParser()

parser.add_argument('--file', '-f', action='append',
dest='files',
help=('additional yaml configuration files to use'),
type=argparse.FileType('rb'))

args = parser.parse_args()

dest=files，是说将命令行中，--file 的参数值赋值给变量files，你可以用args.files访问。

action=append，由于我们会有指定多个文件的需求，那就指定多次--file ，argparse会将其放在一个list里。

type=argparse.FileType('rb')，既然是指定文件，那么参数应该为路径，并指定打开模式为rb，如果如果要取得文件内容，可以用 args.files[0].read()

7. 子解析器

举个例子。

cloud-init --debug single -name mymodule

single 后面是一个子解析器。

# cloud-init.py

def main_single(name, args):
print("name: ", name)
print("args: ", args)
print("I am main_single")

# 添加一个子解析器
subparsers = parser.add_subparsers()

parser_single = subparsers.add_parser('single',
help='run a single module')

# 对single 子解析器添加 action 函数。
parser_single.set_defaults(action=('single', main_single))

# require=True: 命令行指定了single解析器，必须带上--name的参数。
parser_single.add_argument("--name", '-n', action="store",
help="module name to run",
required=True)

args = parser.parse_args()

(name, functor) = args.action
if name in ["single"]:
functor(name, args)

执行命令cloud-init single -name mymodule，输出如下

name: single
args: Namespace(action=('single', ), debug=False, file=None, name='mymodule')
I am main_single

以上，就是 argparse 的使用方法。看完点个收藏哦！