argparse模块介绍

news2025/1/12 18:19:05

        argparse是一个Python模块：命令行选项、参数和子命令解析器。argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义了所需的参数，而 argparse 将找出如何从 sys.argv （命令行）中解析这些参数。argparse 模块还会自动生成帮助和使用消息，并在用户为程序提供无效参数时发出错误。

1 使用流程

1、 创建一个解析器——创建 ArgumentParser() 对象
        使用 argparse 的第一步是创建一个 ArgumentParser 对象，示例：

parser = argparse.ArgumentParser(description='Process some integers.')

        ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。

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, allow_abbrev=True)
  • prog - 程序的名称（默认：sys.argv[0]）
  • usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
  • description - 在参数帮助文档之前显示的文本（默认值：无）
  • epilog - 在参数帮助文档之后显示的文本（默认值：无）
  • parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内
  • formatter_class - 用于自定义帮助文档输出格式的类
  • prefix_chars - 可选参数的前缀字符集合（默认值：’-’）
  • fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：None）
  • argument_default - 参数的全局默认值（默认值： None）
  • conflict_handler - 解决冲突选项的策略（通常是不必要的）
  • add_help - 为解析器添加一个 -h/--help 选项（默认值： True）
  • allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）

2、添加参数——调用 add_argument() 方法添加参数

        给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。这些信息在 parse_args() 调用时被存储和使用。例如：

parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

add_argument() 方法定义如何解析命令行参数

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
  • name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
  • action - 命令行遇到参数时的动作，默认值是 store。
    • – store_const，表示赋值为const；
    • – append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
    • – append_const，将参数规范中定义的一个值保存到一个列表；
    • – count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
  • nargs - 应该读取的命令行参数个数，可以是
    • 具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const
    • 或者是 * 号，表示 0 或多个参数；
    • 或者是 + 号表示 1 或多个参数。
  • const - action 和 nargs 所需要的常量值。
  • default - 不指定参数时的默认值。
  • type - 命令行参数应该被转换成的类型。
  • choices - 参数可允许的值的一个容器。
  • required - 可选参数是否可以省略 (仅针对可选参数)。
  • help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
  • metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
  • dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

3、解析参数——使用 parse_args() 解析添加的参数

        ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。在大多数情况下，这意味着一个简单的 Namespace 对象将从命令行解析出的属性构建：

parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

        在脚本中，通常 parse_args() 会被不带参数调用，而 ArgumentParser 将自动从 sys.argv 中确定命令行参数。

2 结果测试

import argparse

