Python命令行参数解析工具 docopt 安装和应用过程详解


Posted in Python onSeptember 26, 2019

什么是 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 说明提示内容。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python实现带百分比的进度条
Jun 28 Python
用python编写第一个IDA插件的实例
May 29 Python
windows下安装Python虚拟环境virtualenvwrapper-win
Jun 14 Python
python实现Dijkstra算法的最短路径问题
Jun 21 Python
python 实现创建文件夹和创建日志文件的方法
Jul 07 Python
python防止随意修改类属性的实现方法
Aug 21 Python
Django 实现Admin自动填充当前用户的示例代码
Nov 18 Python
Python3 把一个列表按指定数目分成多个列表的方式
Dec 25 Python
自定义Django Form中choicefield下拉菜单选取数据库内容实例
Mar 13 Python
Opencv python 图片生成视频的方法示例
Nov 18 Python
一些让Python代码简洁的实用技巧总结
Aug 23 Python
Python+tkinter实现高清图片保存
Mar 13 Python
django框架创建应用操作示例
Sep 26 #Python
Python从入门到精通之环境搭建教程图解
Sep 26 #Python
python性能测量工具cProfile使用解析
Sep 26 #Python
python使用socket 先读取长度,在读取报文内容示例
Sep 26 #Python
用python写测试数据文件过程解析
Sep 25 #Python
Python使用grequests(gevent+requests)并发发送请求过程解析
Sep 25 #Python
给大家整理了19个pythonic的编程习惯(小结)
Sep 25 #Python
You might like
PHP 自定义错误处理函数trigger_error()
2013/03/26 PHP
详解PHP错误日志的获取方法
2015/07/20 PHP
php实现的操作excel类详解
2016/01/15 PHP
php使用escapeshellarg时中文被过滤的解决方法
2016/07/10 PHP
PHP实现浏览器中直接输出图片的方法示例
2018/03/14 PHP
PHP7 整型处理机制修改
2021/03/09 PHP
jquery animate图片模向滑动示例代码
2011/01/26 Javascript
jquery清空textarea等输入框实现代码
2013/04/22 Javascript
原生JavaScript实现连连看游戏(附源码)
2013/11/05 Javascript
javascript使用appendChild追加节点实例
2015/01/12 Javascript
基于jquery实现鼠标滚轮驱动的图片切换效果
2015/10/26 Javascript
谈一谈bootstrap响应式布局
2016/05/23 Javascript
jQuery事件委托之Safari
2016/07/05 Javascript
JQuery 动态生成Table表格实例代码
2016/12/02 Javascript
Bootstrap进度条实现代码解析
2017/03/07 Javascript
VUE饿了么树形控件添加增删改功能的示例代码
2017/10/17 Javascript
vue移动端html5页面根据屏幕适配的四种解决方法
2018/10/19 Javascript
vue组件tabbar使用方法详解
2018/11/06 Javascript
jquery实现简单拖拽效果
2020/07/20 jQuery
python输出当前目录下index.html文件路径的方法
2015/04/28 Python
python制作最美应用的爬虫
2015/10/28 Python
Python获取某一天是星期几的方法示例
2017/01/17 Python
Python实现统计文本文件字数的方法
2017/05/05 Python
详解python eval函数的妙用
2017/11/16 Python
详解PyTorch中Tensor的高阶操作
2019/08/18 Python
详细整理python 字符串(str)与列表(list)以及数组(array)之间的转换方法
2019/08/30 Python
Python列表list常用内建函数实例小结
2019/10/22 Python
打印tensorflow恢复模型中所有变量与操作节点方式
2020/05/26 Python
Python selenium 加载并保存QQ群成员,去除其群主、管理员信息的示例代码
2020/05/28 Python
python安装读取grib库总结(推荐)
2020/06/24 Python
CSS3 函数技巧 用css 实现js实现的事情(clac Counters Tooltip)
2017/08/15 HTML / CSS
HTML5+CSS3 实现灵动的动画 TAB 切换效果(DEMO)
2017/09/15 HTML / CSS
英国运动风奢侈品购物网站:Maison De Fashion
2020/08/28 全球购物
导师鉴定意见
2015/06/05 职场文书
十二生肖观后感
2015/06/12 职场文书
家庭经济困难证明
2015/06/23 职场文书