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: 是否保持会话,即仅允许会话发起者响应
等待
可直接用 Waiter.wait
等待函数返回结果:
resp = await check.wait(timeout=60, default=False)
或使用异步迭代器持续等待,直到满足结果才退出循环。适合多轮对话:
async for resp in check(timeout=60, default=False):
...
参数:
- default: 超时时返回的默认值
- timeout: 等待超时时间
便捷函数
插件提供了一个 prompt
函数用于直接等待用户输入,适用于等待用户输入文本消息:
from nonebot_plugin_waiter import prompt
resp = await prompt("xxxx", timeout=60)
示例
等待用户输入数字,超时时间为 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()
async for resp in check(timeout=60):
if resp is None:
await test.send("等待超时")
break
if not resp.isdigit():
await test.send("请输入数字")
continue
await test.send(f"你输入了{resp}")
break
在 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
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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65b5b74e61d4c66e1288d806875a986df9d431be3537b98254666b874a843f13 |
|
MD5 | f63def64adcb6d610618f145bd7e66aa |
|
BLAKE2b-256 | 4c4c8ea28acb2fb70cff82d9c72e60f101e5f3073646d3d32e154b9ca0803f6b |
Close
Hashes for nonebot_plugin_waiter-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f49a5f9e679a09f5dca1db704d17357606c1fcb5fe9769ebd95bae2f178c539 |
|
MD5 | f4fb9eeef0d966beb5369d100a430d6a |
|
BLAKE2b-256 | e68c7fb57c200cc3b032a30b5e8e7b325e51ef93532e69274d936d1ef9bd7bf9 |