Python中的命令行参数解析工具之docopt详解


Posted in Python onMarch 27, 2017

前言

docopt 是一个开源的库,代码地址:https://github.com/docopt/docopt。它在 README 中就已经做了详细的介绍,并且还附带了很多例子可供学习,这篇文章也是翻译一下 README 中内容……

docopt 最大的特点在于不用考虑如何解析命令行参数,而是当你把心中想要的格式按照一定的规则写出来后,解析也就完成了。

docopt的安装

docopt有很多种版本,分别支持不同的语言,最简答的docopt支持python脚本,docopt.java支持java脚本,docopts则是支持shell脚本的(下面的例子主要以docopts为例),具体的可以参见github的docopt说明

安装docopt

以mac os x为例安装,安装docopts前首先需要安装docopt,有两种安装方法

方法一

比较简单的方法是直接用 pip 安装, pip install docopt==0.6.2

有些mac可能不支持直接pip 指令,需要先安装pip

方法二

也可以在github上下载源码(docopt是开源项目),然后通过python setup.py install 安装

安装docopts

安装docopts就必须使用上面安装docopt的方法二,在GitHub上下载源码,然后 使用python安装,下载地址

docopt 的实现简单分析

在 Python 中有这么一个属性 __doc__ ,它的值是字符串,一般表示帮助信息,而 docopt 正是利用了这一属性,把帮助信息替换成命令行参数解析说明,再对它进行解析即可。

举个 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。同时还可以把多个单字母的选项合并,-ovi等同于-o、-v、-i。选项也能有参数,此时别忘了给选项添加描述说明。

接下来是使用模式中用到的一些标识的含义,正确地使用他们能够更好的完成解析任务:

* []

代表可选的元素,方括号内的元素可有可无

* ()

代表必须要有的元素,括号内的元素必须要有,哪怕是多个里面选一个。

* |

互斥的元素,竖线两旁的元素只能有一个留下

* ...

代表元素可以重复出现,最后解析的结果是一个列表

* [options]

指定特定的选项,完成特定的任务。

选项描述格式(Option description format)

选项描述同样必不可少,尤其是当选项有参数,并且还需要为它赋默认值时。

为选项添加参数的格式有两种:

-o FILE --output-FILE  # 不使用逗号,使用 = 符号
-i <file>, --input <file> # 使用逗号,不使用 = 符号

为选项添加描述说明,只需要用两个空格分隔选项和说明即可。

为选项添加默认值时,把它添加到选择描述后面即可,格式如下[default: <my-default-value>]

--coefficient=K The K coefficient [default: 2.95]
--output=FILE Output file [default: test.txt]
--directory=DIR Some directory [default: ./]

如果选项是可以重复的,那么它的值[default: ...]将会一个 list列表,若不可以重复,则它的值是一个字符串。

使用

理解了 使用模式格式 和 选项描述格式 之后,再配合给出的例子就能较好的理解了。

接下来就是得到输入的信息了。

在前面提到arguments参数是一个字典类型,包含了用户输入的选项和参数信息,还是上面的代码段例子,假如我们从命令行运行的输入是

python3 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中使用第三方库xlutils来追加写入Excel文件示例
Apr 05 Python
深入探究Python中变量的拷贝和作用域问题
May 05 Python
在Django的模型中执行原始SQL查询的方法
Jul 21 Python
python函数式编程学习之yield表达式形式详解
Mar 25 Python
Python实现去除列表中重复元素的方法小结【4种方法】
Apr 27 Python
Python django框架开发发布会签到系统(web开发)
Feb 12 Python
Python使用sqlite3模块内置数据库
May 07 Python
基于Keras的格式化输出Loss实现方式
Jun 17 Python
python中tab键是什么意思
Jun 18 Python
Django mysqlclient安装和使用详解
Sep 17 Python
基于Python实现全自动下载抖音视频
Nov 06 Python
matplotlib之属性组合包(cycler)的使用
Feb 24 Python
Python使用PDFMiner解析PDF代码实例
Mar 27 #Python
详解python并发获取snmp信息及性能测试
Mar 27 #Python
使用Python写CUDA程序的方法
Mar 27 #Python
pyenv命令管理多个Python版本
Mar 26 #Python
Django实现自定义404,500页面教程
Mar 26 #Python
Python 多线程实例详解
Mar 25 #Python
解决python3 urllib中urlopen报错的问题
Mar 25 #Python
You might like
PHP调用JAVA的WebService简单实例
2014/03/11 PHP
PHP+redis实现的悲观锁机制示例
2018/06/12 PHP
Yii框架Session与Cookie使用方法示例
2019/10/14 PHP
php实现文件上传基本验证
2020/03/04 PHP
为Javascript中的String对象添加去除左右空格的方法(示例代码)
2013/11/30 Javascript
jQuery实现折叠、展开的菜单组效果代码
2015/09/16 Javascript
解决JS无法调用Controller问题的方法
2015/12/31 Javascript
JavaScript数据存储 Cookie篇
2016/07/02 Javascript
遍历json获得数据的几种方法小结
2017/01/21 Javascript
详解vue 配合vue-resource调用接口获取数据
2017/06/22 Javascript
js实现for循环跳过undefined值示例
2019/07/02 Javascript
vue点击按钮动态创建与删除组件功能
2019/12/29 Javascript
Javascript柯里化实现原理及作用解析
2020/10/22 Javascript
js实现日历
2020/11/07 Javascript
python采用getopt解析命令行输入参数实例
2014/09/30 Python
Python字符串中查找子串小技巧
2015/04/10 Python
Python使用matplotlib实现在坐标系中画一个矩形的方法
2015/05/20 Python
Python算法之图的遍历
2017/11/16 Python
Python数据结构之双向链表的定义与使用方法示例
2018/01/16 Python
selenium+python自动化测试环境搭建步骤
2019/06/03 Python
Python读写文件基础知识点
2019/06/10 Python
pyQt5实时刷新界面的示例
2019/06/25 Python
Python 脚本实现淘宝准点秒杀功能
2019/11/13 Python
关于初始种子自动选取的区域生长实例(python+opencv)
2020/01/16 Python
python实现的分层随机抽样案例
2020/02/25 Python
Python Tornado之跨域请求与Options请求方式
2020/03/28 Python
英国派对礼服和连衣裙购物网站:TFNC London
2018/07/07 全球购物
英国在线照明超市:Castlegate Lights
2019/10/30 全球购物
美国家居装饰购物网站:Amanda Lindroth
2020/03/25 全球购物
安全生产标语
2014/06/06 职场文书
学习党的群众路线对照检查材料
2014/09/29 职场文书
专业见习报告范文
2014/11/03 职场文书
呼兰河传读书笔记
2015/06/30 职场文书
JavaScript实现显示和隐藏图片
2021/04/29 Javascript
关于antd tree 和父子组件之间的传值问题(react 总结)
2021/06/02 Javascript
关于Python使用turtle库画任意图的问题
2022/04/01 Python