Python Argparse Tutorial (Python Agrparse 教程)

2024-03-17 11:58
文章标签 python 教程 tutorial argparse agrparse

本文主要是介绍Python Argparse Tutorial (Python Agrparse 教程)，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本文内容来源于Python官方文档，均为本人翻译得来，部分内容可能翻译不准确或者不优雅，欢迎大家批评指正。

Argparse教程

argparse是Python标准库里的推荐的命令行解析模块。

Note: Python还有两个可以完成同样功能的模块，一个是getopt（和Ｃ语言中的getopt()函数等价的），还要一个是不太建议用的模块optparse。需要注意的是argparse是基于optparse的，因此它们在使用上是非常相似的。

基础

我们首先在prog.py中进行一些简单的定义，可以通过python3 prog.py来运行这段代码：

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

位置参数介绍

一个简单的例子：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)

运行以上代码：

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python3 prog.py --help
usage: prog.py [-h] echopositional arguments:echooptional arguments:-h, --help  show this help message and exit
$ python3 prog.py foo
foo

从上面的代码可以看出：

  • 我们添加了add_argument()方法，通过这个方法可以指定我们要让我们的代码接受什么命令行选项。
  • 我们运行代码时需要在命令行中添加我们需要的那个选项
  • parse_args()方法实际上从指定的选项中范湖一些数据，在上面的例子中，返回的是echo。

需要注意的是，尽管help看起来很有用，但是它目前还没有它看起来的那么有用。比如我们能够得知echo是一个位置参数，但是我们除了瞎猜或者是读源码，并不能知道它的作用是什么。所以，接下来会有一些更有用的：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)

看一下对上述代码的运行结果：

$ python3 prog.py -h
usage: prog.py [-h] echopositional arguments:echo        echo the string you use hereoptional arguments:-h, --help  show this help message and exit

接下来，我们再做一点更有用的：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)

下面是运行上述代码的结果：

$ python3 prog.py 4
Traceback (most recent call last):File "prog.py", line 5, in <module>print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

代码运行出现错误。这是因为除非我们指定选项，否则argparse默认把我们给的选项当成strings。所以，让我们来告诉argparse将输入的选项当作integer：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",type=int)
args = parser.parse_args()
print(args.square**2)

接下来是代码的运行结果：

$ python3 prog.py 4
16
$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

代码运行正确。程序现在甚至能够在处理之前对错误的输入进行识别并退出。

可选参数介绍

到目前为止我们已经能够玩转位置参数了。让我们来看看如何添加可选参数。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:print("verbosity turned on")

输入如下：

$ python3 prog.py --verbosity 1
verbosity turned on
$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]optional arguments:-h, --help            show this help message and exit--verbosity VERBOSITYincrease output verbosity
$ python3 prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

让我们来解释一下发生了什么：

  • 这一段代码的意思是当 --verbosity被指定的时候就显示一些东西，当其没有被指定的时候就什么也不显示。
  • 为了表明该选项实际上是可选的，在没有指定它的时候程序也能够正确运行。
  • 需要注意的是，在默认情况下，如果我们没有使用可选参数，那么与之相关的变量将被如遇None作为值，在上面的例子中，可选参数args.verbosity被赋予None值，这就是它无法测试if语句的真值的原因。
  • help提示信息是有所不同的。
  • 当使用--verbosity选项时，我们必须指定一些值，当然可以使任意值。

在上面的例子中，--verbosity可以接受任意值，但是对于我们简单的程序来说，只有两个值实际上是有用：True或者False。让我们相应的修改代码：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",action="store_true")
args = parser.parse_args()
if args.verbose:print("verbosity turned on")

对应的输出：

$ python3 prog.py --verbose
verbosity turned on
$ python3 prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python3 prog.py --help
usage: prog.py [-h] [--verbose]optional arguments:-h, --help  show this help message and exit--verbose   increase output verbosity

接下来解释一下发生了什么：

  • 这个选项现在更多的是一个标志，而不是需要一个值的东西。我们甚至更改了这个选项的名字以符合这个想法。需要注意的是，我们现在指定了一个新的关键字：action，并且赋予其一个值："store_true"。这意味着，如果这个选项被指定了，那么args.verbose会被赋予值True。如果我们不指定它，那么它会被赋予False。
  • 当你强行赋予它一个值时，它就会报错，因为它不知道真正的标志究竟是什么。
  • 注意看一下help文本的不同之处。

选项缩写

如果你对命令行的使用比较熟悉的话，你会发现我们还没有介绍有关选项的缩写版本的主题。当然它是很简单的：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",action="store_true")
args = parser.parse_args()
if args.verbose:print("verbosity turned on")

我们看一下代码运行的结果：

$ python3 prog.py -v
verbosity turned on
$ python3 prog.py --help
usage: prog.py [-h] [-v]optional arguments:-h, --help     show this help message and exit-v, --verbose  increase output verbosity

需要注意的是这个新的特点在help提示中也会反映出来。

