【Python】用于命令项选项与参数解析的模块argparse

在网上参考别人用Python写的东西时，发现他使用argparse定义参数，所以就决定学习一下。

argparse是什么

argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从 sys.argv 中解析出这些参数，并自动生成帮助和使用信息。

使用argarse

使用argarse分为三步，

• 第一步：创建 ArgumentParser() 对象

parser = argparse.ArgumentParser() #创建对象

• 第二步：调用 add_argument() 方法添加参数

parser.add_argument('integer', type=int, help='display an integer')

• 第三步：使用 parse_args() 解析添加的参数

args = parser.parse_args()

add_argument() 方法

使用argarse的第二个步骤是用 add_argument() 方法添加参数，我们看到里面用到了很多参数，下面我就一一介绍每个参数

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

每个参数解释如下:

• name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, –foo。
• action - 命令行遇到参数时的动作，默认值是 store。
  store_const，表示赋值为const；
  append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
  append_const，将参数规范中定义的一个值保存到一个列表；
  count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
• nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• const - action 和 nargs 所需要的常量值。
• default - 不指定参数时的默认值。
• type - 命令行参数应该被转换成的类型。
• choices - 参数可允许的值的一个容器。
• required - 可选参数是否可以省略 (仅针对可选参数)。
• help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
• metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
• dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

举个例子

下面我们看一个实际的例子

import argparse

parser = argparse.ArgumentParser() #初始化

parser.add_argument("--square", help="display a square of a given number", type=int) #添加参数square，命令行参数应被指定为int型
parser.add_argument("--cubic", help="display a cubic of a given number", type=int) #添加参数cubic，命令行参数应被指定为int型

args = parser.parse_args() #解析ca定义好的参数

if args.square: #如果参数是square，则是平方
    print args.square**2

if args.cubic:
    print args.cubic**3 #如果参数是cubic ，则是立方

将上面的代码保存为文件 argparse_usage.py，在终端运行，结果如下：

$ python argparse_usage.py --square 8 #我们选择square，即求8的平方
64

$ python argparse_usage.py --cubic 8 #选择参数cubic，即求8的立方
512