An alternative for got-and-reject in Nonebot
Project description
nonebot-plugin-waiter
该插件提供一个 got-and-reject 会话控制的替代方案,可自由控制超时时间
安装
pip install nonebot-plugin-waiter
使用
导入
from nonebot_plugin_waiter import waiter
创建
...
@waiter()
async def check(event: Event):
...
waiter
装饰一个函数来创建一个 Waiter
对象用以等待预期事件
函数内需要自行判断输入事件是否符合预期并返回结果
waiter
有如下参数:
- waits: 等待的事件类型列表,可以是
Event
的类型或事件的get_type()
返回值; 如果 waits 为空则继承matcher
参数的事件响应器类型 - matcher: 所属的
Matcher
对象,如果不指定则使用当前上下文的Matcher
- parameterless: 非参数类型依赖列表
- keep_session: 是否保持会话,即仅允许会话发起者响应
- rule: 事件响应规则,例如
to_me()
- block: waiter 成功响应后是否阻塞事件传递,默认为
True
等待
可直接用 Waiter.wait
等待函数返回结果:
resp = await check.wait(timeout=60, default=False)
参数:
- before: 等待前发送的消息
- default: 超时时返回的默认值
- timeout: 等待超时时间
或使用异步迭代器持续等待,直到满足结果才退出循环。适合多轮对话:
async for resp in check(timeout=60, default=False):
...
参数:
- default: 超时时返回的默认值
- timeout: 等待超时时间
- retry: 重试次数,不设置则无限重试
- prompt: 重试时发送的消息,若没有设置
retry
则不发送
便捷函数
插件提供了一个 prompt
函数用于直接等待用户输入,适用于等待用户输入文本消息:
from nonebot_plugin_waiter import prompt
resp = await prompt("", timeout=60)
相应的,同时提供了一个 prompt_until
函数用于可重试一定次数地等待用户输入。
from nonebot_plugin_waiter import prompt_until
resp = await prompt_until(
"请输入数字",
lambda msg: msg.extract_plain_text().isdigit(),
timeout=60,
retry=5,
retry_prompt="输入错误,请输入数字。剩余次数:{count}",
)
基于此,还有一个 suggest
函数,用于向用户展示候选项并等待输入。
from nonebot_plugin_waiter import suggest
resp = await suggest("xxx", ["a", "b", "c", "d"])
示例
等待用户输入数字,超时时间为 60 秒,此时 waits 接收所有来自当前用户的消息事件。
from nonebot import on_command
from nonebot.adapters import Event
from nonebot_plugin_waiter import waiter
test = on_command("test")
@test.handle()
async def _():
await test.send("请输入数字")
@waiter(waits=["message"], keep_session=True)
async def check(event: Event):
return event.get_plaintext()
resp = await check.wait(timeout=60)
if resp is None:
await test.send("等待超时")
return
if not resp.isdigit():
await test.send("无效输入")
return
await test.finish(f"你输入了{resp}")
等待用户输入数字,超时时间为 30 秒,只允许重试 5 次,此时 waits 接收所有来自当前用户的消息事件。
from nonebot import on_command
from nonebot.adapters import Event
from nonebot_plugin_waiter import waiter
test = on_command("test")
@test.handle()
async def _():
await test.send("请输入数字")
@waiter(waits=["message"], keep_session=True)
async def check(event: Event):
return event.get_plaintext()
async for resp in check(timeout=30, retry=5, prompt="输入错误,请输入数字。剩余次数:{count}"):
if resp is None:
await test.send("等待超时")
break
if not resp.isdigit():
continue
await test.send(f"你输入了{resp}")
break
else:
await test.send("输入失败")
在 telegram 适配器下等待用户点击按钮,超时时间为 30 秒,此时 waits 接收 telegram 的 CallbackQueryEvent 事件。
from nonebot import on, on_command
from nonebot.adapters.telegram import Bot
from nonebot.adapters.telegram.event import (
MessageEvent,
CallbackQueryEvent,
)
from nonebot.adapters.telegram.model import (
InlineKeyboardButton,
InlineKeyboardMarkup,
InputTextMessageContent,
InlineQueryResultArticle,
)
inline = on_command("inline")
@inline.handle()
async def _(bot: Bot, event: MessageEvent):
await bot.send(
event,
"Hello InlineKeyboard !",
reply_markup=InlineKeyboardMarkup(
inline_keyboard=[
[
InlineKeyboardButton(
text="Say hello to me",
callback_data="hello",
)
],
]
),
)
@waiter(waits=[CallbackQueryEvent])
async def check(event1: CallbackQueryEvent):
if ...:
return event1.id, event1.message
resp = await check.wait(timeout=30)
if resp is None:
await inline.finish("等待超时")
_id, _message = resp
if _message:
await bot.edit_message_text(
"Hello CallbackQuery!", _message.chat.id, _message.message_id
)
await bot.answer_callback_query(_id, text="Hello CallbackQuery!")
await inline.finish()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for nonebot_plugin_waiter-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 698b1a031a154dcf88634f484a33f926966da97b3f055027a948acf6c074914d |
|
MD5 | 94fe9a36a2297523389755fbcd2dbce5 |
|
BLAKE2b-256 | 23288d2d1d407b2521260b4afdbb59b62b0827be79fd610e25ff0f9e987e8ac1 |
Close
Hashes for nonebot_plugin_waiter-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0f98472b68479765e99e7f6a242611cb7d38e77dd2b74d103a02857f95a68e1 |
|
MD5 | f6e80c409265ff7c5176032c53777e17 |
|
BLAKE2b-256 | 6dcf2445acdca20d240206d21e2d1b5277c19da0f282c0691a8e0538754989b5 |