《Python实例》基础之argparse,提供一个友好的接口说明,老大说我做的真好

简介: python经常是作为脚本在使用,在大部分的时候我们写的脚本都要给其他人使用,参数的调用常规的情况下需要提供说明文档,说明每个参数是怎么使用的,但是如果是给同组内的程序同学使用,大都不愿意写文档,对于我们程序同学来说写代码更简单,再说源码都给你了要什么文档。

c7d12dc77a6943dd99aac361f2959733~tplv-k3u1fbpfcp-zoom-crop-mark_1304_1304_1304_734.webp.jpg

这是我参与8月更文挑战的第2天**,活动详情查看:8月更文挑战**


python经常是作为脚本在使用,在大部分的时候我们写的脚本都要给其他人使用,参数的调用常规的情况下需要提供说明文档,说明每个参数是怎么使用的,但是如果是给同组内的程序同学使用,大都不愿意写文档,对于我们程序同学来说写代码更简单,再说源码都给你了要什么文档。


提供文档太费时,又写不好,不提供文档吧又不太又好,今天在python中发现了一个参数解析器,完美的解决这个问题,今天讲一下参数解析器的使用,好了,废话蛮多了,开始吧。


1、模块介绍 模块的源码位置 lib/argparse,如果你在代码中使用的不是这个位置,说明你导入错了。


argparse 可以让你轻松的编写用户友好的命令行接口, argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。


2、来个例子 打开控制台,切换到代码所在的位置,然后输入命令:


python ModifyFile.py -h 命令格式:python fileName.py -h


python :表示执行python命令


ModifyFile.py :是我python的文件


-h :表示查看文档

b5c193047bc046419528bf829e54b517~tplv-k3u1fbpfcp-zoom-in-crop-mark_1304_0_0_0.webp.jpg

可以看到提示了脚本的使用情况,以及三个参数的说明,完美。


3、自己做个 说再多没有用,怎么做呐?直接代码展示


#!/usr/bin/env python
# encoding: utf-8
"""
@Author: 香菜
@time: 2021/8/2 0002 下午 8:02
"""
import argparse
def get_parser():
   parser = argparse.ArgumentParser(description='工作目录中文件后缀名修改')
   parser.add_argument('work_dir', metavar='WORK_DIR', type=str, nargs=1,help='修改后缀名的文件目录')
   parser.add_argument('old_ext', metavar='OLD_EXT',type=str, nargs=1, help='原来的后缀')
   parser.add_argument('new_ext', metavar='NEW_EXT',type=str, nargs=1, help='新的后缀')
   return parser
if __name__ == '__main__':
   parser = get_parser()
   args = vars(parser.parse_args())
   # 从命令行参数中依次解析出参数
   work_dir = args['work_dir'][0]
   old_ext = args['old_ext'][0]
   print("follow me")
复制代码


步骤总结:


1、创建一个参数解析器 argparse.ArgumentParser(description='工作目录中文件后缀名修改')


2、增加几个参数 parser.add_argument('work_dir', metavar='WORK_DIR', type=str, nargs=1,help='修改后缀名的文件目录')


3、在使用参数的地方读取参数 vars(parser.parse_args())


4、在idea中如何调用 4.1 在命令行界面查看说明文档


python argFile.py -h 注:这个执行会直接调用 get_parser 方法,你可以加个 print 在函数内验证一下


4.2 调用这个文件执行:


python argFile.py 'aa' 'jpg' 'png' 4.3 Pycharm 中调用传参文件


在Pycharm 中执行需要参数的文件如果不传递参数会报下面的错误

4b88848d0edb44458431d02c8ac95147~tplv-k3u1fbpfcp-zoom-in-crop-mark_1304_0_0_0.webp.jpg

idea 传递参数也很简单,如下图:

d4b7007688034dcb8905451f6bd418a6~tplv-k3u1fbpfcp-zoom-in-crop-mark_1304_0_0_0.webp.jpg

