wukong-robot 总入口

本文为我的 源代码阅读专栏 第一个工程的代码阅读——wukong-robot 一个优秀的开源智能音箱项目。本文解析的源代码文件为wukong.py及其他相关联的小文件

总入口介绍

wukong-robot 总入口文件为 wukong.py 。main入口代码为：

if __name__ == '__main__':
    if len(sys.argv) == 1:
        wukong = Wukong()
        wukong.run()
    elif '-h' in (sys.argv):
        wukong = Wukong()
        wukong.help()
    else:
        fire.Fire(Wukong)

可以看到，main入口主要使用了Wukong类对项目进行封装。Wukong类的属性和方法如下图所示

Wukong类的公开属性有

• bci。封装后的MUSE接口对象
• detector。对snowboy进行封装后的唤醒词检测对象

和方法

• init。初始化。主要进行变量初始化，配置检查，脑机接口初始化
• initDetector。初始化唤醒词检测对象
• help。打印帮助
• md5。计算md5
• fetch/update。检测/执行更新
• upload。上传 QA 数据集
• restart。重启 wukong-robot
• train。生成snowboy模型
• run。主运行程序
• profiling。运行过程中打印耗时数据，通过私有变量_profiling来控制
• dev。在测试环境中运行，通过私有变量_dev来控制

下面针对Wukong类所包含的主要属性和方法进行详细说明

train

通过调用snowboy.kitt.ai网络接口，将热词声音转换为模型文件

用到的第三方库

• watchdog。watchdog库用来监控指定目录/文件的变化。监测文件内容是否改变可提炼成如下代码

from watchdog.observers import Observer
from watchdog.events import LoggingEventHandler

# 重写event以相应事件
class ConfigMonitor(FileSystemEventHandler):
    # 文件修改
    def on_modified(self, event):
        logger.info("检测到文件 {} 发生变更".format(filename))

self._observer = Observer()
event_handler = ConfigMonitor()
self._observer.schedule(event_handler, path, recursive=False)
# 启动监测
self._observer.start()
# 停止监测
self._observer.stop()

• _thread。python自带的线程库。用以启动线程。用法为_thread.start_new_thread(func,())
• multiprocessing。多进程库。用来做进程控制和进程/线程间通讯
• hashlib。哈希库。用来产生哈希值。如md5hashlib.md5(str(text).encode('utf-8')).hexdigest()
• sys。在wukong-robot项目中用来重启程序

python = sys.executable
os.execl(python, python, * sys.argv)

• fire。生成命令行界面(Command Line Interfaces, CLIs)的工具。fire.Fire(Wukong)

参考

考虑到项目源代码可能会被作者更新，致使代码与我的总结文档不一致，下面列表中会提供原始代码链接和冻结代码链接。冻结代码链到我自己fork的工程中，大家如果需要找原始源码，可以点击原始代码链接

• wukong-robot 原始代码
• wukong-robot 冻结代码（本文参考代码）