从零开始实现微信机器人
阅读目录
安装wxpy
wxpy 登陆
wxpy 好友与聊天群
wxpy 消息处理
wxpy 图灵机器人
wechat_sender
wxpy 登陆
wxpy 使用起来非常简单，我们只需要创建一个bot 对象，程序运行后，会弹出二维码，扫描二维码后显示登陆成功。
下述代码在登陆完成后，会向我们的文件传输助手发送一个“hello world！”。(每个程序都需要一个hello world)。
from wxpy import * bot = Bot() bot.file_helper.send('hello world!') print("ending")
关于Bot（）对象的相关参数说明，我们可以在源码中的注释中看到：
""" :param cache_path: * 设置当前会话的缓存路径，并开启缓存功能；为 `None` (默认) 则不开启缓存功能。 * 开启缓存后可在短时间内避免重复扫码，缓存失效时会重新要求登陆。 * 设为 `True` 时，使用默认的缓存路径 'wxpy.pkl'。 :param console_qr: * 在终端中显示登陆二维码，需要安装 pillow 模块 (`pip3 install pillow`)。 * 可为整数(int)，表示二维码单元格的宽度，通常为 2 (当被设为 `True` 时，也将在内部当作 2)。 * 也可为负数，表示以反色显示二维码，适用于浅底深字的命令行界面。 * 例如: 在大部分 Linux 系统中可设为 `True` 或 2，而在 macOS Terminal 的默认白底配色中，应设为 -2。 :param qr_path: 保存二维码的路径 :param qr_callback: 获得二维码后的回调，可以用来定义二维码的处理方式，接收参数: uuid, status, qrcode :param login_callback: 登陆成功后的回调，若不指定，将进行清屏操作，并删除二维码文件 :param logout_callback: 登出时的回调 """
这里介绍一下三个主要使用到的参数：
cache_path: 在开发过程中可以设置为True 避免每次登陆都需要重新扫描，具有缓存的作用。 qr_path：用于保存二维码生成图片，主要解决服务器图片展示不方便的问题。console_qr：有些情况下，可能不能通过终端打开图片（例如部署在服务器上时），我们可以通过参数选择在终端内显示二维码。
wxpy 好友与聊天群
如代码所示，我们可以通过Bot.friends 以及Bot.groups 来获取到所有的好友以及聊天群，这里需要注意的是，聊天群需要保存到通讯录中，不然可能会出现找不到聊天群的情况。
在搜索方法中，可以提供的参数有：姓名，city，province，sex 等相关变量。
关于好友的详细API文档，可以参考---》 微信好友API
from wxpy import * bot = Bot() # 获取所有好友 friends = bot.friends() # 遍历输出好友名称 for friend in friends: print(friend) # 找到好友 friend = bot.friends.search('被单')[0] print(friend) friend.send("hello world!") # 获取所有聊天群 groups = bot.groups() for group in groups: print(group) # 找到目标群 group = groups.search("409")[0] group.send("hello world!")
wxpy 消息处理
接下来主要介绍一下用户发送消息的类型，目前wxpy 支持发送文本，图片，视频以及文件。主要的发送方式如代码所示：
from wxpy import * bot = Bot() # 获取好友 my_friend = bot.friends().search('被单')[0] # 搜索信息 messages = bot.messages.search(keywords='测试', sender=bot.self) for message in messages: print(message) # 发送文本 my_friend.send('Hello, WeChat!') # 发送图片 my_friend.send_image('my_picture.png') # 发送视频 my_friend.send_video('my_video.mov') # 发送文件 my_friend.send_file('my_file.zip') # 以动态的方式发送图片 my_friend.send('@img@my_picture.png') # 发送公众号 my_friend.send_raw_msg( # 名片的原始消息类型 raw_type=42, # 注意 `username` 在这里应为微信 ID，且被发送的名片必须为自己的好友 raw_content='<msg username="wxpy_bot" nickname="wxpy 机器人"/>' ) # 消息接收监听器 @bot.register() def print_others(msg): # 输出监听到的消息 print(msg) # 回复消息 msg.reply("hello world") embed()
这里比较重要的就是关于 @bot.register（） 的使用，该注释主要用于注册消息接收器，我们可以根据特定的需求，配置不一样的消息接收器。
Bot.register(chats=None, msg_types=None, except_self=True, run_async=True, enabled=True)
详情可以查看源码中的介绍
关于消息处理API，读者可以在该地址下查看详细的配置，这里不做过多的描述。
代码中有使用到：embed() 这个方法， 主要用于阻塞进程，避免由于程序运行结束导致无法接收消息。
# 获取所有类型的消息（好友消息、群聊、公众号，不包括任何自己发送的消息） # 并将获得的消息打印到控制台 @bot.register() def print_others(msg): print(msg)
同时wxpy也可以给注册消息的类型加上限制：
# 回复 my_friend 发送的消息 @bot.register(my_friend) def reply_my_friend(msg): return 'received: {} ({})'.format(msg.text, msg.type) # 回复发送给自己的消息，可以使用这个方法来进行测试机器人而不影响到他人 @bot.register(bot.self, except_self=False) def reply_self(msg): return 'received: {} ({})'.format(msg.text, msg.type) # 打印出所有群聊中@自己的文本消息，并自动回复相同内容 # 这条注册消息是我们构建群聊机器人的基础 @bot.register(Group, TEXT) def print_group_msg(msg): if msg.is_at: print(msg) msg.reply(meg.text)
当然仅仅写以上内容，会导致你的程序主程序运行结束自然退出。wxpy给出了embed()方法，在程序末尾（或其他你想要暂停调试的地方）加上embed()方法就可以让程序保持运行，同时进入Python命令行。
# 进入 Python 命令行、让程序保持运行 # 推荐使用 embed() # 或者仅仅堵塞线程 # bot.join()
wxpy 图灵机器人
前期准备
前往注册图灵机器人，增加一个机器人，并记录机器人的APIKey。具体注册方法可以前往图灵API查看。
使用
1.首先，将图灵API写入程序中：
TULING_TOKEN = 'Your API Key'
2.然后，定义接口链接和需要传输的数据：
url_api = 'http://www.tuling123.com/openapi/api' data = { 'key' : TULING_TOKEN, 'info' : msg.text, # 收到消息的文字内容 }
3.根据文档，通过HTTP请求，我们将会得到一个json格式的文件。使用Requests包，我们可以简单的获得调用接口所返回的信息：
s = requests.post(url_api, data=json.dumps(data))
s =json.loads(s.text)
4.我们一般会得到一个字典内容，其中包括text和code两项：text是图灵机器人回复的文本，而code是返回的编号。详细的返回数据格式也可以在图灵API中看到，除了文字类还有新闻类、图片类、链接类等返回类型。在这里我们以文字类为例，介绍如何处理：
if s['code'] == 100000: print s['text'] # 查看回复消息的内容，可省略 msg.reply(s['text']) # 回复消息
如果需要回复其他类型的消息，也完全可以通过判断code确定消息类型，再决定如何回复。这里给出我的回复方法供大家参考（也可以选择不处理这一类内容）：
if s['code'] == 200000: # 链接类：回复文字和链接 msg.reply(s['text'] + s['url'])
5.wxpy给每个用户定义了一个相对稳定的对象/用户id，为puid，可以始终被获取到并有唯一的稳定性（根据文档），我们可以使用这个id来作为userid传给图灵机器人，以方便识别机器人或航班/列成信息的上下文。
bot.enable_puid() # puid 需要手动开启，请将这句话写在登陆登录之后
这样传送给接口的数据也要同时修改为：
data = { 'key' : TULING_TOKEN, 'info' : msg.text, # 收到消息的文字内容 'userid' : msg.member.puid, # 使用群聊中发送者的 puid 作为 userid 传送给图灵接口， 如果是私聊可以使用 msg.sender.puid }
这样做的好处是，图灵机器人可以根据得userid来获取上下文信息。例如你询问『天气』，它会回复『亲爱的，悄悄地告诉我你在哪个城市？』。在这种情况下，如果你不使用userid参数，你再次回复城市，图灵机器人也无法正确找到天气；如果你使用了这一参数，且两次回复使用的userid相同，图灵机器人会为你回复你回复的城市的天气情况，完成这一对话。
完整程序
# -*- coding: utf-8 -*- from wxpy import * import requests import json TULING_TOKEN = 'you api key' bot = Bot() bot.enable_puid() # puid 需要手动开启 @bot.register() # 这里没有参数默认为回复全部 def group_msg(msg): url_api = 'http://www.tuling123.com/openapi/api' data = { 'key': TULING_TOKEN, 'info': msg.text, # 收到消息的文字内容 'userid': msg.sender.puid, } s = requests.post(url_api, data=json.dumps(data)) s =json.loads(s.text) print(s ) # 打印所获得的json查看如何使用 if s['code'] == 100000: print(s['text']) # 查看回复消息的内容，可省略 msg.reply(s['text']) # 回复消息 embed()
wechat_sender
在熟悉了wxpy 的相关操作后，我们接下来介绍一下一个主要使用到的工具。由于wxpy 的设计，导致了一些业务操作并不好进行实现。因此我们在这里引入一个工具类：wechat_sender 。
首先我们需要像往常一样进行微信登陆，然后使用 listen（） 进行对我们的 bot（） 对象进行监听。
在这里我们可以看到了和上面代码的区别，这里使用的是listen（），上面是使用embed（）进行监听。 我们再这里使用listen 进行监听对象后，可以设置相应的配置。监听默认设置的接收对象为self.file_helper，通过设置receivers 可以配置消息的接收者。
# login.py from wxpy import * from wechat_sender import * bot = Bot() friend = bot.friends().search('被单')[0] listen(bot, token='test', receivers=[friend]) # sender.py coding: utf-8 from wechat_sender import Sender sender = Sender(token='test') sender.send('hello world!')
在别的python 文件中，我们只需要创建一个Sender（） 对象，然后调用Sender.send（）方法，即可对我们设定好的消息接收者发送消息。
Sender（）在创建的时候可以通过特定的参数设定，比如这里使用了 token 用于避免多个listen 导致sender 混淆。还可以在sender中设置receiver 从listen 中选取需要接收消息的对象。