Python命令行参数解析工具 docopt 安装和应用过程详解
作者:海纳百川_有容乃大 发布时间:2022-01-15 05:31:05
什么是 docopt?
1、docopt 是一种 Python 编写的命令行执行脚本的交互语言。
它是一种语言!
它是一种语言!
它是一种语言!
2、使用这种语言可以在自己的脚本中,添加一些规则限制。这样脚本在执行的时候就必须按照这样格式来执行,同时,也可以很方便的编写一些帮助信息(其实很多软件在输入 -h 的时候显示信息 、例如 python -h ,会显示所有的 python 指令,并且页通过 docopt 限制了 python 指令的格式),下面是一些简单的例子:
docopt 的安装
docopt 有很多把版本,分别支持不同的语言,最简单就是支持 python 语言,docopt.java 支持 java脚本,docopts 则是支持 shell 脚本的(下面的例子主要事以 docopts 为例)
1、安装 docopt
方法一:
pip install docopt
方法二:
也可以在 github 上下载源码(docopt 是开源项目),然后通过 Python setup.py install 安装
2、安装 docopts 就必须使用上面的安装docopt 的方法二来进行安装,然后使用 python 安装,下载地址:
https://github.com/docopt/docopts
docopt 实现简单分析
在 Python 中有这么一个属性__doc__ , 它的值是字符串,一般表示帮助信息,而 docopt 正是利用了这一属性,把帮助信息替换成命令行参数解析说明,在对它进行解析即可:
举个例子:
"""Naval Fate.
Usage:
naval_fate.py ship new <name>...
naval_fate.py ship <name> move <x> <y> [--speed=<kn>]
naval_fate.py ship shoot <x> <y>
naval_fate.py mine (set|remove) <x> <y> [--moored | --drifting]
naval_fate.py (-h | --help)
naval_fate.py --version
Options:
-h --help Show this screen.
--version Show version.
--speed=<kn> Speed in knots [default: 10].
--moored Moored (anchored) mine.
--drifting Drifting mine.
"""
from docopt import docopt
if __name__ == '__main__':
arguments = docopt(__doc__, version='Naval Fate 2.0')
print(arguments)
上面代码中,很大一段帮助信息就是我们命令行参数解析说明,在函数入口调用了 docopt 函数进行解析,返回的 arguments 变量是一个字典变量,它记录了选项是否被选用了,参数的值是什么等信息,当程序从命令行运行时,我们就是根据 arguments 变量的记录来得知用户输入的选项和参数信息。
所以如何写好命令行参数解析说明就很重要了,命令行解析信息包含两部部分,分别是使用模式格式和选项描述格式。
使用模式格式(Usage pattern format)
使用模式格式 usage:开始,以空行结束,如上述代码显示,它主要描述了用户添加命令含参数的格式,也就是使用时的格式,解析也是按照此格式来进行的。
每一个使用模式都包含以下元素:
* 参数
参数使用大写字母或者使用尖括号<> 围起来
* 选项
选项以短横线开始 或者 --,只有一个字母时格式 -o,多于一个字母时 --output ,同时还可以把多个单字母的选选项合并, -ov 等同于 -o, -v, -i.。选项也能
参数,此时别忘了给选项添加描述说明
接下来时使用模式中用到的一些标识的含义,正确的使用他们能够更好的完成解析任务:
* []
代表可选的元素,方括号中的元素可有可无
*()
代表必要有的元素,括号内的元素必须要有,哪怕时多个里面选一个
*|
互斥的元素,竖线两旁的元素只能有一个留下
* ....
代表元素可以重复出现,最后解释的结果时一个列表
*[options]
指定特定的选项,完成特定的任务。
选项描述格式(Options description format)
选项描述同样必不可少,尤其时方选项有参数,并且还需要为它赋默认值时。
为选项添加参数的格式有两种:
-o FILE --output -FILE # 不是用逗号, 使用 = 符号
-i <file>, --input <file> # 使用逗号, 不使用 = 符号
为选项添加描述说明,只需要用两个空格分割选项和说明即可
为选项添加默认值时,把它添加到选择描述后面即可,格式如下【defailt: <my-default-value>】
--coefficient=K The K coefficient [default: 2.95]
--output=FILE Output file [default: test.txt]
--directory=DIR Some directory [default: ./]
如果选项时可以重复的,那么它的值 [default: ...] 将会是一个列表,若不可以重复,则它的值时一个字符串。
使用
理解了使用模式格式 和 选项描述格式之后,在配合给出的例子就能较好的理解了;
接下来就是得到输入信息了
在前面提到 arguments 参数是一个字典类型,包含了用户输入的选项和参数信息,还是上面的代码端例子,假如我们从命令行运行的输入是
python test.py ship Guardian move 100 150 --speed=15
那么打印 arguments 参数如下:
{'--drifting': False,
'--help': False,
'--moored': False,
'--speed': '15',
'--version': False,
'<name>': ['Guardian'],
'<x>': '100',
'<y>': '150',
'mine': False,
'move': True,
'new': False,
'remove': False,
'set': False,
'ship': True,
'shoot': False}
从打印的信息可以到,对于选项,使布尔类型来标识是否输入了该选项,则使用具体值来表述。
这样以来,程序就可以从 arguments 变量中得到下一步的操作了,若是用户什么参数都没输入,则打印 Usage 说明提示内容。
来源:https://www.cnblogs.com/jcjc/p/11586618.html
猜你喜欢
- 前言昨天因为小程序功能要获取小程序程序码,看了微信文档爬了好多坑。(留一下记录以防后面被坑)操作因为我获取到了微信那里的图片的图片流一直不知
- 我们可用正规表达式来寻找并替换URL和邮件地址为活动的超级链接。用到的主要函数就是InsertHyperlinks(inText),语法为:
- 阅读上一节:无序列表信息有时候是无序归纳的,有的却有着明确的顺序,在上一篇也提到了。那么简单的来想一下身边有哪些事物是有先后顺序的:操作步骤
- 阅读上一篇文章《WEB2.0网页制作标准教程(5)head区的其他设置》在开始正式内容制作之前,我们必须先了解一下web标准有关代码的规范。
- 在用户登录windows操作系统的时候,如果触发到了登录表单的密码录入框上,并且此时按下了“大写锁定键(Caps Lock)”,那么界面上会
- 问题:在论坛发表回复时出现“The table is full”的提示,字面意义上是数据表已满的意思。因为很少有开发者遭遇单一表超过4G的情
- 前言:前面提到了Python中的数值型内置数据类型,接下来呢我们就着重介绍一下字符串类型。在Python中字符串是一个有序的字符集合,没有独
- 对数据库的管理常规就是进行预防性的维护,以及修复那些出现问题的内容。进行检查和修复通常具有四个主要的任务:1. 对表进行优化2. 对表进行分
- 前言在Python中已经内置了一个smtp邮件发送模块,Django在此基础上进行了简单地封装,让我们在Django环境中可以更方便更灵活的
- 两段使用键盘的上下键进行选择的代码:<Script Language="JScript"> &
- FileUpload上传图片(图片不变形) 的实现方法,需要的朋友可以参考下。<style type="text/css&q
- jQuery的选择器可谓异常强大,没有什么DOM里的任何数据能逃出它的掌心,这点是我非常喜欢的,以前获取NODE要用getElementBy
- 这学期在学习编译原理,最近的上机作业就是做一个简单的词法分析器,在做的过程中,突然有个需求就是判断一个字符串是否为合法的标示符,因为我是用p
- 检测是否注册成功<% Set Jpeg =Server.CreateObject("Persi
- 如下所示:interval=stats.t.interval(a,b,mean,std)t分布的置信区 间a:置信水平b:检验量的自由度me
- CSV文件简单来说CSV文件由任意数目的记录组成,记录间以某种换行符分隔;每条记录由字段组成,字段间的分隔符是其它字符或字符串,最常见的是逗
- SQL Server服务器的配置选项属于那种人们了解较少且经常误用的选项。当一个技术支持人员要求你按照某种方式调整一个选项、而另一个技术支持
- PHP版: $o = array('x'=>1, 'y'=>2, 'z'=>
- 今天看到某人博客推荐了http://dragoninteractive.com/这个网站,貌似一些效果做的比较不错,于是打开了看看,不过还真
- <%dim ylj,ywj,Mlpath,Shell,rarcomm,RetCode,cmd,comm,fsoM