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 的运行速度提高100倍

    一行代码让 Python 的运行速度提高100倍

    python一直被病垢运行速度太慢,但是实际上python的执行效率并不慢,慢的是python用的解释器Cpython运行效率太差。这篇文章主要介绍了一行代码让 Python 的运行速度提高100倍的相关知识,需要的朋友可以参考下
    2018-10-10
  • 利用python在excel中画图的实现方法

    利用python在excel中画图的实现方法

    这篇文章主要介绍了利用python在excel中画图的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • 使用python删除PDF文档页面注释的代码示例

    使用python删除PDF文档页面注释的代码示例

    PDF文档因其跨平台的兼容性和格式稳定性而备受青睐,然而,随着文档在不同用户间的流转,累积的注释可能会变得杂乱无章,因此,适时地移除PDF文档中的注释非常重要,所以本文将演示如何使用Python来删除PDF文档页面的注释,需要的朋友可以参考下
    2024-08-08
  • Python进阶之多线程的实现方法总结

    Python进阶之多线程的实现方法总结

    在python中主要有两种实现多线程的方式:通过threading.Thread () 方法创建线程和通过继承 threading.Thread 类的继承重写run方法,接下来我们分别说一下多线程的两种实现形式吧
    2023-04-04
  • python list转dict示例分享

    python list转dict示例分享

    这篇文章主要介绍了python list转dict的使用方法,大家参考使用吧
    2014-01-01
  • Python类型转换的魔术方法详解

    Python类型转换的魔术方法详解

    这篇文章主要介绍了Python类型转换的魔术方法详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Python实现双X轴双Y轴绘图的示例详解

    Python实现双X轴双Y轴绘图的示例详解

    这篇文章主要介绍了如何利用fig.add_subplot和axes.twinx().twiny()方法实现双X轴双Y轴绘图,文中的示例代码讲解详细,快跟随小编一起动手尝试一下吧
    2022-04-04
  • Python list和str互转的实现示例

    Python list和str互转的实现示例

    这篇文章主要介绍了Python list和str互转的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • pandas对齐运算的实现示例

    pandas对齐运算的实现示例

    本文主要介绍了pandas对齐运算的实现示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-10-10
  • Python Flask-Login模块使用案例详解

    Python Flask-Login模块使用案例详解

    Flask-Login 通过 user session,提供登录的常见任务,比如登入 (logging in)、登出 (logging out) 和当前用户 (current user),这篇文章主要介绍了Python Flask-Login模块使用详解,需要的朋友可以参考下
    2023-01-01

最新评论