wukong-robot 相关辅助工具
本文为我的 源代码阅读专栏 第一个工程的代码阅读——wukong-robot 一个优秀的开源智能音箱项目。本文解析的源代码文件为robot文件夹中的相关辅助工具文件
wukong-robot相关辅助工具介绍
plugins文件夹存放了一下相关插件，这些插件按功能分别放置不同的文件中。
- updater.py。 升级工具
- statistic.py。 用户统计工具
- logging.py。日志工具
- constants.py。 配置工具
- ConfigMonitor.py。 文件监测工具
- utils.py。 其它小工具
下面我针对列出的有引用第三方库的工具进行解析，以了解第三方库的用法
升级工具
updater.py 通过自定义类Updater实现了升级功能。Updater类对外公开两个方法：fetch和update。
fetch用于检查是否有更新。fetch首先判断距离上次检查时间是否超过30分钟，超过30分钟才执行后续逻辑。后续逻辑如下：
- 从服务器获取最新的主仓库版本号、插件库版本号和备注
- 比较当前版本号是否是最新。比较版本时用到了semver.compare方法
update用于分别对主仓库和插件库执行更新。执行更新分为两步，第一步通过git pull拉取代码；第二步通过pip安装代码依赖包。两步都完成后则升级成功
用户统计工具
statistic.py 通过继承自线程的类ReportThread实现了用户统计功能。执行用户统计时，会向服务器上报使用wukong-robot的硬件唯一标识和自定义软件名，便于后台统计
日志工具
logging.py 通过logging库实现了自定义日志功能。在本项目中主要实现了固定日志文件大小进行循环记录（RotatingFileHandler）和获取最近日志信息功能。
文件监测工具
ConfigMonitor.py 继承watchdog.events.FileSystemEventHandler类实现了监测文件修改功能。这样当配置文件被修改时就能第一时间发现并进行更新。
其它小工具
utils.py 实现了其它一些没有归类的小工具。
- 通过smtplib发送邮件
- 删除文件
- 通过AudioSegment进行声音文件格式转换
用到的技术点
- semver。语义化版本表示库。使用主版本+子版本+补丁版本的形式来区分版本号，可通过 compare 判断是否可更新
semver.compare(main_version, current_main_version) - requests。请求包。可以发起各种网络请求。如 GET POST等
- logging。日志记录库。可通过RotatingFileHandler实现固定大小的循环记录功能
- smtplib。邮件发送库。可通过RotatingFileHandler实现固定大小的循环记录功能
import smtplib session = smtplib.SMTP(SMTP_SERVER) session.connect(SMTP_SERVER, SMTP_PORT) session.starttls() session.login(FROM, PASSWORD) session.sendmail(SENDER, TO, msg.as_string()) session.close() - AudioSegment。语音处理工具包。可进行音频剪切、合并、输出等功能
参考
考虑到项目源代码可能会被作者更新，致使代码与我的总结文档不一致，下面列表中会提供原始代码链接和冻结代码链接。冻结代码链到我自己fork的工程中，大家如果需要找原始源码，可以点击原始代码链接