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

如何让argparse为具有两个名称的python脚本显示一个帮助页面?

要让argparse为具有两个名称的Python脚本显示一个帮助页面,可以通过以下步骤实现:

  1. 导入argparse模块:
代码语言:txt
复制
import argparse
  1. 创建ArgumentParser对象:
代码语言:txt
复制
parser = argparse.ArgumentParser()
  1. 添加命令行参数和选项:
代码语言:txt
复制
parser.add_argument('-n', '--name', help='Your name')
  1. 解析命令行参数:
代码语言:txt
复制
args = parser.parse_args()
  1. 编写逻辑代码,根据命令行参数执行相应的操作:
代码语言:txt
复制
if args.name:
    print('Hello, ' + args.name + '!')
else:
    print('Hello, World!')
  1. 在脚本的末尾添加以下代码,用于显示帮助页面:
代码语言:txt
复制
parser.print_help()

完整的Python脚本示例:

代码语言:txt
复制
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-n', '--name', help='Your name')
args = parser.parse_args()

if args.name:
    print('Hello, ' + args.name + '!')
else:
    print('Hello, World!')

parser.print_help()

这样,当在命令行中运行该脚本时,可以通过以下方式显示帮助页面:

代码语言:txt
复制
python script.py -h
python script.py --help

帮助页面将显示脚本的使用方法以及可用的命令行参数和选项。

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

相关·内容

用Click编写Python命令行工具

在本教程最后,你会知道: 为什么click相比于argparse和optparse来说是一个更好选择 如何用它创建一个简单CLI 如何将强制命令行参数添加到您脚本 如何解析命令行标志和选项 如何通过添加帮助...最大不同在于,optparse自Python 3.2以来已被弃用,argparse被认为是在Python中实现CLI标准 你可以在Python文档中找到更多关于它们详细信息,来你知道一个argparse...我们没有实现任何帮助功能,但添加了--help选项,您将看到一个打印到命令行基本帮助页面: ?...这使我们可以使用Python和Requests库创建一个简单实现(简单起见,我们将忽略错误处理和失败请求)。 ? 这个函数使用两个查询参数向天气API发出一个简单请求。...以下是你所学到: 为什么click是一个更好选择相对argparse和optparse 如何用它创建一个简单CLI 如何将强制命令行参数添加到您脚本 如何解析命令行标志和选项; 如何通过添加帮助

3.3K10

怎样学Python 第二十三课 模块化处理用户输入基础

大家好,今天让我们来了解一个非常有用模块,我很久以前就没有意识到这一点,这个模块允许我们简单而有效地使用命令行参数,它不仅会为我们处理这些争论,而且如果事情不对,它会产生一个帮助页面。...我们可以看到,我们首先实际说出我们想要参数,我们可以将多个flags/switches绑定到相同参数。这里我们已经每个参数绑定了两个flag。...在我们给flag之后,我们flag指定帮助,该字符串将在帮助页面生成时作为帮助打印,在帮助字符串之后,我们设置了操作。...第4步:测试你论点 现在我们已经看到参数将如何评估,我们可以测试它们以查看它们是否有效。首先,让我们来看看由argparse生成帮助页面: ~# 。...练习 根据今天所学模块,写出一个Python脚本: 参数如下: -h --heigh 三角形高 -a–asomething 三角形底 通过用户输入参数方式计算三角形面积。

693100

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

这个包,然后包中ArgumentParser类生成一个parser对象(其中description对参数解析器作用进行描述),当我们在命令行显示帮助信息时候会看到description描述信息...action: 命令行遇到flags参数时动作。有两个常见动作,store_true:设定flag参数true;store_false:设定flag参数False。...default: 不指定参数时该参数默认值。 type: 命令行参数应该被转换成数据类型。 required: 是否必选参数或可选参数。 help: 参数帮助信息。...dest:解析后参数名称,默认情况下,对于可选参数选取最长名称,中划线转换为下划线. choices:参数可允许一个容器。 const:action 和 nargs 所需要常量值。...以上就是这个库介绍,我们在实际中,也会遇到这个问题,在实际交付脚本中,大家不知道怎么使用,在交付时候,就可以用这个,去出一个教程,大家运行时候,就知道,这个脚本需要传递参数类型,内容了,方便大家执行脚本时候

15510

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

