Author: wj-Mcat
Code: python-wechaty

个人开发项目,且行且不易,有感兴趣的朋友可以去给一波关注,你们的支持就是我最大的动力,谢谢大家。

Python-wechaty能够使用少量代码即可完成一个机器人,使用起来非常简单,基于OOP的设计思路能够很好监听和处理微信内部大量的事件,比如:自动回复消息,定时发送消息,拉人入群,好友申请同意等等。此外,目前的插件系统里面有很多拿来即用的工具,比如拉人入群等。当然开发一个自己的插件也是非常简单,无需很高深的概念,只需要你能够理解事件和OOP即可。

python-wechaty项目源于wechaty,甚至说很大程度上代码是直接从其翻译过来的,然后加上一些python的特性,让其更加pythonic。作为一个IM的入口工具,未来我们也将添加更多的Chatbot元素进去,让其能够成为一个真正的聊天机器人。

在介绍python-wechaty之前,还是简要介绍一下wechaty。

wechaty

或许有很多人会把wechatywechat联系起来,毕竟在名称上面只是一字之差。这个得从wechaty的起源开始说起,起初,此项目只是作为微信的一个工具库,能够进行一些简单的自动化操作过程,比如:定时发送消息,入群消息发送,好友申请接受等。

可随着项目的逐步更新,wechaty已支持主流的IM软件,比如:微信,钉钉,Telegram。

这个项目从2016年开始,到现在已经获取8k star,是一个非常稳定且用户量非常庞大的项目。官方对其给出的介绍是:

A Conversational AI RPA SDK for Chatbot

所以wechaty作为IM ChatBot的入口工具,是很多聊天机器人的基础架构组件,也将会逐步支持主流聊天机器人的功能。

python-wchaty的诞生

与Wechaty的结缘是在2019年底的一次技术沙龙会上,认识到了原来6行代码就能够开发出一款足够灵活的机器人,当时给我一个很大的震撼。微信作为我们日常聊天工具之一,如果能够对其做一些自动化的过程,能够很大程度上减少繁琐过程的工作量,比如说:办活动时的拉人入群,定时提醒用户打卡,提醒女朋友姨妈快来了等等。而wechaty能够很好的支持以上所有功能,只需要简单的几行代码即可完成。回去之后就立马着手相关资料的查阅,然后逐步进入wechaty的社区。

一个很巧的机会群里面说可以开发一款go-wechaty的开发,当时我就在想,为什么不能够有一款python-wechaty呢,然后就毛遂自荐,成为了python-wechaty的联合作者之一。由于对开源软件和DevOps不是很熟悉,起步阶段遇到了很多的问题,不过经过社区大佬的耐心指导,目前已能够完成对issue和feature的开发和管理。亲身经历,建议大家有机会一定要参加开源项目,能够让你学习到很多知识点。

最简单的Bot

使用python-wechaty能够很简单的开发一款Bot,特别是使用了一个插件系统之后,如下所示:

以上代码中实现了两个主要的功能:

  • 当Bot接受到一个#ding信号,就立马回复一个dong消息,这就是一个基本的ding-dong-bot
  • 当接受到查阅天气的文本语句时,则返回对应的天气查询结果,比如:今天天气如何?

以上两个插件是系统内置的,后续也会增加更多的拿来即用的实用插件,当然用户也可创建自己的插件,方式很简单。

如何开发插件系统

