首页 / PYTHON / Python中最好用的命令行解析工具：argparse

Python中最好用的命令行解析工具：argparse

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了Python中最好用的命令行解析工具：argparse，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含7259字，纯文字阅读大概需要11分钟。

内容图文

Python 做为一个脚本语言，可以很方便地写各种工具。当你在服务端要运行一个工具或服务时，输入参数似乎是一种硬需（当然你也可以通过配置文件来实现）。

如果要以命令行执行，那你需要解析一个命令行参数解析的模块来帮你做这个苦力活。

Python 本身就提供了三个命令行参数解析模块，我这里罗列一下它们的大致情况供你了解。

getopt，只能简单的处理命令行参数
optparse，功能强大，易于使用，可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。（Python2.7以后弃用，不会继续发展）
argparse，使其更加容易的编写用户友好的命令行接口。它所需的程序进程了参数定义，argparse将更好的解析sys.argv。同时argparse模块还能自动生成帮助及用户输入错误参数时的提示信息。

很多初学者可能会使用getopt，上手简单功能也简单。比如说optget无法解析一个参数多个值的情况，如 --file file1 file2 file3，而 optparse 实际上我没有用过，但是考虑到它在Python2.7后已经不再维护，我们通常也不会使用它。

接下来只剩下 argparse 这一神器，它几乎能满足我对命令解析器的所有需求。它支持解析一参数多值，可以自动生成help命令和帮助文档，支持子解析器，支持限制参数取值范围等等功能。

0. HelloWorld

不管学习什么东西，首先第一步都应该是掌握它的大体框架。

而使用 argparse 前，框架很简单，你只需要记住这三行。

#?mytest.py
import?argparse
parser?=?argparse.ArgumentParser(description="used?for?test")

args?=?parser.parse_args()

现在可以尝试一下

[root@localhost?~]#?python?mytest.py?-h
usage:?mytest.py?[-h]

used?for?test

optional?arguments:
??-h,?--help??show?this?help?message?and?exit
[root@localhost?~]#?
[root@localhost?~]#?
[root@localhost?~]#?python?mytest.py
[root@localhost?~]#?

已经可以使用了。

1. 入门配置

这里先讲一下，比较常用的参数配置。

调试：debug
版本号：version

import?argparse
parser?=?argparse.ArgumentParser()

parser.add_argument('--version',?'-v',?action='version',
????????????????????version='%(prog)s?version?:?v?0.01',?help='show?the?version')

parser.add_argument('--debug',?'-d',?action='store_true',
????????????????????help='show?the?version',
????????????????????default=False)

args?=?parser.parse_args()
print("===?end?===")

上面debug处的配置，需要讲一下的是 action='store_true' 和 default = False 的作用和区别

store_true：一旦指定了 -d 或者 --debug ，其值就为 True，store_false则相反
default=False：未指定 -d 或者 --debug，其值就默认为False

当我们执行 python mytest.py -v，就会打印 version 里的内容。

[root@localhost?~]#?python?mytest.py?-v
mytest.py?version?:?v?0.01
[root@localhost?~]#?

一旦执行时，指定了参数 -v ，执行到 parser.parse_args() 就会退出程序，不会打印最后的 === end ===

2. 参数种类

参数可分为必选参数（positional arguments）和可选参数（optional arguments）。

在argsparse 里如何实现呢？

必选参数

用单词做参数，默认就为必选参数

#?mytest.py
import?argparse

parser?=?argparse.ArgumentParser()
parser.add_argument("name")

args?=?parser.parse_args()

print(args.name)

不指定name参数运行一下：python mytest.py

[root@localhost?~]#?python?mytest.py?
usage:?mytest.py?[-h]?name
mytest.py:?error:?too?few?arguments
[root@localhost?~]#

如预期一样，报错了，说缺少参数。那我们指定一下：python mytest.py name wangbm

[root@localhost?~]#?python?mytest.py?wangbm
wangbm
[root@localhost?~]#?

可选参数

有两种方式：

单下划线 - 来指定的短参数，如-h；
双下划线 -- 来指定的长参数，如--help

#?mytest.py
import?argparse

parser?=?argparse.ArgumentParser()
parser.add_argument("-v",?"--verbosity",?help="increase?output?verbosity")

args?=?parser.parse_args()

if?args.verbosity:
????print("verbosity?turned?on")
else:
????print("verbosity?turned?off")