结合位置参数与可选参数

我们的程序的复杂性持续增加：

import argparse
parser = 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)

接下来看一下程序的运行结果：

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python3 prog.py 4
16
$ python3 prog.py 4 --verbose
the square of 4 equals 16
$ python3 prog.py --verbose 4
the square of 4 equals 16
  • 我们在程序中重新加入了位置参数，因此带来了第一次运行的错误。
  • 需要注意的是选项的次序是不重要的。

现在让我们给这个程序一些拥有多个冗长值的能力，并且是加上使用一下它们：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,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)

接下来看一下程序的运行结果：

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python3 prog.py 4 -v 1
4^2 == 16
$ python3 prog.py 4 -v 2
the square of 4 equals 16
$ python3 prog.py 4 -v 3
16

这些结果看起来都是正常的，除了最后一个，最后一个暴露了我们程序里的一个bug。让我们通过限制--verbosity选项可以接受的值来修复这个问题：

import argparse
parser = 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)

接下来是程序的输出：

$ python3 prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v {0,1,2}] squarepositional arguments:square                display a square of a given numberoptional arguments:-h, --help            show this help message and exit-v {0,1,2}, --verbosity {0,1,2}increase output verbosity

需要注意的是这个变化也会反映在error信息和help信息中。

现在，让我们使用一个不同的方法来婉转verbosity，这个方法是非常普遍的。它也和CPython可执行程序处理其详细参数的方式匹配。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",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)

我们介绍了另一个action："count"，这个action的功能是计算特定可选参数出现的次数：

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
4^2 == 16
$ python3 prog.py 4 -vv
the square of 4 equals 16
$ python3 prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python3 prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v] squarepositional arguments:square           display a square of a given numberoptional arguments:-h, --help       show this help message and exit-v, --verbosity  increase output verbosity
$ python3 prog.py 4 -vvv
16
  • 是的，它现在更多的是我们的脚本的以前版本的一个标志（和action="store_true"类似）。这应该能解释出现的错误。
  • 它的行为也类似于"store_true"这个action。
  • 现在这里有一个对于"count" action输出的演示。你可能以前已经见过这种用法了。
  • 如果你不指定-v这个标志，这个标志默认是None值。
  • 正如我们预期的那样，指定标志的长格式，我们会得到同样的输出。
  • 比较令人难受的是，我们的帮助文档并不能给我们的脚本获得的新功能太多的信息，但是可以通过改进脚本的文档（例如通过帮助关键词参数）来解决问题。
  • 最后一个输出暴露了我们程序里的一个bug。

那么就让我们修复这个问题：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count",help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2# bugfix: replace == with >=
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)

接下来是输出：

$ python3 prog.py 4 -vvv
the square of 4 equals 16
$ python3 prog.py 4 -vvvv
the square of 4 equals 16
$ python3 prog.py 4
Traceback (most recent call last):File "prog.py", line 11, in <module>if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'
  • 第一个输出是正常的，并且修复了我们之前的那个bug。也就是说，我们希望任何>=2的值都尽可能作为verbose。
  • 第三个输出是有问题的。

 

未完待续

likebeta也翻译了一些，可以看一下他的Argparse简易教程

这篇关于Python Argparse Tutorial (Python Agrparse 教程)的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/818880。

相关文章

Python将博客内容html导出为Markdown格式

Python将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞？二、准备如何搞？三、说搞咱就搞！抓取文章提取内容构建html转存markdown
阅读更多...
Python获取中国节假日数据记录入JSON文件

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢？我尝试一种更为智能的方法：P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验，
阅读更多...
Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整
阅读更多...
Python Websockets库的使用指南

Python Websockets库的使用指南

《PythonWebsockets库的使用指南》pythonwebsockets库是一个用于创建WebSocket服务器和客户端的Python库,它提供了一种简单的方式来实现实时通信,支持异步和同步... 目录一、WebSocket 简介二、python 的 websockets 库安装三、完整代码示例1.
阅读更多...
揭秘Python Socket网络编程的7种硬核用法

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器：探测开放端口2.简易 HTTP 服务器：10 秒搭个网页3.局域网游戏：多人联机对战4.
阅读更多...
使用Python实现快速搭建本地HTTP服务器

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》：本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.
阅读更多...
Elasticsearch 在 Java 中的使用教程

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J
阅读更多...
Linux系统中卸载与安装JDK的详细教程

Linux系统中卸载与安装JDK的详细教程

《Linux系统中卸载与安装JDK的详细教程》本文详细介绍了如何在Linux系统中通过Xshell和Xftp工具连接与传输文件,然后进行JDK的安装与卸载,安装步骤包括连接Linux、传输JDK安装包... 目录1、卸载1.1 linux删除自带的JDK1.2 Linux上卸载自己安装的JDK2、安装2.1
阅读更多...
Python使用自带的base64库进行base64编码和解码

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意
阅读更多...
Python基于wxPython和FFmpeg开发一个视频标签工具

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2