Handler
WeRoBot会将合法的请求发送给 handlers 依次执行。
如果某一个 Handler 返回了非空值, WeRoBot 就会根据这个值创建回复,后面的 handlers 将不会被执行。
你可以通过修饰符或 add_handler()
添加 handler
import werobot
robot = werobot.WeRoBot(token='tokenhere')
# 通过修饰符添加handler
@robot.handler
def echo(message):
return 'Hello World!'
# 通过`add_handler`添加handler
def echo(message):
return 'Hello World!'
robot.add_handler(echo)
类型过滤
在大多数情况下, 一个 Handler 并不能处理所有类型的消息。幸运的是, WeRoBot 可以帮你过滤收到的消息。
只想处理被新用户关注的消息?:
import werobot
robot = werobot.WeRoBot(token='tokenhere')
@robot.subscribe
def subscribe(message):
return 'Hello My Friend!'
robot.run()
或者,你的 handler 只能处理文本?
import werobot
robot = werobot.WeRoBot(token='tokenhere')
@robot.text
def echo(message):
return message.content
robot.run()
在 WeRobot 中我们把请求分成了 Message 和 Event 两种类型,针对两种类型的请求分别有不同的 Handler。
修饰符 | 类型 |
---|---|
文本 (Message) | |
图像 (Message) | |
位置 (Message) | |
链接 (Message) | |
语音 (Message) | |
未知类型 (Message) | |
被关注 (Event) | |
被取消关注 (Event) | |
自定义菜单事件 (Event) | |
链接 (Event) | |
扫描推送 (Event) | |
扫描弹消息 (Event) | |
弹出系统拍照发图(Event) | |
弹出拍照或者相册发图(Event) | |
弹出微信相册发图器(Event) | |
弹出地理位置选择器(Event) | |
已关注扫描二维码(Event) | |
打开商品主页事件推送(Event) | |
进入公众号事件推送(Event) | |
地理位置信息异步推送(Event) | |
商品审核结果推送(Event) | |
卡券通过审核 (Event) | |
卡券未通过审核 (Event) | |
用户领取卡券 (Event) | |
用户转赠卡券 (Event) | |
用户删除卡券 (Event) | |
卡券被核销 (Event) | |
微信买单完成 (Event) | |
用户进入会员卡 (Event) | |
用户卡券里点击查看公众号进入会话 (Event) | |
会员卡积分余额发生变动 (Event) | |
库存警告 (Event) | |
券点发生变动 (Event) | |
模板信息推送事件 (Event) | |
激活卡券 (Event) | |
上报位置 (Event) | |
未知类型 (Event) |
额,这个 handler 想处理文本信息和地理位置信息?
import werobot
robot = werobot.WeRoBot(token='tokenhere')
@robot.text
@robot.location
def handler(message):
# Do what you love to do
pass
robot.run()
当然,你也可以用 add_handler()
函数添加handler,就像这样:
import werobot
robot = werobot.WeRoBot(token='tokenhere')
def handler(message):
# Do what you love to do
pass
robot.add_handler(handler, type='text')
robot.add_handler(handler, type='location')
robot.run()
注解
通过 robot.handler
添加的 handler 将收到所有信息;只有在其他 handler 没有给出返回值的情况下, 通过 robot.handler
添加的 handler 才会被调用。
robot.key_click —— 回应自定义菜单
key_click()
是对 click()
修饰符的改进。
如果你在自定义菜单中定义了一个 Key 为 abort
的菜单,响应这个菜单的 handler 可以写成这样
@robot.key_click("abort")
def abort():
return "I'm a robot"
当然,如果你不喜欢用 key_click()
,也可以写成这样
@robot.click
def abort(message):
if message.key == "abort":
return "I'm a robot"
两者是等价的。
robot.filter —— 回应有指定文本的消息
现在你可以写这样的代码
@robot.filter("a")
def a():
return "正文为 a "
import re
@robot.filter(re.compile(".*?bb.*?"))
def b():
return "正文中含有 bb "
@robot.filter(re.compile(".*?c.*?"), "d")
def c():
return "正文中含有 c 或正文为 d"
@robot.filter(re.compile("(.*)?e(.*)?"), "f")
def d(message, session, match):
if match:
return "正文为 " + match.group(1) + "e" + match.group(2)
return "正文为 f"
这段代码等价于
@robot.text
def a(message):
if message.content == "a":
return "正文为 a "
import re
@robot.text
def b(message):
if re.compile(".*?bb.*?").match(message.content):
return "正文中含有 b "
@robot.text
def c(message):
if re.compile(".*?c.*?").match(message.content) or message.content == "d":
return "正文中含有 c 或正文为 d"
@robot.text
def d(message):
match = re.compile("(.*)?e(.*)?").match(message.content)
if match:
return "正文为 " + match.group(1) + "e" + match.group(2)
if message.content == "f":
return "正文为 f"
如果你想通过修饰符以外的方法添加 filter,可以使用 add_filter()
方法
def say_hello():
return "hello!"
robot.add_filter(func=say_hello, rules=["hello", "hi", re.compile(".*?hello.*?")])
更多内容详见 werobot.robot.BaseRoBot