试着运行一下 python mytest.py，不会报错。

[root@localhost?~]#?python?mytest.py
verbosity?turned?off
[root@localhost?~]#

3. 参数类型

有的参数，是字符串，有的参数，是数值。

为了对命令行中的参数进行有效的约束，我们可以事先对参数的类型进行声明。argparse 会对参数进行校验，不通过时，会直接抛出错误。

#?mytest.py
import?argparse

parser?=?argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("age",?type=int)

args?=?parser.parse_args()

print(args.name)
print(args.age)

测试一下唄。

[root@localhost?~]#?python?mytest.py?wangbm?eighteen
usage:?mytest.py?[-h]?name?age
mytest.py:?error:?argument?age:?invalid?int?value:?'eighteen'
[root@localhost?~]#?
[root@localhost?~]#?python?mytest.py?wangbm?18
wangbm
18
[root@localhost?~]#

你看，写 eighteen 就不行，提示类型不合法，只有写 18 才行。

4. 互斥参数

有些参数，是互斥的，有你无我。比如，性别。

在 argparse 中如何实现？

import?argparse

parser?=?argparse.ArgumentParser()
group?=?parser.add_mutually_exclusive_group()
group.add_argument("-m",?"--male",?action="store_true")
group.add_argument("-f",?"--female",?action="store_true")
args?=?parser.parse_args()

如果同时指定了这两个参数，就会报错。

[root@localhost?~]#?python?mytest.py?-f
[root@localhost?~]#?python?mytest.py?-m
[root@localhost?~]#?python?mytest.py?-m?-f?
usage:?mytest.py?[-h]?[-m?|?-f]
mytest.py:?error:?argument?-f/--female:?not?allowed?with?argument?-m/--male
[root@localhost?~]#?

5. 可选值

如果是性别，可以像上面那样放在两个参数里然后用互斥组来约束，也可以放在一个参数里，在argparse里限制再在外层做判断。

#?mytest.py
import?argparse

parser?=?argparse.ArgumentParser()
parser.add_argument("-g",?"--gender",?default='male',
????????????????????choices=['male',?'female'])

args?=?parser.parse_args()
print(args.gender)

试着执行一下，发现性别只能是男或女，不能为人妖。

[root@localhost?~]#?python?mytest.py?--gender?male
male
[root@localhost?~]#?python?mytest.py?--gender?female
female
[root@localhost?~]#?
[root@localhost?~]#?
[root@localhost?~]#?python?mytest.py?--gender?other
usage:?mytest.py?[-h]?[-g?{male,female}]
mytest.py:?error:?argument?-g/--gender:?invalid?choice:?'other'?(choose?from?'male',?'female')
[root@localhost?~]#

6. 指定文件

经常会有那种要在脚本中指定配置文件或者其他文件的需求。可以使用下面的配置

import?argparse
parser?=?argparse.ArgumentParser()

parser.add_argument('--file',?'-f',?action='append',
????????????????????dest='files',
????????????????????help=('additional?yaml?configuration?files?to?use'),
????????????????????type=argparse.FileType('rb'))

args?=?parser.parse_args()

dest=files，是说将命令行中，--file 的参数值赋值给变量files，你可以用args.files访问。

action=append，由于我们会有指定多个文件的需求，那就指定多次--file ，argparse会将其放在一个list里。

type=argparse.FileType('rb')，既然是指定文件，那么参数应该为路径，并指定打开模式为rb，如果如果要取得文件内容，可以用 args.files[0].read()

7. 子解析器

如果你对命令行，有过足够多的接触，就会知道有些情况下会有子解析器。

这里我以自己工作中，碰到的例子来举个例子。

cloud-init?--debug?single?-name?mymodule

其中 single 后面是一个子解析器。

#?cloud-init.py

def?main_single(name,?args):
????print("name:?",?name)
????print("args:?",?args)
????print("I?am?main_single")

#?添加一个子解析器
subparsers?=?parser.add_subparsers()

parser_single?=?subparsers.add_parser('single',help='run?a?single?module')

#?对single?子解析器添加?action?函数。
parser_single.set_defaults(action=('single',?main_single))

#?require=True，是说如果命令行指定了single解析器，就必须带上?--name?的参数。
parser_single.add_argument("--name",?'-n',?action="store",
???????????????????????????help="module?name?to?run",
???????????????????????????required=True)

args?=?parser.parse_args()

