python argparse 模块命令行参数用法及说明

 更新时间:2022年11月02日 10:14:41   作者:打工人小飞  
这篇文章主要介绍了python argparse 模块命令行参数用法及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

argparse 是 python 的一个命令行解析包,可根据需要编写高可读性的程序。

网上的许多教程较为冗长和散漫,没有达到精练好掌握的目的,本文针对项目中对 argparse 的用法,用实例对各个参数进行讲解,力求达到让读者秒懂的目的。

先上代码

import argparse

if __name__ == '__main__':
    # 创建命令行解析器句柄,并自定义描述信息
    parser = argparse.ArgumentParser(description='test the argparse package')
    # 定义必选参数 positionArg
    parser.add_argument('positionArg') 
    # 定义可选参数verbosity1
    parser.add_argument('--verbosity1', '-v1', help='test the optional arguments') 
    # 定义可选参数verbosity2,并通过设定store_true表示该选项不需要接收参数,若不设action,则默认是需要接收参数的,否则报错
    parser.add_argument('--verbosity2', '-v2', action='store_true', help='test the action arg') 
    # 指定参数类型(默认是 str)
    parser.add_argument('x', type=int, help='test the type')
    # 设置参数的可选范围
    parser.add_argument('--verbosity3', '-v3', type=str, choices=['one', 'two', 'three', 'four'], help='test choices')
    # 设置参数默认值
    parser.add_argument('--verbosity4', '-v4', type=str, choices=['one', 'two', 'three'], default=1, help='test default value')
    args = parser.parse_args()  # 返回一个命名空间
    print(args)
    params = vars(args)  # 返回 args 的属性和属性值的字典
    for k, v in params.items():
        print(k, v)

代码示例中写上了详细的注释,观看注释也可了解各大概。

下面针对一些特殊点再作详述

action='store_true'

表示该选项不需要接收参数,直接设定该参数为 true,当然,如果不指定 -v2, 则该参数就是 false。

但如果把 action=’store_true’ 去掉,就必须给 -v2 指定一个值。

程序用法帮助

比如该程序命名为 testArg.py,则可在命令行执行如下语句:

python3 testArg.py -h 

运行得到函数的用法帮助文档:

完整的命令行参数执行命令和效果如下:

当然,参数的值也可写成赋值形式,如下所示(等同于上图中的命令):

python3 testArg.py hehe -v1=verb1 --verbosity2 1 -v3=one -v4=two

中间打印的 Namespace 为参数解析返回的命名空间。

如此,结合实例,非常简洁易懂,分享之。当然还有一些其他的用法,此处只列出了一些最常用的用法,在使用中如有需要,可自行查阅文档。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • python实现封装得到virustotal扫描结果

    python实现封装得到virustotal扫描结果

    这篇文章主要介绍了python实现封装得到virustotal扫描结果的方法,是比较实用的技巧,可将扫描结果写入数据库,需要的朋友可以参考下
    2014-10-10
  • Python中的Numeric包和Numarray包使用教程

    Python中的Numeric包和Numarray包使用教程

    这篇文章主要介绍了Python中的Numeric包和Numarray包使用教程,来自IBM官方网站上的技术文档,需要的朋友可以参考下
    2015-04-04
  • 关于Python卷积函数详解

    关于Python卷积函数详解

    这篇文章主要介绍了Python关于卷积的理解,文中有详细的代码示例,具有很好的参考价值,希望对大家有所帮助
    2023-04-04
  • python图形绘制奥运五环实例讲解

    python图形绘制奥运五环实例讲解

    在本文里我们给大家整理了一篇关于python图形绘制奥运五环的实例内容,大家可以跟着学习下。
    2019-09-09
  • python切片的步进、添加、连接简单操作示例

    python切片的步进、添加、连接简单操作示例

    这篇文章主要介绍了python切片的步进、添加、连接简单操作,结合实例形式分析了Python切片运算的常见操作技巧,需要的朋友可以参考下
    2019-07-07
  • Python拼接字符串的7种方法总结

    Python拼接字符串的7种方法总结

    这篇文章主要给大家总结介绍了关于Python拼接字符串的7种方法,分别是来自C语言的%方式、format()拼接方式、() 类似元组方式、面向对象模板拼接、join()拼接方式以及f-string方式,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-11-11
  • python继续找对象详解

    python继续找对象详解

    这篇文章主要为大家介绍了python继续找对象的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-01-01
  • Windows下PyCharm安装图文教程

    Windows下PyCharm安装图文教程

    这篇文章主要为大家详细介绍了Windows下PyCharm安装图文教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-08-08
  • 获取python文件扩展名和文件名方法

    获取python文件扩展名和文件名方法

    本篇文章通过python写一个获取python文件扩展名和文件名的功能,并分享了代码,有兴趣的参考下。
    2018-02-02
  • 深入解析Python中的变量和赋值运算符

    深入解析Python中的变量和赋值运算符

    这篇文章主要介绍了深入解析Python中的变量和赋值运算符,是Python入门学习中的基础知识,需要的朋友可以参考下
    2015-10-10

最新评论