在了解如何开发插件系统之前,可先移驾Plug-in`,插件系统支持对插件的安装,卸载,自定义配置等内容 ,至于具体的实现形式我相信也是需要面对具体的应用场景。而在Wechaty这个面相事件型且交互逻辑非常简单的场景下,插件的设计与开发就非常简单。

我们现在直接来看看,系统内置的叮咚插件是如何实现的。

即时通讯-单聊功能表-聊天功能-聊天app-聊天信息加密沟通-聊天文本-聊天技术-聊天构架源码-聊天 记录同步云储存-聊天消息测回-哇谷即时通讯IM源码
"""basic ding-dong bot for the wechaty plugin"""
from typing import Union

from wechaty import Message, Contact, Room, FileBox
from wechaty.plugin import WechatyPlugin


class DingDongPlugin(WechatyPlugin):
    """basic ding-dong plugin"""
    @property
    def name(self):
        """name of the plugin"""
        return 'ding-dong'

    async def on_message(self, msg: Message):
        """listen message event"""
        from_contact = msg.talker()
        text = msg.text()
        room = msg.room()
        if text == '#ding':
            conversation: Union[
                Room, Contact] = from_contact if room is None else room
            await conversation.ready()
            await conversation.say('dong')

代码很简单,不过也是需要氛围一下几个层面来介绍。

  • WechatyPlugin
  • on_[event_name]
  • init_plugin

WechatyPlugin

此类为一个抽象类,所有的插件必须要继承此基类,并重写其中的函数。

  • name 属性函数

    为抽象函数,必须重写。主要是为了标识插件的名称,作为插件唯一性身份认证。

  • init_plugin 初始化函数

    能够支持插件的初始化过程,比如初始化定时器对象,数据库延迟连接对象等。

  • on_[event_name]

    此类函数主要是为了监听系统中的不同事件,比如:on_message, on_login, on_friendship等事件的监听都只需要重写一下函数即可完成。不同插件之间以及不同事件之间都是独立的,能够很好的专注于不同业务场景下的开发。

event_name

python-wechaty很大程度上是由事件驱动,毕竟很多操作都是基于消息接受触发,由此事件的监听是其基础特性,可能第一感觉就是实用EventEmitter这种模式来监听事件,这样每个事件我都可以注册不同的函数来监听,每个函数中会有不同的逻辑处理。这也是传统的事件监听方法,可这至少会给开发上带来一些不方便:函数的参数需要查阅文档才能够获知,标准的函数式编程。

我不是说函数式编程不好,只是在这种场景下对系统性能并不能提升多少,且python-wechaty 也并不能太注重性能。

由此将其扩展了OOP的方式,用户可继承WechatyWechatyPlugin来监听不同的事件,且在常规的代码编辑器里面重写函数时就可以自动填充函数参数,从而减少查阅事件函数参数的问题。

监听事件的类型有:error, friendship, heartbeat, login, logout, message, ready, room_invite, room_join, room_leave, room_topic, scan

在上面已经展示了WechatyPlugin如何开发,需要注意的地方,那接下来我将给大家详细介绍一下最基础的每日一说的机器人如何开发。

每日一说机器人

每日一说,顾名思义每天每个固定时间段发送一个祝福或提醒,具体内容可自定义。这其中需要注意几点:

  • 机器人内部有一个调度器,用于调度时间事件的触发。
  • 机器人可给制定的人和群发送对应的内容。

以上的功能我封装成一个插件,然后注入到python-wechaty中即可。

"""daily word plugin"""
from datetime import datetime

from apscheduler.schedulers.asyncio import AsyncIOScheduler

from wechaty import Wechaty
from wechaty.plugin import WechatyPlugin


class DailyPlugin(WechatyPlugin):
    """
    say something everyday, like `Daily Words`
    """
    @property
    def name(self) -> str:
        """get the name of the plugin"""
        return 'dayily'

    async def tick(self):
        """time tick for the plugin scheduler"""
        room_id = get_room_id()
        room = self.bot.Room.load(room_id)
        await room.ready()
        await room.say(f'i love you -> {datetime.now()}')

    async def init_plugin(self, wechaty: Wechaty):
        """init plugin"""
        await super().init_plugin(wechaty)
        scheduler = AsyncIOScheduler()
        scheduler.add_job(self.tick, 'cron', hour=6, minute=16)
        scheduler.start()

插件就开发完了,然后将其注入到Wechaty中即可跑起来。

async def main():
    bot = Wechaty().use(DailyPlugin())
    await bot.start()
asyncio.run(main())

是不是超级简单,插件系统帮你隔离所有的业务场景,让代码非常易于开发和维护。

python-wechaty还可以做更多

现在python-wechaty只完成了基本的Chatbot入口工具,离真正的聊天机器人还距离很远,所以未来还有很多工作量可以做,也欢迎更多的研究chatbot,nlp的小伙伴联系我,共同开发让大家都喜欢用的开源软件。

微信号:pure-_--love

--------------

热门搜索:

什么是私有云? 私有云、公有云还是混合云?企业该如何选? 企业聊天APP有什么作用,可以带来哪些便利? 企业选择混合云的优势 聊天APP应该具备哪些功能?怎么确保信息不被泄露? 企业即时通讯的使用价值有哪些 企业IM是什么,有什么使用优势? JM沟通优势有哪些,安全性怎么样? JM沟通APP功能强大且安全性高 IM云系统即时通讯公有云、私有云、企业云、海外云-哇谷IM团队 对于IM即时通讯的性能与并发性问题xmpp等各种通信协议 sso登录统一账号体系和集中认证授权 MongoDB数据库百万并发设计使用方法 WebRTC视频会议服务器性能10万并发 办公协同解决方案的意义 有什么优势? 美国FBI遭黑客攻击 超10万人收到垃圾邮件!这家零佣金券商也被攻击 用户数据泄露-企业即时通讯安全 工作台支持私有化部署-企业办公通信管理-软件开发管理系统-哇谷云 Application scenarios of wagu im cloud service A typical IM architecture might look like this 哇谷IM实现原理讲解-哇谷IM即时通讯云 JM沟通功能图片演示-哇谷IM即时通讯云 硬件配置选择-哇谷IM即时通讯云 IM私有化价格服务系统-哇谷IM即时通讯云 哇谷云服务项目表 哇谷IM定制私有化搭建资料准备工单-哇谷IM即时通讯云 APP中红包功能技术最常见的形式-哇谷im即时通讯云 私有云、公有云还是混合云?企业该如何选? 租用海外云服务器时应注意的事项 私有云比起公有云安全性大大提高 哇谷云服务应用场景十分丰富多元 聊天APP功能强大 用户群体越来越广泛 企业打造私有云平台需要注意的几点 企业聊天办公软件如何挑选,需要具备哪些功能? IM的作用可不只是单纯的聊天工具 企业使用即时通讯的好处有哪些? 企业通讯常见的困扰:有什么办法提高通讯质量? 聊天APP应该具备哪些功能?怎么确保信息不被泄露? 语音会议软件越来越多:到底哪个软件适合开会? 使用手机能否召开视频会议?哪些软件值得选择? JM沟通与传统通讯软件有何区别?是否只能用于社交? 语音会议效果难以保障 你有准备专业会议软件吗 专业企业通讯软件功能齐全 让办公变得更加轻松快捷 业应不应该开发聊天APP 三个不容拒绝的理由 企业通讯软件如何选择 隐私保护终于一切 视频会议没有专用软件 很多事情都无法处理 哪些是常用的微服务框架? 企业如何搭建私有云? 即时通讯软件是否具有聊天回执的功能? 企业即时通讯软件支持多设备登陆吗? 企业即时通讯适合中小企业的即时通讯软件? 盘点全球几大即时通讯软件 介绍两款国外大佬级别的即时通讯APP Short video features 即时通讯短视频功能的基本特点主要有哪些 Features of chat function 聊天功能在即时通讯软件中的产品特色体现在哪里 Increase the function of red envelope 为什么在即时通讯软件中会增加红包功能 instant messaging 即时通讯 办私密软件公 Office privacy software Cloud service 云服务 Im definition IM定义 How to meet office requirements Main features of instant messaging 即时通讯云软件应该如何达到集团办公的需求 企业即时通讯软件设计的特点主要有哪些 Instant messaging cloud red packet  福利发送新办法,IM即时通讯云红包功能的大势所趋 LAN communication 区域网通讯可以促进企业发展,使信息传输更快捷 Production guide of enterprise specific app 企业专属聊天APP的生产指南,这里应有尽有! Waguyun privacy protection 企业通讯无法得到私密保障?哇谷云上办公为您提供专业服务! Choose Wawa Guyun for internal communication 企业内部交流怎么办?现在有了哇谷云!  Advantages of LAN  局域网通讯企业真的需要吗?它有哪些优点? Enterprise instant messaging voice conference app 新发展、新机遇 全球疫情下的企业即时通讯语音会议 Provide efficient enterprise communication 专业呼叫中心 提供高效企业通信解决方案 New layout of global economic integration 协同办公解决方案,全球一体化经济新布局 There is more than one way for IM tools 还在使用微信?IM工具不止有一条途径 Power source for efficient operation 选择办公协同解决方案,现代企业高效运转的动力源 Efficient enterprise specific instant messaging 企业聊天APP,私密度高的高效企业专属即时通讯APP 新一代私有云与早期私有云的区别 The difference between private clouds What are the advantages of private cloud 新一代私有云有哪些优势? 单聊功能 群聊功能红包功能源码 实时音视频 短视频 音视频会议源码 低延迟直播 哇谷IM云服务 IM私有化搭建源码 私有化搭建准备文件 TF签名知识 企业即时通讯 IM 即时通讯 IM定制功能 语音聊天室 在线教育 金融服务 sso单点登录系统 政府加密沟通 企业通信办公 KTV点唱系统 局域网通讯 知识库 企业即时通讯 sso单点登录系统 KTV点唱系统版本Demo JM沟通2.0版本Demo 哇谷IM企业办公版本 哇谷工作台 短视频源码 音视频会议源码 直播聊天源码 ios超级签名服务 哇谷云 哇谷科技 即时通讯 IM下载http://www.juemigoutong.com/webproduct.html IM功能与价格http://www.juemigoutong.com/webcooperation.html 哇谷IM团队,哇谷即时通讯,哇谷官方站 即时通讯-哇谷即时通讯-IM-直播-短视频-音视频会议-大型企业即时通讯办-即时通讯源码-聊天app-http://www.wagukeji.com 即时通讯-哇谷即时通讯-IM-直播-短视频-音视频会议-大型企业即时通讯办-即时通讯源码-聊天app-sso-http://www.juemigoutong.com 即时通讯-哇谷即时通讯-IM-直播-短视频-音视频会议-大型企业即时通讯办-即时通讯源码-聊天app-http://www.wagu.cloud 即时通讯-哇谷即时通讯-IM-直播-短视频-音视频会议-大型企业即时通讯办-即时通讯源码-聊天app-http://bolg.wagu.cloud 即时通讯-哇谷即时通讯-IM-直播-短视频-音视频会议-大型企业即时通讯办-即时通讯源码-聊天app-http://so.wagu.cloud