首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Python argparse -长参数名的帮助文本

Python argparse是Python标准库中的一个模块,用于解析命令行参数。它提供了一种简单而灵活的方式来定义命令行接口,并自动生成帮助文本。

argparse支持两种类型的命令行参数:位置参数和可选参数。位置参数是按照它们在命令行中出现的顺序进行解析的,而可选参数则可以通过指定参数名来解析。

对于长参数名的帮助文本,可以通过在参数定义中使用--前缀来指定。以下是一些常见的参数定义示例:

代码语言:txt
复制
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("--input", help="输入文件的路径")
parser.add_argument("--output", help="输出文件的路径")
parser.add_argument("--verbose", action="store_true", help="是否显示详细信息")

args = parser.parse_args()

在上述示例中,--input--output是两个长参数名,它们分别用于指定输入文件和输出文件的路径。--verbose是一个布尔类型的可选参数,用于控制是否显示详细信息。

在生成帮助文本时,argparse会根据参数定义自动生成相应的描述。对于上述示例,生成的帮助文本可能如下所示:

代码语言:txt
复制
usage: script.py [-h] [--input INPUT] [--output OUTPUT] [--verbose]

optional arguments:
  -h, --help         show this help message and exit
  --input INPUT      输入文件的路径
  --output OUTPUT    输出文件的路径
  --verbose          是否显示详细信息

在帮助文本中,每个参数都会显示其长参数名、描述以及其他相关信息。用户可以通过运行脚本时添加-h--help参数来查看帮助文本。

