argparse是你的好帮手:快速编写自动化脚本、测试脚本、数据处理脚本

简介: argparse是你的好帮手:快速编写自动化脚本、测试脚本、数据处理脚本

在软件开发过程中,命令行界面 是非常常见的一种交互方式。而在 Python 中的 argparse 是一个非常有用的内置模块,它可以帮助我们轻松地编写用户友好的命令行界面,并解析命令行参数。


argparse 提供了丰富的功能和选项,可以让我们快速构建高度定制化的命令行界面,并且可以减少代码的重复性和错误性。

image.png

本篇文章,小编将会深入探讨 argparse 的高级用法和技巧,并提供一些实用的案例来帮助您更好地掌握这个模块。无论您是 Python 初学者还是有经验的开发者,都可以从本篇技术文章中学到有用的知识,并在实际开发中应用 argparse 来提高代码的可维护性和易用性。


介绍:


Python内置模块argparse是一个命令行参数解析器,可以让我们方便地编写命令行接口。argparse可以自动生成帮助信息,支持多种参数类型,可以定义参数的默认值和范围等。在编写命令行工具时,argparse是必不可少的工具之一。

image.png

主要功能:


  • 生成帮助信息:argparse可以自动生成帮助信息,包括程序的使用方法、参数列表和默认值等。
  • 支持多种参数类型:argparse支持多种参数类型,包括字符串、整数、浮点数、布尔值等。
  • 参数解析:argparse可以解析命令行参数,并将它们转换为Python对象。
  • 参数限制:argparse可以限制参数的取值范围,以及参数的个数。
  • 子命令:argparse支持子命令,可以让我们编写复杂的命令行程序。


argparse 的使用场景包括但不限于以下几个方面:


  • 编写命令行工具 argparse可以帮助我们编写命令行工具,例如git、pip等,使得我们的命令行工具更加易用、规范、清晰。
  • 编写自动化脚本 argparse可以帮助我们编写自动化脚本,例如备份脚本、定时任务脚本等,使得我们的脚本更加易用、可配置、可维护。
  • 编写测试脚本 argparse可以帮助我们编写测试脚本,例如性能测试脚本、压力测试脚本等,使得我们的测试脚本更加易用、可配置、可复用。
  • 编写数据处理脚本 argparse可以帮助我们编写数据处理脚本,例如数据清洗脚本、数据分析脚本等,使得我们的数据处理更加规范、清晰、可重现。


使用方法:


首先,我们需要导入argparse模块:

import argparse

然后创建ArgumentParser对象,用于定义命令行参数:

parser = argparse.ArgumentParser(description='命令行工具的描述信息')

其中,description 为可选参数,用于定义命令行工具的描述信息。


接下来可以使用 add_argument() 方法添加命令行参数:

parser.add_argument('filename', help='文件名')
parser.add_argument('--count', type=int, default=1, help='重复次数')
parser.add_argument('--verbose', action='store_true', help='详细输出')

其中,第一个参数是参数名,第二个参数是帮助信息。如果参数是可选的,我们可以使用--开头的长选项,例如--count。如果参数是布尔类型的,我们可以使用action='store_true',例如--verbose。


最后,使用 parse_args() 方法解析命令行参数:

args = parser.parse_args()

这个方法会返回一个对象,其中包含了所有解析出来的参数。我们可以通过属性名来访问这些参数。

可以使用 args. 参数名的方式获取命令行参数的值:

print(args.filename)
print(args.count)
print(args.verbose)

下面是一个使用argparse模块的例子:

import argparse
parser = argparse.ArgumentParser(description='命令行工具的描述信息')
parser.add_argument('filename', help='文件名')
parser.add_argument('--count', type=int, default=1, help='重复次数')
parser.add_argument('--verbose', action='store_true', help='详细输出')
args = parser.parse_args()
for i in range(args.count):
    print(args.filename)
if args.verbose:
    print('完成')

在命令行中执行该脚本,可以输入命令行参数,例如:

python program.py file.txt --count 3 --verbose

执行结果如下:

file.txt
file.txt
file.txt
完成

这是一个简单的示例程序,它接收一个文件名和两个可选参数。如果--verbose选项被指定,它会输出“完成”字样。如果--count选项被指定,它会重复输出文件名。


高级用法


子命令


当我们的命令行工具需要多个子命令时,我们可以使用argparse的子命令功能。


例如,我们可以编写一个 git 命令行工具,它有多个子命令,如 add、commit、push 等。我们可以使用 add_subparsers 方法来添加子命令,并在每个子命令中添加自己的参数。

import argparse
# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='Git 命令行工具')
# 添加子命令
subparsers = parser.add_subparsers(dest='command', help='子命令')
subparsers.required = True
# add 子命令
add_parser = subparsers.add_parser('add', help='添加文件')
add_parser.add_argument('file', help='文件名')
# commit 子命令
commit_parser = subparsers.add_parser('commit', help='提交代码')
commit_parser.add_argument('-m', '--message', help='提交信息')
# push 子命令
push_parser = subparsers.add_parser('push', help='推送代码')
push_parser.add_argument('-f', '--force', action='store_true', help='强制推送')

自定义类型


有时候我们需要解析自定义类型的参数,例如日期、时间等。我们可以使用 argparse 的 type 参数来指定解析函数。


例如,我们可以编写一个解析日期的函数,并将其传递给type参数。

import argparse
from datetime import datetime
# 解析日期参数的函数
def parse_date(date_str):
    try:
        return datetime.strptime(date_str, '%Y-%m-%d').date()
    except ValueError:
        raise argparse.ArgumentTypeError('日期格式应为YYYY-MM-DD')
# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='计算两个日期之间的天数')
# 添加参数
parser.add_argument('start_date', type=parse_date, help='起始日期')
parser.add_argument('end_date', type=parse_date, help='结束日期')

自定义帮助信息


当我们需要自定义帮助信息时,我们可以使用argparse的help参数和formatter_class参数。


例如,我们可以编写一个自定义的帮助信息类,并将其传递给formatter_class参数。

import argparse
# 自定义帮助信息类
class CustomHelpFormatter(argparse.HelpFormatter):
    def __init__(self, prog):
        super().__init__(prog, max_help_position=30, width=100)
    def _format_action(self, action):
        parts = super()._format_action(action)
        if action.help == argparse.SUPPRESS:
            parts = ''
        return parts
# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='计算两个数的和', formatter_class=CustomHelpFormatter)
# 添加参数
parser.add_argument('a', type=int, help='第一个数')
parser.add_argument('b', type=int, help='第二个数')

参数组


当我们的命令行参数比较多时,我们可以使用argparse的参数组功能来将参数分组,使命令行界面更加清晰。我们可以使用add_argument_group方法来创建参数组,并在其中添加参数。


这些是argparse的一些高级用法,可以帮助我们更好地定制化我们的命令行工具,并提高开发效率。

import argparse
# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='命令行工具')
# 创建参数组
group1 = parser.add_argument_group('参数组1')
group1.add_argument('--foo', help='参数1')
group1.add_argument('--bar', help='参数2')
group2 = parser.add_argument_group('参数组2')
group2.add_argument('--baz', help='参数3')
group2.add_argument('--qux', help='参数4')

总结


argparse是Python标准库中用于解析命令行参数的模块,它提供了简单易用的API,可以轻松地解析命令行参数,并生成帮助信息。argparse支持多种参数类型、参数默认值、参数组、子命令等高级用法。同时,argparse还可以与argcomplete库结合使用,为我们的命令行工具添加自动补全功能。使用argparse可以使我们的命令行工具更加易用、规范、清晰。

相关文章
|
10天前
|
人工智能 自然语言处理 测试技术
从人工到AI驱动:天猫测试全流程自动化变革实践
天猫技术质量团队探索AI在测试全流程的落地应用,覆盖需求解析、用例生成、数据构造、执行验证等核心环节。通过AI+自然语言驱动,实现测试自动化、可溯化与可管理化,在用例生成、数据构造和执行校验中显著提效,推动测试体系从人工迈向AI全流程自动化,提升效率40%以上,用例覆盖超70%,并构建行业级知识资产沉淀平台。
从人工到AI驱动:天猫测试全流程自动化变革实践
|
10天前
|
人工智能 运维 监控
当AI遇上自动化:运维测试终于不“加班”了
当AI遇上自动化:运维测试终于不“加班”了
105 9
|
16天前
|
人工智能 自然语言处理 JavaScript
利用MCP Server革新软件测试:更智能、更高效的自动化
MCP Server革新软件测试:通过标准化协议让AI实时感知页面结构,实现自然语言驱动、自适应维护的自动化测试,大幅提升效率,降低脚本开发与维护成本,推动测试左移与持续测试落地。
|
1月前
|
存储 关系型数据库 测试技术
玩转n8n测试自动化:核心节点详解与测试实战指南
n8n中节点是自动化测试的核心,涵盖触发器、数据操作、逻辑控制和工具节点。通过组合节点,测试工程师可构建高效、智能的测试流程,提升测试自动化能力。
|
1月前
|
测试技术 Linux
VPS一键测试脚本,无痕体验+自动导出,服务器测试更轻松
NodeQuality 是一款整合 Yabs、IPQuality、NetQuality 等主流 VPS 测试脚本的全能工具,支持一键测试硬件性能、IP属性、网络质量,并新增分享与导出功能。其“无痕测试”设计不安装依赖、不留残留,兼容性强;测试结果自动排版、截图并生成分享链接,极大提升效率。适合需要全面、快速、干净测试 VPS 的用户,是运维和测评的高效利器。
151 3
|
2月前
|
存储 人工智能 算法
AI测试平台实战:深入解析自动化评分和多模型对比评测
在AI技术迅猛发展的今天,测试工程师面临着如何高效评估大模型性能的全新挑战。本文将深入探讨AI测试平台中自动化评分与多模型对比评测的关键技术与实践方法,为测试工程师提供可落地的解决方案。
|
3月前
|
JSON JavaScript 测试技术
用Postman玩转电商API:一键测试+自动化请求教程
Postman 是电商 API 测试的高效工具,涵盖基础配置、自动化测试、环境管理与请求自动化,助你快速提升开发效率。
|
1月前
|
机器学习/深度学习 人工智能 测试技术
EdgeMark:嵌入式人工智能工具的自动化与基准测试系统——论文阅读
EdgeMark是一个面向嵌入式AI的自动化部署与基准测试系统,支持TensorFlow Lite Micro、Edge Impulse等主流工具,通过模块化架构实现模型生成、优化、转换与部署全流程自动化,并提供跨平台性能对比,助力开发者在资源受限设备上高效选择与部署AI模型。
236 9
EdgeMark:嵌入式人工智能工具的自动化与基准测试系统——论文阅读
|
3月前
|
XML jenkins 机器人
JMeter+Ant+Jenkins实现接口自动化测试持续集成
本文介绍了如何使用Ant生成JMeter接口测试报告,并集成到Jenkins中实现自动化测试。内容涵盖Ant与JMeter环境配置、build.xml文件设置、测试执行及报告生成,同时包括Jenkins插件安装、项目配置和钉钉消息通知的集成,帮助实现持续测试与结果可视化。
539 0