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

如何让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.4K10
  • 怎样学Python 第二十三课 模块化处理用户输入基础

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

    705100

    【测试开发】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 所需要的常量值。...以上就是这个库的介绍,我们在实际中,也会遇到这个问题,在实际的交付的脚本中,大家不知道怎么使用,在交付的时候,就可以用这个,去出一个教程,大家运行的时候,就知道,这个脚本需要传递的参数类型,内容了,方便大家执行脚本的时候

    19210

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

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

    2.8K20

    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...当一个参数被添加到组中时,解析器就像对待一个普通的参数一样对待它,但是会在一个单独的组中显示该参数以获取帮助消息。

    7.1K20

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

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

    22100

    精通 Python OpenCV4:第一部分

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

    3.1K10

    Python argparse 模块

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

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

    65830

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

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

    2.6K20

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

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

    61420

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

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

    4.4K21

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

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

    2.5K00

    如何利用Python学习linux命令?

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

    81710

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

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

    1.6K90

    使用OpenCV,Python和模板匹配来播放“Waldo在哪里?”

    你需要什么: Python,NumPy和OpenCV;了解一些基本的图像处理概念将有所帮助,但不是必须要求。这个操作指南是为了让您了解如何使用OpenCV进行模板匹配。没有安装这些库?没问题。...目标: 那么我们创建Python脚本的最终目标是什么? 目标是:给出沃尔多的查询图像和拼图图像后,找到沃尔登在拼图里的形象,并突出显示他的位置。...我们的拼图和查询图像 我们需要两个图像来构建我们的Python脚本来执行模板匹配。 第一个图像是我们要解决的沃尔多之谜。您可以在本文的顶部看到图1中的谜题。...对与条纹图案具有高相关性的图像区域进行二值化。 本文旨在介绍基本的计算机视觉技术,如模板匹配。稍后我们可以深入讲解更先进的技术。Waldo只是一个我很想要和你分享的很酷且简单的模板匹配方法!...使用Python和OpenCV进行模板匹配其实很简单。首先,您只需要两个图像 - 要匹配的对象的图像和包含该对象的图像。

    2.6K60
    领券