argparse模块:解析命令行参数

                                                                                                                                 

python标准库模块argparse用于解析命令行参数,编写用户友好的命令行界面,该模块还会自动生成帮助信息,并在所给参数无效时报错。 

 

一、基本框架

 

首先写一个简单的例子:

 

例1:

编写代码,命名为test.py

import argparse                                                                                  //第一步,导入模块。

 

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="aaaa")               //第二步,创建ArgumentParser对象
    parser.add_argument('--name',default='liupc')                               //第三步,添加命令行参数
    args = parser.parse_args()                                                             //第四步,通过parse_args()函数获取所有参数args
    name = args.name
    print('Hello {}'.format(name))

打开命令行,使用python命令执行:

 

可以看到加参数和不加参数的不同处理。

 

通过这个例子可以看到,我们可以看到argparse的使用共分为一下四步:

1. 导入argpaser包

2. 通过argparse.ArgumentParser()函数创建ArgumentParser对象。

3. 调用add_argument()向ArgumentParser对象添加命令行参数信息。

4. 通过调用parse_args()来解析ArgumentParser对象中保存的命令行参数,进而使用

 

下面我们来介绍2,3,4步的用法。

 

 

二、argparse.ArgumentParser()函数

 

函数用法:

class argparse.ArgumentParser(prog=None,                                                       //程序名

                                                    usage=None,                                                    //用法信息格式

                                                    description=None,                                             //描述

                                                    epilog=None,                                                     //额外描述信息

                                                    parents=[],                                                         //共享别人的参数

                                                    formatter_class=argparse.HelpFormatter,        //显示格式

                                                    prefix_chars='-',                                                 //命令行的前缀

                                                    fromfile_prefix_chars=None,                             //从文件读入参数

                                                    argument_default=None,                                  //全局缺省值

                                                    conflict_handler=’error’,                                    //冲突处理

                                                    add_help=True,                                                 //是否增加--help选项

                                                    allow_abbrev=True)                                          //是否支持缩写

 


这个函数,我们一般也就用一下description,其他的参数都不怎么用。所以下面的解释可以不看。                                      

 

1. description

前面的例子我们使用了description,我们先来看它。description 用于展示程序的简要介绍信息,通常包括:这个程序可以做什么、怎么做。在帮助信息中 description位于用法信息与参数说明之间。


 

例1:

 

输入python test.py --help,可以看到:

 

可以看到,命令输出为三部分。第一部分是用法信息,第三部分是参数说明。而第二部分就是描述信息。

 

如果什么也不写,那肯定就什么也没有。【例2】

例2:

结果:

  • 3
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值