Python 基础(二十一):argparse 模块

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
简介: Python argparse 模块

1. 简介

argparse 模块主要用于处理 Python 命令行参数和选项,程序定义好所需参数后,该模块会通过 sys.argv 解析出那些参数;除此之外,argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。使用 argparse 模块,我们可以轻松的编写出用户友好的命令行接口。

2. 使用

我们先来看一个简单示例:

import argparse

# 创建解析对象
parser = argparse.ArgumentParser()
# 解析
parser.parse_args()

文件名为 test.py,在控制输入命令:python test.py --help,执行结果:

usage: test.py [-h]

optional arguments:
  -h, --help  show this help message and exit

通过上面的执行结果,我们可以看出 Python 的可选参数包括:--help 和其简写 -h,Python 使用 - 来指定短参数,使用 -- 来指定长参数 ,我们执行一下 python test.py -h,执行结果:

usage: test.py [-h]

optional arguments:
  -h, --help  show this help message and exit

如果使用未定义的参数会报错,如:执行命令 python test.py -a,执行结果:

usage: test.py [-h]
test.py: error: unrecognized arguments: -a

接下来我们看一下如何自定义参数,因为上面示例中 ArgumentParser()parse_args() 函数,我们还没有详细说,所以这里我们也具体看一下:

ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

这个方法是用来创建解析器对象的,看一下方法中每一个参数的含义:

  • prog:程序的名称(默认:sys.argv[0])

  • usage:描述程序用途的字符串(默认值:从添加到解析器的参数生成)

  • description:在参数帮助文档之前显示的文本(默认值:无)

  • epilog:在参数帮助文档之后显示的文本(默认值:无)

  • parents:一个 ArgumentParser 对象的列表,它们的参数也应包含在内

  • formatter_class:用于自定义帮助文档输出格式的类

  • prefix_chars:可选参数的前缀字符集合(默认值:'-')

  • fromfile_prefix_chars:当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)

  • argument_default:参数的全局默认值(默认值: None)

  • conflict_handler:解决冲突选项的策略(通常是不必要的)

  • add_help:为解析器添加一个 -h/--help 选项(默认值: True)

  • allow_abbrev:如果缩写是无歧义的,则允许缩写长选项 (默认值:True)

parse_args(args=None, namespace=None)

用来解析参数,看一下参数说明:

  • args:要分析的字符串列表,默认取自 sys.argv

  • namespace:命名空间

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义单个的命令行参数应当如何解析,看一下参数说明:

  • name or flags:一个命名或者一个选项字符串的列表,例如:-f,--foo

  • action:当参数在命令行中出现时使用的动作基本类型

  • nargs:命令行参数应当消耗的数目

  • const:被一些 action 和 nargs 选择所需求的常数

  • default:当参数未在命令行中出现时使用的值

  • type:命令行参数应当被转换成的类型

  • choices:可用的参数的容器

  • required:此命令行选项是否可省略

  • help:一个选项作用的简单描述

  • metavar:在使用方法消息中使用的参数值示例

  • dest:被添加到 parse_args() 所返回对象上的属性名

下面我们通过具体示例看一下:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(
        '-n', '--name', dest='rname', required=True,
        help='increase output name'
    )
args = parser.parse_args()
name = args.rname
print('Hello', name)

先在控制台执行命令 python test.py -h,执行结果:

usage: test.py [-h] -n RNAME

optional arguments:
  -h, --help            show this help message and exit
  -n RNAME, --name RNAME
                        increase output name

我们可以看到参数已经添加进来了,接着执行命令 python test.py -n Jhonpython test.py --name Jhon,执行结果:

Hello Jhon

从结果可以看出我们已经获取了控制台中输入的参数值了。

相关文章
|
2天前
|
测试技术 Python
手动解决Python模块和包依赖冲突的具体步骤是什么?
需要注意的是,手动解决依赖冲突可能需要一定的时间和经验,并且需要谨慎操作,避免引入新的问题。在实际操作中,还可以结合使用其他方法,如虚拟环境等,来更好地管理和解决依赖冲突😉。
|
12天前
|
Python
在Python中,可以使用内置的`re`模块来处理正则表达式
在Python中,可以使用内置的`re`模块来处理正则表达式
33 5
|
22天前
|
Java 程序员 开发者
Python的gc模块
Python的gc模块
|
25天前
|
数据采集 Web App开发 JavaScript
python-selenium模块详解!!!
Selenium 是一个强大的自动化测试工具,支持 Python 调用浏览器进行网页抓取。本文介绍了 Selenium 的安装、基本使用、元素定位、高级操作等内容。主要内容包括:发送请求、加载网页、元素定位、处理 Cookie、无头浏览器设置、页面等待、窗口和 iframe 切换等。通过示例代码帮助读者快速掌握 Selenium 的核心功能。
73 5
|
29天前
|
Python
SciPy 教程 之 SciPy 模块列表 6
SciPy教程之常量模块介绍:涵盖公制、二进制(字节)、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率及力学单位。示例展示了角度单位转换为弧度的几个常用常量。
20 7
|
29天前
|
Python
SciPy 教程 之 SciPy 模块列表 7
`scipy.constants` 模块提供了常用的时间单位转换为秒数的功能。例如,`constants.hour` 返回 3600.0 秒,表示一小时的秒数。其他常用时间单位包括分钟、天、周、年和儒略年。
18 6
|
26天前
|
Python
SciPy 教程 之 SciPy 模块列表 13
SciPy教程之SciPy模块列表13:单位类型。常量模块包含多种单位,如公制、二进制(字节)、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率和力学单位。示例代码展示了如何使用`constants`模块获取零摄氏度对应的开尔文值(273.15)和华氏度与摄氏度的转换系数(0.5556)。
18 1
|
27天前
|
XML 前端开发 数据格式
超级详细的python中bs4模块详解
Beautiful Soup 是一个用于从网页中抓取数据的 Python 库,提供了简单易用的函数来处理导航、搜索和修改分析树。支持多种解析器,如 Python 标准库中的 HTML 解析器和更强大的 lxml 解析器。通过简单的代码即可实现复杂的数据抓取任务。本文介绍了 Beautiful Soup 的安装、基本使用、对象类型、文档树遍历和搜索方法,以及 CSS 选择器的使用。
64 1
|
28天前
|
Python
SciPy 教程 之 SciPy 模块列表 9
SciPy教程之常量模块介绍,涵盖多种单位类型,如公制、质量、角度、时间、长度、压强等。示例展示了如何使用`scipy.constants`模块查询不同压强单位对应的帕斯卡值,包括atm、bar、torr、mmHg和psi。
15 1
|
28天前
|
Python
SciPy 教程 之 SciPy 模块列表 8
SciPy教程之常量模块单位类型介绍。该模块包含多种单位,如公制、质量、角度、时间、长度、压强、体积、速度、温度、能量、功率和力学单位。示例展示了部分长度单位的转换值,例如英寸、英尺、海里等。
16 1
下一篇
无影云桌面