一日一技：用Python如何正确开发命令行交互程序

Posted 2020-12-21

一日一技：用Python如何正确开发命令行交互程序

摄影：产品经理
与产品经理周游世界
我要写一个命令行交互程序，当用户输入不同命令时执行不同操作。

相信看本文的同学，你可能会这样写：

def query_by_id(user_id):
    print(f‘查询 id 为：{user_id} 对应的用户‘)

def query_by_name(user_name):
    print(f‘查询用户名为：{user_name} 的用户‘)

def main():
    while True:
        option = input(‘请输入选项前面的数字：1. 根据 id 查询；2.根据用户名查询>‘)
        if option == ‘1‘:
            user_id = input(‘请输入用户 id>‘)
            query_by_id(user_id)
        elif option == ‘2‘:
            user_name = input(‘请输入用户名>‘)
            query_by_name(user_name)
        elif option == ‘exit‘:
            print(‘退出！‘)
            break
        else:
            print(‘输入无效，请重新输入‘)

if __name__ == ‘__main__‘:
    main()

运行效果如下图左边所示：

这种方式确实可以达到目的。但 Python 实际上有专门用来实现这个目的的模块，叫做cmd。这是 Python 自带的。

我们来改造一下上面的例子：

import cmd

class Query(cmd.Cmd):
    intro = ‘用户信息查询系统，输入 help 或者?查看帮助。
‘
    prompt = ‘query>‘

    def do_query_by_id(self, arg):
        ‘根据用户 id 查询用户‘
        self.query_by_id(arg)

    def do_query_by_name(self, arg):
        ‘根据用户名查询‘
        self.query_by_name(arg)

    def do_exit(self, _):
        ‘退出‘
        exit(0)

    def query_by_id(self, user_id):
        print(f‘查询 id 为：{user_id} 对应的用户‘)

    def query_by_name(self, user_name):
        print(f‘查询用户名为：{user_name} 的用户‘)

if __name__ == ‘__main__‘:
    Query().cmdloop()

运行效果如下图所示：

我们需要实现一个类，继承cmd.Cmd。在我们自己写的这个类中，类属性intro表示我们的命令行程序运行时显示的内容。prompt是每行的提示符，类似于 Python 的>>>或者 CMD 的C:>。

所有以do_开头的方法，都对应了我们可以执行的命令。例如do_query_by_id表示命令query_by_id。当我们输入命令query_by_id时，就会执行这个方法里面的内容。命令后面的参数会通过arg参数传入进来。

命令执行方法里面的第一行字符串(docstring)会自动变成这个命令的帮助文档。当你在命令中输入help 命令时，就会显示帮助信息。

当你直接输入?或者help时，就会显示当前可以使用的所有命令。

类定义好以后，我们可以通过类名().cmdloop()来运行。

这样写出来的命令行交互程序，易用性好很多。

cmd模块还可以定义每个命令执行前的 hook 函数和执行后的 hook 函数。更多用法，请看官方文档[1]

参考资料

[1]
官方文档: https://docs.python.org/3/library/cmd.html