docopt——好用的Python命令行参数解释器
Qingchat
使用的命令行参数解释器是 docopt
,用下来感觉非常棒,所以决定介绍一下这个库。( 奉劝各位看官,真爱生命,远离argparse。 )
介绍
docopt 本质上是在 Python 中引入了一种针对命令行参数的形式语言,在代码的最开头使用"""
文档注释的形式写出符合要求的文档,就会自动生成对应的parse,体验非常赞。
用法
样例
docopt的使用非常简单,以Qingchat为例,你只需要在代码最开头加入:
"""Qingchat CLI Usage:
qingchat config ip <ip>
qingchat config port <port>
qingchat config login
qingchat group list
qingchat group choose <group_name>...
qingchat group clean
qingchat group send -t <content>
qingchat group send -i <media>
qingchat group send -f <file> [<delaytime>] Options:
-h --help Show this screen.
-v --version Show version.
"""
然后在执行代码中加入:
arguments = docopt(__doc__, version='Qingchat 0.3.2')
就会在你的程序中导入一个 arguments
字典,这个字典中的内容形如:
{
'-f': False,
'-i': False,
'-t': False,
'<content>': None,
'<file>': None,
'<group_name>': [],
'<ip>': '127.0.0.1',
'<media>': None,
'<port>': None,
'choose': False,
'clean': False,
'config': True,
'group': False,
'ip': True,
'list': False,
'login': False,
'port': False,
'send': False
}
这样应该就能很容易看出来,我们在文档中写的每一个短语,都被转化为一个对应的类型。只要直接调用 arguments['xxx']
就可以判断或者使用对应的值,从而实现对应的功能。
详解
前面我们举了一个例子,下面我们来详细介绍一下如何完成一个符合 docopt
要求的注释文档。
Usage
所有出现在 usage:
(区分大小写)和一个空行之间的文本都会被识别为一个命令组合, usage
后的第一个字母将会被识别为这个程序的名字,所有命令组合的每一个部分(空格分隔)都会成为字典中的一个key。
参数
形如 <argument>
或者 ARGUMENT
的文本将会被识别为参数。
在转化后的字典中的取值为 True
或者 False
。
Usage: my_program <host> <port>
选项
形如 -o
或者 --option
的文本将会被识别为选项。
在转化后的字典中的取值为 True
或者 False
。
Usage: my_program -f <file>
Tips:
- 短选项可以组合起来,比如
-abc
等价于-a -b -c
- 长选项需要的参数需要使用
=
或者空格来分隔,--input=ARG
等价于--input ARG
- 短选项可以不需要空格,
-f FILE
等价于-fFILE
命令
其他不满足 --options
或者 <arguments>
的文本将会被识别为(子)命令。
在转化后的字典中取值为 True
或者 False
。
可选项
形如 [optional elements]
的文本是可选项。
elements
包括上述的三种类型:参数,选项以及命令。
在相同或者不同的括号中都是一样的:
Usage: my_program [command --option <argument>]
等价于
Usage: my_program [command] [--option] [<argument>]
必填项
形如 (required elements)
的文本是必填项。
上述三种元素默认都是必填项, ()
符号用在一些比较特殊的情形下,比如:
Usage: my_program (--either-this <and-that> | <or-this>)
选择项
形如 element|another
的文本是选择项,你可以从中选择一个值。
Usage: my_program go (--up | --down | --left | --right)
列表项
形如 element...
的文本是列表项,你可以输入多个参数。
比如说:
Usage: my_program open <file>...
然后你可以通过 arguments['<file>']
来访问这个列表。
Option
Option
部分用于指定某些特殊情形,比如:
- 将某个短参数与长参数关联起来,比如
-i <file>, --input <file>
- 某个选项有一个参数
- 选项的默认值,比如
--coefficient=K The K coefficient [default: 2.95]
docopt——好用的Python命令行参数解释器的更多相关文章
- Python命令行参数解析模块getopt使用实例
Python命令行参数解析模块getopt使用实例 这篇文章主要介绍了Python命令行参数解析模块getopt使用实例,本文讲解了使用语法格式.短选项参数实例.长选项参数实例等内容,需要的朋友可以参 ...
- python命令行参数解析OptionParser类用法实例
python命令行参数解析OptionParser类用法实例 本文实例讲述了python命令行参数解析OptionParser类的用法,分享给大家供大家参考. 具体代码如下: from opt ...
- Python命令行参数及文件读出写入
看完了柯老板的个人编程作业,虽然是评测组不用做此次作业,但还是想对本次作业涉及到利用Python命令行参数以及进行文件读出写入操作做一个简单的总结.(个人编程作业还是想自己能敲一敲,毕竟我的码力还是小 ...
- python命令行参数解析模块argparse和docopt
http://blog.csdn.net/pipisorry/article/details/53046471 还有其他两个模块实现这一功能,getopt(等同于C语言中的getopt())和弃用的o ...
- python命令行参数
〇.python中对应的argc, argv需要模块:sys参数个数:len(sys.argv)脚本名: sys.argv[0]参数1: sys.argv[1]参数2: sys. ...
- [转]Python 命令行参数和getopt模块详解
FROM : http://www.tuicool.com/articles/jaqQvq 有时候我们需要写一些脚本处理一些任务,这时候往往需要提供一些命令行参数,根据不同参数进行不同的处理,在Pyt ...
- Python 命令行参数和getopt模块详解
有时候我们需要写一些脚本处理一些任务,这时候往往需要提供一些命令行参数,根据不同参数进行不同的处理,在Python里,命令行的参数和C语言很类似(因为标准Python是用C语言实现的).在C语言里,m ...
- Python 命令行参数解析
方法1: Python有一个类可以专门处理命令行参数,先看代码: #!/usr/bin/env python # encoding: utf-8 from optparse import Option ...
- Python命令行参数sys.argv[]
学习C语言的时候就没弄明白命令行参数的用法,在学习Pyton 的时候又遇到了命令行参数,在这里稍微学习了一下,稍微明白了一些在这里做个记录方便后面回顾复习. Sys.argv[]是用来获取命令行参数的 ...
随机推荐
- Latex基础__如何用latex编写矩阵、矩阵等式、方程组、等式左对齐
数学矩阵和方程组是数学工作者经常遇到的,那么如何用latex书写处漂亮的方程组.矩阵.多个等式呢,下面将对这个问题一一做介绍.1. 写矩阵. 代码: \begin{equation} \left[ \ ...
- tomcat启动很慢很慢很慢
今天下载tomcat8.5,启动的时候发现非常慢,大概三分钟左右才能启动,网上搜到一个解决方案,在此记录下来 原因: Tomcat 7/8都使用org.apache.catalina.util.Ses ...
- 【BZOJ2565】最长双回文串(回文树)
[BZOJ2565]最长双回文串(回文树) 题面 BZOJ 题解 枚举断点\(i\) 显然的,我们要求的就是以\(i\)结尾的最长回文后缀的长度 再加上以\(i+1\)开头的最长回文前缀的长度 至于最 ...
- DOM节点类型
DOM1级定义了一个Node接口,该接口将由DOM中的所有节点类型实现.这个Node接口在JavaScript中是作为Node类型实现的:除了IE外,在其他所有浏览器中都可以访问到这个类型.JavaS ...
- SQL语句的学习理解
1.手电筒当天下载自定义活跃: SELECT user_dim.app_info.app_instance_id FROM [flashlight35-6aae4:com_scroll_sos_fla ...
- Linux中“is not in the sudoers file”解决方法
当在终端执行sudo命令时,系统提示"hadoop is not in the sudoers file": 其实就是没有权限进行sudo,解决方法如下(这里假设用户名是cuser ...
- javaweb 关于页面获取数据
EL(Excepress Language表达式语言) 1.....所有的EL都是以$"{"开始,以"}"结尾的.例:${sessionScope.user.s ...
- CSS个别属性
*{ scrollbar-3dlight-color:#fff; // 3d亮色阴影边框(threedlightshadow)的外观颜色 scrollbar-highlight-color:#fff; ...
- 每个java初学者都应该搞懂的问题
对于这个系列里的问题,每个学JAVA的人都应该搞懂.当然,如果只是学JAVA玩玩就无所谓了.如果你认为自己已经超越初学者了,却不很懂这些问题,请将你自己重归初学者行列.内容均来自于CSDN的经典老贴. ...
- ubuntu下ftp服务
(1).首先用命令检查是否安装了vsftpd vsftpd -version 如果未安装用一下命令安装 sudo apt-get install vsftpd 安装完成后,再次输入vsftpd -ve ...