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

python argparse:如果提供了选项,则不会在帮助菜单中显示参数的名称

Python argparse是Python标准库中的一个模块,用于解析命令行参数。它提供了一种简单而灵活的方式来处理命令行参数,并生成帮助信息。

argparse模块的主要作用是解析命令行参数,并将其转换为Python对象。它可以处理位置参数和可选参数,并提供了丰富的功能来定义参数的类型、默认值、帮助信息等。

对于选项参数,如果提供了选项,则不会在帮助菜单中显示参数的名称。这在一些情况下非常有用,例如当参数名称非常明确或者在帮助菜单中不需要显示参数名称时。

下面是一个示例代码,演示了如何使用argparse模块来解析命令行参数,并设置选项参数不显示参数名称:

代码语言:txt
复制
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--verbose', help='increase output verbosity', action='store_true')
args = parser.parse_args()

if args.verbose:
    print('Verbose mode is enabled')
else:
    print('Verbose mode is disabled')

在上面的代码中,--verbose是一个选项参数,使用action='store_true'来表示它是一个开关参数。如果在命令行中提供了--verbose选项,则args.verbose的值为True,否则为False

这个功能在一些需要简化命令行界面的情况下非常有用,可以减少帮助菜单中的冗余信息,提高用户体验。

推荐的腾讯云相关产品:腾讯云函数(Serverless云函数计算服务),它提供了无服务器的计算能力,可以帮助开发者更轻松地构建和管理应用程序。腾讯云函数支持多种编程语言,包括Python,可以与argparse模块结合使用来处理命令行参数。

腾讯云函数产品介绍链接地址:腾讯云函数

注意:本答案中没有提及亚马逊AWS、Azure、阿里云、华为云、天翼云、GoDaddy、Namecheap、Google等流行的云计算品牌商,如有需要,请自行了解相关信息。

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

相关·内容

argparse------用于命令行选项参数和子命令解析器

程序定义它需要什么参数argparse将找出如何从sys.argv解析这些参数argparse模块还自动生成帮助和使用消息,并在用户给程序提供无效参数时发出错误。...以确定如何在帮助消息显示程序名称。这个缺省值几乎总是可取,因为它将使帮助消息与在命令行上调用程序方式匹配。...特别是,在设置名称空间返回值属性之前,如果提供类型转换参数,解析器将应用任何类型转换参数。...description - 帮助输出子解析器组描述,默认情况下为None。 prog - 使用子命令帮助显示使用信息,默认情况下程序名称和子解析器参数之前任何位置参数。...当一个参数被添加到组时,解析器就像对待一个普通参数一样对待它,但是会在一个单独显示参数以获取帮助消息。

6.8K20

Python argparse 模块作用,以及分享一个通用代码模板

argparsePython 内置一个用于命令项选项参数解析模块。它作用是帮助我们处理命令行输入,轻松编写用户友好命令行接口。...argparse 模块还会自动生成帮助和使用信息。如果用户传入无效参数argparse显示错误消息,帮助用户正确使用程序。...帮助参数提供参数说明。类似地,剩下代码为解析器添加了更多参数,每个参数都有各自名称、数据类型、默认值和帮助说明。...总的来说,这段代码使用 argparse 设置一个参数解析器,定义多个命令行参数及其类型、默认值和帮助信息,解析提供参数,最终以字典形式返回。...argparse 提供一种简单方式来定义和解析命令行参数,使得我们 Python 脚本能够更好地与命令行接口集成。

13000

Python argparse 模块

从这四个命令我们可以学到一些概念: ls 命令在不接受任何参数时也是有作用,它默认用于展示当前目录下内容。 如果我们想它让提供非默认以外功能,我们必须指定更多参数。...在我们示例,我们为每个文件显示更多偏偏,而不仅仅是显示文件名。在这种情况下,-l被称为可选参数。 这是帮助文本一小段。...第二个开始显示 argparse 模块用处,我们几乎什么也没做,但是已经得到了很好帮助信息 --help 选项可以简写成 -h,它是唯一一个我们能指定选项(即不需要代码定义),指定任何其他都会导致报错...需要注意是,如果一个可选参数没有指定,与它相关联参数(在这个例子是 args.verbosity),默认情况下会赋值为 None,这也是 if 语句为 False 原因。...这意味着如果我们这个选项指定,我们将给 args.verbose 赋值为 True,反之为 False。 当你手动指定选项值时会报错,因为它实际存储是 True。 注意帮助信息不同。

1K20

python argparse处理命令行参数

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

1.6K20

Python-argparse模块

最近在GitHub上欣赏别人写代码,发现一个常用模块–argparse,居然我到现在才知道,简直是罪过,于是马上开始这个模块用法学习,这样后面我在写时候就可以摈弃input()函数来交互。...argparse模块功能 该模块可以在命令模式下完成使用者与程序之间参数交互,并且这个模块会自动生成help菜单,让使用者可以通过 -h|–help查看程序使用方法等。...使用方法 这里主要分四步: import导入该模块:import argparse 创建解析器对象:parse = argparse.ArgumenParser() 添加需要命令行参数选项:parse.add_argument...| | requred | 设置参数是否为必选项 | | dest | 设置help显示参数名和名字空间中属性值名...# 添加参数 # dest值设置namespace属性值名称 parse.add_argument("-n","--name",dest="name",type=str,default