对于腾讯云相关产品和产品介绍链接地址,可以根据具体的需求和场景选择适合的产品。腾讯云提供了丰富的云计算服务,包括云服务器、云数据库、云存储、人工智能等。您可以访问腾讯云官方网站(https://cloud.tencent.com/)了解更多信息。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

最全总结 | 聊聊 Python 命令行参数化几种方式!

,第一个参数代表脚本主文件名称 3. argparse 内置 argparse 模块可以非常轻松地编写出友好命令行参数脚本,并且它能自动生成帮助使用手册,在用户给程序传入无效参数时能抛出清晰错误信息...使用时候,我们就可以通过「 -h / --help 」命令参数查看帮助文档 # 查看命令行参数帮助文档 python3 2_argparse.py --help # 或 python3 2_argparse.py...args % python3 2_argparse.py -a3 所有命令行参数为: 命令行参数名:arg1,参数值:None 命令行参数名:arg2,参数值:xag 命令行参数名:arg3,参数值...% python3 2_argparse.py -a1 -a2 -a3 所有命令行参数为: 命令行参数名:arg1,参数值: 命令行参数名:arg2,参数值: 命令行参数名:arg3,参数值:...:-n 23 longopts 参数列表 定义参数列表时,如果某个参数有值,需要在短参数后追加一个「 = 」符号 传使用方式:--port 8080 这里以传入数据库连接参数为例(参数包含 ip、

1.8K20

parser.add_argument()用法——命令行选项、参数和子命令解析器

argparse是一个Python模块:命令行选项、参数和子命令解析器。...通过使用这种方法,可以在使用 1、argparse简介: argparse 模块是 Python 内置一个用于命令项选项与参数解析模块,argparse 模块可以让人轻松编写用户友好命令行接口。...通过在程序中定义好我们需要参数,然后 argparse 将会从 sys.argv 解析出这些参数。argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。...help - 参数帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数帮助信息. metavar - 在 usage 说明中数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写数名称...直接运行python test.py,输出结果False 运行python test.py --sparse,输出结果True 也就是说,action=‘store_true’,只要运行时该变量有传就将该变量设为

1.6K20

【测试开发】python系列教程:argparse 模块

这个包,然后包中ArgumentParser类生成一个parser对象(其中description对参数解析器作用进行描述),当我们在命令行显示帮助信息时候会看到description描述信息...Flag参数不需要指定参数值,只需要带有参数名即可。 action: 命令行遇到flags参数时动作。...注意:如果直接运行程序,默认不读取该变量,要使用必须要进行传,例如:python try.py --epochs nargs: 应该读取命令行参数个数,可以是具体数字,或者是?...default: 不指定参数时该参数默认值。 type: 命令行参数应该被转换成数据类型。 required: 是否为必选参数或可选参数。 help: 参数帮助信息。...metavar:在 usage 说明中数名称,对于必选参数,默认就是参数名称,对于可选参数默认是全大写数名称。

15510

python argparse处理命令行参数

位置参数是必须提供,前面不需要短横杠修饰,直接就是参数名称,ls命令用法示意如下 ls -l dir 其中-l就是一个选项, dir则是一个位置参数, 要在python脚本中实现这样命令行传,...为脚本自动添加了-h选项,用来查看帮助文档 python test.py -h usage: test.py [-h] [-l] dir positional arguments: dir...在该模块中,关键是掌握add_argument方法使用,该方法有多个参数,列表如下 1. name 表示参数名称,选项可以同时提供短选项和选项,也可以只提供其中一种,位置参数直接写参数名称即可...,当运行-h来查看脚本帮助信息时,默认使用name或者dest值,如果指定了metavar,则参数名称显示为metavar值, 该参数仅在显示帮助信息时有用,没有其他实际含义,用法如下 >>> parser.add_argument...,提供了强大命令行传方式,尽管在python中还有其他模块也提供了命令行参数处理功能,但是官方还是首推使用argparse来处理命令行参数。

1.6K20

Python-argparse模块

最近在GitHub上欣赏别人写代码,发现一个常用模块–argparse,居然我到现在才知道,简直是罪过,于是马上开始了这个模块用法学习,这样后面我在写时候就可以摈弃input()函数来交互了。...这个模块是python内置所有是不需要安装,我们直接import即可。...argparse模块功能 该模块可以在命令模式下完成使用者与程序之间参数交互,并且这个模块会自动生成help菜单,让使用者可以通过 -h|–help查看程序使用方法等。...None | 从父(公共)解析器中继承所有的参数选项 | | formatter_class | None | 定制说明文本显示风格...| requred | 设置参数是否为必选项 | | dest | 设置help中显示数名和名字空间中属性值名

45620

Python argparse标准库快速入门

Python是一门非常好用脚本语言,自然使用它来开发命令行程序也比较方便。而且Python标准库中有一个名为argparse库,可以非常方便让我们把命令行参数转换成所需数据格式。...如果想详细了解argparse的话,可以查看Python官方文档,目前已经出了中文版文档,极大方便了我们中国开发者,虽然有些地方没有完整翻译,但是已经完全够用了。...prog - 程序名称(默认:sys.argv[0]),默认是Python程序文件名 usage - 描述程序用途字符串(默认值:从添加到解析器参数生成) description - 在参数帮助文档之前显示文本...(默认值:无) epilog - 在参数帮助文档之后显示文本(默认值:无) parents - 一个 ArgumentParser 对象列表,它们参数也应包含在内。...参数名 方法第一个参数是参数名称,可以是一个字符串(name)或者是-开头一组字符串(flags),前者是位置参数,会按照添加顺序被读取;后者是关键字参数,可以以任意顺序指定。

86310

Python笔记:外部参数传入考察(一)argparse

2. argparse一般使用方法 argparse库是python自带一种用于实现脚本参数传递函数库。...较之前述sys.argv暴力传方法,argparse库具有以下优点: 接口上更为友好,可以通过key-value形式进行参数传递,用户更容易明白他传递参数具体含义; 参数传递包括但不限定于string...其调用方式如下: python test_argparse.py -h 或者 python test_argparse.py --help 这两种方式都可以打印出argparse参数信息。...可以看到,mode和file_type参数传递不需要给出参数名,但是必须要按照参数定义顺序进行参数传递,而input不需要遵循参数定义顺序,但是必须要传入参数名。...当然,argparse只是进行外部传其中一个常用库而已,事实上,使用tf.flags也可以完成相同功能,在机器学习领域,它或许会比argparse更为常用,但这就是另外一个故事了,也许之后我会再写一个博客来介绍一下

4.1K21

制作一个简单命令行测试工具

一、命令行工具编写 各种语言下都有相应方法实现命令行工具编写,本文主要以python为例,用到模块为argparse。...位置参数传时无需指定参数名,但必传,不传会报错;可选参数传时必须注明参数名,但可以选择不传(不考虑required属性情况下)。同时,传顺序可以调换,不影响解析。...除了上述这种基本用法外,argparse模块还有很多其他用法,在此不一一介绍,有兴趣朋友可以自行了解。下面来根据一个实际中应用,具体说说argparse模块编写命令行工具如何与接口测试相结合。...三、总结 本期为大家介绍了通过编写命令行工具来实现简化接口传以方便测试有关内容。这种方法适用于大部分接口测试,除了简化传,还可以应用于grpc接口测试,实用性较强。...本文只简单介绍了python下使用argparse模块来编写命令行工具基本方法,关于更多其他高级用法和其他语言下实现,欢迎大家一起讨论交流~ ?

1.1K10

Python 命令行之旅:深入argparse (一)

前言 在第一篇“初探 argparse文章中,我们初步掌握了使用 argparse 四部曲,对它有了一个基本体感。但是它具体支持哪些类型参数?这些参数该如何配置?...本文将带你深入了解 argparse 参数。 本系列文章默认使用 Python 3 作为解释器进行讲解。...若你仍在使用 Python 2,请注意两者之间语法和库使用差异哦~ 参数动作 你是否还记得?...它常常用于将多个参数所对应固定值都保存在同一个列表中,相应需要 dest 入来配合,以放在同一个列表中,如: 不指定 dest 入,则固定值保存在以参数名命名变量中 >>> parser.add_argument...我们可以通过 - 来指定短参数,也就是名称短参数;也可以通过 -- 来指定长参数,也就是名称参数。当然也可以两个都指定。

67530

Python3 命令行参数解析

argparse 模块是 Python 标准库中推荐命令行解析模块,命令行参数解析在 windows 系统下不适用,但在 linux 系统下几乎要总是考虑命令行参数解析。...,这里可用到 argparse 模块,它是 Python 内置一个用于命令选项与参数解析模块,通过在程序中定义好我们需要参数,argparse 将会从 sys.argv 中解析出这些参数,并自动生成帮助和使用信息...,将参数规范中定义一个值保存到一个列表; count,存储遇到次数;此外,也可以继承 argparse.Action 自定义参数解析; nargs – 应该读取命令行参数个数,可以是具体数字,或者是...help – 参数帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数帮助信息. metavar – 在 usage 说明中数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写数名称.... dest – 解析后数名称,默认情况下,对于可选参数选取最长名称,中划线转换为下划线. argparse示例 示例 1 代码如下: import argparse if __name__ ==

1.2K11

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

简介 argparse 模块主要用于处理 Python 命令行参数和选项,程序定义好所需参数后,该模块会通过 sys.argv 解析出那些参数;除此之外,argparse 模块还会自动生成帮助和使用手册...看一下方法中每一个参数含义: prog:程序名称(默认:sys.argv[0]) usage:描述程序用途字符串(默认值:从添加到解析器参数生成) description:在参数帮助文档之前显示文本...(默认值:无) epilog:在参数帮助文档之后显示文本(默认值:无) parents:一个 ArgumentParser 对象列表,它们参数也应包含在内 formatter_class:用于自定义帮助文档输出格式类...:如果缩写是无歧义,则允许缩写选项 (默认值:True) parse_args(args=None, namespace=None) 用来解析参数,看一下参数说明: args:要分析字符串列表,默认取自...参考: https://docs.python.org/zh-cn/3/library/argparse.html

57720

Python 命令行之旅:深入 argparse(二)

本文将继续深入了解 argparse 进阶玩法,一窥探其全貌,助力我们拥有实现复杂命令行程序能力。 本系列文章默认使用 Python 3 作为解释器进行讲解。...若你仍在使用 Python 2,请注意两者之间语法和库使用差异哦~ 帮助 自动生成帮助 当你在命令行程序中指定 -h 或 --help 参数时,都会输出帮助信息。...而 argparse 可通过指定 add_help 入为 True 或不指定,以达到自动输出帮助信息目的。...入来控制所输出帮助格式。...由于后续子解析器会自动生成帮助信息,这里父解析器指定 add_help=False 以不自动生成帮助信息: # bash.py import argparse parser = argparse.ArgumentParser

1.4K20

Python argparse 模块

在我们示例中,我们为每个文件显示更多偏偏,而不仅仅是显示文件名。在这种情况下,-l被称为可选参数。 这是帮助文本一小段。...它非常有用,因为你可以通过它找到从未使用过程序,并且只需要阅读帮助文本即可了解其工作方式。...第二个开始显示 argparse 模块用处,我们几乎什么也没做,但是已经得到了很好帮助信息 --help 选项可以简写成 -h,它是唯一一个我们能指定选项(即不需要代码定义),指定任何其他都会导致报错...正如我们认为一样,当我们使用选项,输出结果仍然是一样。 然而,我们帮助信息对这一个新功能解释得不是很好,但这一点仍旧是可以通过修改脚本代码来修复(通过 help 关键字)。...在最后一个输出里,我添加了选项与短选项混合,这样你能看到选项顺序灵活性。

1K20
领券