注:参数之间空格隔开


debug执行结果看下,可以看到已经能获取到输入的三个参数,完美

f18339d5050043f7a78991e940cc07b1~tplv-k3u1fbpfcp-zoom-in-crop-mark_1304_0_0_0.webp.jpg

5、总结 argparse 的应用场景很明确就是为自己的程序提供命令行接口说明,


这只是入门级别的,如果你想给你的程序更好的参数提示,可以查阅相关文档。


模块的使用频率比较少,但是也需要掌握,如果别人不会只有你会是不是也很牛逼。加油

目录
相关文章
|
18天前
|
存储 缓存 JavaScript
python实战篇:利用request库打造自己的翻译接口
python实战篇:利用request库打造自己的翻译接口
31 1
python实战篇:利用request库打造自己的翻译接口
|
1月前
|
数据采集 JSON API
如何实现高效率超简洁的实时数据采集?——Python实战电商数据采集API接口
你是否曾为获取重要数据而感到困扰?是否因为数据封锁而无法获取所需信息?是否因为数据格式混乱而头疼?现在,所有这些问题都可以迎刃而解。让我为大家介绍一款强大的数据采集API接口。
|
1月前
|
测试技术 Python
Python中的装饰器:概念、用法及实例
【2月更文挑战第25天】 装饰器在Python中是一种强大的工具,它允许我们在不修改原始函数代码的情况下,增加函数的功能。本文将深入探讨装饰器的概念,解析其工作原理,并通过实例来展示如何在Python中使用装饰器。
|
1月前
|
存储 缓存 Python
Python中的装饰器:概念、用法和实例
【2月更文挑战第25天】 在Python编程中,装饰器是一种强大的工具,它允许我们在不修改原始函数代码的情况下,增加或修改函数的行为。本文将深入探讨装饰器的概念、用法以及通过实例来使其更易于理解。我们将看到,装饰器不仅仅是语法糖,而是一种可以极大提高代码复用性和可读性的有效工具。
|
1月前
|
Python
Python 中的装饰器:概念、用法和实例
【2月更文挑战第23天】 在编程世界中,装饰器是一种强大的工具,它允许我们在不改变现有代码的情况下增加或修改函数和类的行为。本文将深入探讨 Python 中装饰器的概念、用法以及如何创建自定义装饰器。我们将通过实例来演示装饰器的实用性和灵活性,帮助读者更好地理解和应用这一技术。
|
1月前
|
机器学习/深度学习 人工智能 数据可视化
Python在数据分析中的威力及应用实例
本文探讨了Python在数据分析领域的重要性和灵活性,着重介绍了Python在大数据处理、机器学习和可视化方面的应用实例,展示了其强大的功能和便捷的特点。
|
1月前
|
测试技术 开发者 Python
Python中的装饰器:概念、应用与实例
【2月更文挑战第22天】 本文深入探讨了Python中的一个重要特性——装饰器。我们将详细解析装饰器的概念,阐述其在Python编程中的应用,并通过具体的代码实例来展示其使用方法和效果。无论你是Python初学者还是有经验的开发者,本文都将帮助你更好地理解和使用装饰器。
16 0
|
7天前
|
存储 机器学习/深度学习 数据可视化
Python面板时间序列数据预测:格兰杰因果关系检验Granger causality test药品销售实例与可视化
Python面板时间序列数据预测:格兰杰因果关系检验Granger causality test药品销售实例与可视化
56 6
|
7天前
|
机器学习/深度学习 数据可视化 算法
PYTHON用决策树分类预测糖尿病和可视化实例
PYTHON用决策树分类预测糖尿病和可视化实例
16 0
|
8天前
|
算法 数据可视化 Python
Python中LARS和Lasso回归之最小角算法Lars分析波士顿住房数据实例
Python中LARS和Lasso回归之最小角算法Lars分析波士顿住房数据实例
13 0

热门文章

最新文章