nonebot.adapters.onebot.v11.helpers

OneBot v11 流程辅助。

def extract_image_urls(message)

  • 说明: 提取消息中的图片链接

  • 参数

  • 返回

    • list[str]: 图片链接列表

def ImageURLs(prompt=None)

  • 说明: 提取消息中图片链接extract_image_urls的依赖注入版本

  • 参数

    • prompt (str | None): 当不存在图片链接时发送给用户的错误消息. 默认为 None.

  • 返回

    • untyped

def extract_numbers(message)

  • 说明: 提取消息中的数字

  • 参数

  • 返回

    • list[float]: 数字列表, 可以是浮点数或整数

def Numbers(prompt=None)

  • 说明: 提取消息中的数字extract_numbers的依赖注入版本

  • 参数

    • prompt (str | None): 当不存在数字时发送给用户的错误消息.

  • 返回

    • list[float]

def convert_chinese_to_bool(message)

  • 说明: 将中文中表示判断的词语转换为布尔值

  • 参数

    • message (Message | str): 消息对象或消息文本

  • 返回

    • bool | None: 是表达同意的布尔值, 如果无法确认判断的词语, 则返回 None

def remove_empty_lines(message, include_stripped=False)

  • 说明: 移除消息中的空行

  • 参数

    • message (Message | str): 消息对象或消息文本

    • include_stripped (bool): 是否包含只有空格的行

  • 返回

    • str: 移除空行后的消息文本

def is_cancellation(message)

  • 说明: 判断消息是否表示取消

  • 参数

    • message (Message | str): 消息对象或消息文本

  • 返回

    • bool: 是否表示取消的布尔值

def HandleCancellation(cancel_prompt=None)

  • 说明: 检查消息是否表示取消is_cancellation的依赖注入版本

  • 参数

    • cancel_prompt (str | None): 当消息表示取消时发送给用户的取消消息

  • 返回

    • bool

enum CooldownIsolateLevel

  • 说明: 命令冷却的隔离级别

  • 参数

    auto

    • GLOBAL: 1

    • GROUP: 2

    • USER: 3

    • GROUP_USER: 4

def Cooldown(cooldown=5, *, prompt=None, isolate_level=CooldownIsolateLevel.USER, parallel=1)

  • 说明: 依赖注入形式的事件冷却

  • 参数

    • cooldown (float): 冷却间隔

    • prompt (str | None): 当触发冷却时发送给用户的提示消息

    • isolate_level (CooldownIsolateLevel): 事件冷却的隔离级别, 参考 CooldownIsolateLevel

    • parallel (int): 并行执行的命令数量

  • 返回

    • None

  • 用法

    @matcher.handle(parameterless=[Cooldown(cooldown=11.4514, ...)])
    async def handle_command(matcher: Matcher, message: Message):
        ...

async def autorevoke_send(bot, event, message, at_sender=False, revoke_interval=60, **kwargs)

  • 说明: 发出消息指定时间后自动撤回

  • 参数

    • bot (Bot): 实例化的 Bot 类

    • event (Event): 事件对象

    • message (str | Message | MessageSegment): 消息对象或消息文本

    • at_sender (bool): 是否在消息中添加 @ 用户

    • revoke_interval (int): 撤回消息的间隔时间, 单位为秒

    • **kwargs

  • 返回

    • asyncio.TimerHandle: TimerHandle 对象, 可以用来取消定时撤回任务