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

2024-05-31 00:18
文章标签 python 笔记 解析 命令行 argparse

本文主要是介绍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。

相关文章

Linux中shell解析脚本的通配符、元字符、转义符说明

Linux中shell解析脚本的通配符、元字符、转义符说明

《Linux中shell解析脚本的通配符、元字符、转义符说明》：本文主要介绍shell通配符、元字符、转义符以及shell解析脚本的过程,通配符用于路径扩展,元字符用于多命令分割,转义符用于将特殊... 目录一、linux shell通配符(wildcard)二、shell元字符（特殊字符 Meta）三、s
阅读更多...
Python脚本实现自动删除C盘临时文件夹

Python脚本实现自动删除C盘临时文件夹

《Python脚本实现自动删除C盘临时文件夹》在日常使用电脑的过程中,临时文件夹往往会积累大量的无用数据,占用宝贵的磁盘空间,下面我们就来看看Python如何通过脚本实现自动删除C盘临时文件夹吧... 目录一、准备工作二、python脚本编写三、脚本解析四、运行脚本五、案例演示六、注意事项七、总结在日常使用
阅读更多...
Python将大量遥感数据的值缩放指定倍数的方法(推荐)

Python将大量遥感数据的值缩放指定倍数的方法(推荐)

《Python将大量遥感数据的值缩放指定倍数的方法(推荐)》本文介绍基于Python中的gdal模块,批量读取大量多波段遥感影像文件,分别对各波段数据加以数值处理,并将所得处理后数据保存为新的遥感影像... 本文介绍基于python中的gdal模块，批量读取大量多波段遥感影像文件，分别对各波段数据加以数值处
阅读更多...
python管理工具之conda安装部署及使用详解

python管理工具之conda安装部署及使用详解

《python管理工具之conda安装部署及使用详解》这篇文章详细介绍了如何安装和使用conda来管理Python环境,它涵盖了从安装部署、镜像源配置到具体的conda使用方法,包括创建、激活、安装包... 目录pytpshheraerUhon管理工具：conda部署+使用一、安装部署1、 下载2、 安装3
阅读更多...
Python进阶之Excel基本操作介绍

Python进阶之Excel基本操作介绍

《Python进阶之Excel基本操作介绍》在现实中,很多工作都需要与数据打交道,Excel作为常用的数据处理工具,一直备受人们的青睐,本文主要为大家介绍了一些Python中Excel的基本操作,希望... 目录概述写入使用 xlwt使用 XlsxWriter读取修改概述在现实中，很多工作都需要与数据打交
阅读更多...
使用Python实现在Word中添加或删除超链接

使用Python实现在Word中添加或删除超链接

《使用Python实现在Word中添加或删除超链接》在Word文档中,超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能,本文将为大家介绍一下Python如何实现在Word中添加或... 在Word文档中，超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能。通过添加超
阅读更多...
Python MySQL如何通过Binlog获取变更记录恢复数据

Python MySQL如何通过Binlog获取变更记录恢复数据

《PythonMySQL如何通过Binlog获取变更记录恢复数据》本文介绍了如何使用Python和pymysqlreplication库通过MySQL的二进制日志（Binlog）获取数据库的变更记录... 目录python mysql通过Binlog获取变更记录恢复数据1.安装pymysqlreplicat
阅读更多...
利用Python编写一个简单的聊天机器人

利用Python编写一个简单的聊天机器人

《利用Python编写一个简单的聊天机器人》这篇文章主要为大家详细介绍了如何利用Python编写一个简单的聊天机器人,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 使用 python 编写一个简单的聊天机器人可以从最基础的逻辑开始，然后逐步加入更复杂的功能。这里我们将先实现一个简单的
阅读更多...
基于Python开发电脑定时关机工具

基于Python开发电脑定时关机工具

《基于Python开发电脑定时关机工具》这篇文章主要为大家详细介绍了如何基于Python开发一个电脑定时关机工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 简介2. 运行效果3. 相关源码1. 简介这个程序就像一个“忠实的管家”，帮你按时关掉电脑，而且全程不需要你多做
阅读更多...
Python实现高效地读写大型文件

Python实现高效地读写大型文件

《Python实现高效地读写大型文件》Python如何读写的是大型文件,有没有什么方法来提高效率呢,这篇文章就来和大家聊聊如何在Python中高效地读写大型文件,需要的可以了解下... 目录一、逐行读取大型文件二、分块读取大型文件三、使用 mmap 模块进行内存映射文件操作（适用于大文件）四、使用 pand
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2