argparse模块的使用

简单示例

我们先来看一个简单示例。主要有三个步骤：

• 创建 ArgumentParser() 对象
• 调用 add_argument() 方法添加参数
• 使用 parse_args() 解析添加的参数

定位参数

上面的示例，其实就展示了定位参数的使用，我们再来看一个例子 - 计算一个数的平方：

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 A.py 3

9

可选参数

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)

args = parser.parse_args()

if args.square:
    print(args.square ** 2)

if args.cubic:
    print(args.cubic ** 3)

混合使用

定位参数和选项参数可以混合使用，看下面一个例子，给一个整数序列，输出它们的和或最大值（默认）：

import argparse
 
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                   help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                   const=sum, default=max,
                   help='sum the integers (default: find the max)')
 
args = parser.parse_args()
print(args.accumulate(args.integers))

E:PycharmProjectsstyle_transfer3clttyou-style-model-for-image-style-fusion-and-transfer-masterstyle-model-for-image-style-fusion-and-transfercore>python A.py
usage: A.py [-h] [--sum] N [N ...]
A.py: error: the following arguments are required: N

E:PycharmProjectsstyle_transfer3clttyou-style-model-for-image-style-fusion-and-transfer-masterstyle-model-for-image-style-fusion-and-transfercore>python A.py 1 4 2 9
9

E:PycharmProjectsstyle_transfer3clttyou-style-model-for-image-style-fusion-and-transfer-masterstyle-model-for-image-style-fusion-and-transfercore>python A.py 2 0 4 6 --sum
12

add_argument() 方法

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 自定义参数解析；
    • action='store_true'，只要运行时该变量有传参就将该变量设为True,不传参就是false
• nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号(允许不指定参数，利用const中的常量给予值)，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
• const - action 和 nargs 所需要的常量值。
• default - 不指定参数时的默认值。
• type - 命令行参数应该被转换成的类型。
• choices - 参数可允许的值的一个容器。
• required - 可选参数是否可以省略 (仅针对可选参数)。
• help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
• metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
• dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

 parser.add_argument('-test_2','-i',type=float,default=2) #-test_2 命令 和 -i 命令相同

parser.add_argument('-test',action='store_const',const=12)
print(args.test)
 
#action='store_const' 不能与type一起使用
命令行：python untitled.py -test
output：12
命令行:python untitled.py -test 13 #报错

cltt

 

argparse模块的使用