专栏首页未闻Code一日一技:用Python如何正确开发命令行交互程序

一日一技:用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 或者?查看帮助。\n'
    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

本文分享自微信公众号 - 未闻Code(itskingname),作者:kingname

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-01-22

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 一日一技:如何为 Pyppeteer 设置带有权限验证的代理?

    在我们使用 Pyppeteer 的时候,可能会需要设置代理,此时,你需要使用如下方法:

    青南
  • 使用Docker Swarm搭建分布式爬虫集群

    在爬虫开发过程中,你肯定遇到过需要把爬虫部署在多个服务器上面的情况。此时你是怎么操作的呢?逐一SSH登录每个服务器,使用git拉下代码,然后运行?代码修改了,于...

    青南
  • 一日一技:实现有过期时间的LRU缓存

    在一日一技:实现函数调用结果的 LRU 缓存一文中,我们提到Python自带的LRU缓存lru_cache。通过这个装饰器可以非常轻松地实现缓存。

    青南
  • 手牵手从零开始带你走通整个mybatis开发流程

    经过前两篇文章《Mybatis系列之入门》和《Mybatis系列之配置》的介绍,我们对Mybatis有了一定的了解,下面就接合一个实例学习案例,来巩固一下我们前...

    好好学java
  • Mybatis ResultMap和ResultType的差别

    ResultMap和ResultType: 两者都是表示查询结果集与java对象之间的一种关系,处理查询结果集,映射到java对象。 resultMap:表...

    赵哥窟
  • SQL增删改查

    深浅无解
  • SSH框架之Hibernate第三篇

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

    海仔
  • Hibernate第三天:Hibernate的一对多配置、Hibernate的多对多的配置

    * * 前提:一对多的双方都设置cascade="save-update"

    AlbertYang
  • 科普文-什么是ORM

    ORM全称是:Object Relational Mapping(对象关系映射),其主要作用是在编程中,把面向对象的概念跟数据库中表的概念对应起来。举例来说就是...

    the5fire
  • salt实现自动化部署项目

    既然有总入口这个init.sls文件,如上的配置文件可以看到还应该有user和project的子配置文件,具体内容如下:

    嘻哈记

扫码关注云+社区

领取腾讯云代金券