python笔记8--命令行解析Argparse

2024-05-31 00:18

本文主要是介绍python笔记8--命令行解析Argparse,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

python笔记8--命令行解析Argparse

  • 1 功能
  • 2 源码案例
    • 2.1 默认功能
    • 2.3 添加说明
    • 2.4 设置参数类型
    • 2.5 设置参数可省略
    • 2.6 同时存在可省略和必须参数
    • 2.7 设置参数的范围
    • 2.8 结束案例
  • 3 说明

python获取输入参数的方式有多种,一种使用sys.argv获取输入的参数,然后根据值判断是否包括某个参数;第二种使用Argparse来获取和设置参数,该方法较实用,笔者查阅了相关资料并加以整理,放在此处以便于后续查阅和学习!

1 功能

  1. 默认功能
  2. 添加参数
  3. 添加说明
  4. 设置参数类型
  5. 设置参数可省略
  6. 同时存在可省略和必须参数
  7. 设置参数的范围
  8. 结束案例

2 源码案例

2.1 默认功能

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
args = parser.parse_args()

测试结果:
```bash
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg0.py
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg0.py -h
usage: arg0.py [-h]

optional arguments:-h, --help  show this help message and exit
默认有-h|--help帮助信息。
## 2.2 添加参数
源码:
```python
#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg1.py 
usage: arg1.py [-h] echo
arg1.py: error: the following arguments are required: echo
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg1.py -h
usage: arg1.py [-h] echopositional arguments:echooptional arguments:-h, --help  show this help message and exit
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg1.py test
test

添加一个echo参数,可以通过args.echo获取具体参数值。

2.3 添加说明

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.description = 'This is a basic test'
parser.add_argument("echo", help='print string')
args = parser.parse_args()
print(args.echo)

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg2.py -h
usage: arg2.py [-h] echoThis is a basic testpositional arguments:echo        print stringoptional arguments:-h, --help  show this help message and exit
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg2.py test2
test2

通过description添加说明,通过help对参数加以说明。

2.4 设置参数类型

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.description = 'This is a basic test, A+B'
parser.add_argument("paraA", help='this is int', type=int)
parser.add_argument("paraB", help='this is int', type=int)
args = parser.parse_args()
print('{0} + {1} = {2}'.format(args.paraA, args.paraB,args.paraA+args.paraB))

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg3.py pa pb
usage: arg3.py [-h] paraA paraB
arg3.py: error: argument paraA: invalid int value: 'pa'
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg3.py 1 2
1 + 2 = 3

通过type设置参数类型,设置类型后直接获取参数就可以执行相关运算。

2.5 设置参数可省略

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.description = 'This is a basic test, A+B'
parser.add_argument("--paraA", help='this is int', type=int)
parser.add_argument("--paraB", help='this is int', type=int)
args = parser.parse_args()
if args.paraA:print('A={0}'.format(args.paraA))
if args.paraB:print('B={0}'.format(args.paraB))
if args.paraA and args.paraB:print('{0} + {1} = {2}'.format(args.paraA, args.paraB,args.paraA+args.paraB))

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg4.py --paraA 1
A=1
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg4.py --paraB 1
B=1
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg4.py --      paraA 1 --paraB 2
A=1
B=2
1 + 2 = 3

在参数名称前加–即可设置参数为可省略;
通过 parser.add_argument(’-a’, “–paraA”, help=‘this is int’, type=int) 添加-a,也可以使用-a 1来简化参数输入。

parser.add_argument('-a', "--paraA", help='this is int', type=int)
parser.add_argument('-b', "--paraB", help='this is int', type=int)测试结果:
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg4.py -a 1 -b 2
A=1
B=2
1 + 2 = 3

2.6 同时存在可省略和必须参数

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:print("the square of {} equals {}".format(args.square, answer))
else:print(answer)

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg5.py -h
usage: arg5.py [-h] [-v] squarepositional arguments:square         display a square of a given numberoptional arguments:-h, --help     show this help message and exit-v, --verbose  increase output verbosity
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg5.py 3 --verbose
the square of 3 equals 9
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg5.py 3
9

–verbose 后添加action,且值为store_true,因此只要出现 --verbose 其值就为True,不需要额外对–verbose赋值;

2.7 设置参数的范围

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:print("{}^2 == {}".format(args.square, answer))
else:print(answer)

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg6.py 3 -v 3
usage: arg6.py [-h] [-v {0,1,2}] square
arg6.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg6.py 3 -v 1
3^2 == 9

通过choices=[]设置参数的范围,超出范围即报错;