argparse一个Python模块:命令行选项、参数和子命令解析器。...通过使用这种方法,可以在使用 1、argparse简介: argparse 模块是 Python 内置一个用于命令项选项与参数解析模块,argparse 模块可以人轻松编写用户友好命令行接口。...在帮助消息中,这个描述会显示在命令行用法字符串和各种参数帮助消息之间。...store_const,表示赋值const; append,将遇到值存储成列表,也就是如果参数重复则会保存多个值; append_const,将参数规范中定义一个值保存到一个列表; count,存储遇到次数...help - 参数帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数帮助信息. metavar - 在 usage 说明中参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写参数名称

1.6K20

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

help='sum the integers (default: find the max)')稍后,调用parse_args()将返回一个具有整数和累加两个属性对象。...以确定如何帮助消息中显示程序名称。这个缺省值几乎总是可取,因为它将使帮助消息与在命令行上调用程序方式匹配。...(default: 42)MetavarTypeHelpFormatter每个参数使用类型参数名称作为其值显示名称(而不是像常规格式化程序那样使用dest):>>> parser = argparse.ArgumentParser...metavar提供一个元组每个参数指定一个不同显示:>>> parser = argparse.ArgumentParser(prog='PROG')>>> parser.add_argument...当一个参数被添加到组中时,解析器就像对待一个普通参数一样对待它,但是会在一个单独组中显示该参数以获取帮助消息。

6.8K20

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

argparsePython 内置一个用于命令项选项与参数解析模块。它作用是帮助我们处理命令行输入,轻松编写用户友好命令行接口。...命令行接口需求: 假设您编写了一个 Python 脚本,您希望用户能够在运行脚本时提供一些选项或参数。例如,您脚本可能需要从命令行获取文件路径、模型参数、指定输出目录等。...argparse 模块还会自动生成帮助和使用信息。如果用户传入无效参数,argparse显示错误消息,帮助用户正确使用程序。...parser.add_argument 依次解析器添加了各个参数。例如,第一个参数名称为 “–task_name”,这意味着从命令行运行脚本时,可将其作为 --task_name 传递。...它需要一个字符串值(type=str),默认值 “bigbench”。帮助参数提供了参数说明。类似地,剩下代码解析器添加了更多参数,每个参数都有各自名称、数据类型、默认值和帮助说明。

13000

精通 Python OpenCV4:第一部分

可以在这个页面上看到此文件非常完整示例,其中包含许多注释,可帮助您了解如何适配它来满足您需求。 此文件由 Python 包装规范(PyPa)提出。...从这种意义上讲,执行程序时,Python 从命令行获取所有值并将其设置在sys.argv列表中。 列表一个元素是脚本完整路径(或脚本名称-取决于操作系统),该路径始终sys.argv[0]。...,列表一个元素sysargv_python.py(sys.argv[0])是脚本名称。...换句话说,Python 在标准库中有一个名为argparse模块,用于解析命令行参数。 首先,程序确定所需参数。 然后,argparse将研究如何将这些参数解析sys.argv。...但是,为了您有一个完整了解,还将提供一个有关如何使用shift参数示例。 请记住,对于本节中包含所有示例,已经创建了一个画布来绘制所有形状。

3K10

Python argparse 模块

原英文链接如下: https://docs.python.org/3.7/howto/argparse.html#id1 note 还有两个其他模块也可以完成相同任务,分别是 getopt(与C语言中...在我们示例中,我们每个文件显示更多偏偏,而不仅仅是显示文件名。在这种情况下,-l被称为可选参数。 这是帮助文本一小段。...第二个开始显示 argparse 模块用处,我们几乎什么也没做,但是已经得到了很好帮助信息 --help 选项可以简写成 -h,它是唯一一个我们能指定选项(即不需要代码定义),指定任何其他都会导致报错...正如我们认为一样,当我们使用长选项,输出结果仍然是一样。 然而,我们帮助信息对这一个新功能解释得不是很好,但这一点仍旧是可以通过修改脚本代码来修复(通过 help 关键字)。...我们把它设置 0 是为了它可以进行整数比较。记住,默认情况下,如果一个可选参数没有被指定,它将得到 None 值,它不能进行整数比较(因此会报 TypeError 异常)。

1K20

python argparse处理命令行参数