parser = argparse.ArgumentParser(description='Model parameter settings')
parser.add_argument('-s', '--sparse', dest='sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('-e', '--epoch', dest='epoch', type=int, default=40, help='# of epoch')
parser.add_argument('-b', '--batch_size', dest='batch_size', type=int, default=128, help='# images in batch')
parser.add_argument('-u', '--use_gpu', dest='use_gpu', type=int, default=1, help='gpu flag, 1 for GPU and 0 for CPU')
parser.add_argument('-l', '--lr', dest='lr', type=float, default=0.0001, help='initial learning rate for adam')
parser.add_argument('-c', '--C', dest='C', default='Resnet', help='choose model')
 
args = parser.parse_args()

print(args.sparse)          # print(args["sparse"]) 也可以
print(args.epoch)
print(args.batch_size)
print(args.use_gpu)
print(args.lr)
print(args.C)

        显示帮助文档：

        输错命令会告诉你usage用法：

        使用命令修改参数：

action='store_true’ 的使用说明
action 命令行遇到参数时的动作，默认值是 store。也就是说，action=‘store_true’，只要运行时该变量有传参就将该变量设为True。

3 补充内容

        parse_args() 报错解决 error: the following arguments are required: xxx

usage: test.py [-h] xxx
test.py: error: the following arguments are required: xxx

原因：

  • args 分为可选参数（用–指定）和必选参数（不加–指定）。
  • 如果你定义参数xxx时，没有用–指定，那么该参数为需要在命令行内手动指定。此时即使通过default设置默认参数，也还是会报错。

        使用互斥参数——参考代码中的注释和运行结果

import math
import argparse
parser = argparse.ArgumentParser(description='Calculate volume of a cylinder')
parser.add_argument('-r', '--radius', type=int, metavar='', required=True, help='Radius of cylinder')
parser.add_argument('-H', '--height', type=int, metavar='', required=True, help='Height of cylinder')
# 添加互斥组
group = parser.add_mutually_exclusive_group()
# 给互斥组添加两个参数
# 给参数的action属性赋值store_true，程序默认为false,当你执行这个命令的时候，默认值被激活成True
group.add_argument('-q', '--quiet', action='store_true', help='Print quiet')
group.add_argument('-v', '--verbose', action='store_true', help='Print verbose')
args = parser.parse_args()
def cylinder_volume(radius, height):
    vol = (math.pi) * (radius**2) * (height)  # 体积公式
    return vol
if __name__ == '__main__':
    volume = cylinder_volume(args.radius, args.height)
    # 互斥参数
    if args.quiet:
        print(volume)
    elif args.verbose:
        print('Volume of a Cylinder with radius %s and height %s is %s' % (args.radius, args.height, volume))
    else:
        print('Volume of Cylinder = %s' % volume)
    # 这就是互斥参数如何工作的，你不能同时执行两个命令，你可以执行一个，所以和互斥组里的两个参数交互时，你只能
    # 执行quiet和verbose中的一个，或者是都不执行按照默认计划来
    # 使用： python test_argparse.py  -r 2 -H 4
    #       python test_argparse.py  -r 2 -H 4 -v
    #       python test_argparse.py  -r 2 -H 4 -q

        argparse还支持子命令，使得你可以更好地组织和管理不同功能的命令行工具。

import argparse

def main():
    parser = argparse.ArgumentParser(description='一个命令行解析器')
    parser.add_argument('input_file', help='输入文件路径')
    parser.add_argument('-o', '--output', help='输出文件路径')
    parser.add_argument('--count', type=int, help='一个整数参数')
    parser.add_argument('--threshold', type=float, help='一个浮点数参数')

    subparsers = parser.add_subparsers(title='子命令', dest='subcommand')

    # 子命令1
    subparser1 = subparsers.add_parser('command1', help='执行命令1')
    subparser1.add_argument('--option1', help='命令1的选项')

    # 子命令2
    subparser2 = subparsers.add_parser('command2', help='执行命令2')
    subparser2.add_argument('--option2', help='命令2的选项')

    args = parser.parse_args()

    if hasattr(args, 'subcommand'):
        if args.subcommand == 'command1':
            print(f'执行命令1，选项: {args.option1}')
        elif args.subcommand == 'command2':
            print(f'执行命令2，选项: {args.option2}')
    else:
        print(f'输入文件路径: {args.input_file}')
        print(f'输出文件路径: {args.output}')
        print(f'整数参数: {args.count}')
        print(f'浮点数参数: {args.threshold}')

if __name__ == '__main__':
    main()

参考

  • argparse 教程：https://docs.python.org/zh-cn/3/howto/argparse.html
  • Python之使用argparse在命令行读取文件：https://blog.csdn.net/MilkLeong/article/details/115639740

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1137333.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

实时数仓-Hologres介绍与架构

实时数仓-Hologres介绍与架构

本文是向大家介绍Hologres是一款实时HSAP产品&#xff0c;隶属阿里自研大数据品牌MaxCompute&#xff0c;兼容 PostgreSQL 生态、支持MaxCompute数据直接查询&#xff0c;支持实时写入实时查询&#xff0c;实时离线联邦分析&#xff0c;低成本、高时效、快速构筑企业实时数据仓…
阅读更多...
笔记本电脑识别不了刻录机，由于设备驱动程序的前一个实例仍在内存中，windows 无法加载这个硬件的设备驱动程序。 (代码 38)

笔记本电脑识别不了刻录机，由于设备驱动程序的前一个实例仍在内存中，windows 无法加载这个硬件的设备驱动程序。 (代码 38)

目录 1 问题2 解决 1 问题 笔记本电脑识别不了刻录机&#xff0c;由于设备驱动程序的前一个实例仍在内存中&#xff0c;windows 无法加载这个硬件的设备驱动程序。 (代码 38) 笔记本电脑插入刻录机&#xff0c;一直识别不了&#xff1b; 右边点击属性 这里展示 由于设备驱动…
阅读更多...
powerdesigner逆向mysql与pg生成er图

powerdesigner逆向mysql与pg生成er图

一、逆向mysql数据库 官网下载mysql的ODBC(开放数据库互连) 选择自己对应版本&#xff0c;我的power designer是32位的&#xff0c;需要选择32的ODBC进行下载&#xff0c;不然power designer会监测不到。 双击exe文件&#xff0c;安装ODBC 这个比较简单&#xff0c;就不阐述了…
阅读更多...
nu1l-死亡ping命令攻略

nu1l-死亡ping命令攻略

book-nu1l docker 虚拟化技术 把传统的虚拟机堪称容器 依赖镜像启动容器&#xff0c;镜像可以理解为模板克隆的虚拟机&#xff0c;删除容器&#xff0c;对镜像没有影响 镜像在云端 本地要使用某个镜像&#xff0c;根据地址&#xff0c;直接从云端拉取 基本命令 # 查看系统…
阅读更多...
day14_集合

day14_集合

今日内容 零、 复习昨日 一、集合框架体系 二、Collection 三、泛型 四、迭代 五、List(ArrayList、LinkedList) 零、 复习 throw和throws什么区别 throwthrows位置方法里面方法签名上怎么写throw 异常对象throws异常类名(多个)作用真正抛出异常对象声明抛出的异常类型 运行时…
阅读更多...
【开发篇】一、处理函数：定时器与定时服务

【开发篇】一、处理函数：定时器与定时服务

文章目录 1、基本处理函数2、定时器和定时服务3、KeyedProcessFunction下演示定时器4、process重获取当前watermark 前面API篇完结&#xff0c;对数据的转换、聚合、窗口等&#xff0c;都是基于DataStream的&#xff0c;称DataStreamAPI&#xff0c;如图&#xff1a; 在Flink…
阅读更多...
【Linux08-进程信号】信号的一生……

【Linux08-进程信号】信号的一生……

今天&#xff0c;带来Linux下进程信号的讲解。文中不足错漏之处望请斧正&#xff01; 是什么 生活中的信号 例子: 红绿灯来电铃声老妈倒数321叫我起床外卖小哥叫我下楼拿外卖 理解: 过程&#xff1a;收到信号 → 分析信号 → 产生信号对应的行为信号不一定会被立即处理&…
阅读更多...
Flutter——最详细(Scaffold)使用教程

Flutter——最详细(Scaffold)使用教程

Scaffold简介 相当于界面的主体&#xff08;类似于安卓最外层PhoneWindow&#xff09;&#xff0c;组件的展示都必须依附于它。 使用场景&#xff1a; 每一个界面都是脚手架&#xff0c;通过它来进行架构实现&#xff0c;优美的布局效果。 属性作用appBar顶部的标题栏body显示整…
阅读更多...
Qwt QwtPlotMarker标记类详解

Qwt QwtPlotMarker标记类详解

1.概述 QwtPlotMarker类是Qwt绘图库中用于在图表上绘制标记的类。标记可以是垂直或水平线、直线、文本或箭头等。它可用于标记某个特定的位置、绘制参考线或注释信息。 以下是类继承关系图&#xff1a; 2.常用方法 设置标记的坐标。传入x和y坐标值&#xff0c;标记将被放置在…
阅读更多...
红黑树--讲解以及详细实现过程

红黑树--讲解以及详细实现过程

目录 红黑树理解红黑树概念红黑树性质 红黑树实现红黑树图解基础结构实现插入实现 红黑树理解 红黑树概念 红黑树&#xff0c;是一种二叉搜索树&#xff0c;但在每个结点上增加一个存储位表示结点的颜色&#xff0c;可以是Red或Black。 通过对任何一条从根到叶子的路径上各个…
阅读更多...
六零导航页SQL注入漏洞复现（CVE-2023-45951）

六零导航页SQL注入漏洞复现（CVE-2023-45951）

0x01 产品简介 LyLme Spage&#xff08;六零导航页&#xff09;是中国六零&#xff08;LyLme&#xff09;开源的一个导航页面。致力于简洁高效无广告的上网导航和搜索入口&#xff0c;支持后台添加链接、自定义搜索引擎&#xff0c;沉淀最具价值链接&#xff0c;全站无商业推广…
阅读更多...
前端（二十五）——前端实现 OCR 图文识别的详细步骤与示例代码

前端（二十五）——前端实现 OCR 图文识别的详细步骤与示例代码

&#x1f601;博主&#xff1a;小猫娃来啦 &#x1f601;文章核心&#xff1a;前端实现 OCR 图文识别的详细步骤与示例代码 文章目录 简介确定使用的 OCR API创建前端界面添加图像上传功能发送识别请求和处理识别结果完善代码添加注释结论附录 简介 在现代应用程序中&#xff…
阅读更多...
如何选择向量数据库｜Weaviate Cloud v.s. Zilliz Cloud

如何选择向量数据库｜Weaviate Cloud v.s. Zilliz Cloud

随着以 Milvus 为代表的向量数据库在 AI 产业界越来越受欢迎&#xff0c;传统数据库和检索系统也开始在快速集成专门的向量检索插件方面展开角逐。 例如 Weaviate 推出开源向量数据库&#xff0c;凭借其易用、开发者友好、上手快速、API 文档齐全等特点脱颖而出。同样&#xff…
阅读更多...
使用AOP切面实现日志记录功能

使用AOP切面实现日志记录功能

系列文章 1.SpringBoot整合RabbitMQ并实现消息发送与接收 2. 解析JSON格式参数 & 修改对象的key 3. VUE整合Echarts实现简单的数据可视化 4. Java中运用BigDecimal对字符串的数值进行加减乘除等操作 5. List&#xff1c;HashMap&#xff1c;String,String&#xff1e;&…
阅读更多...
【Javascript】函数（变量作用域）

【Javascript】函数（变量作用域）

变量&#xff1a;全局变量&#xff0c;局部变量 全局变量 挂载到window对象上的 var a全局变量;console.log(a);var a全局变量;console.log(window.a);var a全局变量;在控制台里输入a也能打印a的值 局部变量 函数体内部声明的变量 var a全局变量;function test(){var b局部…
阅读更多...
软考高级之系统架构师系列之UP、RUP、4+1视图、JAD、JRP、RAD

软考高级之系统架构师系列之UP、RUP、4+1视图、JAD、JRP、RAD

概述 软件工程是一个很庞杂的系统工程&#xff0c;而我们面对的软件需求也很复杂&#xff1a; 面对不同规模&#xff08;复杂度&#xff0c;模块量&#xff0c;用户量&#xff0c;开发周期等等&#xff09;的软件项目&#xff0c;人员储备不尽不同的开发团队也会采用不同的软…
阅读更多...
数据可视化在行业解决方案中的实践应用 ——华为云Astro Canvas大屏开发研究及指南

数据可视化在行业解决方案中的实践应用 ——华为云Astro Canvas大屏开发研究及指南

本文主要探讨华为云Astro Canvas在数据可视化大屏开发中的应用及效果。首先阐述Astro Canvas的基本概念、功能和特性说明&#xff0c;接着集中分析展示其在教育、金融、交通行业等不同领域实际应用案例&#xff1b;之后&#xff0c;详细介绍使用该工具进行大屏图表创建的开发指…
阅读更多...
22年下半年上午题

22年下半年上午题

计算机指令集 cpu的构成 存储器 决策表 原型模型 白盒测试 活动图 构件图 半圆是需接口&#xff0c;满圆是供接口&#xff0c;上图有小错误。 故障类型 b-树 排序算法复杂度 二分查找平均比较次数 成功查找比较平均次数 失败查找平均比较次数 如有 OSI 模型层次对应典型机器…
阅读更多...
Vue+ElementUI项目打包部署到Ubuntu服务器中

Vue+ElementUI项目打包部署到Ubuntu服务器中

1、修改config/index.js中的assetsPublicPath: /,修改为assetsPublicPath: ./ assetsPublicPath: ./2、在build/utils.js中增加publicPath: ../../ publicPath: ../../3、打开终端&#xff0c;在根目录下执行npm run build进行打包&#xff0c;打包成功后会生成dist npm run…
阅读更多...
前端使用 printJS 插件打印多页：第一页空白问题解决

前端使用 printJS 插件打印多页：第一页空白问题解决

printJS({printable: [data:image/jpg;base64,${this.printData.url}],type: image,style: media print { page {size: auto; margin: 0; } body{margin:0 5px}} // 解决出现多页打印时第一页空白问题 })
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023