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: 等待超时时间
示例
等待用户输入数字,超时时间为 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
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8ecc4aba1f5113da723f73ef7967724632fcb6a53791ff334aba9d718731f2b |
|
MD5 | 7c3a438582dd0f523d92199d202d37f7 |
|
BLAKE2b-256 | fd1fcb0496f72c50fb7a6901e10c93df2f76c5cc0bede21feddc4d4b9b8f6aee |
Close
Hashes for nonebot_plugin_waiter-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcb3abb6ec309472b9d9869bbe74cb33cc101defe95353f839b7fada7612b3c0 |
|
MD5 | 76191dce86b8ca76a582fb19946ac7db |
|
BLAKE2b-256 | 43b7654f7752e13d2ec82dbcbee6f68428ee9f55e7be3dd3f86c11cfa122d2cd |