2.8 结束案例

源码:

#!/usr/bin/pythonimport argparseparser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.yif args.quiet:print(answer)
elif args.verbose:print("{} to the power {} equals {}".format(args.x, args.y, answer))
else:print("{}^{} == {}".format(args.x, args.y, answer))

测试结果:

(py3_env) xg@xghome:~/file/code/python/argparse$ python arg7.py -h
usage: arg7.py [-h] [-v | -q] x ycalculate X to the power of Ypositional arguments:x              the basey              the exponentoptional arguments:-h, --help     show this help message and exit-v, --verbose-q, --quiet
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg7.py 2 3 -q
8
(py3_env) xg@xghome:~/file/code/python/argparse$ python arg7.py 2 3 -v
2 to the power 3 equals 8

3 说明

参考文献:
[1]Argparse Tutorial
[2]Python3.7 - Argparse模块讲解

这篇关于python笔记8--命令行解析Argparse的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1017131

相关文章

一文教你Python如何快速精准抓取网页数据

《一文教你Python如何快速精准抓取网页数据》这篇文章主要为大家详细介绍了如何利用Python实现快速精准抓取网页数据,文中的示例代码简洁易懂,具有一定的借鉴价值,有需要的小伙伴可以了解下... 目录1. 准备工作2. 基础爬虫实现3. 高级功能扩展3.1 抓取文章详情3.2 保存数据到文件4. 完整示例

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述:为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展

基于Python打造一个智能单词管理神器

《基于Python打造一个智能单词管理神器》这篇文章主要为大家详细介绍了如何使用Python打造一个智能单词管理神器,从查询到导出的一站式解决,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 项目概述:为什么需要这个工具2. 环境搭建与快速入门2.1 环境要求2.2 首次运行配置3. 核心功能使用指

Python实现微信自动锁定工具

《Python实现微信自动锁定工具》在数字化办公时代,微信已成为职场沟通的重要工具,但临时离开时忘记锁屏可能导致敏感信息泄露,下面我们就来看看如何使用Python打造一个微信自动锁定工具吧... 目录引言:当微信隐私遇到自动化守护效果展示核心功能全景图技术亮点深度解析1. 无操作检测引擎2. 微信路径智能获

Python中pywin32 常用窗口操作的实现

《Python中pywin32常用窗口操作的实现》本文主要介绍了Python中pywin32常用窗口操作的实现,pywin32主要的作用是供Python开发者快速调用WindowsAPI的一个... 目录获取窗口句柄获取最前端窗口句柄获取指定坐标处的窗口根据窗口的完整标题匹配获取句柄根据窗口的类别匹配获取句

利用Python打造一个Excel记账模板

《利用Python打造一个Excel记账模板》这篇文章主要为大家详细介绍了如何使用Python打造一个超实用的Excel记账模板,可以帮助大家高效管理财务,迈向财富自由之路,感兴趣的小伙伴快跟随小编一... 目录设置预算百分比超支标红预警记账模板功能介绍基础记账预算管理可视化分析摸鱼时间理财法碎片时间利用财

Python中的Walrus运算符分析示例详解

《Python中的Walrus运算符分析示例详解》Python中的Walrus运算符(:=)是Python3.8引入的一个新特性,允许在表达式中同时赋值和返回值,它的核心作用是减少重复计算,提升代码简... 目录1. 在循环中避免重复计算2. 在条件判断中同时赋值变量3. 在列表推导式或字典推导式中简化逻辑

python处理带有时区的日期和时间数据

《python处理带有时区的日期和时间数据》这篇文章主要为大家详细介绍了如何在Python中使用pytz库处理时区信息,包括获取当前UTC时间,转换为特定时区等,有需要的小伙伴可以参考一下... 目录时区基本信息python datetime使用timezonepandas处理时区数据知识延展时区基本信息

Python位移操作和位运算的实现示例

《Python位移操作和位运算的实现示例》本文主要介绍了Python位移操作和位运算的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 位移操作1.1 左移操作 (<<)1.2 右移操作 (>>)注意事项:2. 位运算2.1

Qt实现网络数据解析的方法总结

《Qt实现网络数据解析的方法总结》在Qt中解析网络数据通常涉及接收原始字节流,并将其转换为有意义的应用层数据,这篇文章为大家介绍了详细步骤和示例,感兴趣的小伙伴可以了解下... 目录1. 网络数据接收2. 缓冲区管理(处理粘包/拆包)3. 常见数据格式解析3.1 jsON解析3.2 XML解析3.3 自定义