Skip to content

Latest commit

 

History

History
319 lines (175 loc) · 6.57 KB

messages.rst

File metadata and controls

319 lines (175 loc) · 6.57 KB

消息处理

..  module:: wxpy

每当机器人接收到消息时，会自动执行以下两个步骤

  1. 将消息保存到 :class:`Bot.messages` 中
  2. 查找消息预先注册的函数，并执行(若有匹配的函数)

消息对象

消息对象代表每一条从微信获取到的消息。

基本属性

..  autoattribute:: Message.type


..  attribute:: Message.bot

    接收此消息的 :class:`机器人对象 <Bot>`


..  autoattribute:: Message.id

内容数据

..  autoattribute:: Message.text


..  automethod:: Message.get_file


..  autoattribute:: Message.file_name


..  autoattribute:: Message.file_size


..  autoattribute:: Message.media_id


..  attribute:: Message.raw

    原始数据 (dict 数据)

用户相关

..  autoattribute:: Message.chat


..  autoattribute:: Message.sender


..  autoattribute:: Message.receiver


..  autoattribute:: Message.member


..  autoattribute:: Message.card

群聊相关

..  autoattribute:: Message.member


..  autoattribute:: Message.is_at

时间相关

..  autoattribute:: Message.create_time


..  autoattribute:: Message.receive_time


..  autoattribute:: Message.latency

其他属性

..  autoattribute:: Message.url


..  autoattribute:: Message.articles


..  autoattribute:: Message.location


..  autoattribute:: Message.img_height


..  autoattribute:: Message.img_width


..  autoattribute:: Message.play_length


..  autoattribute:: Message.voice_length

回复方法

..  method:: Message.reply(...)

    等同于 :meth:`Message.chat.send(...) <Chat.send>`


..  method:: Message.reply_image(...)

    等同于 :meth:`Message.chat.send_image(...) <Chat.send_image>`


..  method:: Message.reply_file(...)

    等同于 :meth:`Message.chat.send_file(...) <Chat.send_file>`


..  method:: Message.reply_video(...)

    等同于 :meth:`Message.chat.send_video(...) <Chat.send_video>`


..  method:: Message.reply_msg(...)

    等同于 :meth:`Message.chat.send_msg(...) <Chat.send_msg>`


..  method:: Message.reply_raw_msg(...)

    等同于 :meth:`Message.chat.send_raw_msg(...) <Chat.send_raw_msg>`

转发消息

..  automethod:: Message.forward

自动处理消息

可通过 预先注册 的方式，实现消息的自动处理。

"预先注册" 是指
预先将特定聊天对象的特定类型消息，注册到对应的处理函数，以实现自动回复等功能。

注册消息

Hint

每当收到新消息时，将根据注册规则找到匹配条件的执行函数。
并将 :class:`消息对象 <Message>` 作为唯一参数传入该函数。

将 :meth:`Bot.register` 作为函数的装饰器，即可完成注册。

# 打印所有*群聊*对象中的*文本*消息
@bot.register(Group, TEXT)
def print_group_msg(msg):
    print(msg)

Attention!

优先匹配 后注册 的函数，且仅匹配 一个 注册函数。

..  automethod:: Bot.register

Tip

  1. chats 和 msg_types 参数可以接收一个列表或干脆一个单项。按需使用，方便灵活。
  2. chats 参数既可以是聊天对象实例，也可以是对象类。当为类时，表示匹配该类型的所有聊天对象。
  3. 在被注册函数中，可以通过直接 return <回复内容> 的方式来回复消息，等同于调用 msg.reply(<回复内容>)。

开始运行

Note

在完成注册操作后，若没有其他操作，程序会因主线程执行完成而退出。
因此务必堵塞线程以保持监听状态！
wxpy 的 :any:`embed()` 可在堵塞线程的同时，进入 Python 命令行，方便调试，一举两得。
from wxpy import *

bot = Bot()

@bot.register()
def print_messages(msg):
    print(msg)

# 堵塞线程，并进入 Python 命令行
embed()

..  autofunction:: embed

示例代码

在以下例子中，机器人将

  • 忽略 "一个无聊的群" 的所有消息
  • 回复好友 "游否" 和其他群聊中被 @ 的 TEXT 类消息
  • 打印所有其他消息

初始化机器人，并找到好友和群聊:

from wxpy import *
bot = Bot()
my_friend = bot.friends().search('游否')[0]
boring_group = bot.groups().search('一个无聊的群')[0]

打印所有其他消息:

@bot.register()
def just_print(msg):
    # 打印消息
    print(msg)

回复好友"游否"和其他群聊中被 @ 的 TEXT 类消息:

@bot.register([my_friend, Group], TEXT)
def auto_reply(msg):
    # 如果是群聊，但没有被 @，则不回复
    if isinstance(msg.chat, Group) and not msg.is_at:
        return
    else:
        # 回复消息内容和类型
        return '收到消息: {} ({})'.format(msg.text, msg.type)

忽略"一个无聊的群"的所有消息:

@bot.register(boring_group)
def ignore(msg):
    # 啥也不做
    return

堵塞线程，并进入 Python 命令行:

embed()

动态开关注册配置

Note

该操作需要在额外的线程中进行！

查看当前的注册配置情况:

bot.registered
# [<MessageConfig: just_print (Async, Enabled)>,
#  <MessageConfig: auto_reply (Async, Enabled)>,
#  <MessageConfig: ignore (Async, Enabled)>]

关闭所有注册配置:

bot.registered.disable()

重新开启 just_print 函数:

bot.registered.enable(just_print)

查看当前开启的注册配置:

bot.registered.enabled
# [<MessageConfig: just_print (Async, Enabled)>]

..  autoclass:: wxpy.api.messages.Registered
    :members:

已发送消息

..  autoclass:: SentMessage

    ..  hint:: 大部分属性与 :class:`Message` 相同

    ..  automethod:: recall

历史消息

可通过访问 bot.messages 来查看历史消息列表。

消息列表为 :class:`Messages` 对象，具有搜索功能。

例如，搜索所有自己在手机上发出的消息:

sent_msgs = bot.messages.search(sender=bot.self)
print(sent_msgs)

..  autoclass:: Messages

    ..  attribute:: max_history

        设置最大保存条数，即：仅保存最后的 n 条消息。

        ::

            bot = Bot()
            # 设置历史消息的最大保存数量为 10000 条
            bot.messages.max_history = 10000

    ..  automethod:: search

        ::

            # 搜索所有自己发送的，文本中包含 'wxpy' 的消息
            bot.messages.search('wxpy', sender=bot.self)