45620

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

argparse是一个Python模块:命令行选项参数和子命令解析器。...通过使用这种方法,可以在使用 1、argparse简介: argparse 模块是 Python 内置一个用于命令项选项参数解析模块,argparse 模块可以让人轻松编写用户友好命令行接口。...通俗来讲就是: 命令行运行代码时直接给相应变量赋值,就不需要在改python具体代码。...在帮助消息,这个描述会显示在命令行用法字符串和各种参数帮助消息之间。...help - 参数帮助信息,当指定为 argparse.SUPPRESS 时表示不显示参数帮助信息. metavar - 在 usage 说明参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写参数名称

1.6K20

Python argparse标准库快速入门

prog - 程序名称(默认:sys.argv[0]),默认是Python程序文件名 usage - 描述程序用途字符串(默认值:从添加到解析器参数生成) description - 在参数帮助文档之前显示文本...当然比较特殊一个是open,它会将参数作为文件来打开。 如果默认open还不能满足,还可以使用argparse.FileType,它提供读写模式、文件编码、缓冲区大小等详细设置。...metavar和dest metavar参数用来指定参数显示名称,而dest用来指定参数底层使用属性名。...而bar参数修改了dest,所以底层属性名发生了变化,但是在帮助信息并没有什么改变。...,这样使用者在用-h命令时候就可以看到参数帮助信息

86310

python: argparse库 & 命令行解析工具

store_const,表示赋值为const; append,将遇到值存储成列表,也就是如果参数重复则会保存多个值; append_const,将参数规范定义一个值保存到一个列表; count,存储遇到次数...help - 参数帮助信息,当指定为 argparse.SUPPRESS 时表示不显示参数帮助信息. metavar - 在 usage 说明参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写参数名称.... dest - 解析后参数名称,默认情况下,对于可选参数选取最长名称划线转换为下划线....1.py 10 --square=2 --cubic=3 10 4 27 ---- ---- Ref: argparse 使用 argparse - 命令行选项参数解析(译) Argparse简易教程...python argparse用法总结 ---- ----

67930

Python 模块:argparse

