WeRoBot 是一个微信公众号开发框架。基于MIT协议,Python作为开发语言!
https://github.com/offu/WeRoBot
最简单的Hello World, 会给收到的每一条信息回复 Hello World
import werobot
robot = werobot.WeRoBot(token='tokenhere')
@robot.handler
def hello(message):
return 'Hello World!'
# 让服务器监听在 0.0.0.0:80
robot.config['HOST'] = '0.0.0.0'
robot.config['PORT'] = 80
robot.run()
WeRoBot 会解析微信服务器发来的消息, 并将消息转换成成 Message 或者是 Event 。 Message 表示用户发来的消息,如文本消息、图片消息; Event 则表示用户触发的事件, 如关注事件、扫描二维码事件。 在消息解析、转换完成后, WeRoBot 会将消息转交给 Handler 进行处理,并将 Handler 的返回值返回给微信服务器。
在刚才的 Hello World 中, 我们编写的
@robot.handler
def hello(message):
return 'Hello World!'
就是一个简单的 Handler , @robot.handler 意味着 robot 会将所有接收到的消息( 包括 Message 和 Event ) 都转交给这个 Handler 来处理。 当然, 你也可以编写一些只能处理特定消息的 Handler
# @robot.text 修饰的 Handler 只处理文本消息
@robot.text
def echo(message):
return message.content
# @robot.image 修饰的 Handler 只处理图片消息
@robot.image
def img(message):
return message.img
WeRoBot 提供了 Session 功能, 可以让你方便的记录用户状态。 比如, 这个 Handler 可以判断发消息的用户之前有没有发送过消息
@robot.text
def first(message, session):
if 'first' in session:
return '你之前给我发过消息'
session['first'] = True
return '你之前没给我发过消息'
Session 功能默认开启, 并使用 SQLite 存储 Session 数据
自定义菜单能够帮助公众号丰富界面,让用户更好更快地理解公众号的功能。 werobot.client.Client 封装了微信的部分 API 接口,我们可以使用 werobot.client.Client.create_menu() 来创建自定义菜单。 在使用 Client 之前, 我们需要先提供微信公众平台内的 AppID 和 AppSecret
from werobot import WeRoBot
robot = WeRoBot()
robot.config["APP_ID"] = "你的 AppID"
robot.config["APP_SECRET"] = "你的 AppSecret"
client = robot.client
然后, 我们就可以创建自定义菜单了
client.create_menu({
"button":[{
"type": "click",
"name": "今日歌曲",
"key": "music"
}]
})
注意以上代码只需要运行一次就可以了。在创建完自定义菜单之后, 我们还需要写一个 Handler 来响应菜单的点击操作
@robot.key_click("music")
def music(message):
return '你点击了“今日歌曲”按钮'
以上是最基本的使用方法,详细如何使用建议结合微信公众号开发文档以及WeRoBot文档