《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 的应用场景很明确就是为自己的程序提供命令行接口说明,


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


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

目录
相关文章
|
28天前
|
C语言 Python
python 调用c接口
【10月更文挑战第12天】 ctypes是Python的一个外部库,提供和C语言兼容的数据类型,可以很方便地调用C DLL中的函数
48 0
|
12天前
|
测试技术 API 数据安全/隐私保护
Python连接到Jira实例、登录、查询、修改和创建bug
通过使用Python和Jira的REST API,可以方便地连接到Jira实例并进行各种操作,包括查询、修改和创建Bug。`jira`库提供了简洁的接口,使得这些操作变得简单易行。无论是自动化测试还是开发工作流的集成,这些方法都可以极大地提高效率和准确性。希望通过本文的介绍,您能够更好地理解和应用这些技术。
48 0
|
1月前
|
Python
Python中的push方法详解与实例
Python中的push方法详解与实例
|
1月前
|
JSON 缓存 API
在 Python 中使用公共类处理接口请求的响应结果
在 Python 中使用公共类处理接口请求的响应结果
28 1
|
1月前
|
Python
Python 练习实例100
Python 练习实例100
|
1月前
|
Python
Python 练习实例98
Python 练习实例98
|
1月前
|
数据处理 Python
Python内置时间模块:Datetime实例详解(一)
Python内置时间模块:Datetime实例详解(一)
|
1月前
|
Python
Python 练习实例99
Python 练习实例99
|
2月前
|
Python
Python 练习实例94
Python 练习实例94
|
2月前
|
Python
Python 练习实例92
Python 练习实例92