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


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


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

目录
相关文章
|
4天前
|
SQL API Python
Python DB API下规范下cursor对象常用接口
Python DB API下规范下cursor对象常用接口。
22 4
|
3天前
|
存储 Java 数据安全/隐私保护
Python----类对象和实例对象
Python----类对象和实例对象
9 2
|
3天前
|
Web App开发 设计模式 测试技术
python自动化测试实战 —— 自动化测试框架的实例
python自动化测试实战 —— 自动化测试框架的实例
15 0
|
4天前
|
数据采集 NoSQL 中间件
python-scrapy框架(四)settings.py文件的用法详解实例
python-scrapy框架(四)settings.py文件的用法详解实例
10 0
|
3天前
|
监控 PHP Python
1688快速获取整店铺列表 采集接口php Python
在电子商务的浪潮中,1688平台作为中国领先的批发交易平台,为广大商家提供了一个展示和销售商品的广阔舞台;然而,要在众多店铺中脱颖而出,快速获取商品列表并进行有效营销是关键。
|
4天前
|
数据可视化 Python
python中Copula在多元联合分布建模可视化2实例合集|附数据代码
python中Copula在多元联合分布建模可视化2实例合集|附数据代码
|
3天前
|
机器学习/深度学习 存储 算法
Python套索回归lasso、SCAD、LARS分析棒球运动员薪水3个实例合集|附数据代码
Python套索回归lasso、SCAD、LARS分析棒球运动员薪水3个实例合集|附数据代码
|
4天前
|
机器学习/深度学习 算法 数据挖掘
【视频】支持向量机算法原理和Python用户流失数据挖掘SVM实例(下)
【视频】支持向量机算法原理和Python用户流失数据挖掘SVM实例(下)
|
4天前
|
机器学习/深度学习 算法 搜索推荐
【视频】支持向量机算法原理和Python用户流失数据挖掘SVM实例(上)
【视频】支持向量机算法原理和Python用户流失数据挖掘SVM实例
|
4天前
|
人工智能 安全 数据安全/隐私保护
Python中多种生成随机密码超实用实例
Python中多种生成随机密码超实用实例
13 0