对于脚本编程而言,经常需要从命令行传递参数到脚本中。对于命令行参数定义和使用,有一套完整规则,以linux上ls命令例 ls --help Usage: ls [OPTION]......从输出内容可以看到,命令行参数可以分为两大类 可选参数 位置参数 option表示可选参数,有两种写法,一种是一个短横杠后面加选项名称,称之为短选项,另外一种是两个短横杠后面加选项名称,称之长选项。...位置参数是必须提供,前面不需要短横杠修饰,直接就是参数名称,ls命令用法示意如下 ls -l dir 其中-l就是一个选项, dir则是一个位置参数, 要在python脚本中实现这样命令行传参,...可以看到,argparse脚本自动添加了-h选项,用来查看帮助文档 python test.py -h usage: test.py [-h] [-l] dir positional arguments...,当运行-h来查看脚本帮助信息时,默认使用name或者dest值,如果指定了metavar,则参数名称显示metavar值, 该参数仅在显示帮助信息时有用,没有其他实际含义,用法如下 >>> parser.add_argument

1.6K20

会用python把linux命令写一遍的人,进大厂有多容易?

文章中我就提到如何提升自己 python 能力呢?直接找项目写,但是作为零基础 / 小白 / 入门 你来说做一个博客还要学 web 框架、html、css、js,又成为了阻碍你写实际项目的阻碍。...2018.2 - 使用模块:argparse, os 了解argparse模块 argparsepython标准库,他可以使我们很友好编写命令行界面,并且可以自动生成帮助文档和使用消息,还能在参数无效时候发出错误...argparse.ArgumentParse类参数理解 1. prog:改变应用名字,我们可以使用`%(prog)s`引用应用名字,默认应用名字文件名。...2. usage: 显示这个命令用法, 一般用来显示参数用法 3. description:显示这个命令帮助信息 4. epilog: 显示命令帮助信息,位置在参数下面 argparse.ArgumentParser.add_argument...8. dest: 自定义参数名称,默认名称为 “- 后面的值” 或者 “-- 后面的值”。 编写ls命令脚本 这里我们就简单指定三个参数. - -a: 添加 -a 参数,显示隐藏文件。

63830

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

通过创建命令行界面(CLI),可以使程序功能强大并具有交互性。CLI允许您接受命令行参数(操作系统命令行中程序名称后面的信息),以便向程序添加其他特性,使代码易于使用和灵活。...处理错误情况:用户确切地知道哪里出了问题 运行时状态:如果任务没有立即完成,您应该打印出当前进度 使用argparse读取参数: Argparse一个用于解析命令行参数Python标准库模块。...作为程序员,您可以定义要接受参数,而argparse将知道如何从sys中解析这些参数。当用户给程序提供无效参数时,Argparse还会自动生成帮助和使用消息,并输出错误。...() 现在使用--help选项运行代码: python3 test_cli.py --help 你应该会收到一个很好默认帮助信息,像这样: usage: test_cli.py [-h] optional...一种简单方法是将参数值存储变量,然后打印这些值。

2.4K20

如何使用Python命令行参数——创建自己Python命令行参数脚本简单指南

$ python main.py arg1 arg2 我们将使用Pythonargparse模块来配置命令行参数和选项。argparse 模块可以人轻松编写用户友好命令行接口。...程序定义它需要参数,然后argparse 将弄清如何从 sys.argv 解析出那些参数。argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。...conda install argparse 定义位置参数和可选参数 创建一个ArgumentParse对象parser,在ArgumentParser中对该脚本做简要描述。...中默认定义参数,显示脚本中定义描述,用户在使用该脚本时提供帮助。...调用 --help 可以获取choices使用说明信息。 现在你已经学会了如何使用自定义参数创建自己Python命令行。希望这篇文章对你有帮助

2.4K00

会用python把linux命令写一遍的人,进大厂有多容易?

文章中我就提到如何提升自己 python 能力呢?直接找项目写,但是作为零基础 / 小白 / 入门 你来说做一个博客还要学 web 框架、html、css、js,又成为了阻碍你写实际项目的阻碍。...2018.2 - 使用模块:argparse, os 了解argparse模块 argparsepython标准库,他可以使我们很友好编写命令行界面,并且可以自动生成帮助文档和使用消息,还能在参数无效时候发出错误...argparse.ArgumentParse类参数理解 1. prog:改变应用名字,我们可以使用`%(prog)s`引用应用名字,默认应用名字文件名。...2. usage: 显示这个命令用法, 一般用来显示参数用法 3. description:显示这个命令帮助信息 4. epilog: 显示命令帮助信息,位置在参数下面 argparse.ArgumentParser.add_argument...8. dest: 自定义参数名称,默认名称为 “- 后面的值” 或者 “-- 后面的值”。 编写ls命令脚本 这里我们就简单指定三个参数. - -a: 添加 -a 参数,显示隐藏文件。

