22 Python的argparse模块

这篇具有很好参考价值的文章主要介绍了22 Python的argparse模块。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

概述

        在上一节,我们介绍了Python的datetime模块,包括:datetime模块中一些常用的属性和函数。在这一节,我们将介绍Python的argparse模块。argparse模块是Python的一个标准库,用于编写命令行界面。它可以处理命令行参数和选项,并生成帮助和使用信息。

        该模块主要包含的功能如下:

        帮助和使用信息生成:自动生成帮助和使用信息,包括参数和选项的说明、用法示例等。

        命令行参数解析:解析命令行参数和选项,包括位置参数、可选参数和标志。

        参数类型检查:支持对参数类型进行检查,包括整数、浮点数、字符串等。

        子命令支持:支持定义子命令,每个子命令可以有自己的参数和选项。

        参数组:支持将参数分组,以方便管理和使用。

        下面,我们将逐一介绍argparse模块中一些常用的类和函数。

argparse.ArgumentParser类

        argparse.ArgumentParser是argparse模块中的一个类,用于创建解析器对象,帮助处理命令行参数和选项,并生成帮助和使用信息。使用argparse.ArgumentParser类可以简化命令行参数和选项的解析过程,以下是具体的使用步骤:

        1、导入argparse模块:import argparse。

        2、实例化一个对象:parser = argparse.ArgumentParser()。

        3、加入参数或选项:parser.add_argument(),每一个add_argument方法对应一个要关注的参数或选项。

        4、获取参数:args = parser.parse_args(),解析成功之后即可使用。

        在创建argparse.ArgumentParser对象时,可以指定一些可选参数,比如:description,用于描述程序的用途和参数的说明。

add_argument基本选项

        通过调用add_argument函数,可以指定命令行参数的名称、类型、默认值等属性,为参数提供帮助文本和元数据。

# test.py
import argparse

# 创建解析器对象
parser = argparse.ArgumentParser(description = '这是一个示例程序')

# 添加参数
parser.add_argument('param_name', type = int, help = '这是一个整数参数')

# 解析参数
args = parser.parse_args()

# 使用参数
print(args.param_name)

        在上面的示例代码中,我们使用add_argument函数添加了一个名为param_name的参数,指定了它的类型为整数,并提供了帮助文本。然后,通过调用parse_args函数解析命令行参数,并将解析后的参数值存储在args对象中。最后,我们可以使用args.param_name访问该参数的值。如果我们在命令行输入python test.py 66命令,则会输出:66。

add_argument更多选项

        add_argument函数还有许多其他选项,如下。

        metavar:指定参数的元变量名称,用于帮助文本中。

        nargs:指定参数接收的值的数量,可以是固定的数量,也可以是可变数量。其中,'+'表示至少需要一个参数,'*'表示可以接受任意数量的参数,数字表示只接受固定数量的参数。

        default:指定参数的默认值。

        choices:限制参数的取值范围。

        required:指定参数是否必需。

        help:提供参数的帮助文本。

        下面是一个稍微复杂一点的示例代码,用到了更多的选项。

# test.py
import argparse

# 创建解析器对象
parser = argparse.ArgumentParser(description = '这是一个示例程序')

# 添加参数
parser.add_argument('integers', metavar='N', type=int, nargs='+', help = '用于运算的整数的个数')
parser.add_argument('--sum', dest='compute_sum', action='store_true', help = '计算输入的整数的和')
parser.add_argument('--max', dest='find_max', action='store_true', help = '找到输入的最大整数')
parser.add_argument('--average', dest='compute_average', action='store_true', help = '计算输入的平均值')

# 解析参数
args = parser.parse_args()

# 使用参数
if args.compute_sum:
    print(sum(args.integers))
elif args.find_max:
    print(max(args.integers))
elif args.compute_average:
    print(sum(args.integers) / len(args.integers))
else:
    print('未选择任何操作')

        在上面的示例代码中,我们添加了如下几个参数和选项。

        integers:一个位置参数,接受一个或多个整数作为输入。

        --sum:一个可选的选项,用于计算输入整数的总和。

        --max:一个可选的选项,用于找出输入整数的最大值。

        --average:一个可选的选项,用于计算输入整数的平均值。

        通过解析命令行参数,我们可以根据用户选择的选项执行相应的操作,并打印输出相应的结果。上述代码的执行结果如下。

python test.py -h
usage: test.py [-h] [--sum] [--max] [--average] N [N ...]

这是一个示例程序

positional arguments:
  N           用于运算的整数的个数

options:
  -h, --help  show this help message and exit
  --sum       计算输入的整数的和
  --max       找到输入的最大整数
  --average   计算输入的平均值
  
python test.py --sum 5 6 7
18

python test.py --max 5 6 7
7

python test.py --average 5 6 7
6.0

python test.py 5 6 7
未选择任何操作

add_argument的action选项

        action选项用来定义当命令行选项被触发时的行为。有多种可用的行为,如下。

        'store':默认值。当命令行选项被触发时,将选项后面的参数值存储下来。

        'store_const':当命令行选项被触发时,将一个常量值存储下来。比如:add_argument('--foo', action='store_const', const=42)会将42存储为args.foo。

        'store_true' 和 'store_false':当命令行选项被触发时,将一个布尔值存储下来。比如:add_argument('--foo', action='store_true')会在args.foo为真(即选项被触发)时存储一个True值。

        'append':当命令行选项被触发时,将一个值添加到列表中。比如:add_argument('--foo', action='append', default=[])会将任何遇到的--foo选项的值添加到args.foo列表中。

        'append_const':当命令行选项被触发时,将一个常量值添加到列表中。比如:add_argument('--foo', action='append_const', const=42)会将42添加到args.foo列表中。

