python cmdln命令行终端持续运行模块使用教程

发表评论

A+

Python命令行运行的解析库有多种，如：argarse、docopt、click、invoke等，其中Argarse为python内置标准库，使用较为频繁，但用起来也较为麻烦。下面折叠部分为几种模块的基本用法，如果有时间可以具体了解。今天要分享的是一个非常好用的命令行持续运行的库 cmdln，是在python内置模块cmd的基础上进一步封装的开源项目。

一、cmdln库的优点

1.cmdln是在cmd模块基础上的封装，使用上和cmd一样简单，将函数名添加前缀do_即可实现函数通过命令行运行；

2.实现了类似Tkinter的mainloop方法，能够通过命令行单次执行，或多次执行，保持会话持续在终端运行，有点类似于ipython编辑器；

3.cmdln提供了方面便的函数解析功能，将命令参数进行自动解析，不需要重新造轮子编写参数解析函数；

4.有时代码中实现的函数命令功能较多，若手动整理有多少函数功能就会非常麻烦，cmdln库提供了一种方便的集成帮助，直接将所有函数进行整理并形成命令列表，方便查看有哪些命令及如何使用。同时，对每一个函数也提供了帮助信息，如：需要怎样使用该命令，需要哪些参数，每个参数是什么作用，最后的返回结果是什么等。

二、cmdln的使用方法

在了解cmdln使用之前先初步了解一下cmd模块的方法介绍及使用案例：

（1）cmdloop()：类似与Tkinter的mainloop，运行Cmd解析器；

（2）onecmd(str)：读取输入，并进行处理，通常不需要重载该函数，而是使用更加具体的do_command来执行特定的命令；

（3）emptyline()：当输入空行时调用该方法；

（4）default(line)：当无法识别输入的command时调用该方法；

（5）completedefault(text,line,begidx,endidx):如果不存在针对的complete_*()方法，那么会调用该函数，该函数主要是用于tab补充，且只能在linux下使用。

（6）precmd(line)：命令line解析之前被调用该方法；

（7）postcmd(stop，line)：命令line解析之后被调用该方法；

（8）preloop()：cmdloop()运行之前调用该方法；

（9）postloop()：cmdloop()退出之后调用该方法；

（10）help_command()：对command命令的说明，其中command为可变字符

from cmd import Cmd
import os
class Client(Cmd):
u"""help
这是doc
"""
prompt = 'pyFun>'
intro = 'Welcom to pyFun!'
def __init(self):
Cmd.__init__(self)
def do_hello(self, arg):
print('hello', arg)
def do_exit(self, arg):
print('Bye!')
return True # 返回True，直接输入exit命令将会退出
def preloop(self):
print("print(this line before entering the loop")
def postloop(self):
# print('Bye!')
print("print this line after leaving the loop")
def precmd(self, line):
print("print(this line before do a command")
return Cmd.precmd(self, line)
def postcmd(self, stop, line):
print("print(this line after do a command")
return Cmd.postcmd(self, stop, line)
if __name__ == '__main__':
try:
os.system('cls')
client = Client()
client.cmdloop()
except:
exit()

cmdln也与之类似，包括了alias命令别称，option命令参数，命令持续运行svn.main(loop=LOOP_ALWAYS)等，同时输入help 命令名则可以输出对应该条命令的说明文档，

内置的说明文档变量有如下几个：

"${name}"            工具名称

"${option_list}"     参数列表

"${command_list}"    命令列表

"${help_list}"       参数帮助列表

"${cmd_name}"        命名名称

"${cmd_usage}"       命令帮助信息

"${cmd_option_list}" 命令参数信息列表

import sys
import cmdln
class MySVN(cmdln.Cmdln):
name = "svn"
@cmdln.alias("stat", "st")
@cmdln.option("-u", "--show-updates", action="store_true",
help="display update information")
@cmdln.option("-v", "--verbose", action="store_true",
help="print extra information")
def do_status(self, subcmd, opts, *paths):
"""${cmd_name}: print the status of working copy files and directories
${cmd_usage}
${cmd_option_list}
"""
print("'svn %s' opts: %s" % (subcmd, opts))
print("'svn %s' paths: %s" % (subcmd, paths))
if __name__ == "__main__":
svn = MySVN()
sys.exit(svn.main())

三、cmdln项目打包

通过cmdln库建立的项目可以通过pyinstaller进行打包成独立的exe文件，这样可以直接将exe文件分发给其他人使用，需要先通过pip installer pyinstaller 安装pyinstaller，然后用cmd命令打开项目所在的入口文件目录中，pyinstaller -F example.py 即可将其打包成命名行工具了。