59120

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

简介 在编程中,我们往往会遇到需要通过外部参数来控制脚本运行模式情况,在通用框架类代码中,这种情况尤为明显,因此,这里,我们来考察一下如何将参数传入到脚本文件中,而不是作为固定参数写死在脚本当中。...2. argparse一般使用方法 argparse库是python自带一种用于实现脚本参数传递函数库。...下面,我们考察如何写入信息。 其信息包括两部分: 整体参数说明,这部分内容在创建parser时传入; 局部每一个参数说明,这部分内容在添加每一个参数时通过help参数进行传入。...3. default参数与required参数 argparse库可以为参数设置是否必须以及默认值。 当一个参数被设置必需时,如果传入该参数则会发生报错。..._get_kwargs()) 测试发现: 如果不传入a和c参数,脚本会直接报错,说明required参数默认值True,且其判断优先级高于default参数; b与d参数可以不传入,不过不传入这两个参数

4.1K21

如何利用Python学习linux命令?

没错,就是 linux 中经常会用到 ls 命令。 文章中我就提到如何提升自己 python 能力呢?...使用模块:argparse, os 了解argparse模块 argparsepython标准库,他可以使我们很友好编写命令行界面,并且可以自动生成帮助文档和使用消息,还能在参数无效时候发出错误...argparse.ArgumentParse类参数理解 1. prog:改变应用名字,我们可以使用`%(prog)s`引用应用名字,默认应用名字文件名。...2. usage: 显示这个命令用法, 一般用来显示参数用法 3. description:显示这个命令帮助信息 4. epilog: 显示命令帮助信息,位置在参数下面 argparse.ArgumentParser.add_argument...8. dest: 自定义参数名称,默认名称为 “- 后面的值” 或者 “-- 后面的值”。 编写ls命令脚本 这里我们就简单指定三个参数. - -a: 添加 -a 参数,显示隐藏文件。

79310

Python3 初学实践案例(3)argparse 命令行参数库使用

首先,我们定义一个分析器 parser = argparse.ArgumentParser() 官方教程就是这么写,我粗浅认为,这是为了代码变得短一些。...定义分析器之后,我们就可以往里面添加我们需要参数。 我们脚本添加一个说明描述 首先呢,我们脚本是干啥,得先描述一下。...后面的 %(prog)s 代表你自己脚本名称。这个是可变。并且是可以设置。...添加一个互相排斥二选一选填参数 上面添加这些参数是可以满足很多场景,但是一个场景满足不了,比如,我需要 -m | -c 这两个参数只能出现一个,如果同时出现两个就不行。...打印帮助信息 我们在程序后面加上 -h 这个参数,就可以得到一个我们程序详细帮助信息。这个是 argparse 自带牛逼功能。省得我们自己去构建帮助信息,我表示非常喜欢。

1.5K90

python-argparse

对于简单程序脚本,可以直接使用sys.argv[] 来获取命令行参数,但是应用到大软件项目中,我们需要更加规范,更加方便而功能强大工具来处理命令行参数,本文主要介绍python标准库argparse...简单使用,详细方法及示例请参考python标准库 python获取命令行参数 获取参数 sys.argv sys.argv[0] 程序名称,其后分别为参数,len(sys.argv)可得出所有参数个数...缺点有两个,一是长短配置项需要分开处理,二是对非法参数和必填参数处理需要手动 optparse 比getopt 更加方便,强劲,采用声明式风格,还可以自动生成帮助信息 argparse 继承了optparse...,所以现在主要学习argparse argparse argparse 解析命令行选项,参数以及子命令 argparse 可以帮助更方便写出用户友好命令行接口。...程序定义它需要什么参数,argparse 解决如何解析这些来自sys.argv 参数 argparse 同样自动生成帮助和使用说明信息并且当使用者给出错误参数时分发错误 #引入模块 import argparse

77710
领券