(name,?functor)?=?args.action
if?name?in?["single"]:
????functor(name,?args)

执行命令cloud-init single -name mymodule，输出如下

name:??single
args:??Namespace(action=('single',?<function?main_single?at?0x0000000003F161E0>),?debug=False,?file=None,?name='mymodule')
I?am?main_single

Python中最好用的命令行解析工具：argparse - 文章图片 — 关注公众号，获取最新干货！

内容总结

以上是互联网集市为您收集整理的Python中最好用的命令行解析工具：argparse全部内容，希望文章能够帮你解决Python中最好用的命令行解析工具：argparse所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/840476.html

来源：【匿名】

【上一篇】Python中万物皆对象？的理解【下一篇】浅谈PHP运行Python脚本的方法

更多 ►

【Python中最好用的命令行解析工具：argparse】教程文章相关的互联网学习教程文章

python-argparse使用【代码】

官方文档：https://docs.python.org/zh-cn/3.7/library/argparse.html?highlight=argparse#module-argparseargparse 模块可以编辑用户友好的命令行接口import argparse""" 获取一个整数数列并计算合计或者最大值 """parser = argparse.ArgumentParser(description=‘Process some integers.‘) parser.add_argument(‘integers‘, metavar=‘N‘, type=int, nargs=‘+‘,help=‘an integer for the accumulator‘) parser.add_argu...

Python 命令行工具 argparse 模块使用详解【代码】【图】

先来介绍一把最基本的用法import argparseparser = argparse.ArgumentParser() parser.parse_args()在执行 parse_args() 之前，所有追加到命令行的参数都不会生效，生效了之后的默认情况类似于这样： Reference:https://www.jianshu.com/p/fef2d215b91d python argparse用法总结原文：https://www.cnblogs.com/piperck/p/8446580.html

Python argparse

http://songpengfei.iteye.com/blog/1440158https://docs.python.org/2/library/argparse.htmlhttp://stackoverflow.com/questions/15753701/argparse-option-for-passing-a-list-as-option原文：http://www.cnblogs.com/yxzfscg/p/5012344.html

python – 在argparse中使用numpy数据类型【代码】

我正在设置一个Argparse解析器来通过shell读取一些用户输入.输入将用于从包含字符串和数字的pandas DataFrame中提取数据.我想在Argparse.add_argument()中自动设置type =参数以匹配相应列的数据类型. 我的想法是设置像这样的Argparse参数,其中inputdata是DataFrame：for c in inputdata.columns:inputname= cinputtype= np.dtype(inputdata[c])parser.add_argument("--"+inputname, type=inputtype)但是,这不起作用：Python引发了一...

关于Argparse的10篇文章推荐【图】

这篇文章主要为大家详解Python命令行解析工具Argparse用法，感兴趣的小伙伴们可以参考一下最近在研究pathon的命令行解析工具，argparse，它是Python标准库中推荐使用的编写命令行程序的工具。以前老是做UI程序，今天试了下命令行程序，感觉相当好，不用再花大把时间去研究界面问题，尤其是vc++中尤其繁琐。现在用python来实现命令行，核心计算模块可以用c自己写扩展库，效果挺好。学习了argparse，在官方文档中找到一篇toturial，简...

Python中argparse库的基本使用（示例）

本篇文章给大家带来的内容是关于Python中argparse库的基本使用（示例），有一定的参考价值，有需要的朋友可以参考一下，希望对你有所帮助。基本使用import argparse# 创建解析器 parser = argparse.ArgumentParser(description = This is a test) parser.parse_args()可以在shell中测试：$ python test.py --help ...添加参数import argparseparser = argparse.ArgumentParser(description = This is a test) parser.add_argument(...

详解Python命令行解析工具Argparse用法

Python命令行解析工具Argparse的详细介绍

最近在研究pathon的命令行解析工具，argparse，它是Python标准库中推荐使用的编写命令行程序的工具。以前老是做UI程序，今天试了下命令行程序，感觉相当好，不用再花大把时间去研究界面问题，尤其是vc++中尤其繁琐。现在用python来实现命令行，核心计算模块可以用c自己写扩展库，效果挺好。学习了argparse，在官方文档中找到一篇toturial，简单翻译了下。http://docs.python.org/2/howto/argparse.html#id1Argparse Tutorial这篇教...

python中argparse模块用法实例详解

