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

标签:python,命令行,参数,解析,工具,docopt
0
投稿

猜你喜欢

  • Python全栈之字符串和列表相关操作

    2022-02-04 04:15:25
  • python 删除字符串中连续多个空格并保留一个的方法

    2021-08-16 14:07:25
  • mysql5.5 master-slave(Replication)配置方法

    2024-01-20 07:37:25
  • 出现“不能执行已释放的Script代码”错误的原因及解决办法

    2024-04-19 10:02:13
  • js用typeof方法判断undefined类型

    2024-04-19 09:53:43
  • Tensorflow 2.4加载处理图片的三种方式详解

    2023-12-07 05:28:26
  • Python中如何获取类属性的列表

    2023-02-10 21:57:41
  • 解决python给列表里添加字典时被最后一个覆盖的问题

    2022-08-24 17:18:42
  • Python实现一元一次与一元二次方程求解

    2022-03-30 14:09:32
  • 解决python3爬虫无法显示中文的问题

    2022-11-27 15:18:59
  • HTML编辑器FCKeditor使用详解

    2010-02-28 12:30:00
  • Python 获取 datax 执行结果保存到数据库的方法

    2024-01-26 23:32:08
  • Python类继承和多态原理解析

    2023-04-30 17:31:38
  • python绘制汉诺塔

    2023-07-09 23:13:19
  • show一下刚做的系统登录界面

    2008-09-13 19:13:00
  • 解决 jupyter notebook 回车换两行问题

    2022-09-11 17:23:46
  • 一文带你掌握Go语言中文件的写入操作

    2024-02-07 13:23:54
  • JavaScript判断各种浏览器类型及版本

    2008-09-29 15:17:00
  • python安装库的最详细方法(以安装pygame库为例)

    2021-03-08 04:29:40
  • python爬虫字体加密的解决

    2021-02-22 12:25:57
  • asp之家 网络编程 m.aspxhome.com