# test.py
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--param1', action = 'store_true')
parser.add_argument('--param2', action = 'append', default = [])
parser.add_argument('numbers', nargs = '+')
args = parser.parse_args()

print(args.param1)
print(args.param2)
print(args.numbers)

        在上面的示例代码中,--param1选项被触发时,将存储一个True值。--param2选项可以接受任意数量的参数,并将它们添加到一个列表中。numbers选项接受一个或多个参数,并将它们添加到一个列表中。上述代码的执行结果如下。文章来源地址https://www.toymoban.com/news/detail-723077.html

python test.py 99 100 --param1 --param2 6 --param2 9
True
['6', '9']
['99', '100']

到了这里,关于22 Python的argparse模块的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • python中argparse模块关于 parse_args() 函数详解(全)

    原理:命令行解析使用argparse包 作用:命令行传参赋值 可用在机器学习深度学习 或者 脚本运行等 了解这个函数需要了解其背后的原理以及具体参数 在深度学习模型框架中几乎都有的模块 浓缩后的示例代码: 主要的对象值赋参,对应的参数具体如下: 主要有两种情况: 位

    2024年02月16日
    浏览(41)
  • 30 Python的matplotlib模块

    概述         在上一节,我们介绍了Python的pandas模块,包括:Series、DataFrame、数据读取和写入等内容。在这一节,我们将介绍Python的matplotlib模块。matplotlib模块是一个Python的2D绘图库,可以实现各种类型的图形绘制,包括:线图、柱状图、饼图、散点图等。matplotlib支持各种

    2024年02月08日
    浏览(48)
  • 挑战30天学完Python:Day12 模块

    🎉 本系列为Python基础学习,原稿来源于 30-Days-Of-Python 英文项目,大奇主要是对其本地化翻译、逐条验证和补充,想通过30天完成正儿八经的系统化实践。此系列适合零基础同学,或仅了解Python一点知识,但又没有系统学习的使用者。总之如果你想提升自己的Python技能,欢迎

    2023年04月27日
    浏览(38)
  • python中的argparse基本用法

    1、argparse是一个python模块,用途是:命令行选项、参数和子命令的解释。 2、使用步骤: 导入argparse模块,并创建解释器 添加所需参数 解析参数 3、用法示例: 4、命令行运行方式 假设上述文件的名字是gf.py 在命令行运行时,则有以下几种情况: python gf.py potato ,这种方式会

    2024年02月12日
    浏览(38)
  • Python之使用argparse在命令行读取文件

    关于argparse之parser.add_argument()的用法,这篇文章有较为详细的讲解。因为作业需要,我需要在命令行读入txt文件,网上看了不少博客,都没有直接介绍,而小白在自己尝试的过程中踩了不少坑,尽管做法很简单。这里记在这里。 1.在Python的shell中写一个 ArgparseTry.py 文件,其中

    2023年04月08日
    浏览(81)
  • python argparse传入布尔参数不生效的解决方法

    在一个需要用到flag作为信号控制代码中一些代码片段是否运行的,比如\\\"--flag True\\\"或者\\\"--flag False\\\"。 但是古怪的是无法传入False,无论传入True还是False,程序里面都是True的参数,所以这个flag并没有生效,也就失去了意义。 参考代码: 执行上面的代码:python3 test.py --flag False

    2024年02月13日
    浏览(37)
  • 30天拿下Rust之切片

    概述         在Rust中,切片是一种非常重要的引用类型。它允许你安全地引用一段连续内存中的数据,而不需要拥有这些数据的所有权。切片不包含分配的内存空间,它仅仅是一个指向数据开始位置和长度的数据结构。切片是对数组的一个连续引用,它提供了一种方便、

    2024年03月13日
    浏览(53)
  • 30天拿下Rust之引用

    概述         在Rust语言中,引用机制是其所有权系统的重要组成部分,它为开发者提供了一种既高效又安全的方式来访问和共享数据。引用可以被视为一个指向内存地址的指针,它允许我们间接地访问和操作存储在内存中的数据。与其他语言中的指针不同,Rust中的引用是

    2024年03月10日
    浏览(44)
  • 30天拿下Rust之泛型

    概述         在Rust语言中,泛型是一种强大的工具,它允许我们编写可复用且灵活的代码。通过泛型,我们可以创建适用于多种类型的数据结构和函数,而无需为每种类型都重复编写相同的逻辑。在Rust中,泛型通过指定类型参数来实现,这些类型参数会在编译时被具体类

    2024年03月17日
    浏览(49)
  • 30天拿下Rust之输入输出

    概述         在软件开发中,输入输出(I/O)是任何应用程序的基本构建模块。Rust作为一门注重安全和性能的语言,在其标准库中提供了强大的I/O功能。这些功能使得Rust程序员能够非常轻松地进行标准I/O、文件读写等操作。 标准I/O         在Rust中,标准输入通常通

    2024年03月24日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包