Handler

WeRoBot会将合法的请求发送给 handlers 依次执行。

如果某一个 Handler 返回了非空值, WeRoBot 就会根据这个值创建回复,后面的 handlers 将不会被执行。

你可以通过修饰符或 add_handler() 添加 handler

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. # 通过修饰符添加handler
  4. @robot.handler
  5. def echo(message):
  6. return'Hello World!'
  7. # 通过`add_handler`添加handler
  8. def echo(message):
  9. return'Hello World!'
  10. robot.add_handler(echo)

类型过滤

在大多数情况下, 一个 Handler 并不能处理所有类型的消息。幸运的是, WeRoBot 可以帮你过滤收到的消息。

只想处理被新用户关注的消息?:

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. @robot.subscribe
  4. def subscribe(message):
  5. return'Hello My Friend!'
  6. robot.run()

或者,你的 handler 只能处理文本?

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. @robot.text
  4. def echo(message):
  5. return message.content
  6. robot.run()

在 WeRobot 中我们把请求分成了 Message 和 Event 两种类型,针对两种类型的请求分别有不同的 Handler。

修饰符

类型

robot.text

文本 (Message)

robot.image

图像 (Message)

robot.location

位置 (Message)

robot.link

链接 (Message)

robot.voice

语音 (Message)

robot.unknown

未知类型 (Message)

robot.subscribe

被关注 (Event)

robot.unsubscribe

被取消关注 (Event)

robot.click

自定义菜单事件 (Event)

robot.view

链接 (Event)

robot.scancode_push

扫描推送 (Event)

robot.scancode_waitmsg

扫描弹消息 (Event)

robot.pic_sysphoto

弹出系统拍照发图(Event)

robot.pic_photo_or_album

弹出拍照或者相册发图(Event)

robot.pic_weixin

弹出微信相册发图器(Event)

robot.location_select

弹出地理位置选择器(Event)

robot.scan

已关注扫描二维码(Event)

robot.user_scan_product

打开商品主页事件推送(Event)

robot.user_scan_product_enter_session

进入公众号事件推送(Event)

robot.user_scan_product_async

地理位置信息异步推送(Event)

robot.user_scan_product_verify_action

商品审核结果推送(Event)

robot.card_pass_check

卡券通过审核 (Event)

robot.card_not_pass_check

卡券未通过审核 (Event)

robot.user_get_card

用户领取卡券 (Event)

robot.user_gifting_card

用户转赠卡券 (Event)

robot.user_del_card

用户删除卡券 (Event)

robot.user_consume_card

卡券被核销 (Event)

robot.user_pay_from_pay_cell

微信买单完成 (Event)

robot.user_view_card

用户进入会员卡 (Event)

robot.user_enter_session_from_card

用户卡券里点击查看公众号进入会话 (Event)

robot.update_member_card

会员卡积分余额发生变动 (Event)

robot.card_sku_remind

库存警告 (Event)

robot.card_pay_order

券点发生变动 (Event)

robot.templatesendjobfinish_event

模板信息推送事件 (Event)

robot.submit_membercard_user_info

激活卡券 (Event)

robot.location_event

上报位置 (Event)

robot.unknown_event

未知类型 (Event)

额,这个 handler 想处理文本信息和地理位置信息?

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. @robot.text
  4. @robot.location
  5. def handler(message):
  6. # Do what you love to do
  7. pass
  8. robot.run()

当然,你也可以用 add_handler() 函数添加handler,就像这样:

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. def handler(message):
  4. # Do what you love to do
  5. pass
  6. robot.add_handler(handler, type='text')
  7. robot.add_handler(handler, type='location')
  8. robot.run()

注解

通过 robot.handler 添加的 handler 将收到所有信息;只有在其他 handler 没有给出返回值的情况下, 通过 robot.handler 添加的 handler 才会被调用。

robot.key_click —— 回应自定义菜单

key_click() 是对 click() 修饰符的改进。

如果你在自定义菜单中定义了一个 Key 为 abort 的菜单,响应这个菜单的 handler 可以写成这样

  1. @robot.key_click("abort")
  2. def abort():
  3. return"I'm a robot"

当然,如果你不喜欢用 key_click() ,也可以写成这样

  1. @robot.click
  2. def abort(message):
  3. if message.key =="abort":
  4. return"I'm a robot"

两者是等价的。

robot.filter —— 回应有指定文本的消息

filter() 是对 text() 修饰符的改进。

现在你可以写这样的代码

  1. @robot.filter("a")
  2. def a():
  3. return"正文为 a "
  4. import re
  5. @robot.filter(re.compile(".*?bb.*?"))
  6. def b():
  7. return"正文中含有 bb "
  8. @robot.filter(re.compile(".*?c.*?"),"d")
  9. def c():
  10. return"正文中含有 c 或正文为 d"
  11. @robot.filter(re.compile("(.*)?e(.*)?"),"f")
  12. def d(message, session, match):
  13. if match:
  14. return"正文为 "+ match.group(1)+"e"+ match.group(2)
  15. return"正文为 f"

这段代码等价于

  1. @robot.text
  2. def a(message):
  3. if message.content =="a":
  4. return"正文为 a "
  5. import re
  6. @robot.text
  7. def b(message):
  8. if re.compile(".*?bb.*?").match(message.content):
  9. return"正文中含有 b "
  10. @robot.text
  11. def c(message):
  12. if re.compile(".*?c.*?").match(message.content)or message.content =="d":
  13. return"正文中含有 c 或正文为 d"
  14. @robot.text
  15. def d(message):
  16. match = re.compile("(.*)?e(.*)?").match(message.content)
  17. if match:
  18. return"正文为 "+ match.group(1)+"e"+ match.group(2)
  19. if message.content =="f":
  20. return"正文为 f"

如果你想通过修饰符以外的方法添加 filter,可以使用 add_filter() 方法

  1. def say_hello():
  2. return"hello!"
  3. robot.add_filter(func=say_hello, rules=["hello","hi", re.compile(".*?hello.*?")])

更多内容详见 werobot.robot.BaseRoBot