python argparse基本用法总结

argparse模块是命令行参数解决包，可以很方便的接收从命令行传过来参数，也可以对传过来的参数进行定制化处理。原有的optparse已经慢慢的被弃用了，所以现在开始对argparse进行基本学习和介绍。

1、简单的基本示例

按照平时工作的需求，基本都是传入固定格式的开始时间、结束时间和表相关信息，下面这个例子是传入基本的时间参数：

import argparse
import datetime

def get_parser():
    # 生成argparse对象
    parser = argparse.ArgumentParser(description="Demo of argparse")
    # 添加需要的参数
    parser.add_argument('--start_dt', type=str,  default=datetime.datetime.now().strftime("%Y-%m-%d"))
    parser.add_argument('--end_dt', type=str, required=True, default=datetime.datetime.now().strftime("%Y-%m-%d"))
    # 返回parser对象
    return parser

if __name__ == '__main__':
    parser = get_parser()
    # 获取参数
    args = parser.parse_args()
    start_dt = args.start_dt
    end_dt = args.end_dt
    print(start_dt)
    print(end_dt)
复制代码

在命令行执行下面的操作就可以获取开始时间和结束时间：

image.png

上面的代码段中，我们显示引入了argparse包，然后通过argparse.ArgumentParser函数生成argparse对象，其中这个函数的description函数表示在命令行显示帮助信息的时候，这个程序的描述信息。之后我们通过对象的add_argument函数来增加参数。这里我们只增加了一个--name的参数，然后后面的default参数表示如果没提供参数，我们默认采用的值。即如果像下面这样执行命令：

image.png

注意：对于start_dt字段设置可选传入，也就是默认的。

最后我们通过argpaser对象的parser_args函数来获取所有参数args，然后通过args.name的方式得到我们设置的--name参数的值，可以看到这里argparse默认的参数名就是--name形式里面--后面的字符串。下面就具体讲下argument中具体参数。

2、default：没有设置值情况下的默认参数

如同上例中展示的，default表示命令行没有设置该参数的时候，程序中用什么值来代替。如：start_dt默认使用的是当前的时间来代替。

default=datetime.datetime.now().strftime("%Y-%m-%d")
复制代码

3、required: 表示这个参数是否一定需要设置

如果设置了required=True，则在实际运行的时候不设置该参数将报错：

parser.add_argument('--end_dt', type=str, required=True, default=datetime.datetime.now().strftime("%Y-%m-%d"))
复制代码

end_dt设置为True，但是在执行的没有传入，就会报如下错误：

image.png

4、type：参数类型

默认的参数类型是str类型，如果你的程序需要一个整数或者布尔型参数，你需要设置type=int或type=bool。

5、choices：参数值只能从几个选项里面选择

import argparse

def get_parser():
    parser = argparse.ArgumentParser(
        description='choices demo')
    parser.add_argument('-arch', required=True, choices=['alexnet', 'vgg'])
    return parser

if __name__ == '__main__':
    parser = get_parser()
    args = parser.parse_args()
    print('the arch of CNN is '.format(args.arch))
复制代码

image.png

image.png

6、help：指定参数的说明信息

在现实帮助信息的时候，help参数的值可以给使用工具的人提供该参数是用来设置什么的说明，对于大型的项目，help参数和很有必要的，不然使用者不太明白每个参数的含义，增大了使用难度。

如果参数过多或者设置的名称不能见名知意，这个help信息就有很大作用，一般要求是要写上的。

7、dest：设置参数在代码中的变量名

argparse默认的变量名是--或-后面的字符串，但是你也可以通过dest=xxx来设置参数的变量名，然后在代码中用args.xxx来获取参数的值。

parser.add_argument('--s', dest='start_dt', type=str,  default=datetime.datetime.now().strftime("%Y-%m-%d"))
parser.add_argument('--e', dest='end_dt', type=str, required=True, default=datetime.datetime.now().strftime("%Y-%m-%d"))

start_dt = args.start_dt
end_dt = args.end_dt
复制代码

image.png

image.png

这个参数使用上大大减少传参的复杂度，一般使用字母传参，然后在里面定义变量名。

8、nargs： 设置参数在使用可以提供的个数

使用方式如下：

parser.add_argument('-name', nargs=x)
复制代码

其中x的候选值和含义如下：

值  含义
N   参数的绝对个数（例如：3）
'?'   0或1个参数
'*'   0或所有参数
'+'   所有，并且至少一个参数
复制代码

9、参考资料

vra.github.io/2017/12/02/…

docs.python.org/zh-cn/3.7/l…