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正则表达式的使用

    python正则表达式的使用

    这篇文章主要介绍了python正则表达式的使用,需要的朋友可以参考下
    2017-06-06
  • 使用pycharm将自己项目代码上传github(小白教程)

    使用pycharm将自己项目代码上传github(小白教程)

    github是一个代码托管平台,本文主要介绍了使用pycharm将自己项目代码上传github,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Django rest framework如何自定义用户表

    Django rest framework如何自定义用户表

    Django 默认的用户表很多时候这些基本字段不够用,本文介绍在 DRF上使用自定义用户表进行接口访问控制的功能设计。感兴趣的可以了解一下
    2021-06-06
  • python对文档中元素删除,替换操作

    python对文档中元素删除,替换操作

    这篇文章主要介绍了python对文档中元素删除,替换操作,pthon更换文档中某元素、python改变或者删除txt文档中某一列元素,下文具体代码实现需要的小伙伴可以参考一下
    2022-04-04
  • python argparse模块传参用法实例

    python argparse模块传参用法实例

    这篇文章主要为大家介绍了python argparse模块传参用法实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • Python格式化输出之format用法详解

    Python格式化输出之format用法详解

    Python中格式化字符串目前有两种阵营:%和format,这篇文章主要给大家介绍了关于Python格式化输出之format用法的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-01-01
  • 微信小程序跳一跳游戏 python脚本跳一跳刷高分技巧

    微信小程序跳一跳游戏 python脚本跳一跳刷高分技巧

    这篇文章主要为大家详细介绍了微信小程序跳一跳游戏,python脚本跳一跳刷高分技巧,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • python openCV自制绘画板

    python openCV自制绘画板

    这篇文章主要为大家详细介绍了python openCV自制绘画板,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-10-10
  • 使用cx_freeze把python打包exe示例

    使用cx_freeze把python打包exe示例

    这篇文章主要介绍了使用cx_freeze把python打包成exe的示例,大家参考使用吧
    2014-01-01
  • python em算法的实现

    python em算法的实现

    这篇文章主要介绍了python em算法的实现,帮助大家更好的理解机器学习,感兴趣的朋友可以了解下
    2020-10-10

最新评论