本文实例讲述了python中argparse模块用法。分享给大家供大家参考。具体分析如下：平常在写命令行工具的时候，经常会带参数，所以用python中的argparse来实现。# -*- coding: utf-8 -*- import argparse args = "-f hello.txt -n 1 2 3 -x 100 -y b -z a -q hello @args.txt i_am_bar -h".split() # 使用@args.txt要求fromfile_prefix_chars="@" # args.txt文件中应该一行一个参数，想改变行为参考convert_arg_line_to_args()...

python命令行参数解析包argparse【代码】

官方文档 https://docs.python.org/zh-cn/3/howto/argparse.html 代码示例 import argparseimport os# 解析命令行参数 ap = argparse.ArgumentParser() ap.add_argument("-d", "--dataset", required=True,help="path to input dataset of images") ap.add_argument("-d", "--output", required=True,help="outputdir") args["dataset"]# 命令行参数 ./a.py --dataset ./dir1 --output ./out

Python中如何将json文件转换成argparse【代码】

废话不多说了，就是json格式的文件或者数据，我们存到argparse这种类型的变量里面去。 import argparsedef get_args_from_json(json_file_path, args_dict):import jsonsummary_filename = json_file_pathwith open(summary_filename) as f:summary_dict = json.load(fp=f)for key in summary_dict.keys():args_dict[key] = summary_dict[key]return args_dictparser = argparse.ArgumentParser(description='Hello world') args_d...

Python argparse模块详解【代码】【图】

argparse是python用于解析命令行参数和选项的标准模块，用于代替已经过时的optparse模块。官方文档中讲到的，本文基本都提到了，但只是简要记录，如果需要深入理解，可查看原文。 https://docs.python.org/3/library/argparse.html 使用步骤 import argparse # 导入模板parser = argparse.ArgumentParser() # 创建parserparser.add_argument() # 添加参数args = parser.parse_args() ...

python argparse基本用法总结【代码】

1、argparse是什么这个模块时用来在命令行模式下运行Python脚本，使能够传入参数，直接看个例子：就是比通过的命令行运行多了杠杠啥，杠啥。 Python test_duye.py --video body.MP4 --image a.png --relative --adapt_scale 2、基本用法 # -*- coding: utf-8 -*-import argparse import datetimedef get_parser():# 生成argparse对象parser = argparse.ArgumentParser(description="帮助信息-->我的公众号名字是：杜唯西")# 添加...

Python中argparse使用的时候用-还是用--？【代码】

在文件test.py中， import argparseparser = argparse.ArgumentParser(description="SSc score prediction.") parser.add_argument( '-f', '--fold',choices=(1,2,3,4,5), help='5-fold training', type=int, default=2) # 这里'-f'和'--fold'可以只保留一个，或者都保留。只保留一个的话，args就会存在响应的属性args.f或者args.fold。如果都保留的话，并不会同时存在2个属性，而是会存在args.fold这一个。 args = parser.parse_...

python argparse模块总结【代码】

文章目录一、argparse是什么？二、使用步骤1.导包2. 使用流程3.参数位置参数-positional arguments可选参数-optional arguments三. 参考一、argparse是什么？ argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。 ref: argparse — 命令行选项、参数和子命令...

首页 / PYTHON / Python中最好用的命令行解析工具：argparse

Python中最好用的命令行解析工具：argparse

内容导读

内容图文

0. HelloWorld

1. 入门配置

2. 参数种类

3. 参数类型

4. 互斥参数

5. 可选值

6. 指定文件

7. 子解析器

内容总结

内容备注

内容手机端

【Python中最好用的命令行解析工具：argparse】教程文章相关的互联网学习教程文章

python-argparse使用【代码】

Python 命令行工具 argparse 模块使用详解【代码】【图】

Python argparse

python – 在argparse中使用numpy数据类型【代码】

关于Argparse的10篇文章推荐【图】

Python中argparse库的基本使用（示例）

详解Python命令行解析工具Argparse用法

Python命令行解析工具Argparse的详细介绍

python中argparse模块用法实例详解

python命令行参数解析包argparse【代码】

Python中如何将json文件转换成argparse【代码】

Python argparse模块详解【代码】【图】

python argparse基本用法总结【代码】

Python中argparse使用的时候用-还是用--？【代码】

python argparse模块总结【代码】

PYTHON - 相关标签

命令行 - 相关标签

PYTHON - 技术教程分类

PYTHON - 最新教程

PYTHON - 最热教程