Python——argparse模块

127 阅读 0 评论 84 点赞

我是靠谱客的博主小巧舞蹈，这篇文章主要介绍Python——argparse模块，现在分享给大家，希望可以做个参考。

在使用pointnet网络的时候，遇到这个argparse模块，因此，记录一下自己用到的地方以及自己的理解。

argparse是Python的一个内置模块，用于命令选项与参数解析的模块，在程序中我们定义好自己需要的一些参数，argparse这个模块将会从sys.argc中解析出这些参数，并自动生成帮助和使用信息。
比如：在我目前用到的pointnet网络中，官方介绍我可以查看 train.py 脚本的帮助文档，只需在终端中输入：pyhton train.py -h，接下来，让我们看看这个到底是什么鬼。
这个图是在终端中执行该语句后的信息，在这些信息中可以看到“optional arguments”这个可选参数中的各个参数就是作者在train.py 中利用内置模块argparse模块所写出来的。不信，你看～
简单介绍了argparse的功能后，来看下argparse的使用步骤：

导入argparse模块

复制代码

1
2
import argparse

创建ArgumentParser()对象。

复制代码

1
2
parser = argparse.ArgumentParser()

添加命令行参数和选项

复制代码

1
2
parser.add_argument()

解析增加的参数

复制代码

1
2
parser.parse_args()

实例一：简单示范

复制代码

1
2
3
4
5
6
7
8
9
# parse_arg.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()

print(args.integer)

先写出测试的.py文件，在终端执行得到下图：
terminal测试parse

实例2：定位参数

复制代码

1
2
3
4
5
6
7
8
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('square', type=int, help='display a square of a given number')
args = parser.parse_args()

print(args.square**2)

运行结果如下:
spare_arg_square

实例三：可选参数

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import argparse

parser = argparse.ArgumentParser()

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

args = parser.parse_args()

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

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

运行结果如下：
可选参数

实例四：混合使用

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
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)

运行结果如下：
在这里插入图片描述

add_argument() 方法

add_argument() 方法定义如何解析命令行参数：

复制代码

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

①name or flags…
字符串的名字或者列表，e.g. foo或者-f，–foo。
②action
命令行遇到参数时的动作，默认值是store。
i)store_const：表示赋值为const；
ii)append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
iii)append_const：将参数规范中定义的一个值保存到一个列表；
iv)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：解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线。

参考资料：
http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html
https://docs.python.org/3.5/library/argparse.html#the-parse-args-method