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。

相关文章

使用Python和OpenCV库实现实时颜色识别系统

使用Python和OpenCV库实现实时颜色识别系统

《使用Python和OpenCV库实现实时颜色识别系统》：本文主要介绍使用Python和OpenCV库实现的实时颜色识别系统,这个系统能够通过摄像头捕捉视频流,并在视频中指定区域内识别主要颜色（红... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间详解
阅读更多...
SQLite3命令行工具最佳实践指南

SQLite3命令行工具最佳实践指南

《SQLite3命令行工具最佳实践指南》SQLite3是轻量级嵌入式数据库,无需服务器支持,具备ACID事务与跨平台特性,适用于小型项目和学习,sqlite3.exe作为命令行工具,支持SQL执行、数... 目录1. SQLite3简介和特点2. sqlite3.exe使用概述2.1 sqlite3.exe
阅读更多...
一文深入详解Python的secrets模块

一文深入详解Python的secrets模块

《一文深入详解Python的secrets模块》在构建涉及用户身份认证、权限管理、加密通信等系统时,开发者最不能忽视的一个问题就是“安全性”,Python在3.6版本中引入了专门面向安全用途的secr... 目录引言一、背景与动机：为什么需要 secrets 模块？二、secrets 模块的核心功能1. 基
阅读更多...
python常见环境管理工具超全解析

python常见环境管理工具超全解析

《python常见环境管理工具超全解析》在Python开发中,管理多个项目及其依赖项通常是一个挑战,下面：本文主要介绍python常见环境管理工具的相关资料,文中通过代码介绍的非常详细,需要的朋友... 目录1. conda2. pip3. uvuv 工具自动创建和管理环境的特点4. setup.py5.
阅读更多...
Python常用命令提示符使用方法详解

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,：本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安
阅读更多...
Python UV安装、升级、卸载详细步骤记录

Python UV安装、升级、卸载详细步骤记录

《PythonUV安装、升级、卸载详细步骤记录》：本文主要介绍PythonUV安装、升级、卸载的详细步骤,uv是Astral推出的下一代Python包与项目管理器,主打单一可执行文件、极致性能... 目录安装检查升级设置自动补全卸载UV 命令总结 官方文档详见：https://docs.astral.sh/
阅读更多...
全面解析HTML5中Checkbox标签

全面解析HTML5中Checkbox标签

《全面解析HTML5中Checkbox标签》Checkbox是HTML5中非常重要的表单元素之一，通过合理使用其属性和样式自定义方法，可以为用户提供丰富多样的交互体验，这篇文章给大家介绍HTML5中C... 在html5中，Checkbox（复选框）是一种常用的表单元素，允许用户在一组选项中选择多个项目。本
阅读更多...
Python并行处理实战之如何使用ProcessPoolExecutor加速计算

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.
阅读更多...
Python中help()和dir()函数的使用

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象（如模块、类、函数等）的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(
阅读更多...
Python虚拟环境与Conda使用指南分享

Python虚拟环境与Conda使用指南分享

《Python虚拟环境与Conda使用指南分享》：本文主要介绍Python虚拟环境与Conda使用指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、python 虚拟环境概述1.1 什么是虚拟环境1.2 为什么需要虚拟环境二、Python 内置的虚拟环境工具
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2