代码保存在名为 prog.py 文件,它可以在命令行运行并提供有用帮助消息: ?...- 在参数帮助文档之前显示文本(默认值:无) epilog - 在参数帮助文档之后显示文本(默认值:无) parents - 一个 ArgumentParser 对象列表,它们参数也应包含在内...prog 默认情况下,ArgumentParser 对象使用 sys.argv[0] 来确定如何在帮助消息显示程序名称。这一默认值几乎总是可取,因为它将使帮助消息与从命令行调用此程序方式相匹配。...在帮助消息,这个描述会显示在命令行用法字符串和各种参数帮助消息之间: >>> parser = argparse.ArgumentParser(description='A foo that bars...argparse.py: error: option --foo is required 正如例子显示那样,如果一个选项被标记为必选,如果那个选项不在命令行,parse_args() 将会报一个错误

2.5K10

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

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

57720

python-argparse

简单使用,详细方法及示例请参考python标准库 python获取命令行参数 获取参数 sys.argv sys.argv[0] 为程序名称,其后分别为参数,len(sys.argv)可得出所有参数个数...python标准库getopt, optparse, argparse都是专门处理命令行参数模块 getopt 是类似UNIX系统getopt这个C函数实现,可以处理长短配置项和参数。...缺点有两个,一是长短配置项需要分开处理,二是对非法参数和必填参数处理需要手动 optparse 比getopt 更加方便,强劲,采用声明式风格,还可以自动生成帮助信息 argparse 继承optparse...,所以现在主要学习argparse argparse argparse 解析命令行选项参数以及子命令 argparse 可以帮助更方便写出用户友好命令行接口。...因为是可选参数,而又必须提供参数,自相矛盾,应避免使用 help 对此参数简短描述 metavar 此参数在usage信息名字,实际名字未变,仍为dest 所定义 dest 经过parse_args

77710

用Click编写Python命令行工具

在本教程最后,你会知道: 为什么click相比于argparse和optparse来说是一个更好选择 如何用它创建一个简单CLI 如何将强制命令行参数添加到您脚本 如何解析命令行标志和选项 如何通过添加帮助...根据CLI复杂性,通常可以将参数传递给脚本,可以是: 1.参数,它是传递给脚本必需参数如果您不提供它,CLI将返回一个错误。...例如,click是这个命令参数:pip install click。 2.或者它可以是一个选项,它是一个可选(||)参数,结合名称和值部分,如--cache-dir ./my-cache。...Python 3.x标准库中提供命令行框架 将命令和参数添加到脚本是非常强大,但命令行解析并不像您想象那样直截了当。...以下是你所学到: 为什么click是一个更好选择相对argparse和optparse 如何用它创建一个简单CLI 如何将强制命令行参数添加到您脚本 如何解析命令行标志和选项; 如何通过添加帮助

3.3K10

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 模块

Python内置sys.argv保存完整参数列表,我们可以从中解析出需要参数: # tesone1.py import sys print(sys.argv) source = sys.argv...),当我们在命令行显示帮助信息时候会看到description描述信息。...][, type][,choices][, required][, help][, metavar][, dest]) 每个参数解释如下: name or flags: 普通参数或flag参数选项参数名称或标签...注意:如果直接运行程序,默认不读取该变量,要使用必须要进行传参,例如:python try.py --epochs nargs: 应该读取命令行参数个数,可以是具体数字,或者是?...metavar:在 usage 说明参数名称,对于必选参数,默认就是参数名称,对于可选参数默认是全大写参数名称

15510

Python3脚本编程常用.md

[TOC] 0x00 Python命令行参数 实现命令行参数输入得几种方法: sys模块argv getopt 模块 sys.argv #!...WeiyiGeek.sys.argv getopt Python 提供 getopt 模块来获取命令行参数(指定参数名称) getopt 模块是专门处理命令行参数模块,用于获取命令行选项参数,也就是...- long_options: 以列表格式定义,long_options 后等号(=)表示如果设置该选项,必须有附加参数,否则就不附加参数。...- metavar :使用消息参数名称,当ArgumentParser生成帮助消息时,它需要某种方法来引用每个期望参数。...,type=argparse.FileType('w+'),default=sys.stdout) #可使用metavar指定替代名称,当ArgumentParser生成帮助消息时,

99330

Python创建命令行界面的最佳方式

当用户运行这个程序时,它们被限制为一组定义规则。例如,如果我想将输出记录到文本文件,该怎么办?作为一个用户,您可以创建一个命令行界面来提供这些问题解决方案。 ?...处理错误情况:让用户确切地知道哪里出了问题 运行时状态:如果任务没有立即完成,您应该打印出当前进度 使用argparse读取参数Argparse是一个用于解析命令行参数Python标准库模块。...作为程序员,您可以定义要接受参数,而argparse将知道如何从sys解析这些参数。当用户给程序提供无效参数时,Argparse还会自动生成帮助和使用消息,并输出错误。...() 现在使用--help选项运行代码: python3 test_cli.py --help 你应该会收到一个很好默认帮助信息,像这样: usage: test_cli.py [-h] optional...现在使用argparse添加额外参数如果没有指定需要哪些参数argparse将假定它们是可选。你也可以设置参数类型,对于——lines,我们取一个整数。

2.4K20

python 模块argparse用法实

有些程序可能希望支持/f这样选项,可以使用prefix_chars="/"  fromfile_prefix_chars - (default: None)如果你希望命令行参数可以从文件读取,就可能用到...例如,如果fromfile_prefix_chars='@',命令行参数中有一个为"@args.txt",args.txt内容会作为命令行参数  add_help - 是否增加-h/-help选项(default...help="params means"),但代码不能使用shortname     dest: 参数在程序对应变量名称 add_argument("a",dest='code_name')    ...("c", type=int)     metavar: 参数名字,在显示 帮助信息时才用到.    ...'B', 'C', 0])     required:通常-f这样选项是可选,但是如果required=True那么就是必须     nsrgs 用来指定参数个数,可以是1,2,3....也可以是

45210

pythonargparse 命令行参数解析包

简介argparsepython自带命令行参数解析包,可以用来方便地读取命令行参数,当你代码需要频繁地修改参数时候,使用这个工具可以将参数和代码分离开来,让你代码更简洁,适用范围更广使用方法导入...如:python demo.py zcy2、default参数提供参数默认值3、required:默认情况下,可选项(前面有'-')被认为并不一定需要出现在命令行参数,但是如果设置required...此类设置违背人常识,应避免使用4、type:用于类型检查和类型转换;参数类型,默认是str ,如果需要int ,type=int即可5、choices:参数值只能在几个选项中选择:# file-name...nargs.py -name A B CHello to A, B, C8、metavar: 参数名字,在显示 帮助信息时才用到....(帮助信息)

76330

Python参数传递与解析

Python传递命令行参数 Python命令行参数传递和C语言类似,都会把命令行参数保存到argv变量。对于python而言,argv是sys模块定义一个list。...opts元素是一个元组,保存了解析好选项参数对。args保存除去所有选项选项参数之外,剩下所有参数如果解析出错则会抛出GetoptError异常,该异常有一个参数err。...: epilog指定字符串将会显示帮助文档最后 parents: 一个 ArgumentParser对象列表,这些对象选项参数也会被继承 add_help: 添加-h/--help选项,默认为...,选项参数必须从这组参数来选取。.../arg_parse.py -f hello hello 小结 getopt虽然提供接近Unix C用户接口,方便了熟悉Unix C程序猿/媛们,但argparse模块功能更为强大,使用起来也更为简洁

2.1K70
领券