mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-12-01 01:25:07 +08:00
Ju4tCode
GitHub
commit
cfd992b6b1
@ -7,8 +7,10 @@
|
|||||||
|
|
||||||
# NoneBot
|
# NoneBot
|
||||||
|
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
<!-- markdownlint-disable-next-line MD036 -->
|
<!-- markdownlint-disable-next-line MD036 -->
|
||||||
_✨ 跨平台 Python 异步机器人框架 ✨_
|
_✨ 跨平台 Python 异步机器人框架 ✨_
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -32,6 +34,9 @@ _✨ 跨平台 Python 异步机器人框架 ✨_
|
|||||||
<a href="https://core.telegram.org/bots/api">
|
<a href="https://core.telegram.org/bots/api">
|
||||||
<img src="https://img.shields.io/badge/telegram-Bot-lightgrey?style=social&logo=telegram">
|
<img src="https://img.shields.io/badge/telegram-Bot-lightgrey?style=social&logo=telegram">
|
||||||
</a>
|
</a>
|
||||||
|
<a href="https://open.feishu.cn/document/home/index">
|
||||||
|
<img src="https://img.shields.io/badge/%E9%A3%9E%E4%B9%A6-Bot-lightgrey?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAk1BMVEX///8zMzNJSUlSUlJcXFxtbW0zMzNLS0szMzMzMzNBQUGVlZUzMzM1NTU0NDQzMzMzMzM0NDQ0NDQ0NDQ3NzdDQ0M0NDQ2NjY4ODg9PT0zMzM0NDQ5OTk7OzszMzM0NDQ3NzczMzM0NDQ0NDQ0NDQ0NDQ3Nzc2NjY4ODg2NjY7Ozs0NDQ6Ojo6Ojo3Nzc4ODgzMzNGdMWJAAAAMHRSTlMD6h0TDgr8GNf0KQbvhLT45KKTmm4jwHVJLdLFQzbcjFTgzsq7rl58T2kyqD46Y1riMDRhAAAFr0lEQVR42uzZWXKiUACF4YMyqKAQhyjOc7STmLP/1bVlLukESIJ3sLGKbwFU/Q8HuIBKpVKpVCqVSqVSqVQqlUqlUvmNM10Mcfda/U6TPdw3e9lb8ayLO+bPniYu+amjNcPd8U7PFhML0RE5uCvnaY/5SVt0WFvckcu0vxjiYmDxbu5cl2mn9UVHRMa4B2LaP3RYKD1vL6adccRFLSLL/izxxbRz7UXHimdLlFdq2mlvnztYRznZh96cP3G/dkxQRrOnR5c/c5eiQ+S2UTbe/sHir9zD1w6+okz8aXvMItyRqE46ApSHmHYRYdLRoPCMcrAP3TkLC6fpDp5QAn/EtItqij3UG/zgQZH5aWc7ZqJjzA9jKFGf9ppXC3I6uMB/Mzh2mpQQ/Mnp4BSy1Kctx4pFx5qfhA4kqE87pCyrldfBDm6sLqat2mGnttXHDfkvYtryooHo2PCrFm5lcNw1qWr1XUeEm7BH3QYVRJNGcOmoietNmNKDWeKFnCo6b3Wc1drW/NsOLpFRqmmT4xgfPFw42Q7XhkFi2kq2DtKcR2Y8wpTacRdQ3aZYB59ggiOmrS6sFevgDNr9GW6pzRAZdsQsC3rV3x4i6uQha8+sB2h9am9c6rVBDj9ixr5k007rIs+CGV65pl3wXjRi2hrKYjFtM/rI02JaW3XaPYtGtZHHY9qL0lN7QuO2yBMzpenLTvtkZNos+AY1ZcpObtoLtWmrj6TNlCOuJqZ9M3PkaDBlIBHCmwpHyHpjSgMS2ryhcIqsmsWULmR0eTPhK7LsMdMOKHdJM+nw8E+8ZoYDOT3eRDDDuz6HNt7VeszaQtYDJch+38WRZ51TDO+0Y54hylzy0XHib2JI83c0zIoLd1hAeUus1jenQe2HQ79Dg6wB3i1d/uoNpS2JrulgHWqcRxqySjoObrFjfUlLVrVrOtiGMmdCA+ZJx8hlEa9QZ2+oXcNLOkIWEUAHe22sYxqykGdoUV//5w6eoKlkTI3Gdbx7CVmQB10lDWqzSTpemyyoAW28ubYO++oOLqBPbUUtJknHrMnCRihdyaOTdAQsLHSgtSTS2BEHLK4DvQYWFW2lOtiHZi3Fko6fXCjgNVooV0nHl7tMBP1aAaXtJDvYgwGxdMmzLzu1JUyYNSU7IAwiiZ8OJrxKlTzI38QnMORFoqSn8Fh9gikvIa/UVejgDMZMQ9mOOa8WwKCRyysslF6hn2HSwZX4+ew1KGEPCSZKhoqHMw9mLd1rO8aUMYZpexbRV/2AsYBxy7/t3NtuglAQheFR6wEPVEQtaq1WxQNqnfd/urY08QJFYHZS15D9vcHckMzOz/QWA9/3jqHrbmbr1bT10a90ncQcoiclgKY/Vq81q6P2JJqfI+NHPqdDSMRzsEtIXmYGcQcQk2fwKgHxTCIVJGMWwTu6sWGxPSFx+QpkOfz3QcYEJWQhtGsbR5aKCIrHInjXNsSDeITFZ6ELYZEMAnltY8AyawKz4KJAr21IBzkRmB6LOIRGOEhIaHYsciA0uxIshwa/DLQIzrAEy2HswBIBwck9yNOvbWT4YgHEU4zbEiyHsQsXhnmKccmxp2cbxvb8CyDbMBXwD4hsw1BQguUw9s4Mk20YOTFQtmHiDJVtGJhjZRtyEVi2ITbhnLBOMd5qOvqXwz9RFy3bkJpU0LINeTCsJdvIztHVZhsJo77SbOPG6FNltpFQqMxsE7hmS+9ymJxE7XKYUGupyzZS1Kbaso00tbWybONBTadyObyjPlaVbTycRFO28Uh9oyjbEJ/E2JImnVDXy1y6zpHvW5E2npJsI5unI9vIwVe3HKYZaMg2clkoyDby6Wl5mcv0Bp9t5DVEzzZyG4JnG/kdsLONArbQ2UYRlwZwtlHIsoGbbRSdRNtymGbf0LYcpgleQbMNwdUCbcthmrP2j++VjqdSy7Isy7Isy4LxDTcBnqEPd5jdAAAAAElFTkSuQmCC" alt="feishu">
|
||||||
|
</a>
|
||||||
<br />
|
<br />
|
||||||
<a href="https://jq.qq.com/?_wv=1027&k=5OFifDh">
|
<a href="https://jq.qq.com/?_wv=1027&k=5OFifDh">
|
||||||
<img src="https://img.shields.io/badge/qq%E7%BE%A4-768887710-orange?style=flat-square" alt="QQ Chat">
|
<img src="https://img.shields.io/badge/qq%E7%BE%A4-768887710-orange?style=flat-square" alt="QQ Chat">
|
||||||
@ -77,7 +82,8 @@ NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义
|
|||||||
- [OneBot(CQHTTP) 协议](https://github.com/howmanybots/onebot/blob/master/README.md) (QQ 等)
|
- [OneBot(CQHTTP) 协议](https://github.com/howmanybots/onebot/blob/master/README.md) (QQ 等)
|
||||||
- [Mirai-API-HTTP 协议](https://github.com/project-mirai/mirai-api-http)
|
- [Mirai-API-HTTP 协议](https://github.com/project-mirai/mirai-api-http)
|
||||||
- [钉钉](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
- [钉钉](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
||||||
- [Telegram](https://core.telegram.org/bots/api) _计划中_
|
- [Telegram](https://core.telegram.org/bots/api)
|
||||||
|
- [飞书](https://open.feishu.cn/document/home/index)
|
||||||
|
|
||||||
更多：[商店](https://v2.nonebot.dev/store.html)
|
更多：[商店](https://v2.nonebot.dev/store.html)
|
||||||
|
|
||||||
@ -121,6 +127,7 @@ NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义
|
|||||||
```
|
```
|
||||||
|
|
||||||
或者尝试以下镜像：
|
或者尝试以下镜像：
|
||||||
|
|
||||||
- [文档镜像(中国境内)](https://nb2.baka.icu)
|
- [文档镜像(中国境内)](https://nb2.baka.icu)
|
||||||
- [文档镜像(vercel)](https://nonebot2-vercel-mirror.vercel.app)
|
- [文档镜像(vercel)](https://nonebot2-vercel-mirror.vercel.app)
|
||||||
|
|
||||||
|
|||||||
@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
home: true
|
|
||||||
heroImage: /logo.png
|
|
||||||
tagline: 跨平台 Python 异步 QQ 机器人框架
|
|
||||||
actionText: 开始使用
|
|
||||||
actionLink: guide/
|
|
||||||
features:
|
|
||||||
- title: 简洁
|
|
||||||
details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
|
|
||||||
- title: 易于扩展
|
|
||||||
details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
|
|
||||||
- title: 高性能
|
|
||||||
details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
|
|
||||||
footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
|
|
||||||
---
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
# 深入
|
|
||||||
|
|
||||||
## 它如何工作？
|
|
||||||
|
|
||||||
<!-- TODO: how to work -->
|
|
||||||
|
|
||||||
~~未填坑~~
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 事件处理函数重载
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 权限控制
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 发布插件
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 钩子函数
|
|
||||||
@ -1,318 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.drivers 模块
|
|
||||||
|
|
||||||
## 后端驱动适配基类
|
|
||||||
|
|
||||||
各驱动请继承以下基类
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Driver`
|
|
||||||
|
|
||||||
基类：`abc.ABC`
|
|
||||||
|
|
||||||
Driver 基类。将后端框架封装，以满足适配器使用。
|
|
||||||
|
|
||||||
|
|
||||||
### `_adapters`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Type[Bot]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
已注册的适配器列表
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_ws_connection_hook`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Set[T_WebSocketConnectionHook]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
WebSocket 连接建立时执行的函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_ws_disconnection_hook`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Set[T_WebSocketDisconnectionHook]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
WebSocket 连接断开时执行的函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(env, config)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `env: Env`: 包含环境信息的 Env 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `config: Config`: 包含配置信息的 Config 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `env`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`str`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
环境名称
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `config`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Config`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
配置对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_clients`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Bot]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
已连接的 Bot
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `register_adapter(name, adapter, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
注册一个协议适配器
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `name: str`: 适配器名称，用于在连接时进行识别
|
|
||||||
|
|
||||||
|
|
||||||
* `adapter: Type[Bot]`: 适配器 Class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `type`
|
|
||||||
|
|
||||||
驱动类型名称
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `server_app`
|
|
||||||
|
|
||||||
驱动 APP 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `asgi`
|
|
||||||
|
|
||||||
驱动 ASGI 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `logger`
|
|
||||||
|
|
||||||
驱动专属 logger 日志记录器
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `bots`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Bot]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取当前所有已连接的 Bot
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `on_startup(func)`
|
|
||||||
|
|
||||||
注册一个在驱动启动时运行的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `on_shutdown(func)`
|
|
||||||
|
|
||||||
注册一个在驱动停止时运行的函数
|
|
||||||
|
|
||||||
|
|
||||||
### `on_bot_connect(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数使他在 bot 通过 WebSocket 连接成功时执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **函数参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: 当前连接上的 Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `on_bot_disconnect(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数使他在 bot 通过 WebSocket 连接断开时执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **函数参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: 当前连接上的 Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_bot_connect(bot)`
|
|
||||||
|
|
||||||
在 WebSocket 连接成功后，调用该函数来注册 bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
### `_bot_disconnect(bot)`
|
|
||||||
|
|
||||||
在 WebSocket 连接断开后，调用该函数来注销 bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `run(host=None, port=None, *args, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
启动驱动框架
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `host: Optional[str]`: 驱动绑定 IP
|
|
||||||
|
|
||||||
|
|
||||||
* `post: Optional[int]`: 驱动绑定端口
|
|
||||||
|
|
||||||
|
|
||||||
* `*args`
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `_handle_http()`
|
|
||||||
|
|
||||||
用于处理 HTTP 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `_handle_ws_reverse()`
|
|
||||||
|
|
||||||
用于处理 WebSocket 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `WebSocket`
|
|
||||||
|
|
||||||
基类：`object`
|
|
||||||
|
|
||||||
WebSocket 连接封装，统一接口方便外部调用。
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(websocket)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `websocket: Any`: WebSocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `websocket`
|
|
||||||
|
|
||||||
WebSocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `closed`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
连接是否已经关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `accept()`
|
|
||||||
|
|
||||||
接受 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `close(code)`
|
|
||||||
|
|
||||||
关闭 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `receive()`
|
|
||||||
|
|
||||||
接收一条 WebSocket 信息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `send(data)`
|
|
||||||
|
|
||||||
发送一条 WebSocket 信息
|
|
||||||
@ -1,120 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.drivers.fastapi 模块
|
|
||||||
|
|
||||||
## FastAPI 驱动适配
|
|
||||||
|
|
||||||
后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Config`
|
|
||||||
|
|
||||||
基类：`pydantic.env_settings.BaseSettings`
|
|
||||||
|
|
||||||
FastAPI 驱动框架设置，详情参考 FastAPI 文档
|
|
||||||
|
|
||||||
|
|
||||||
### `fastapi_openapi_url`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
openapi.json 地址，默认为 None 即关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `fastapi_docs_url`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
swagger 地址，默认为 None 即关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `fastapi_redoc_url`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
redoc 地址，默认为 None 即关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Driver`
|
|
||||||
|
|
||||||
基类：[`nonebot.drivers.Driver`](README.md#nonebot.drivers.Driver)
|
|
||||||
|
|
||||||
FastAPI 驱动框架
|
|
||||||
|
|
||||||
|
|
||||||
* **上报地址**
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/`: HTTP POST 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/http/`: HTTP POST 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/ws`: WebSocket 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/ws/`: WebSocket 上报
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
驱动名称: `fastapi`
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `server_app`
|
|
||||||
|
|
||||||
`FastAPI APP` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `asgi`
|
|
||||||
|
|
||||||
`FastAPI APP` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `logger`
|
|
||||||
|
|
||||||
fastapi 使用的 logger
|
|
||||||
|
|
||||||
|
|
||||||
### `on_startup(func)`
|
|
||||||
|
|
||||||
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
|
||||||
|
|
||||||
|
|
||||||
### `on_shutdown(func)`
|
|
||||||
|
|
||||||
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
|
||||||
|
|
||||||
|
|
||||||
### `run(host=None, port=None, *, app=None, **kwargs)`
|
|
||||||
|
|
||||||
使用 `uvicorn` 启动 FastAPI
|
|
||||||
@ -1,62 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.drivers.quart 模块
|
|
||||||
|
|
||||||
## Quart 驱动适配
|
|
||||||
|
|
||||||
后端使用方法请参考: [Quart 文档](https://pgjones.gitlab.io/quart/index.html)
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Driver`
|
|
||||||
|
|
||||||
基类：[`nonebot.drivers.Driver`](README.md#nonebot.drivers.Driver)
|
|
||||||
|
|
||||||
Quart 驱动框架
|
|
||||||
|
|
||||||
|
|
||||||
* **上报地址**
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/http`: HTTP POST 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/ws`: WebSocket 上报
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
驱动名称: `quart`
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `server_app`
|
|
||||||
|
|
||||||
`Quart` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `asgi`
|
|
||||||
|
|
||||||
`Quart` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `logger`
|
|
||||||
|
|
||||||
fastapi 使用的 logger
|
|
||||||
|
|
||||||
|
|
||||||
### `on_startup(func)`
|
|
||||||
|
|
||||||
参考文档: [Startup and Shutdown](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)
|
|
||||||
|
|
||||||
|
|
||||||
### `on_shutdown(func)`
|
|
||||||
|
|
||||||
参考文档: [Startup and Shutdown](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)
|
|
||||||
|
|
||||||
|
|
||||||
### `run(host=None, port=None, *, app=None, **kwargs)`
|
|
||||||
|
|
||||||
使用 `uvicorn` 启动 Quart
|
|
||||||
@ -1,214 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.exception 模块
|
|
||||||
|
|
||||||
## 异常
|
|
||||||
|
|
||||||
下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
|
|
||||||
这些异常并非所有需要用户处理，在 NoneBot 内部运行时被捕获，并进行对应操作。
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NoneBotException`
|
|
||||||
|
|
||||||
基类：`Exception`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 NoneBot 发生的异常基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `IgnoredException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `reason`: 忽略事件的原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ParserExit`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
`shell command` 处理消息失败时返回的异常
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `status`
|
|
||||||
|
|
||||||
|
|
||||||
* `message`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `PausedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
|
|
||||||
可用于用户输入新信息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `RejectedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
|
|
||||||
可用于用户重新输入。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `FinishedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
|
|
||||||
可用于结束用户会话。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `StopPropagation`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 终止事件向下层传播。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
在 `Matcher.block == True` 时抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `RequestDenied`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Bot 连接请求不合法。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `status_code: int`: HTTP 状态码
|
|
||||||
|
|
||||||
|
|
||||||
* `reason: str`: 拒绝原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `AdapterException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
代表 `Adapter` 抛出的异常，所有的 `Adapter` 都要在内部继承自这个 `Exception`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `adapter_name: str`: 标识 adapter
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NoLogException`
|
|
||||||
|
|
||||||
基类：`Exception`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 对当前 `Event` 进行处理但不显示 Log 信息，可在 `get_log_string` 时抛出
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ApiNotAvailable`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在 API 连接不可用时抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NetworkError`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在网络出现问题时抛出，如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ActionFailed`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求成功返回数据，但 API 操作失败。
|
|
||||||
@ -1,63 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.permission 模块
|
|
||||||
|
|
||||||
## 权限
|
|
||||||
|
|
||||||
每个 `Matcher` 拥有一个 `Permission` ，其中是 **异步** `PermissionChecker` 的集合，只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
`PermissionChecker` 既可以是 async function 也可以是 sync function
|
|
||||||
:::
|
|
||||||
|
|
||||||
|
|
||||||
## `MESSAGE`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意 `message` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 message type 的 Matcher。
|
|
||||||
|
|
||||||
|
|
||||||
## `NOTICE`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意 `notice` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 notice type 的 Matcher。
|
|
||||||
|
|
||||||
|
|
||||||
## `REQUEST`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意 `request` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 request type 的 Matcher。
|
|
||||||
|
|
||||||
|
|
||||||
## `METAEVENT`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意 `meta_event` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 meta_event type 的 Matcher。
|
|
||||||
|
|
||||||
|
|
||||||
## `USER(*user, perm=<nonebot.permission.Permission object>)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在白名单内且满足 perm
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `*user: str`: 白名单
|
|
||||||
|
|
||||||
|
|
||||||
* `perm: Permission`: 需要同时满足的权限
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `SUPERUSER`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意超级用户消息类型事件
|
|
||||||
@ -1,214 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.typing 模块
|
|
||||||
|
|
||||||
## 类型
|
|
||||||
|
|
||||||
下面的文档中，「类型」部分使用 Python 的 Type Hint 语法，见 [PEP 484](https://www.python.org/dev/peps/pep-0484/)、[PEP 526](https://www.python.org/dev/peps/pep-0526/) 和 [typing](https://docs.python.org/3/library/typing.html)。
|
|
||||||
|
|
||||||
除了 Python 内置的类型，下面还出现了如下 NoneBot 自定类型，实际上它们是 Python 内置类型的别名。
|
|
||||||
|
|
||||||
以下类型均可从 nonebot.typing 模块导入。
|
|
||||||
|
|
||||||
|
|
||||||
## `T_State`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[Any, Any]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件处理状态 State 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_StateFactory`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event], Awaitable[T_State]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件处理状态 State 类工厂函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_WebSocketConnectionHook`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
WebSocket 连接建立时执行的函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_WebSocketDisconnectionHook`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
WebSocket 连接断开时执行的函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_EventPreProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, T_State], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件预处理函数 EventPreProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_EventPostProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, T_State], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件预处理函数 EventPostProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_RunPreProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Matcher, Bot, Event, T_State], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPreProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_RunPostProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Matcher, Optional[Exception], Bot, Event, T_State], Awaitable[None]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_RuleChecker`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, T_State], Union[bool, Awaitable[bool]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
RuleChecker 即判断是否响应事件的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_PermissionChecker`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event], Union[bool, Awaitable[bool]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
RuleChecker 即判断是否响应消息的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_Handler`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
|
|
||||||
* `Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
* `Callable[[Bot, Event], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
* `Callable[[Bot, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
* `Callable[[Bot], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Handler 即事件的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_ArgsParser`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。
|
|
||||||
@ -1,197 +0,0 @@
|
|||||||
# 事件处理
|
|
||||||
|
|
||||||
在上一章中，我们已经注册了事件响应器，现在我们可以正式编写事件处理逻辑了！
|
|
||||||
|
|
||||||
## [事件处理函数](../api/typing.md#handler)
|
|
||||||
|
|
||||||
```python{1,2,8,9}
|
|
||||||
@weather.handle()
|
|
||||||
async def handle_first_receive(bot: Bot, event: Event, state: T_State):
|
|
||||||
args = str(event.get_message()).strip() # 首次发送命令时跟随的参数，例：/天气 上海，则args为上海
|
|
||||||
if args:
|
|
||||||
state["city"] = args # 如果用户发送了参数则直接赋值
|
|
||||||
|
|
||||||
|
|
||||||
@weather.got("city", prompt="你想查询哪个城市的天气呢？")
|
|
||||||
async def handle_city(bot: Bot, event: Event, state: T_State):
|
|
||||||
city = state["city"]
|
|
||||||
if city not in ["上海", "北京"]:
|
|
||||||
await weather.reject("你想查询的城市暂不支持，请重新输入！")
|
|
||||||
city_weather = await get_weather(city)
|
|
||||||
await weather.finish(city_weather)
|
|
||||||
```
|
|
||||||
|
|
||||||
在之前的样例中，我们定义了两个函数 `handle_first_receive`, `handle_city`，他们被事件响应器的装饰器装饰从而成为事件响应器的事件处理函数。
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
在事件响应器中，事件处理函数是**顺序**执行的！
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 添加一个事件处理函数
|
|
||||||
|
|
||||||
事件响应器提供了三种装饰事件处理函数的装饰器，分别是：
|
|
||||||
|
|
||||||
1. [handle()](../api/matcher.md#classmethod-handle)
|
|
||||||
2. [receive()](../api/matcher.md#classmethod-receive)
|
|
||||||
3. [got(key, prompt, args_parser)](../api/matcher.md#classmethod-got-key-prompt-none-args-parser-none)
|
|
||||||
|
|
||||||
#### handle()
|
|
||||||
|
|
||||||
简单的为事件响应器添加一个事件处理函数，这个函数将会在上一个处理函数正常返回执行完毕后立即执行。
|
|
||||||
|
|
||||||
#### receive()
|
|
||||||
|
|
||||||
指示 NoneBot 接收一条新的用户消息后继续执行该处理函数。此时函数将会接收到新的消息而非前一条消息，之前相关信息可以存储在 state 中。
|
|
||||||
|
|
||||||
特别的，当装饰的函数前没有其他事件处理函数，那么 `receive()` 不会接收一条新的消息而是直接使用第一条接收到的消息。
|
|
||||||
|
|
||||||
#### got(key, prompt, args_parser)
|
|
||||||
|
|
||||||
指示 NoneBot 当 `state` 中不存在 `key` 时向用户发送 `prompt` 等待用户回复并赋值给 `state[key]`。
|
|
||||||
|
|
||||||
`prompt` 可以为 `str`, `Message`, `MessageSegment`，若为空则不会向用户发送，若不为空则会在 format 之后发送，即 `prompt.format(**state)`，注意对 `{}` 进行转义。示例：
|
|
||||||
|
|
||||||
```python
|
|
||||||
@matcher.receive()
|
|
||||||
async def handle(bot: Bot, event: Event, state: T_State):
|
|
||||||
state["key"] = "hello"
|
|
||||||
|
|
||||||
|
|
||||||
@matcher.got("key2", prompt="{key}!")
|
|
||||||
async def handle2(bot: Bot, event: Event, state: T_State):
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
`args_parser` 为参数处理函数，在这里传入一个新的函数以覆盖默认的参数处理。详情参照 [args_parser](#参数处理函数-args-parser)
|
|
||||||
|
|
||||||
特别的，这些装饰器都可以套娃使用：
|
|
||||||
|
|
||||||
```python
|
|
||||||
@matcher.got("key1")
|
|
||||||
@matcher.got("key2")
|
|
||||||
async def handle(bot: Bot, event: Event, state: T_State):
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
### 事件处理函数参数
|
|
||||||
|
|
||||||
事件处理函数类型为：
|
|
||||||
|
|
||||||
- `Callable[[Bot, Event, T_State, Matcher], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, Event, Matcher], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, T_State, Matcher], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, Event], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot, Matcher], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
- `Callable[[Bot], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
简单说就是：除了 `bot` 参数，其他都是可选的。
|
|
||||||
|
|
||||||
以下函数都是合法的事件处理函数（仅列举常用的）：
|
|
||||||
|
|
||||||
```python
|
|
||||||
async def handle(bot: Bot, event: Event, state: T_State):
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def handle(bot: Bot, event: Event, state: T_State, matcher: Matcher):
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def handle(bot: Bot, event: Event):
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def handle(bot: Bot, state: T_State):
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def handle(bot: Bot):
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
:::danger 警告
|
|
||||||
函数的参数名固定不能修改！
|
|
||||||
:::
|
|
||||||
|
|
||||||
参数分别为：
|
|
||||||
|
|
||||||
1. [nonebot.adapters.Bot](../api/adapters/#class-bot): 即事件上报连接对应的 Bot 对象，为 BaseBot 的子类。特别注意，此处的类型注释可以替换为指定的 Bot 类型，例如：`nonebot.adapters.cqhttp.Bot`，只有在上报事件的 Bot 类型与类型注释相符时才会执行该处理函数！可用于多平台进行不同的处理。
|
|
||||||
2. [nonebot.adapters.Event](../api/adapters/#class-event): 即上报事件对象，可以获取到上报的所有信息。
|
|
||||||
3. [state](../api/typing.md#t-state): 状态字典，可以存储任意的信息，其中还包含一些特殊的值以获取 NoneBot 内部处理时的一些信息，如：
|
|
||||||
|
|
||||||
- `state["_current_key"]`: 存储当前 `got` 获取的参数名
|
|
||||||
- `state["_prefix"]`, `state["_suffix"]`: 存储当前 TRIE 匹配的前缀/后缀，可以通过该值获取用户命令的原始命令
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
NoneBot 会对不同类型的参数进行不同的操作，详情查看 [事件处理函数重载](../advanced/overloaded-handlers.md)
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 参数处理函数 args_parser
|
|
||||||
|
|
||||||
在使用 `got` 获取用户输入参数时，需要对用户的消息进行处理以转换为我们所需要的信息。在默认情况下，NoneBot 会把用户的消息字符串原封不动的赋值给 `state[key]` 。可以通过以下两种方式修改默认处理逻辑：
|
|
||||||
|
|
||||||
- `@matcher.args_parser` 装饰器：直接装饰一个函数作为参数处理器
|
|
||||||
- `got(key, prompt, args_parser)`：直接把函数作为参数传入
|
|
||||||
|
|
||||||
参数处理函数类型为：`Callable[[Bot, Event, T_State], Union[Awaitable[None], Awaitable[NoReturn]]]`，即：
|
|
||||||
|
|
||||||
```python
|
|
||||||
async def parser(bot: Bot, event: Event, state: T_State):
|
|
||||||
state[state["_current_key"]] = str(event.get_message())
|
|
||||||
```
|
|
||||||
|
|
||||||
特别的，`state["_current_key"]` 中存储了当前获取的参数名
|
|
||||||
|
|
||||||
### 逻辑控制
|
|
||||||
|
|
||||||
NoneBot 也为事件处理函数提供了一些便捷的逻辑控制函数：
|
|
||||||
|
|
||||||
#### `matcher.send`
|
|
||||||
|
|
||||||
这个函数用于发送一条消息给当前交互的用户。~~其实这并不是一个逻辑控制函数，只是不知道放在哪里……~~
|
|
||||||
|
|
||||||
#### `matcher.pause`
|
|
||||||
|
|
||||||
这个函数用于结束当前事件处理函数，强制接收一条新的消息再运行**下一个消息处理函数**。
|
|
||||||
|
|
||||||
#### `matcher.reject`
|
|
||||||
|
|
||||||
这个函数用于结束当前事件处理函数，强制接收一条新的消息再**再次运行当前消息处理函数**。常用于用户输入信息不符合预期。
|
|
||||||
|
|
||||||
#### `matcher.finish`
|
|
||||||
|
|
||||||
这个函数用于直接结束当前事件处理。
|
|
||||||
|
|
||||||
以上三个函数都拥有一个参数 `message` / `prompt`，用于向用户发送一条消息。以及 `**kwargs` 直接传递给 `bot.send` 的额外参数。
|
|
||||||
|
|
||||||
## 常用事件处理结构
|
|
||||||
|
|
||||||
```python
|
|
||||||
matcher = on_command("test")
|
|
||||||
|
|
||||||
# 修改默认参数处理
|
|
||||||
@matcher.args_parser
|
|
||||||
async def parse(bot: Bot, event: Event, state: T_State):
|
|
||||||
print(state["_current_key"], ":", str(event.get_message()))
|
|
||||||
state[state["_current_key"]] = str(event.get_message())
|
|
||||||
|
|
||||||
@matcher.handle()
|
|
||||||
async def first_receive(bot: Bot, event: Event, state: T_State):
|
|
||||||
# 获取用户原始命令，如：/test
|
|
||||||
print(state["_prefix"]["raw_command"])
|
|
||||||
# 处理用户输入参数，如：/test arg1 arg2
|
|
||||||
raw_args = str(event.get_message()).strip()
|
|
||||||
if raw_args:
|
|
||||||
arg_list = raw_args.split()
|
|
||||||
# 将参数存入state以阻止后续再向用户询问参数
|
|
||||||
state["arg1"] = arg_list[0]
|
|
||||||
|
|
||||||
|
|
||||||
@matcher.got("arg1", prompt="参数？")
|
|
||||||
async def arg_handle(bot: Bot, event: Event, state: T_State):
|
|
||||||
# 在这里对参数进行验证
|
|
||||||
if state["arg1"] not in ["allow", "list"]:
|
|
||||||
await matcher.reject("参数不正确！请重新输入")
|
|
||||||
# 发送一些信息
|
|
||||||
await bot.send(event, "message")
|
|
||||||
await matcher.send("message")
|
|
||||||
await matcher.finish("message")
|
|
||||||
```
|
|
||||||
@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
home: true
|
home: true
|
||||||
heroImage: /logo.png
|
heroImage: /logo.png
|
||||||
tagline: An asynchronous bot framework.
|
tagline: 跨平台 Python 异步机器人框架
|
||||||
actionText: 开始使用
|
actionText: 开始使用
|
||||||
actionLink: guide/
|
actionLink: guide/
|
||||||
features:
|
features:
|
||||||
@ -11,5 +11,5 @@ features:
|
|||||||
details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
|
details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
|
||||||
- title: 高性能
|
- title: 高性能
|
||||||
details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
|
details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
|
||||||
footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
|
footer: MIT Licensed | Copyright © 2018 - 2021 NoneBot Team
|
||||||
---
|
---
|
||||||
177
archive/2.0.0a16/advanced/README.md
Normal file
177
archive/2.0.0a16/advanced/README.md
Normal file
@ -0,0 +1,177 @@
|
|||||||
|
# 深入
|
||||||
|
|
||||||
|
## 它如何工作？
|
||||||
|
|
||||||
|
如同[概览](../guide/README.md)所言:
|
||||||
|
|
||||||
|
> NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。
|
||||||
|
|
||||||
|
`Nonebot2` 是一个可以对机器人上报的事件进行处理并完成具体功能的机器人框架，在这里，我们将简要讲述它的工作内容。
|
||||||
|
|
||||||
|
**便捷起见，以下内容对 `Nonebot2` 会被称为 `nonebot`，与 `Nonebot2` 交互的机器人实现会被称为 `协议端`**。
|
||||||
|
|
||||||
|
在实际应用中，`nonebot` 会充当一个高性能，轻量级的 Python 微服务框架。协议端可以通过 `http`, `websocket` 等方式与之通信，这个通信往往是双向的：一方面，协议端可以上报数据给 `nonebot`，`nonebot` 会处理数据并返回响应给协议端；另一方面，`nonebot` 可以主动推送数据给协议端。而 `nonebot` 便是围绕双向通信进行工作的。
|
||||||
|
|
||||||
|
在开始工作之前，`nonebot` 需要进行准备工作：
|
||||||
|
|
||||||
|
1. **运行 `nonebot.init` 初始化函数**，它会读取配置文件，并初始化 `nonebot` 和后端驱动 `driver` 对象。
|
||||||
|
2. **注册协议适配器 `adapter`** 。
|
||||||
|
3. **加载插件**。
|
||||||
|
|
||||||
|
准备工作完成后，`nonebot` 会利用 `uvicorn` 启动，并运行 `on_startup` 钩子函数。
|
||||||
|
|
||||||
|
随后，倘若一个协议端与 `nonebot` 进行了连接，`nonebot` 的后端驱动 `driver` 就会将 `adapter` 实例化为 `bot`，`nonebot` 便会利用 `bot` 开始工作，它的工作内容分为两个方面：
|
||||||
|
|
||||||
|
1. **事件处理**，`bot` 会将协议端上报的数据转化为 `事件`(`Event`)，之后 `nonebot` 会根据一套既定流程来处理 `事件`。
|
||||||
|
|
||||||
|
2. **调用 `API`**, 在**事件处理**的过程中，`nonebot` 可以通过 `bot` 调用协议端指定的 `API` 来获取更多数据，或者反馈响应给协议端; `nonebot` 也可以通过调用 `API` 向协议端主动请求数据或者主动推送数据。
|
||||||
|
|
||||||
|
在**指南**模块， 我们已经叙述了[如何配置 nonebot](../guide/basic-configuration.md), [如何注册协议适配器](../guide/getting-started.md)，[如何加载插件](../guide/loading-a-plugin.md), 在这里便不再赘述。
|
||||||
|
|
||||||
|
下面，我们将对**事件处理**， **调用 API**进行说明。
|
||||||
|
|
||||||
|
## 事件处理
|
||||||
|
|
||||||
|
我们可以先看事件处理的流程图：
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
在流程图里，我们可以看到，`nonebot` 会有三个阶段来处理事件：
|
||||||
|
|
||||||
|
1. **driver 处理上报数据**
|
||||||
|
2. **adapter 处理原始数据**
|
||||||
|
3. **nonebot 处理 Event**
|
||||||
|
|
||||||
|
我们将顺序说明这三个阶段。其中，会将第三个阶段拆分成**概念解释**，**处理 Event**，**特殊异常处理**三个部分来说明。
|
||||||
|
|
||||||
|
### driver 处理上报数据
|
||||||
|
|
||||||
|
1. 协议端会通过 `websocket` 或者 `http` 等方式与 `nonebot` 的后端驱动 `driver` 连接，`driver` 会根据之前注册的 `adapter` 和配置文件的内容来进行鉴权，从而获得这个连接的唯一识别 id `self-id`，随后 `adapter` 就会利用 `self-id` 实例化为 `bot` 对象。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
需要注意的是，如果协议端通过 `websocket` 与 `nonebot` 连接，这个步骤只会在建立连接时进行，并在之后运行 `on_bot_connect` 钩子函数；通过 `http` 方式连接时，会在协议端每次上报数据时都进行这个步骤。
|
||||||
|
:::
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
连接之前必须要注册 `adapter`
|
||||||
|
:::
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
`self-id` 是帐号的唯一识别 ID，这意味着不能出现相同的 `self-id`。
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. `driver` 会将接收到的数据转交给 `bot` 对象进一步处理。
|
||||||
|
|
||||||
|
### adapter 处理原始数据
|
||||||
|
|
||||||
|
1. `bot` 会利用事先定义好的 `Event Model` 对上报的数据进行分析处理，将数据转化为 `nonebot` 可以处理的 `Event` 对象。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
`adapter` 在转换数据格式的同时可以进行一系列的特殊操作，例如 `CQHTTP` 会对 `reply` 信息进行提取。
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. `Event` 会传入 `nonebot` 做进一步处理。
|
||||||
|
|
||||||
|
### nonebot 处理 Event
|
||||||
|
|
||||||
|
在讲述这个阶段之前，我们需要先对几个概念进行解释。
|
||||||
|
|
||||||
|
#### 概念解释
|
||||||
|
|
||||||
|
1. **hook**，或者说**钩子函数**，它们可以在 `nonebot` 处理 `Event` 的不同时刻进行拦截，修改或者扩展，在 `nonebot` 中，钩子函数分为 `事件预处理hook`，`运行预处理hook`，`运行后处理hook` 和 `事件后处理hook`。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
关于`hook`的更多信息，可以查阅[这里](./runtime-hook.md)
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. **Matcher**与**matcher**，在**指南**中，我们讲述了[如何注册事件响应器](../guide/creating-a-matcher)，这里的事件响应器或者说 `Matcher` 并不是一个具体的实例 `instance`，而是一个具有特定属性的类 `class`。只有当 `Matcher` **响应事件**时，才会实例化为具体的 `instance`，也就是 `matcher`。`matcher` 可以认为是 `nonebot` 处理 `Event` 的基本单位，运行 `matcher` 是`nonebot`工作的主要内容。
|
||||||
|
|
||||||
|
3. **handler**，或者说**事件处理函数**, 它们可以认为是 `nonebot` 处理 `Event` 的最小单位。在不考虑 `hook` 的情况下，**运行 matcher 就是顺序运行 matcher.handlers**，这句话换种表达方式就是，`handler` 只有添加到 `matcher.handlers` 时，才可以参与到 `nonebot` 的工作中来。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
如何让 `handler` 添加到 `matcher.handlers`？
|
||||||
|
|
||||||
|
一方面，我们可以参照[这里](../guide/creating-a-handler)利用装饰器来添加；另一方面，我们在用 `on()` 或者 `on_*()` 注册事件响应器时，可以添加 `handlers=[handler1, handler2, ...]` 这样的关键词参数来添加。
|
||||||
|
:::
|
||||||
|
|
||||||
|
#### 处理 Event
|
||||||
|
|
||||||
|
1. **执行事件预处理 hook**， `nonebot` 接收到 `Event` 后，会传入到 `事件预处理hook` 中进行处理。
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
需要注意的是，执行多个 `事件预处理hook` 时并无顺序可言，它们是**并行运行**的。这个原则同样适用于其他的 `hook`。
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. **按优先级升序选出同一优先级的 Matcher**，`nonebot` 提供了一个全局字典 `matchers`，这个字典的 `key` 是优先级 `priority`，`value` 是一个 `list`，里面存放着同一优先级的 `Matcher`。在注册 `Matcher` 时，它和优先级 `priority` 会添加到里面。
|
||||||
|
|
||||||
|
在执行 `事件预处理hook` 后，`nonebot` 会对 `matchers` 的 `key` 升序排序并选择出当前最小优先级的 `Matcher`。
|
||||||
|
|
||||||
|
3. **根据 Matcher 定义的 Rule, Permission 判断是否运行**，在选出 `Matcher` 后，`nonebot` 会将 `bot`，`Event` 传入到 `Matcher.check_rule` 和 `Matcher.check_perm` 两个函数中，两个函数分别对 Matcher 定义的 Rule, Permission 进行 check，当 check 通过后，这个 `Matcher` 就会响应事件。但是当同一个优先级的所有 `Matcher` 均没有响应时，`nonebot` 会返回到上一个步骤，选择出下一优先级的 `Matcher`。
|
||||||
|
|
||||||
|
4. **实例化 matcher 并执行运行预处理 hook**，当 `Matcher` 响应事件后，它便会实例化为 `matcher`，并执行 `运行预处理hook`。
|
||||||
|
|
||||||
|
5. **顺序运行 matcher 的所有 handlers**，`运行预处理hook` 执行完毕后，便会运行 `matcher`，也就是**顺序运行**它的 `handlers`。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
`matcher` 运行 `handlers` 的顺序是: 先运行该 `matcher` 的类 `Matcher` 注册时添加的 `handlers`(如果有的话)，再按照装饰器装饰顺序运行装饰的 `handlers`。
|
||||||
|
:::
|
||||||
|
|
||||||
|
6. **执行运行后处理 hook**，`matcher` 的 `handlers` 运行完毕后，会执行 `运行后处理hook`。
|
||||||
|
|
||||||
|
7. **判断是否停止事件传播**，`nonebot` 会根据当前优先级所有 `matcher` 的 `block` 参数或者 `StopPropagation` 异常判断是否停止传播 `Event`，如果事件没有停止传播，`nonebot` 便会返回到第 2 步， 选择出下一优先级的 `Matcher`。
|
||||||
|
|
||||||
|
8. **执行事件后处理 hook**，在 `Event` 停止传播或执行完所有响应的 `Matcher` 后，`nonebot` 会执行 `事件后处理hook`。
|
||||||
|
|
||||||
|
当 `事件后处理hook` 执行完毕后，当前`Event`的处理周期就顺利结束了。
|
||||||
|
|
||||||
|
#### 特殊异常处理
|
||||||
|
|
||||||
|
在这个阶段，`nonebot` 规定了几个特殊的异常，当 `nonebot` 捕获到它们时，会用特定的行为来处理它们。
|
||||||
|
|
||||||
|
1. **IgnoredException**
|
||||||
|
|
||||||
|
这个异常可以在 `事件预处理hook` 和 `运行预处理hook` 抛出。
|
||||||
|
|
||||||
|
当 `事件预处理hook` 抛出它时，`nonebot` 会忽略当前的 `Event`，不进行处理。
|
||||||
|
|
||||||
|
当 `运行预处理hook` 抛出它时，`nonebot` 会忽略当前的 `matcher`，结束当前 `matcher` 的运行。
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
当 `hook` 需要抛出这个异常时，要写明原因。
|
||||||
|
:::
|
||||||
|
|
||||||
|
2. **PausedException**
|
||||||
|
|
||||||
|
这个异常可以在 `handler` 中由 `Matcher.pause` 抛出。
|
||||||
|
|
||||||
|
当 `nonebot` 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行，并将后续的 `handler` 交给一个临时 `Matcher` 来响应当前交互用户的下一个消息事件，当临时 `Matcher` 响应时，临时 `Matcher` 会运行后续的 handlers。
|
||||||
|
|
||||||
|
3. **RejectedException**
|
||||||
|
|
||||||
|
这个异常可以在 `handler` 中由 `Matcher.reject` 抛出。
|
||||||
|
|
||||||
|
当 `nonebot` 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行，并将当前 handler 和后续 `handler` 交给一个临时 `Matcher` 来响应当前交互用户的下一个消息事件，当临时 `Matcher` 响应时，临时 `Matcher` 会运行当前 `handler` 和后续的 `handler`。
|
||||||
|
|
||||||
|
4. **FinishedException**
|
||||||
|
|
||||||
|
这个异常可以在 `handler` 中由 `Matcher.finish` 抛出。
|
||||||
|
|
||||||
|
当 `nonebot` 捕获到它时，会停止运行当前 `handler` 并结束当前 `matcher` 的运行。
|
||||||
|
|
||||||
|
5. **StopPropagation**
|
||||||
|
|
||||||
|
这个异常一般会在执行 `运行后处理hook` 后抛出。
|
||||||
|
|
||||||
|
当 `nonebot` 捕获到它时， 会停止传播当前 `Event`，不再寻找下一优先级的 `Matcher`，直接执行 `事件后处理hook`。
|
||||||
|
|
||||||
|
## 调用 API
|
||||||
|
|
||||||
|
`nonebot` 可以通过 `bot` 来调用 `API` ，`API` 可以向协议端发送数据，也可以向协议端请求更多的数据。
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
不同 `adapter` 规定了不同的 API，对应的 API 列表请参照协议规范。
|
||||||
|
:::
|
||||||
|
|
||||||
|
一般来说，我们可以用 `bot.*` 来调用 `API`(\*是 `API` 的 `action` 或者 `endpoint`)。
|
||||||
|
|
||||||
|
对于发送消息而言，一方面可以调用既有的 API；另一方面 `nonebot` 实现了两个便捷方法，`bot.send(event, message, **kwargs)` 方法和可以在 `handler` 中使用的 `Matcher.send(message, **kwargs)` 方法，来向事件主体发送消息。
|
||||||
@ -9,7 +9,7 @@
|
|||||||
|
|
||||||
下面将介绍第二种方法—— `export` 和 `require` 机制：
|
下面将介绍第二种方法—— `export` 和 `require` 机制：
|
||||||
|
|
||||||
## 使用 export and require
|
## 使用 export 和 require
|
||||||
|
|
||||||
现在，假定有两个插件 `pluginA` 和 `pluginB`，需要在 `pluginB` 中调用 `pluginA` 中的一个变量 `varA` 和一个函数 `funcA`。
|
现在，假定有两个插件 `pluginA` 和 `pluginB`，需要在 `pluginB` 中调用 `pluginA` 中的一个变量 `varA` 和一个函数 `funcA`。
|
||||||
|
|
||||||
BIN
archive/2.0.0a16/advanced/images/plugin_store_publish.png
Normal file
BIN
archive/2.0.0a16/advanced/images/plugin_store_publish.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
archive/2.0.0a16/advanced/images/plugin_store_publish_2.png
Normal file
BIN
archive/2.0.0a16/advanced/images/plugin_store_publish_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
64
archive/2.0.0a16/advanced/overloaded-handlers.md
Normal file
64
archive/2.0.0a16/advanced/overloaded-handlers.md
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
# 事件处理函数重载
|
||||||
|
|
||||||
|
当我们在编写 `nonebot2` 应用时，常常会遇到这样一个问题：该怎么让同一类型的不同事件执行不同的响应逻辑？又或者如何让不同的 `adapter` 针对同一类型的事件作出不同响应？
|
||||||
|
|
||||||
|
针对这个问题， `nonebot2` 提供一个便捷而高效的解决方案：事件处理函数重载机制。简单地说，`handler` (事件处理函数) 会根据其参数的 `type hints` ([PEP484 类型标注](https://www.python.org/dev/peps/pep-0484/)) 来对相对应的 `adapter` 和 `Event` 进行响应，并且会忽略不符合其参数类型标注的情况。
|
||||||
|
|
||||||
|
必须要注意的是，该机制利用了 `inspect` 标准库获取到了事件处理函数的 `singnature` (签名) ，进一步获取到参数名称和类型标注。故而，我们在编写 `handler` 时，参数的名称和类型标注必须要符合 `T_Handler` 规定，详情可以参看 **指南** 中的[事件处理](../guide/creating-a-handler)。
|
||||||
|
|
||||||
|
::: tip 提示
|
||||||
|
|
||||||
|
如果想了解更多关于 `inspect` 标准库的信息，可以查看[官方文档](https://docs.python.org/zh-cn/3.9/library/inspect.html)。
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
下面，我们会以 `CQHTTP` 中的 `群聊消息事件` 和 `私聊消息事件` 为例，对该机制的应用进行简单的介绍。
|
||||||
|
|
||||||
|
## 一个例子
|
||||||
|
|
||||||
|
首先，我们需要导入需要的方法、类型。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot import on_command
|
||||||
|
from nonebot.adapters.cqhttp import Bot, GroupMessageEvent, PrivateMessageEvent
|
||||||
|
```
|
||||||
|
|
||||||
|
之后，我们可以注册一个 `Matcher` 来响应 `消息事件` 。
|
||||||
|
|
||||||
|
```python
|
||||||
|
matcher = on_command("testoverload")
|
||||||
|
```
|
||||||
|
|
||||||
|
最后, 我们编写不同的 `handler` 并编写不同的类型标注来实现事件处理函数重载：
|
||||||
|
|
||||||
|
```python
|
||||||
|
@matcher.handle()
|
||||||
|
async def _(bot: Bot, event: GroupMessageEvent):
|
||||||
|
await matcher.send("群聊消息事件响应成功！")
|
||||||
|
|
||||||
|
|
||||||
|
@matcher.handle()
|
||||||
|
async def _(bot: Bot, event: PrivateMessageEvent):
|
||||||
|
await matcher.send("私聊消息事件响应成功！")
|
||||||
|
```
|
||||||
|
|
||||||
|
此时，我们可以在群聊或私聊中对我们的机器人发送 `testoverload` ，它会在不同的场景做出不同的应答。
|
||||||
|
|
||||||
|
这样一个简单的事件处理函数重载就完成了。
|
||||||
|
|
||||||
|
## 进阶
|
||||||
|
|
||||||
|
事件处理函数重载机制同样支持被 `matcher.got` 等装饰器装饰的函数。 例如：
|
||||||
|
|
||||||
|
```python
|
||||||
|
@matcher.got("key1", prompt="群事件提问")
|
||||||
|
async def _(bot: Bot, event: GroupMessageEvent):
|
||||||
|
await matcher.send("群聊消息事件响应成功！")
|
||||||
|
|
||||||
|
|
||||||
|
@matcher.got("key2", prompt="私聊事件提问")
|
||||||
|
async def _(bot: Bot, event: PrivateMessageEvent):
|
||||||
|
await matcher.send("私聊消息事件响应成功！")
|
||||||
|
```
|
||||||
|
|
||||||
|
只有触发事件符合的函数才会触发装饰器。
|
||||||
90
archive/2.0.0a16/advanced/permission.md
Normal file
90
archive/2.0.0a16/advanced/permission.md
Normal file
@ -0,0 +1,90 @@
|
|||||||
|
# 权限控制
|
||||||
|
|
||||||
|
**权限控制**是机器人在实际应用中需要解决的重点问题之一，`Nonebot` 提供了十分完善且灵活的权限控制机制—— `Permission` 机制。接下来我们将对这个机制进行简单的说明。
|
||||||
|
|
||||||
|
## 应用
|
||||||
|
|
||||||
|
如同 `Rule` 一样, `Permission` 可以在[注册事件响应器](../guide/creating-a-matcher)时添加 `permission` 参数来加以应用，这样 `Nonebot` 会在事件响应时检测事件主体的权限。下面我们以 `SUPERUSER` 为例，对该机制的应用做一下介绍。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.permission import SUPERUSER
|
||||||
|
from nonebot.adapters import Bot
|
||||||
|
from nonebot import on_command
|
||||||
|
|
||||||
|
matcher = on_command("测试超管", permission=SUPERUSER)
|
||||||
|
|
||||||
|
|
||||||
|
@matcher.handle()
|
||||||
|
async def _(bot: Bot):
|
||||||
|
await matcher.send("超管命令测试成功")
|
||||||
|
|
||||||
|
|
||||||
|
@matcher.got("key1", "超管提问")
|
||||||
|
async def _(bot: Bot, event: Event):
|
||||||
|
await matcher.send("超管命令got成功")
|
||||||
|
```
|
||||||
|
|
||||||
|
在这段代码中，我们事件响应器指定了 `SUPERUSER` 这样一个权限，那么机器人只会响应超级管理员的 `测试超管` 命令，并且会响应该超级管理员的连续对话。
|
||||||
|
|
||||||
|
::: tip 提示
|
||||||
|
|
||||||
|
在这里需要强调的是，`Permission` 与 `Rule` 的表现并不相同， `Rule` 只会在初次响应时生效，在余下的对话中并没有限制事件；但是 `Permission` 会持续生效，在连续对话中会一直对事件主体加以限制。
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## 进阶
|
||||||
|
|
||||||
|
`Permission` 除了可以在注册事件响应器时加以应用，还可以在编写事件处理函数 `handler` 时主动调用，我们可以利用这个特性在一个 `handler` 里对不同权限的事件主体进行区别响应，下面我们以 `CQHTTP` 中的 `GROUP_ADMIN` (普通管理员非群主)和 `GROUP_OWNER` 为例，说明下怎么进行主动调用。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot import on_command
|
||||||
|
from nonebot.adapters.cqhttp import Bot
|
||||||
|
from nonebot.adapters.cqhttp import GroupMessageEvent
|
||||||
|
from nonebot.adapters.cqhttp import GROUP_ADMIN, GROUP_OWNER
|
||||||
|
|
||||||
|
matcher = on_command("测试权限")
|
||||||
|
|
||||||
|
@matcher.handle()
|
||||||
|
async def _(bot: Bot, event: GroupMessageEvent):
|
||||||
|
if await GROUP_ADMIN(bot, event):
|
||||||
|
await matcher.send("管理员测试成功")
|
||||||
|
elif await GROUP_OWNER(bot, event):
|
||||||
|
await matcher.send("群主测试成功")
|
||||||
|
else:
|
||||||
|
await matcher.send("群员测试成功")
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
在这段代码里，我们并没有对命令的权限指定，这个命令会响应所有在群聊中的 `测试权限` 命令，但是在 `handler` 里，我们对两个 `Permission` 进行主动调用，从而可以对不同的角色进行不同的响应。
|
||||||
|
|
||||||
|
## 自定义
|
||||||
|
|
||||||
|
如同 `Rule` 一样, `Permission` 也是由非负数个 `PermissionChecker` 组成的，但只需其中一个返回 `True` 时就会匹配成功。下面则是 `PermissionChecker` 和 `Permission` 示例：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.adapters import Bot, Event
|
||||||
|
from nonebot.permission import Permission
|
||||||
|
|
||||||
|
async def async_checker(bot: Bot, event: Event) -> bool:
|
||||||
|
return True
|
||||||
|
|
||||||
|
def sync_checker(bot: Bot, event: Event) -> bool:
|
||||||
|
return True
|
||||||
|
|
||||||
|
def check(arg1, arg2):
|
||||||
|
|
||||||
|
async def _checker(bot: Bot, event: Event) -> bool:
|
||||||
|
return bool(arg1 + arg2)
|
||||||
|
|
||||||
|
return Permission(_checker)
|
||||||
|
```
|
||||||
|
|
||||||
|
`Permission` 和 `PermissionChecker` 之间可以使用 `或 |` 互相组合：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.permission import Permission
|
||||||
|
|
||||||
|
Permission(async_checker1) | sync_checker | async_checker2
|
||||||
|
```
|
||||||
|
|
||||||
|
同样地，如果想用 `Permission(*checkers)` 包裹构造 `Permission` ，函数必须是异步的；但是在利用 `或 |` 符号连接构造时， `Nonebot` 会自动包裹同步函数为异步函数。
|
||||||
49
archive/2.0.0a16/advanced/publish-plugin.md
Normal file
49
archive/2.0.0a16/advanced/publish-plugin.md
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
# 发布插件
|
||||||
|
|
||||||
|
## 前注
|
||||||
|
|
||||||
|
本章节仅包含插件发布流程指导，插件开发请查阅 **[创建插件](../guide/creating-a-plugin.md)** 章节与 **[Plugin API 文档](../api/plugin.md)** 。
|
||||||
|
|
||||||
|
## 插件发布流程
|
||||||
|
|
||||||
|
### 发布到 PyPI
|
||||||
|
|
||||||
|
您可以选择任意自己喜欢的方式将您的插件发布到 **[PyPI](https://pypi.org/)** ，如使用 **[setuptools](https://pypi.org/project/setuptools/)** 或 **[poetry](https://pypi.org/project/poetry/)** 进行PyPI发布。
|
||||||
|
|
||||||
|
发布时，请您为自己的插件取一个清晰易懂的名字。通常而言，一款 NoneBot2 插件名称使用 *nonebot-plugin-* 作为前缀(如`nonebot-plugin-foo`)，以 *nonebot_plugin_* 作为导入名的前缀(如`nonebot_plugin_foo`)，这并非是强制规范, 而是为了防止与其他PyPI包产生冲突, 所以我们推荐您在没有特殊需求的情况下这样做。
|
||||||
|
|
||||||
|
发布后，请确保您的插件已能公开的从 PyPI 访问到，请检查您的插件在PyPI的地址：`https://pypi.org/project/<您的Nonebot2插件项目名>`
|
||||||
|
|
||||||
|
### 托管您的插件源代码
|
||||||
|
|
||||||
|
将插件源代码及相关构建文件（如`pyproject.toml`或`setup.py`等与PyPI包构建相关的文件）托管在公开代码仓。
|
||||||
|
|
||||||
|
请确保您的代码仓地址能够被正确的访问，检查您的插件在代码仓的地址，如 `https://github.com/<您的Github用户名>/<您的插件Github项目名>` 。
|
||||||
|
|
||||||
|
### 申请发布到Nonebot2插件商店
|
||||||
|
|
||||||
|
完成在 PyPI 的插件发布流程与源代码托管流程后，请您前往 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 页面，切换到插件页签，点击 **发布插件** 按钮。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
如图所示，在弹出的插件信息提交表单内，填入您所要发布的相应插件信息。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
完成填写后，请点击 **发布** 按钮，这将自动在 **[NoneBot2](https://github.com/nonebot/nonebot2)** 代码仓内创建发布您的插件的对应Issue。
|
||||||
|
|
||||||
|
### 等待插件发布处理
|
||||||
|
|
||||||
|
您的插件发布Issue创建后，将会经过*Nonebot2 Publish Bot*的检查，以确保插件信息正确无误。
|
||||||
|
|
||||||
|
之后，NoneBot2的维护者们将会对插件进行进一步的检查，以确保用户能够正常安装并使用该插件。
|
||||||
|
|
||||||
|
完成这些步骤后，您的插件将会被合并到 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** ，而您也将成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** 的一员。
|
||||||
|
|
||||||
|
## 完成
|
||||||
|
|
||||||
|
恭喜您，经过上述的发布流程，您的插件已经成功发布到Nonebot2商店了。
|
||||||
|
|
||||||
|
此时，您可以在 **[NoneBot2商店](https://v2.nonebot.dev/store.html)** 的插件页签查找到您的插件。同时，欢迎您成为 **[NoneBot2贡献者](https://github.com/nonebot/nonebot2/graphs/contributors)** ！
|
||||||
|
|
||||||
|
**Congratulations!**
|
||||||
163
archive/2.0.0a16/advanced/runtime-hook.md
Normal file
163
archive/2.0.0a16/advanced/runtime-hook.md
Normal file
@ -0,0 +1,163 @@
|
|||||||
|
# 钩子函数
|
||||||
|
|
||||||
|
[`钩子编程`](https://zh.wikipedia.org/wiki/%E9%92%A9%E5%AD%90%E7%BC%96%E7%A8%8B)
|
||||||
|
|
||||||
|
> 钩子编程（hooking），也称作“挂钩”，是计算机程序设计术语，指通过拦截软件模块间的函数调用、消息传递、事件传递来修改或扩展操作系统、应用程序或其他软件组件的行为的各种技术。处理被拦截的函数调用、事件、消息的代码，被称为钩子（hook）。
|
||||||
|
|
||||||
|
在 `nonebot2` 中有一系列预定义的钩子函数，分为两类：`全局钩子函数` 和 `事件钩子函数` ，这些钩子函数可以用装饰器的形式来使用。
|
||||||
|
|
||||||
|
## 全局钩子函数
|
||||||
|
|
||||||
|
全局钩子函数是指 `nonebot2` 针对其本身运行过程的钩子函数。
|
||||||
|
|
||||||
|
这些钩子函数是由其后端驱动 `driver`来运行的，故需要先获得全局 `driver` 对象：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot import get_driver
|
||||||
|
|
||||||
|
|
||||||
|
driver=get_driver()
|
||||||
|
```
|
||||||
|
|
||||||
|
共分为六种函数：
|
||||||
|
|
||||||
|
### 启动准备
|
||||||
|
|
||||||
|
这个钩子函数会在 `nonebot2` 启动时运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
@driver.on_startup
|
||||||
|
async def do_something():
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 终止处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `nonebot2` 终止时运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
@driver.on_shutdown
|
||||||
|
async def do_something():
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### bot 连接处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `bot` 通过 `websocket` 连接到 `nonebot2` 时运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
@driver.on_bot_connect
|
||||||
|
async def do_something(bot: Bot):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### bot 断开处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `bot` 断开与 `nonebot2` 的 `websocket` 连接时运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
@driver.on_bot_disconnect
|
||||||
|
async def do_something(bot: Bot):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### bot api 调用钩子
|
||||||
|
|
||||||
|
这个钩子函数会在 `Bot` 调用 API 时运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.adapters import Bot
|
||||||
|
|
||||||
|
@Bot.on_calling_api
|
||||||
|
async def handle_api_call(bot: Bot, api: str, data: Dict[str, Any]):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### bot api 调用后钩子
|
||||||
|
|
||||||
|
这个钩子函数会在 `Bot` 调用 API 后运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.adapters import Bot
|
||||||
|
|
||||||
|
@Bot.on_called_api
|
||||||
|
async def handle_api_result(bot: Bot, exception: Optional[Exception], api: str, data: Dict[str, Any], result: Any):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
## 事件处理钩子
|
||||||
|
|
||||||
|
这些钩子函数指的是影响 `nonebot2` 进行 `事件处理` 的函数。
|
||||||
|
|
||||||
|
:::tip 提示
|
||||||
|
|
||||||
|
关于 `事件处理` 的流程，可以在[这里](./README.md)查阅。
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::warning 注意
|
||||||
|
|
||||||
|
1.在事件处理钩子函数中，与 `matcher` 运行状态相关的函数将不可用，如 `matcher.finish()`
|
||||||
|
|
||||||
|
2.如果需要在事件处理钩子函数中打断整个对话的执行，请参考以下范例：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.exception import IgnoredException
|
||||||
|
|
||||||
|
|
||||||
|
@event_preprocessor
|
||||||
|
async def do_something(bot: Bot, event: Event, state: T_State):
|
||||||
|
raise IgnoredException("reason")
|
||||||
|
```
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
共分为四种函数：
|
||||||
|
|
||||||
|
### 事件预处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `Event` 上报到 `nonebot2` 时运行
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.message import event_preprocessor
|
||||||
|
|
||||||
|
@event_preprocessor
|
||||||
|
async def do_something(bot: Bot, event: Event, state: T_State):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 事件后处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `nonebot2` 处理 `Event` 后运行
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.message import event_postprocessor
|
||||||
|
|
||||||
|
@event_postprocessor
|
||||||
|
async def do_something(bot: Bot, event: Event, state: T_State):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 运行预处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `nonebot2`运行 `matcher` 前运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.message import run_preprocessor
|
||||||
|
|
||||||
|
@run_preprocessor
|
||||||
|
async def do_something(matcher: Matcher, bot: Bot, event: Event, state: T_State):
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### 运行后处理
|
||||||
|
|
||||||
|
这个钩子函数会在 `nonebot2`运行 `matcher` 后运行。
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.message import run_postprocessor
|
||||||
|
|
||||||
|
@run_postprocessor
|
||||||
|
async def do_something(matcher: Matcher, exception: Optional[Exception], bot: Bot, event: Event, state: T_State):
|
||||||
|
pass
|
||||||
|
```
|
||||||
@ -1,14 +1,14 @@
|
|||||||
# 定时任务
|
# 定时任务
|
||||||
|
|
||||||
[`APScheduler`](https://apscheduler.readthedocs.io/en/latest/index.html) —— Advanced Python Scheduler
|
[`APScheduler`](https://apscheduler.readthedocs.io/en/3.x/) —— Advanced Python Scheduler
|
||||||
|
|
||||||
> Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code to be executed later, either just once or periodically. You can add new jobs or remove old ones on the fly as you please. If you store your jobs in a database, they will also survive scheduler restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs it should have run while it was offline.
|
> Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code to be executed later, either just once or periodically. You can add new jobs or remove old ones on the fly as you please. If you store your jobs in a database, they will also survive scheduler restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs it should have run while it was offline.
|
||||||
|
|
||||||
## 从 NoneBot v1 迁移
|
## 从 NoneBot v1 迁移
|
||||||
|
|
||||||
`APScheduler` 作为 `nonebot` v1 的可选依赖，为众多 bot 提供了方便的定时任务功能。`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件，你可以在 [插件广场](https://v2.nonebot.dev/store.html) 中找到它。
|
`APScheduler` 作为 `nonebot` v1 的可选依赖，为众多 bot 提供了方便的定时任务功能。`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件，你可以在 [商店](https://v2.nonebot.dev/store.html) 中找到它。
|
||||||
|
|
||||||
相比于 `nonebot` v1 ，只需要安装插件并修改 `scheduler` 的导入方式即可完成迁移。
|
相比于 `nonebot` v1，`nonebot` v2 只需要安装插件并修改 `scheduler` 的导入方式即可完成迁移。
|
||||||
|
|
||||||
## 安装插件
|
## 安装插件
|
||||||
|
|
||||||
@ -47,9 +47,9 @@ poetry add nonebot-plugin-apscheduler
|
|||||||
```python
|
```python
|
||||||
from nonebot import require
|
from nonebot import require
|
||||||
|
|
||||||
scheduler = require('nonebot_plugin_apscheduler').scheduler
|
scheduler = require("nonebot_plugin_apscheduler").scheduler
|
||||||
|
|
||||||
@scheduler.scheduled_job('cron', hour='*/2', id='xxx', args=[1], kwargs={arg2: 2})
|
@scheduler.scheduled_job("cron", hour="*/2", id="xxx", args=[1], kwargs={"arg2": 2})
|
||||||
async def run_every_2_hour(arg1, arg2):
|
async def run_every_2_hour(arg1, arg2):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
@ -71,12 +71,12 @@ scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx"
|
|||||||
```python
|
```python
|
||||||
from nonebot import require
|
from nonebot import require
|
||||||
|
|
||||||
scheduler = require('nonebot_plugin_apscheduler').scheduler
|
scheduler = require("nonebot_plugin_apscheduler").scheduler
|
||||||
```
|
```
|
||||||
|
|
||||||
### 编写定时任务
|
### 编写定时任务
|
||||||
|
|
||||||
由于本部分为标准的通过 `APScheduler` 配置定时任务，有关指南请参阅 [APScheduler 官方文档](https://apscheduler.readthedocs.io/en/latest/userguide.html#adding-jobs)。
|
由于本部分为标准的通过 `APScheduler` 配置定时任务，有关指南请参阅 [APScheduler 官方文档](https://apscheduler.readthedocs.io/en/3.x/userguide.html#adding-jobs)。
|
||||||
|
|
||||||
### 配置插件选项
|
### 配置插件选项
|
||||||
|
|
||||||
@ -116,7 +116,7 @@ nonebot.init(apscheduler_autostart=True)
|
|||||||
|
|
||||||
`APScheduler` 相关配置。修改/增加其中配置项需要确保 `prefix: apscheduler`。
|
`APScheduler` 相关配置。修改/增加其中配置项需要确保 `prefix: apscheduler`。
|
||||||
|
|
||||||
对于 `APScheduler` 的相关配置，请参阅 [scheduler-config](https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-config) 和 [BaseScheduler](https://apscheduler.readthedocs.io/en/latest/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)
|
对于 `APScheduler` 的相关配置，请参阅 [scheduler-config](https://apscheduler.readthedocs.io/en/3.x/userguide.html#scheduler-config) 和 [BaseScheduler](https://apscheduler.readthedocs.io/en/3.x/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)
|
||||||
|
|
||||||
> 官方文档在绝大多数时候能提供最准确和最具时效性的指南
|
> 官方文档在绝大多数时候能提供最准确和最具时效性的指南
|
||||||
|
|
||||||
@ -19,6 +19,9 @@
|
|||||||
* [nonebot.matcher](matcher.html)
|
* [nonebot.matcher](matcher.html)
|
||||||
|
|
||||||
|
|
||||||
|
* [nonebot.handler](handler.html)
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.rule](rule.html)
|
* [nonebot.rule](rule.html)
|
||||||
|
|
||||||
|
|
||||||
@ -46,6 +49,9 @@
|
|||||||
* [nonebot.drivers.quart](drivers/quart.html)
|
* [nonebot.drivers.quart](drivers/quart.html)
|
||||||
|
|
||||||
|
|
||||||
|
* [nonebot.drivers.aiohttp](drivers/aiohttp.html)
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.adapters](adapters/)
|
* [nonebot.adapters](adapters/)
|
||||||
|
|
||||||
|
|
||||||
@ -56,3 +62,6 @@
|
|||||||
|
|
||||||
|
|
||||||
* [nonebot.adapters.mirai](adapters/mirai.html)
|
* [nonebot.adapters.mirai](adapters/mirai.html)
|
||||||
|
|
||||||
|
|
||||||
|
* [nonebot.adapters.feishu](adapters/feishu.html)
|
||||||
@ -27,35 +27,57 @@ Driver 对象
|
|||||||
Config 配置对象
|
Config 配置对象
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(connection_type, self_id, *, websocket=None)`
|
### `_calling_api_hook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Set[T_CallingAPIHook]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
call_api 时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_called_api_hook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Set[T_CalledAPIHook]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
call_api 后执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `__init__(self_id, request)`
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `connection_type: str`: http 或者 websocket
|
|
||||||
|
|
||||||
|
|
||||||
* `self_id: str`: 机器人 ID
|
* `self_id: str`: 机器人 ID
|
||||||
|
|
||||||
|
|
||||||
* `websocket: Optional[WebSocket]`: Websocket 连接对象
|
* `request: HTTPConnection`: request 连接对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `connection_type`
|
|
||||||
|
|
||||||
连接类型
|
|
||||||
|
|
||||||
|
|
||||||
### `self_id`
|
### `self_id`
|
||||||
|
|
||||||
机器人 ID
|
机器人 ID
|
||||||
|
|
||||||
|
|
||||||
### `websocket`
|
### `request`
|
||||||
|
|
||||||
Websocket 连接对象
|
连接信息
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `type`
|
### _abstract property_ `type`
|
||||||
@ -63,16 +85,16 @@ Websocket 连接对象
|
|||||||
Adapter 类型
|
Adapter 类型
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `register(driver, config)`
|
### _classmethod_ `register(driver, config, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
register 方法会在 driver.register_adapter 时被调用，用于初始化相关配置
|
`register` 方法会在 `driver.register_adapter` 时被调用，用于初始化相关配置
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
### _abstract async classmethod_ `check_permission(driver, request)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -87,27 +109,17 @@ Adapter 类型
|
|||||||
* `driver: Driver`: Driver 对象
|
* `driver: Driver`: Driver 对象
|
||||||
|
|
||||||
|
|
||||||
* `connection_type: str`: 连接类型
|
* `request: HTTPConnection`: request 请求详情
|
||||||
|
|
||||||
|
|
||||||
* `headers: dict`: 请求头
|
|
||||||
|
|
||||||
|
|
||||||
* `body: Optional[dict]`: 请求数据，WebSocket 连接该部分为空
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
* `str`: 连接唯一标识符
|
* `Optional[str]`: 连接唯一标识符，`None` 代表连接不合法
|
||||||
|
|
||||||
|
|
||||||
|
* `Optional[HTTPResponse]`: HTTP 上报响应
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `RequestDenied`: 请求非法
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -123,11 +135,30 @@ Adapter 类型
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `message: dict`: 收到的上报消息
|
* `message: bytes`: 收到的上报消息
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `call_api(api, **data)`
|
### _abstract async_ `_call_api(api, **data)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`adapter` 实际调用 api 的逻辑实现函数，实现该方法以调用 api。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `api: str`: API 名称
|
||||||
|
|
||||||
|
|
||||||
|
* `**data`: API 数据
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _async_ `call_api(api, **data)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -177,9 +208,59 @@ await bot.send_msg(message="hello world")
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `on_calling_api(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
调用 api 预处理。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: 当前 bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `api: str`: 调用的 api 名称
|
||||||
|
|
||||||
|
|
||||||
|
* `data: Dict[str, Any]`: api 调用的参数字典
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `on_called_api(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
调用 api 后处理。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: 当前 bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `exception: Optional[Exception]`: 调用 api 时发生的错误
|
||||||
|
|
||||||
|
|
||||||
|
* `api: str`: 调用的 api 名称
|
||||||
|
|
||||||
|
|
||||||
|
* `data: Dict[str, Any]`: api 调用的参数字典
|
||||||
|
|
||||||
|
|
||||||
|
* `result: Any`: api 调用的返回
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `MessageSegment`
|
## _class_ `MessageSegment`
|
||||||
|
|
||||||
基类：`abc.ABC`
|
基类：`Mapping`, `abc.ABC`, `Generic`[`nonebot.adapters._message.TM`]
|
||||||
|
|
||||||
消息段基类
|
消息段基类
|
||||||
|
|
||||||
@ -204,7 +285,7 @@ await bot.send_msg(message="hello world")
|
|||||||
|
|
||||||
## _class_ `Message`
|
## _class_ `Message`
|
||||||
|
|
||||||
基类：`list`, `abc.ABC`
|
基类：`List`[`nonebot.adapters._message.TMS`], `abc.ABC`
|
||||||
|
|
||||||
消息数组
|
消息数组
|
||||||
|
|
||||||
@ -219,6 +300,47 @@ await bot.send_msg(message="hello world")
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `template(format_string)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
根据创建消息模板, 用法和 `str.format` 大致相同, 但是可以输出消息对象, 并且支持以 `Message` 对象作为消息模板
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **示例**
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
>>> Message.template("{} {}").format("hello", "world")
|
||||||
|
Message(MessageSegment(type='text', data={'text': 'hello world'}))
|
||||||
|
>>> Message.template("{} {}").format(MessageSegment.image("file///..."), "world")
|
||||||
|
Message(MessageSegment(type='image', data={'file': 'file///...'}), MessageSegment(type='text', data={'text': 'world'}))
|
||||||
|
>>> Message.template(
|
||||||
|
... MessageSegment.text('test {event.user_id}') + MessageSegment.face(233) +
|
||||||
|
... MessageSegment.text('test {event.message}')).format(event={'user_id':123456, 'message':'hello world'}
|
||||||
|
... )
|
||||||
|
Message(MessageSegment(type='text', data={'text': 'test 123456'}),
|
||||||
|
MessageSegment(type='face', data={'face': 233}),
|
||||||
|
MessageSegment(type='text', data={'text': 'test hello world'}))
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `format_string: str`: 格式化字符串
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `MessageFormatter[TM]`: 消息格式化器
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `append(obj)`
|
### `append(obj)`
|
||||||
|
|
||||||
|
|
||||||
@ -251,15 +373,6 @@ await bot.send_msg(message="hello world")
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `reduce()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
缩减消息数组，即按 MessageSegment 的实现拼接相邻消息段
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `extract_plain_text()`
|
### `extract_plain_text()`
|
||||||
|
|
||||||
|
|
||||||
@ -291,6 +404,9 @@ Event 基类。提供获取关键信息的方法，其余信息可直接获取
|
|||||||
* `Literal["message", "notice", "request", "meta_event"]`
|
* `Literal["message", "notice", "request", "meta_event"]`
|
||||||
|
|
||||||
|
|
||||||
|
* 其他自定义 `str`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `get_event_name()`
|
### _abstract_ `get_event_name()`
|
||||||
|
|
||||||
@ -424,3 +540,19 @@ Event 基类。提供获取关键信息的方法，其余信息可直接获取
|
|||||||
|
|
||||||
|
|
||||||
* `bool`
|
* `bool`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `MessageTemplate`
|
||||||
|
|
||||||
|
基类：`string.Formatter`, `Generic`[`nonebot.adapters._template.TM`]
|
||||||
|
|
||||||
|
消息模板格式化实现类
|
||||||
|
|
||||||
|
|
||||||
|
### `format(*args, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
根据模板和参数生成消息对象
|
||||||
@ -26,6 +26,9 @@ CQHTTP 配置类
|
|||||||
* `secret` / `cqhttp_secret`: CQHTTP HTTP 上报数据签名口令
|
* `secret` / `cqhttp_secret`: CQHTTP HTTP 上报数据签名口令
|
||||||
|
|
||||||
|
|
||||||
|
* `ws_urls` / `cqhttp_ws_urls`: CQHTTP 正向 Websocket 连接 Bot ID、目标 URL 字典
|
||||||
|
|
||||||
|
|
||||||
# NoneBot.adapters.cqhttp.utils 模块
|
# NoneBot.adapters.cqhttp.utils 模块
|
||||||
|
|
||||||
|
|
||||||
@ -147,7 +150,7 @@ CQHTTP 配置类
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
检查消息开头是否存在，去除并赋值 `event.to_me`
|
检查消息开头是否存在昵称，去除并赋值 `event.to_me`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -193,7 +196,7 @@ CQHTTP 配置类
|
|||||||
|
|
||||||
## _class_ `Bot`
|
## _class_ `Bot`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
基类：[`nonebot.adapters._bot.Bot`](README.md#nonebot.adapters._bot.Bot)
|
||||||
|
|
||||||
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||||
|
|
||||||
@ -204,7 +207,7 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
|||||||
* 返回: `"cqhttp"`
|
* 返回: `"cqhttp"`
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
### _async classmethod_ `check_permission(driver, request)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -307,17 +310,119 @@ CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
|||||||
|
|
||||||
## _class_ `MessageSegment`
|
## _class_ `MessageSegment`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
基类：[`nonebot.adapters._message.MessageSegment`](README.md#nonebot.adapters._message.MessageSegment)[`Message`]
|
||||||
|
|
||||||
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `get_message_class()`
|
||||||
|
|
||||||
|
|
||||||
|
### `is_text()`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `anonymous(ignore_failure=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `at(user_id)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `contact(type_, id)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `contact_group(group_id)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `contact_user(user_id)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `dice()`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `face(id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `forward(id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `image(file, type_=None, cache=True, proxy=True, timeout=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `json(data)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `location(latitude, longitude, title=None, content=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `music(type_, id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `music_custom(url, audio, title, content=None, img_url=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `node(id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `node_custom(user_id, nickname, content)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `poke(type_, id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `record(file, magic=None, cache=None, proxy=None, timeout=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `reply(id_)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `rps()`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `shake()`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `share(url='', title='', content=None, image=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `text(text)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `video(file, cache=None, proxy=None, timeout=None)`
|
||||||
|
|
||||||
|
|
||||||
|
### _static_ `xml(data)`
|
||||||
|
|
||||||
|
|
||||||
|
### `type`
|
||||||
|
|
||||||
|
|
||||||
|
* 类型: `str`
|
||||||
|
|
||||||
|
|
||||||
|
* 说明: 消息段类型
|
||||||
|
|
||||||
|
|
||||||
|
### `data`
|
||||||
|
|
||||||
|
|
||||||
|
* 类型: `Dict[str, Union[str, list]]`
|
||||||
|
|
||||||
|
|
||||||
|
* 说明: 消息段数据
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Message`
|
## _class_ `Message`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
基类：[`nonebot.adapters._message.Message`](README.md#nonebot.adapters._message.Message)[`nonebot.adapters.cqhttp.message.MessageSegment`]
|
||||||
|
|
||||||
CQHTTP 协议 Message 适配。
|
CQHTTP 协议 Message 适配。
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `get_segment_class()`
|
||||||
|
|
||||||
|
|
||||||
|
### `extract_plain_text()`
|
||||||
|
|
||||||
# NoneBot.adapters.cqhttp.permission 模块
|
# NoneBot.adapters.cqhttp.permission 模块
|
||||||
|
|
||||||
|
|
||||||
@ -377,7 +482,7 @@ CQHTTP 协议 Message 适配。
|
|||||||
|
|
||||||
## _class_ `Event`
|
## _class_ `Event`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
基类：[`nonebot.adapters._event.Event`](README.md#nonebot.adapters._event.Event)
|
||||||
|
|
||||||
CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
|
CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md)
|
||||||
|
|
||||||
@ -94,7 +94,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
## _class_ `Bot`
|
## _class_ `Bot`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
基类：[`nonebot.adapters._bot.Bot`](README.md#nonebot.adapters._bot.Bot)
|
||||||
|
|
||||||
钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||||
|
|
||||||
@ -105,7 +105,7 @@ sidebarDepth: 0
|
|||||||
* 返回: `"ding"`
|
* 返回: `"ding"`
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
### _async classmethod_ `check_permission(driver, request)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -129,6 +129,9 @@ sidebarDepth: 0
|
|||||||
* `api: str`: API 名称
|
* `api: str`: API 名称
|
||||||
|
|
||||||
|
|
||||||
|
* `event: Optional[MessageEvent]`: Event 对象
|
||||||
|
|
||||||
|
|
||||||
* `**data: Any`: API 参数
|
* `**data: Any`: API 参数
|
||||||
|
|
||||||
|
|
||||||
@ -150,7 +153,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `send(event, message, at_sender=False, **kwargs)`
|
### _async_ `send(event, message, at_sender=False, webhook=None, secret=None, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -171,6 +174,12 @@ sidebarDepth: 0
|
|||||||
* `at_sender: bool`: 是否 @ 事件主体
|
* `at_sender: bool`: 是否 @ 事件主体
|
||||||
|
|
||||||
|
|
||||||
|
* `webhook: Optional[str]`: 该条消息将调用的 webhook 地址。不传则将使用 sessionWebhook，若其也不存在，该条消息不发送，使用自定义 webhook 时注意你设置的安全方式，如加关键词，IP地址，加签等等。
|
||||||
|
|
||||||
|
|
||||||
|
* `secret: Optional[str]`: 如果你使用自定义的 webhook 地址，推荐使用加签方式对消息进行验证，将 机器人安全设置页面，加签一栏下面显示的SEC开头的字符串 传入这个参数即可。
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 覆盖默认参数
|
* `**kwargs`: 覆盖默认参数
|
||||||
|
|
||||||
|
|
||||||
@ -199,7 +208,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
## _class_ `MessageSegment`
|
## _class_ `MessageSegment`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
基类：[`nonebot.adapters._message.MessageSegment`](README.md#nonebot.adapters._message.MessageSegment)[`Message`]
|
||||||
|
|
||||||
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||||||
|
|
||||||
@ -236,12 +245,12 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
|||||||
|
|
||||||
### _static_ `extension(dict_)`
|
### _static_ `extension(dict_)`
|
||||||
|
|
||||||
"标记 text 文本的 extension 属性，需要与 text 消息段相加。
|
标记 text 文本的 extension 属性，需要与 text 消息段相加。
|
||||||
|
|
||||||
|
|
||||||
### _static_ `code(code_language, code)`
|
### _static_ `code(code_language, code)`
|
||||||
|
|
||||||
"发送 code 消息段
|
发送 code 消息段
|
||||||
|
|
||||||
|
|
||||||
### _static_ `markdown(title, text)`
|
### _static_ `markdown(title, text)`
|
||||||
@ -265,7 +274,7 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
|||||||
* `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列
|
* `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列
|
||||||
|
|
||||||
|
|
||||||
* `btns`: [{ "title": title, "actionURL": actionURL }, ...]
|
* `btns`: `[{ "title": title, "actionURL": actionURL }, ...]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -277,13 +286,13 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `links`: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]
|
* `links`: `[{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Message`
|
## _class_ `Message`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
基类：[`nonebot.adapters._message.Message`](README.md#nonebot.adapters._message.Message)[`nonebot.adapters.ding.message.MessageSegment`]
|
||||||
|
|
||||||
钉钉 协议 Message 适配。
|
钉钉 协议 Message 适配。
|
||||||
|
|
||||||
@ -292,7 +301,7 @@ message += MessageSegment.atDingtalkIds(event.senderId)
|
|||||||
|
|
||||||
## _class_ `Event`
|
## _class_ `Event`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
基类：[`nonebot.adapters._event.Event`](README.md#nonebot.adapters._event.Event)
|
||||||
|
|
||||||
钉钉协议事件。各事件字段参考 [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
钉钉协议事件。各事件字段参考 [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
||||||
|
|
||||||
249
archive/2.0.0a16/api/adapters/feishu.md
Normal file
249
archive/2.0.0a16/api/adapters/feishu.md
Normal file
@ -0,0 +1,249 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu 模块
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu.config 模块
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Config`
|
||||||
|
|
||||||
|
钉钉配置类
|
||||||
|
|
||||||
|
|
||||||
|
* **配置项**
|
||||||
|
|
||||||
|
|
||||||
|
* `app_id` / `feishu_app_id`: 飞书开放平台后台“凭证与基础信息”处给出的 App ID
|
||||||
|
|
||||||
|
|
||||||
|
* `app_secret` / `feishu_app_secret`: 飞书开放平台后台“凭证与基础信息”处给出的 App Secret
|
||||||
|
|
||||||
|
|
||||||
|
* `encrypt_key` / `feishu_encrypt_key`: 飞书开放平台后台“事件订阅”处设置的 Encrypt Key
|
||||||
|
|
||||||
|
|
||||||
|
* `verification_token` / `feishu_verification_token`: 飞书开放平台后台“事件订阅”处设置的 Verification Token
|
||||||
|
|
||||||
|
|
||||||
|
* `tenant_access_token` / `feishu_tenant_access_token`: 请求飞书 API 后返回的租户密钥
|
||||||
|
|
||||||
|
|
||||||
|
* `is_lark` / `feishu_is_lark`: 是否使用Lark（飞书海外版），默认为 false
|
||||||
|
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu.exception 模块
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `ActionFailed`
|
||||||
|
|
||||||
|
基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.feishu.exception.FeishuAdapterException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
API 请求返回错误信息。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `retcode: Optional[int]`: 错误码
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `NetworkError`
|
||||||
|
|
||||||
|
基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.feishu.exception.FeishuAdapterException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
网络错误。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `retcode: Optional[int]`: 错误码
|
||||||
|
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu.bot 模块
|
||||||
|
|
||||||
|
|
||||||
|
## `_check_at_me(bot, event)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
检查消息开头或结尾是否存在 @机器人，去除并赋值 `event.reply`, `event.to_me`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `event: Event`: Event 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `_check_nickname(bot, event)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
检查消息开头是否存在昵称，去除并赋值 `event.to_me`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `event: Event`: Event 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `_handle_api_result(result)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
处理 API 请求返回值。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `result: Optional[Dict[str, Any]]`: API 返回数据
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Any`: API 调用返回数据
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **异常**
|
||||||
|
|
||||||
|
|
||||||
|
* `ActionFailed`: API 调用失败
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Bot`
|
||||||
|
|
||||||
|
基类：[`nonebot.adapters._bot.Bot`](README.md#nonebot.adapters._bot.Bot)
|
||||||
|
|
||||||
|
飞书 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
||||||
|
|
||||||
|
|
||||||
|
### _async_ `handle_message(message)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
处理事件并转换为 [Event](#class-event)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _async_ `call_api(api, **data)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
调用 飞书 协议 API
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `api: str`: API 名称
|
||||||
|
|
||||||
|
|
||||||
|
* `**data: Any`: API 参数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Any`: API 调用返回数据
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **异常**
|
||||||
|
|
||||||
|
|
||||||
|
* `NetworkError`: 网络错误
|
||||||
|
|
||||||
|
|
||||||
|
* `ActionFailed`: API 调用失败
|
||||||
|
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu.message 模块
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `MessageSegment`
|
||||||
|
|
||||||
|
基类：[`nonebot.adapters._message.MessageSegment`](README.md#nonebot.adapters._message.MessageSegment)[`Message`]
|
||||||
|
|
||||||
|
飞书 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Message`
|
||||||
|
|
||||||
|
基类：[`nonebot.adapters._message.Message`](README.md#nonebot.adapters._message.Message)[`nonebot.adapters.feishu.message.MessageSegment`]
|
||||||
|
|
||||||
|
飞书 协议 Message 适配。
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `MessageSerializer`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
飞书 协议 Message 序列化器。
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `MessageDeserializer`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
飞书 协议 Message 反序列化器。
|
||||||
|
|
||||||
|
# NoneBot.adapters.feishu.event 模块
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Event`
|
||||||
|
|
||||||
|
基类：[`nonebot.adapters._event.Event`](README.md#nonebot.adapters._event.Event)
|
||||||
|
|
||||||
|
飞书协议事件。各事件字段参考 [飞书文档](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)
|
||||||
|
|
||||||
|
|
||||||
|
## `get_event_model(event_name)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `List[Type[Event]]`
|
||||||
@ -117,7 +117,7 @@ Bot会话管理器, 提供API主动调用接口
|
|||||||
|
|
||||||
## _class_ `Bot`
|
## _class_ `Bot`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot)
|
基类：[`nonebot.adapters._bot.Bot`](README.md#nonebot.adapters._bot.Bot)
|
||||||
|
|
||||||
mirai-api-http 协议 Bot 适配。
|
mirai-api-http 协议 Bot 适配。
|
||||||
|
|
||||||
@ -292,7 +292,7 @@ API中为了使代码更加整洁, 我们采用了与PEP8相符的命名规则
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `type: str`: "friend" 或 "group" 或 "temp"
|
* `type: str`: “friend” 或 “group” 或 “temp”
|
||||||
|
|
||||||
|
|
||||||
* `img: BytesIO`: 图片的BytesIO对象
|
* `img: BytesIO`: 图片的BytesIO对象
|
||||||
@ -311,7 +311,7 @@ API中为了使代码更加整洁, 我们采用了与PEP8相符的命名规则
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `type: str`: 当前仅支持 "group"
|
* `type: str`: 当前仅支持 “group”
|
||||||
|
|
||||||
|
|
||||||
* `voice: BytesIO`: 语音的BytesIO对象
|
* `voice: BytesIO`: 语音的BytesIO对象
|
||||||
@ -679,37 +679,6 @@ API中为了使代码更加整洁, 我们采用了与PEP8相符的命名规则
|
|||||||
* `info: Dict[str, Any]`: 群员资料, 格式见 `member_info` 的返回值
|
* `info: Dict[str, Any]`: 群员资料, 格式见 `member_info` 的返回值
|
||||||
|
|
||||||
|
|
||||||
# NoneBot.adapters.mirai.bot_ws 模块
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `WebsocketBot`
|
|
||||||
|
|
||||||
基类：`nonebot.adapters.mirai.bot.Bot`
|
|
||||||
|
|
||||||
mirai-api-http 正向 Websocket 协议 Bot 适配。
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `register(driver, config, qq)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
注册该Adapter
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `driver: Driver`: 程序所使用的\`\`Driver\`\`
|
|
||||||
|
|
||||||
|
|
||||||
* `config: Config`: 程序配置对象
|
|
||||||
|
|
||||||
|
|
||||||
* `qq: int`: 要使用的Bot的QQ号 **注意: 在使用正向Websocket时必须指定该值!**
|
|
||||||
|
|
||||||
|
|
||||||
# NoneBot.adapters.mirai.message 模块
|
# NoneBot.adapters.mirai.message 模块
|
||||||
|
|
||||||
|
|
||||||
@ -722,9 +691,9 @@ mirai-api-http 正向 Websocket 协议 Bot 适配。
|
|||||||
|
|
||||||
## _class_ `MessageSegment`
|
## _class_ `MessageSegment`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment)
|
基类：[`nonebot.adapters._message.MessageSegment`](README.md#nonebot.adapters._message.MessageSegment)[`MessageChain`]
|
||||||
|
|
||||||
CQHTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http 消息类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/MessageType.md)
|
Mirai-API-HTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http 消息类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/MessageType.md)
|
||||||
|
|
||||||
|
|
||||||
### `as_dict()`
|
### `as_dict()`
|
||||||
@ -963,22 +932,13 @@ CQHTTP 协议 MessageSegment 适配。具体方法参考 [mirai-api-http 消息
|
|||||||
|
|
||||||
## _class_ `MessageChain`
|
## _class_ `MessageChain`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message)
|
基类：[`nonebot.adapters._message.Message`](README.md#nonebot.adapters._message.Message)[`nonebot.adapters.mirai.message.MessageSegment`]
|
||||||
|
|
||||||
Mirai 协议 Message 适配
|
Mirai 协议 Message 适配
|
||||||
|
|
||||||
由于Mirai协议的Message实现较为特殊, 故使用MessageChain命名
|
由于Mirai协议的Message实现较为特殊, 故使用MessageChain命名
|
||||||
|
|
||||||
|
|
||||||
### `reduce()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
忽略为空的消息段, 合并相邻的纯文本消息段
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `export()`
|
### `export()`
|
||||||
|
|
||||||
导出为可以被正常json序列化的数组
|
导出为可以被正常json序列化的数组
|
||||||
@ -1060,7 +1020,7 @@ Mirai 协议 Message 适配
|
|||||||
|
|
||||||
## _class_ `Event`
|
## _class_ `Event`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
基类：[`nonebot.adapters._event.Event`](README.md#nonebot.adapters._event.Event)
|
||||||
|
|
||||||
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
||||||
|
|
||||||
@ -1082,17 +1042,17 @@ mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
|
用户权限枚举类
|
||||||
用户权限枚举类
|
|
||||||
|
|
||||||
>
|
|
||||||
> * `OWNER`: 群主
|
|
||||||
|
|
||||||
|
|
||||||
> * `ADMINISTRATOR`: 群管理
|
* `OWNER`: 群主
|
||||||
|
|
||||||
|
|
||||||
> * `MEMBER`: 普通群成员
|
* `ADMINISTRATOR`: 群管理
|
||||||
|
|
||||||
|
|
||||||
|
* `MEMBER`: 普通群成员
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `MessageEvent`
|
## _class_ `MessageEvent`
|
||||||
@ -1471,22 +1431,39 @@ Bot被邀请入群申请
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
|
用户权限枚举类
|
||||||
用户权限枚举类
|
|
||||||
|
|
||||||
>
|
|
||||||
> * `OWNER`: 群主
|
|
||||||
|
|
||||||
|
|
||||||
> * `ADMINISTRATOR`: 群管理
|
* `OWNER`: 群主
|
||||||
|
|
||||||
|
|
||||||
> * `MEMBER`: 普通群成员
|
* `ADMINISTRATOR`: 群管理
|
||||||
|
|
||||||
|
|
||||||
|
* `MEMBER`: 普通群成员
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `NudgeSubjectKind`
|
||||||
|
|
||||||
|
基类：`str`, `enum.Enum`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
戳一戳类型枚举类
|
||||||
|
|
||||||
|
|
||||||
|
* `Group`: 群
|
||||||
|
|
||||||
|
|
||||||
|
* `Friend`: 好友
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Event`
|
## _class_ `Event`
|
||||||
|
|
||||||
基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event)
|
基类：[`nonebot.adapters._event.Event`](README.md#nonebot.adapters._event.Event)
|
||||||
|
|
||||||
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
mirai-api-http 协议事件，字段与 mirai-api-http 一致。各事件字段参考 [mirai-api-http 事件类型](https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md)
|
||||||
|
|
||||||
@ -1758,6 +1735,13 @@ Bot在群里的权限被改变
|
|||||||
|
|
||||||
成员权限改变的事件（该成员不是Bot）
|
成员权限改变的事件（该成员不是Bot）
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `NudgeEvent`
|
||||||
|
|
||||||
|
基类：`nonebot.adapters.mirai.event.notice.NoticeEvent`
|
||||||
|
|
||||||
|
戳一戳触发事件
|
||||||
|
|
||||||
# NoneBot.adapters.mirai.event.request 模块
|
# NoneBot.adapters.mirai.event.request 模块
|
||||||
|
|
||||||
|
|
||||||
@ -59,6 +59,8 @@ NoneBot 主要配置。大小写不敏感。
|
|||||||
|
|
||||||
NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
|
NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
|
||||||
|
|
||||||
|
配置格式为 `<module>[:<class>]`，默认类名为 `Driver`。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `host`
|
### `host`
|
||||||
@ -106,6 +108,30 @@ NoneBot 主要配置。大小写不敏感。
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `log_level`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**: `Union[int, str]`
|
||||||
|
|
||||||
|
|
||||||
|
* **默认值**: `None`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
配置 NoneBot 日志输出等级，可以为 `int` 类型等级或等级名称，参考 [loguru 日志等级](https://loguru.readthedocs.io/en/stable/api/logger.html#levels)。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **示例**
|
||||||
|
|
||||||
|
|
||||||
|
```default
|
||||||
|
LOG_LEVEL=25
|
||||||
|
LOG_LEVEL=INFO
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### `api_root`
|
### `api_root`
|
||||||
|
|
||||||
|
|
||||||
529
archive/2.0.0a16/api/drivers/README.md
Normal file
529
archive/2.0.0a16/api/drivers/README.md
Normal file
@ -0,0 +1,529 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.drivers 模块
|
||||||
|
|
||||||
|
## 后端驱动适配基类
|
||||||
|
|
||||||
|
各驱动请继承以下基类
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Driver`
|
||||||
|
|
||||||
|
基类：`abc.ABC`
|
||||||
|
|
||||||
|
Driver 基类。
|
||||||
|
|
||||||
|
|
||||||
|
### `_adapters`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Dict[str, Type[Bot]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
已注册的适配器列表
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_bot_connection_hook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Set[T_BotConnectionHook]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
Bot 连接建立时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_bot_disconnection_hook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Set[T_BotDisconnectionHook]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
Bot 连接断开时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `__init__(env, config)`
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `env: Env`: 包含环境信息的 Env 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `config: Config`: 包含配置信息的 Config 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `env`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`str`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
环境名称
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `config`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Config`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
配置对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_clients`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Dict[str, Bot]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
已连接的 Bot
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `bots`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Dict[str, Bot]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
获取当前所有已连接的 Bot
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `register_adapter(name, adapter, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个协议适配器
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `name: str`: 适配器名称，用于在连接时进行识别
|
||||||
|
|
||||||
|
|
||||||
|
* `adapter: Type[Bot]`: 适配器 Class
|
||||||
|
|
||||||
|
|
||||||
|
* `**kwargs`: 其他传递给适配器的参数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `type`
|
||||||
|
|
||||||
|
驱动类型名称
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `logger`
|
||||||
|
|
||||||
|
驱动专属 logger 日志记录器
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract_ `run(*args, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
启动驱动框架
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `*args`
|
||||||
|
|
||||||
|
|
||||||
|
* `**kwargs`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract_ `on_startup(func)`
|
||||||
|
|
||||||
|
注册一个在驱动启动时运行的函数
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract_ `on_shutdown(func)`
|
||||||
|
|
||||||
|
注册一个在驱动停止时运行的函数
|
||||||
|
|
||||||
|
|
||||||
|
### `on_bot_connect(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
装饰一个函数使他在 bot 通过 WebSocket 连接成功时执行。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **函数参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: 当前连接上的 Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `on_bot_disconnect(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
装饰一个函数使他在 bot 通过 WebSocket 连接断开时执行。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **函数参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: 当前连接上的 Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_bot_connect(bot)`
|
||||||
|
|
||||||
|
在 WebSocket 连接成功后，调用该函数来注册 bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
### `_bot_disconnect(bot)`
|
||||||
|
|
||||||
|
在 WebSocket 连接断开后，调用该函数来注销 bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `ForwardDriver`
|
||||||
|
|
||||||
|
基类：`nonebot.drivers.Driver`
|
||||||
|
|
||||||
|
Forward Driver 基类。将客户端框架封装，以满足适配器使用。
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract_ `setup_http_polling(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 HTTP 轮询连接，如果传入一个函数，则该函数会在每次连接时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[HTTPPollingSetup, Callable[[], Awaitable[HTTPPollingSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract_ `setup_websocket(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 WebSocket 连接，如果传入一个函数，则该函数会在每次重连时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[WebSocketSetup, Callable[[], Awaitable[WebSocketSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `ReverseDriver`
|
||||||
|
|
||||||
|
基类：`nonebot.drivers.Driver`
|
||||||
|
|
||||||
|
Reverse Driver 基类。将后端框架封装，以满足适配器使用。
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `server_app`
|
||||||
|
|
||||||
|
驱动 APP 对象
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `asgi`
|
||||||
|
|
||||||
|
驱动 ASGI 对象
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `HTTPConnection`
|
||||||
|
|
||||||
|
基类：`abc.ABC`
|
||||||
|
|
||||||
|
|
||||||
|
### `http_version`
|
||||||
|
|
||||||
|
One of `"1.0"`, `"1.1"` or `"2"`.
|
||||||
|
|
||||||
|
|
||||||
|
### `scheme`
|
||||||
|
|
||||||
|
URL scheme portion (likely `"http"` or `"https"`).
|
||||||
|
|
||||||
|
|
||||||
|
### `path`
|
||||||
|
|
||||||
|
HTTP request target excluding any query string,
|
||||||
|
with percent-encoded sequences and UTF-8 byte sequences
|
||||||
|
decoded into characters.
|
||||||
|
|
||||||
|
|
||||||
|
### `query_string`
|
||||||
|
|
||||||
|
URL portion after the `?`, percent-encoded.
|
||||||
|
|
||||||
|
|
||||||
|
### `headers`
|
||||||
|
|
||||||
|
A dict of name-value pairs,
|
||||||
|
where name is the header name, and value is the header value.
|
||||||
|
|
||||||
|
Order of header values must be preserved from the original HTTP request;
|
||||||
|
order of header names is not important.
|
||||||
|
|
||||||
|
Header names must be lowercased.
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `type`
|
||||||
|
|
||||||
|
Connection type.
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `HTTPRequest`
|
||||||
|
|
||||||
|
基类：`nonebot.drivers.HTTPConnection`
|
||||||
|
|
||||||
|
HTTP 请求封装。参考 [asgi http scope](https://asgi.readthedocs.io/en/latest/specs/www.html#http-connection-scope)。
|
||||||
|
|
||||||
|
|
||||||
|
### `method`
|
||||||
|
|
||||||
|
The HTTP method name, uppercased.
|
||||||
|
|
||||||
|
|
||||||
|
### `body`
|
||||||
|
|
||||||
|
Body of the request.
|
||||||
|
|
||||||
|
Optional; if missing defaults to `b""`.
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
Always `http`
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `HTTPResponse`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
HTTP 响应封装。参考 [asgi http scope](https://asgi.readthedocs.io/en/latest/specs/www.html#http-connection-scope)。
|
||||||
|
|
||||||
|
|
||||||
|
### `status`
|
||||||
|
|
||||||
|
HTTP status code.
|
||||||
|
|
||||||
|
|
||||||
|
### `body`
|
||||||
|
|
||||||
|
HTTP body content.
|
||||||
|
|
||||||
|
Optional; if missing defaults to `None`.
|
||||||
|
|
||||||
|
|
||||||
|
### `headers`
|
||||||
|
|
||||||
|
A dict of name-value pairs,
|
||||||
|
where name is the header name, and value is the header value.
|
||||||
|
|
||||||
|
Order must be preserved in the HTTP response.
|
||||||
|
|
||||||
|
Header names must be lowercased.
|
||||||
|
|
||||||
|
Optional; if missing defaults to an empty dict.
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
Always `http`
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `WebSocket`
|
||||||
|
|
||||||
|
基类：`nonebot.drivers.HTTPConnection`, `abc.ABC`
|
||||||
|
|
||||||
|
WebSocket 连接封装。参考 [asgi websocket scope](https://asgi.readthedocs.io/en/latest/specs/www.html#websocket-connection-scope)。
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
Always `websocket`
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract property_ `closed`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`bool`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
连接是否已经关闭
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `accept()`
|
||||||
|
|
||||||
|
接受 WebSocket 连接请求
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `close(code)`
|
||||||
|
|
||||||
|
关闭 WebSocket 连接请求
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `receive()`
|
||||||
|
|
||||||
|
接收一条 WebSocket text 信息
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `receive_bytes()`
|
||||||
|
|
||||||
|
接收一条 WebSocket binary 信息
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `send(data)`
|
||||||
|
|
||||||
|
发送一条 WebSocket text 信息
|
||||||
|
|
||||||
|
|
||||||
|
### _abstract async_ `send_bytes(data)`
|
||||||
|
|
||||||
|
发送一条 WebSocket binary 信息
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `HTTPPollingSetup`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
|
||||||
|
### `adapter`
|
||||||
|
|
||||||
|
协议适配器名称
|
||||||
|
|
||||||
|
|
||||||
|
### `self_id`
|
||||||
|
|
||||||
|
机器人 ID
|
||||||
|
|
||||||
|
|
||||||
|
### `url`
|
||||||
|
|
||||||
|
URL
|
||||||
|
|
||||||
|
|
||||||
|
### `method`
|
||||||
|
|
||||||
|
HTTP method
|
||||||
|
|
||||||
|
|
||||||
|
### `body`
|
||||||
|
|
||||||
|
HTTP body
|
||||||
|
|
||||||
|
|
||||||
|
### `headers`
|
||||||
|
|
||||||
|
HTTP headers
|
||||||
|
|
||||||
|
|
||||||
|
### `http_version`
|
||||||
|
|
||||||
|
HTTP version
|
||||||
|
|
||||||
|
|
||||||
|
### `poll_interval`
|
||||||
|
|
||||||
|
HTTP 轮询间隔
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `WebSocketSetup`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
|
||||||
|
### `adapter`
|
||||||
|
|
||||||
|
协议适配器名称
|
||||||
|
|
||||||
|
|
||||||
|
### `self_id`
|
||||||
|
|
||||||
|
机器人 ID
|
||||||
|
|
||||||
|
|
||||||
|
### `url`
|
||||||
|
|
||||||
|
URL
|
||||||
|
|
||||||
|
|
||||||
|
### `headers`
|
||||||
|
|
||||||
|
HTTP headers
|
||||||
|
|
||||||
|
|
||||||
|
### `reconnect_interval`
|
||||||
|
|
||||||
|
WebSocket 重连间隔
|
||||||
101
archive/2.0.0a16/api/drivers/aiohttp.md
Normal file
101
archive/2.0.0a16/api/drivers/aiohttp.md
Normal file
@ -0,0 +1,101 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.drivers.aiohttp 模块
|
||||||
|
|
||||||
|
## AIOHTTP 驱动适配
|
||||||
|
|
||||||
|
本驱动仅支持客户端连接
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Driver`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.ForwardDriver`](README.md#nonebot.drivers.ForwardDriver)
|
||||||
|
|
||||||
|
AIOHTTP 驱动框架
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
驱动名称: `aiohttp`
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `logger`
|
||||||
|
|
||||||
|
aiohttp driver 使用的 logger
|
||||||
|
|
||||||
|
|
||||||
|
### `on_startup(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个启动时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `func: Callable[[], Awaitable[None]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `on_shutdown(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个停止时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `func: Callable[[], Awaitable[None]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `setup_http_polling(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 HTTP 轮询连接，如果传入一个函数，则该函数会在每次连接时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[HTTPPollingSetup, Callable[[], Awaitable[HTTPPollingSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `setup_websocket(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 WebSocket 连接，如果传入一个函数，则该函数会在每次重连时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[WebSocketSetup, Callable[[], Awaitable[WebSocketSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `run(*args, **kwargs)`
|
||||||
|
|
||||||
|
启动 aiohttp driver
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `WebSocket`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.WebSocket`](README.md#nonebot.drivers.WebSocket)
|
||||||
234
archive/2.0.0a16/api/drivers/fastapi.md
Normal file
234
archive/2.0.0a16/api/drivers/fastapi.md
Normal file
@ -0,0 +1,234 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.drivers.fastapi 模块
|
||||||
|
|
||||||
|
## FastAPI 驱动适配
|
||||||
|
|
||||||
|
本驱动同时支持服务端以及客户端连接
|
||||||
|
|
||||||
|
后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Config`
|
||||||
|
|
||||||
|
基类：`pydantic.env_settings.BaseSettings`
|
||||||
|
|
||||||
|
FastAPI 驱动框架设置，详情参考 FastAPI 文档
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_openapi_url`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[str]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`openapi.json` 地址，默认为 `None` 即关闭
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_docs_url`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[str]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`swagger` 地址，默认为 `None` 即关闭
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_redoc_url`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[str]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`redoc` 地址，默认为 `None` 即关闭
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_reload`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[bool]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
开启/关闭冷重载，默认会在配置了 app 的 debug 模式启用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_reload_dirs`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
重载监控文件夹列表，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_reload_delay`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[float]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
重载延迟，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_reload_includes`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `fastapi_reload_excludes`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
不要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Driver`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.ReverseDriver`](README.md#nonebot.drivers.ReverseDriver), [`nonebot.drivers.ForwardDriver`](README.md#nonebot.drivers.ForwardDriver)
|
||||||
|
|
||||||
|
FastAPI 驱动框架
|
||||||
|
|
||||||
|
|
||||||
|
* **上报地址**
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/`: HTTP POST 上报
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/http/`: HTTP POST 上报
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/ws`: WebSocket 上报
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/ws/`: WebSocket 上报
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
驱动名称: `fastapi`
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `server_app`
|
||||||
|
|
||||||
|
`FastAPI APP` 对象
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `asgi`
|
||||||
|
|
||||||
|
`FastAPI APP` 对象
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `logger`
|
||||||
|
|
||||||
|
fastapi 使用的 logger
|
||||||
|
|
||||||
|
|
||||||
|
### `on_startup(func)`
|
||||||
|
|
||||||
|
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
||||||
|
|
||||||
|
|
||||||
|
### `on_shutdown(func)`
|
||||||
|
|
||||||
|
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
||||||
|
|
||||||
|
|
||||||
|
### `setup_http_polling(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 HTTP 轮询连接，如果传入一个函数，则该函数会在每次连接时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[HTTPPollingSetup, Callable[[], Awaitable[HTTPPollingSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `setup_websocket(setup)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
注册一个 WebSocket 连接，如果传入一个函数，则该函数会在每次重连时被调用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `setup: Union[WebSocketSetup, Callable[[], Awaitable[WebSocketSetup]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `run(host=None, port=None, *, app=None, **kwargs)`
|
||||||
|
|
||||||
|
使用 `uvicorn` 启动 FastAPI
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `WebSocket`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.WebSocket`](README.md#nonebot.drivers.WebSocket)
|
||||||
149
archive/2.0.0a16/api/drivers/quart.md
Normal file
149
archive/2.0.0a16/api/drivers/quart.md
Normal file
@ -0,0 +1,149 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.drivers.quart 模块
|
||||||
|
|
||||||
|
## Quart 驱动适配
|
||||||
|
|
||||||
|
后端使用方法请参考: [Quart 文档](https://pgjones.gitlab.io/quart/index.html)
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Config`
|
||||||
|
|
||||||
|
基类：`pydantic.env_settings.BaseSettings`
|
||||||
|
|
||||||
|
Quart 驱动框架设置
|
||||||
|
|
||||||
|
|
||||||
|
### `quart_reload`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[bool]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
开启/关闭冷重载，默认会在配置了 app 的 debug 模式启用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `quart_reload_dirs`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
重载监控文件夹列表，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `quart_reload_delay`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[float]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
重载延迟，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `quart_reload_includes`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `quart_reload_excludes`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[List[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
不要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Driver`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.ReverseDriver`](README.md#nonebot.drivers.ReverseDriver)
|
||||||
|
|
||||||
|
Quart 驱动框架
|
||||||
|
|
||||||
|
|
||||||
|
* **上报地址**
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/http`: HTTP POST 上报
|
||||||
|
|
||||||
|
|
||||||
|
* `/{adapter name}/ws`: WebSocket 上报
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `type`
|
||||||
|
|
||||||
|
驱动名称: `quart`
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `server_app`
|
||||||
|
|
||||||
|
`Quart` 对象
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `asgi`
|
||||||
|
|
||||||
|
`Quart` 对象
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `logger`
|
||||||
|
|
||||||
|
Quart 使用的 logger
|
||||||
|
|
||||||
|
|
||||||
|
### `on_startup(func)`
|
||||||
|
|
||||||
|
参考文档: [Startup and Shutdown](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)
|
||||||
|
|
||||||
|
|
||||||
|
### `on_shutdown(func)`
|
||||||
|
|
||||||
|
参考文档: [Startup and Shutdown](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)
|
||||||
|
|
||||||
|
|
||||||
|
### `run(host=None, port=None, *, app=None, **kwargs)`
|
||||||
|
|
||||||
|
使用 `uvicorn` 启动 Quart
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `WebSocket`
|
||||||
|
|
||||||
|
基类：[`nonebot.drivers.WebSocket`](README.md#nonebot.drivers.WebSocket)
|
||||||
@ -40,6 +40,27 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _exception_ `ParserExit`
|
||||||
|
|
||||||
|
基类：`nonebot.exception.NoneBotException`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`shell command` 处理消息失败时返回的异常
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `status`
|
||||||
|
|
||||||
|
|
||||||
|
* `message`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `PausedException`
|
## _exception_ `PausedException`
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
基类：`nonebot.exception.NoneBotException`
|
||||||
@ -111,27 +132,6 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `RequestDenied`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Bot 连接请求不合法。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `status_code: int`: HTTP 状态码
|
|
||||||
|
|
||||||
|
|
||||||
* `reason: str`: 拒绝原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `AdapterException`
|
## _exception_ `AdapterException`
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
基类：`nonebot.exception.NoneBotException`
|
||||||
111
archive/2.0.0a16/api/handler.md
Normal file
111
archive/2.0.0a16/api/handler.md
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# NoneBot.handler 模块
|
||||||
|
|
||||||
|
## 事件处理函数
|
||||||
|
|
||||||
|
该模块实现事件处理函数的封装，以实现动态参数等功能。
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Handler`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
事件处理函数类
|
||||||
|
|
||||||
|
|
||||||
|
### `__init__(func)`
|
||||||
|
|
||||||
|
装饰事件处理函数以便根据动态参数运行
|
||||||
|
|
||||||
|
|
||||||
|
### `func`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`T_Handler`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `signature`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`inspect.Signature`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数签名
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `bot_type`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Union[Type["Bot"], inspect.Parameter.empty]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数接受的 Bot 对象类型
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `event_type`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[Union[Type[Event], inspect.Parameter.empty]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数接受的 event 类型 / 不需要 event 参数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `state_type`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[Union[T_State, inspect.Parameter.empty]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数是否接受 state 参数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `matcher_type`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[Union[Type["Matcher"], inspect.Parameter.empty]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件处理函数是否接受 matcher 参数
|
||||||
@ -7,7 +7,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
## 事件响应器
|
## 事件响应器
|
||||||
|
|
||||||
该模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行 对话 。
|
该模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行对话 。
|
||||||
|
|
||||||
|
|
||||||
## `matchers`
|
## `matchers`
|
||||||
@ -35,6 +35,21 @@ sidebarDepth: 0
|
|||||||
### `module`
|
### `module`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[ModuleType]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件响应器所在模块
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `plugin_name`
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
|
|
||||||
`Optional[str]`
|
`Optional[str]`
|
||||||
@ -43,7 +58,37 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
事件响应器所在模块名称
|
事件响应器所在插件名
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `module_name`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[str]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件响应器所在模块名
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `module_prefix`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[str]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件响应器所在模块前缀
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -197,6 +242,36 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_default_type_updater`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[T_TypeUpdater]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件响应器类型更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `_default_permission_updater`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Optional[T_PermissionUpdater]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
事件响应器权限更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `__init__()`
|
### `__init__()`
|
||||||
|
|
||||||
实例化 Matcher 以便运行
|
实例化 Matcher 以便运行
|
||||||
@ -207,7 +282,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
|
|
||||||
`List[T_Handler]`
|
`List[Handler]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -217,7 +292,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, default_state_factory=None, expire_time=None)`
|
### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, expire_time=None, default_state=None, default_state_factory=None, default_parser=None, default_type_updater=None, default_permission_updater=None)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -341,6 +416,38 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `type_updater(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
装饰一个函数来更改当前事件响应器的默认响应事件类型更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `func: T_TypeUpdater`: 响应事件类型更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _classmethod_ `permission_updater(func)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
装饰一个函数来更改当前事件响应器的默认会话权限更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `func: T_PermissionUpdater`: 会话权限更新函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `handle()`
|
### _classmethod_ `handle()`
|
||||||
|
|
||||||
|
|
||||||
@ -388,7 +495,7 @@ sidebarDepth: 0
|
|||||||
* `key: str`: 参数名
|
* `key: str`: 参数名
|
||||||
|
|
||||||
|
|
||||||
* `prompt: Optional[Union[str, Message, MessageSegment]]`: 在参数不存在时向用户发送的消息
|
* `prompt: Optional[Union[str, Message, MessageSegment, MessageFormatter]]`: 在参数不存在时向用户发送的消息
|
||||||
|
|
||||||
|
|
||||||
* `args_parser: Optional[T_ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
|
* `args_parser: Optional[T_ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
|
||||||
@ -468,3 +575,12 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `stop_propagation()`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
阻止事件传播
|
||||||
@ -52,6 +52,15 @@ sidebarDepth: 0
|
|||||||
* `load_plugins` => `nonebot.plugin.load_plugins`
|
* `load_plugins` => `nonebot.plugin.load_plugins`
|
||||||
|
|
||||||
|
|
||||||
|
* `load_all_plugins` => `nonebot.plugin.load_all_plugins`
|
||||||
|
|
||||||
|
|
||||||
|
* `load_from_json` => `nonebot.plugin.load_from_json`
|
||||||
|
|
||||||
|
|
||||||
|
* `load_from_toml` => `nonebot.plugin.load_from_toml`
|
||||||
|
|
||||||
|
|
||||||
* `load_builtin_plugins` => `nonebot.plugin.load_builtin_plugins`
|
* `load_builtin_plugins` => `nonebot.plugin.load_builtin_plugins`
|
||||||
|
|
||||||
|
|
||||||
@ -160,6 +169,52 @@ asgi = nonebot.get_asgi()
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## `get_bot(self_id=None)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
当提供 self_id 时，此函数是 get_bots()[self_id] 的简写；当不提供时，返回一个 Bot。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `self_id: Optional[str]`: 用来识别 Bot 的 ID
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Bot`: Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **异常**
|
||||||
|
|
||||||
|
|
||||||
|
* `KeyError`: 对应 ID 的 Bot 不存在
|
||||||
|
|
||||||
|
|
||||||
|
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
|
|
||||||
|
|
||||||
|
* `ValueError`: 没有传入 ID 且没有 Bot 可用
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **用法**
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
assert nonebot.get_bot('12345') == nonebot.get_bots()['12345']
|
||||||
|
|
||||||
|
another_unspecified_bot = nonebot.get_bot()
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## `get_bots()`
|
## `get_bots()`
|
||||||
|
|
||||||
|
|
||||||
@ -14,6 +14,80 @@ sidebarDepth: 0
|
|||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Permission`
|
||||||
|
|
||||||
|
基类：`object`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`Matcher` 规则类，当事件传递时，在 `Matcher` 运行前进行检查。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **示例**
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
Permission(async_function) | sync_function
|
||||||
|
# 等价于
|
||||||
|
from nonebot.utils import run_sync
|
||||||
|
Permission(async_function, run_sync(sync_function))
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### `__init__(*checkers)`
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `*checkers: Callable[[Bot, Event], Awaitable[bool]]`: **异步** PermissionChecker
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### `checkers`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
存储 `PermissionChecker`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
|
||||||
|
* `Set[Callable[[Bot, Event], Awaitable[bool]]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### _async_ `__call__(bot, event)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
检查是否满足某个权限
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `bot: Bot`: Bot 对象
|
||||||
|
|
||||||
|
|
||||||
|
* `event: Event`: Event 对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `bool`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `MESSAGE`
|
## `MESSAGE`
|
||||||
|
|
||||||
|
|
||||||
@ -38,84 +112,26 @@ sidebarDepth: 0
|
|||||||
* **说明**: 匹配任意 `meta_event` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 meta_event type 的 Matcher。
|
* **说明**: 匹配任意 `meta_event` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 meta_event type 的 Matcher。
|
||||||
|
|
||||||
|
|
||||||
## `USER(*user, perm=<nonebot.permission.Permission object>)`
|
## `USER(*user, perm=None)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
在白名单内且满足 perm
|
`event` 的 `session_id` 在白名单内且满足 perm
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `*user: int`: 白名单
|
* `*user: str`: 白名单
|
||||||
|
|
||||||
|
|
||||||
* `perm: Permission`: 需要同时满足的权限
|
* `perm: Optional[Permission]`: 需要同时满足的权限
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PRIVATE`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意私聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `PRIVATE_FRIEND`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意好友私聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `PRIVATE_GROUP`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意群临时私聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `PRIVATE_OTHER`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意其他私聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `GROUP`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意群聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `GROUP_MEMBER`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意群员群聊消息类型事件
|
|
||||||
|
|
||||||
:::warning 警告
|
|
||||||
该权限通过 event.sender 进行判断且不包含管理员以及群主！
|
|
||||||
:::
|
|
||||||
|
|
||||||
|
|
||||||
## `GROUP_ADMIN`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意群管理员群聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `GROUP_OWNER`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意群主群聊消息类型事件
|
|
||||||
|
|
||||||
|
|
||||||
## `SUPERUSER`
|
## `SUPERUSER`
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意超级用户消息类型事件
|
* **说明**: 匹配任意超级用户消息类型事件
|
||||||
|
|
||||||
|
|
||||||
## `EVERYBODY`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 匹配任意消息类型事件
|
|
||||||
@ -25,38 +25,6 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Export`
|
|
||||||
|
|
||||||
基类：`dict`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
插件导出内容以使得其他插件可以获得。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
nonebot.export().default = "bar"
|
|
||||||
|
|
||||||
@nonebot.export()
|
|
||||||
def some_function():
|
|
||||||
pass
|
|
||||||
|
|
||||||
# this doesn't work before python 3.9
|
|
||||||
# use
|
|
||||||
# export = nonebot.export(); @export.sub
|
|
||||||
# instead
|
|
||||||
# See also PEP-614: https://www.python.org/dev/peps/pep-0614/
|
|
||||||
@nonebot.export().sub
|
|
||||||
def something_else():
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Plugin`
|
## _class_ `Plugin`
|
||||||
|
|
||||||
基类：`object`
|
基类：`object`
|
||||||
@ -82,16 +50,7 @@ def something_else():
|
|||||||
* **说明**: 插件模块对象
|
* **说明**: 插件模块对象
|
||||||
|
|
||||||
|
|
||||||
### `matcher`
|
### _property_ `export`
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Set[Type[Matcher]]`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**: 插件内定义的 `Matcher`
|
|
||||||
|
|
||||||
|
|
||||||
### `export`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Export`
|
* **类型**: `Export`
|
||||||
@ -100,6 +59,15 @@ def something_else():
|
|||||||
* **说明**: 插件内定义的导出内容
|
* **说明**: 插件内定义的导出内容
|
||||||
|
|
||||||
|
|
||||||
|
### _property_ `matcher`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**: `Set[Type[Matcher]]`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**: 插件内定义的 `Matcher`
|
||||||
|
|
||||||
|
|
||||||
## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)`
|
## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)`
|
||||||
|
|
||||||
|
|
||||||
@ -121,7 +89,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -162,7 +130,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -206,7 +174,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -247,7 +215,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -288,7 +256,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -314,7 +282,7 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `on_startswith(msg, rule=None, **kwargs)`
|
## `on_startswith(msg, rule=None, ignorecase=False, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -326,16 +294,19 @@ def something_else():
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 指定消息开头内容
|
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
|
||||||
|
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
|
* `ignorecase: bool`: 是否忽略大小写
|
||||||
|
|
||||||
|
|
||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -361,7 +332,7 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `on_endswith(msg, rule=None, **kwargs)`
|
## `on_endswith(msg, rule=None, ignorecase=False, **kwargs)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -373,16 +344,19 @@ def something_else():
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 指定消息结尾内容
|
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
|
||||||
|
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
|
* `ignorecase: bool`: 是否忽略大小写
|
||||||
|
|
||||||
|
|
||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -429,7 +403,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -481,7 +455,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -538,7 +512,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -590,7 +564,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -695,7 +669,7 @@ def something_else():
|
|||||||
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值
|
* `**kwargs`: 其他传递给 `on_shell_command` 的参数，将会覆盖命令组默认值
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -767,7 +741,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -808,7 +782,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -852,7 +826,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -893,7 +867,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -934,7 +908,7 @@ def something_else():
|
|||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -972,7 +946,10 @@ def something_else():
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 指定消息开头内容
|
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
|
||||||
|
|
||||||
|
|
||||||
|
* `ignorecase: bool`: 是否忽略大小写
|
||||||
|
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
@ -981,7 +958,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1019,7 +996,10 @@ def something_else():
|
|||||||
* **参数**
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 指定消息结尾内容
|
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
|
||||||
|
|
||||||
|
|
||||||
|
* `ignorecase: bool`: 是否忽略大小写
|
||||||
|
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
||||||
@ -1028,7 +1008,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1075,7 +1055,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1127,7 +1107,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1184,7 +1164,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1236,7 +1216,7 @@ def something_else():
|
|||||||
* `permission: Optional[Permission]`: 事件响应权限
|
* `permission: Optional[Permission]`: 事件响应权限
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
* `handlers: Optional[List[Union[T_Handler, Handler]]]`: 事件处理函数列表
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
||||||
@ -1267,7 +1247,7 @@ def something_else():
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
使用 `importlib` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。
|
使用 `PluginManager` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1308,6 +1288,85 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `load_all_plugins(module_path, plugin_dir)`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
导入指定列表中的插件以及指定目录下多个插件，以 `_` 开头的插件不会被导入！
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `module_path: Set[str]`: 指定插件集合
|
||||||
|
|
||||||
|
|
||||||
|
* `plugin_dir: Set[str]`: 指定插件路径集合
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Set[Plugin]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `load_from_json(file_path, encoding='utf-8')`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
导入指定 json 文件中的 `plugins` 以及 `plugin_dirs` 下多个插件，以 `_` 开头的插件不会被导入！
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `file_path: str`: 指定 json 文件路径
|
||||||
|
|
||||||
|
|
||||||
|
* `encoding: str`: 指定 json 文件编码
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Set[Plugin]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `load_from_toml(file_path, encoding='utf-8')`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
导入指定 toml 文件 `[nonebot.plugins]` 中的 `plugins` 以及 `plugin_dirs` 下多个插件，
|
||||||
|
以 `_` 开头的插件不会被导入！
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **参数**
|
||||||
|
|
||||||
|
|
||||||
|
* `file_path: str`: 指定 toml 文件路径
|
||||||
|
|
||||||
|
|
||||||
|
* `encoding: str`: 指定 toml 文件编码
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Set[Plugin]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `load_builtin_plugins(name='echo')`
|
## `load_builtin_plugins(name='echo')`
|
||||||
|
|
||||||
|
|
||||||
@ -1363,22 +1422,6 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `export()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取插件的导出内容对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Export`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `require(name)`
|
## `require(name)`
|
||||||
|
|
||||||
|
|
||||||
@ -1399,3 +1442,51 @@ def something_else():
|
|||||||
|
|
||||||
|
|
||||||
* `Optional[Export]`
|
* `Optional[Export]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## _class_ `Export`
|
||||||
|
|
||||||
|
基类：`dict`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
插件导出内容以使得其他插件可以获得。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **示例**
|
||||||
|
|
||||||
|
|
||||||
|
```python
|
||||||
|
nonebot.export().default = "bar"
|
||||||
|
|
||||||
|
@nonebot.export()
|
||||||
|
def some_function():
|
||||||
|
pass
|
||||||
|
|
||||||
|
# this doesn't work before python 3.9
|
||||||
|
# use
|
||||||
|
# export = nonebot.export(); @export.sub
|
||||||
|
# instead
|
||||||
|
# See also PEP-614: https://www.python.org/dev/peps/pep-0614/
|
||||||
|
@nonebot.export().sub
|
||||||
|
def something_else():
|
||||||
|
pass
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## `export()`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
获取插件的导出内容对象
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **返回**
|
||||||
|
|
||||||
|
|
||||||
|
* `Export`
|
||||||
@ -91,7 +91,7 @@ Rule(async_function, run_sync(sync_function))
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `startswith(msg)`
|
## `startswith(msg, ignorecase=False)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -107,7 +107,7 @@ Rule(async_function, run_sync(sync_function))
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `endswith(msg)`
|
## `endswith(msg, ignorecase=False)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -46,7 +46,7 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_WebSocketConnectionHook`
|
## `T_BotConnectionHook`
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
@ -57,12 +57,12 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
WebSocket 连接建立时执行的函数
|
Bot 连接建立时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `T_WebSocketDisconnectionHook`
|
## `T_BotDisconnectionHook`
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
* **类型**
|
||||||
@ -73,7 +73,39 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
WebSocket 连接断开时执行的函数
|
Bot 连接断开时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `T_CallingAPIHook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Callable[[Bot, str, Dict[str, Any]], Awaitable[None]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`bot.call_api` 时执行的函数
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `T_CalledAPIHook`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Callable[[Bot, Optional[Exception], str, Dict[str, Any], Any], Awaitable[None]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
`bot.call_api` 后执行的函数，参数分别为 bot, exception, api, data, result
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -212,3 +244,35 @@ sidebarDepth: 0
|
|||||||
* **说明**
|
* **说明**
|
||||||
|
|
||||||
ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。
|
ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `T_TypeUpdater`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Callable[[Bot, Event, T_State, str], Awaitable[str]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
TypeUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新响应的事件类型。默认会更新为 `message`。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `T_PermissionUpdater`
|
||||||
|
|
||||||
|
|
||||||
|
* **类型**
|
||||||
|
|
||||||
|
`Callable[[Bot, Event, T_State, Permission], Awaitable[Permission]]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
PermissionUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新会话对象权限。默认会更新为当前事件的触发对象。
|
||||||
@ -52,7 +52,18 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `logger_wrapper`
|
## _class_ `DataclassEncoder`
|
||||||
|
|
||||||
|
基类：`json.encoder.JSONEncoder`
|
||||||
|
|
||||||
|
|
||||||
|
* **说明**
|
||||||
|
|
||||||
|
在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## `logger_wrapper(logger_name)`
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
* **说明**
|
||||||
@ -72,13 +83,3 @@ sidebarDepth: 0
|
|||||||
|
|
||||||
|
|
||||||
* `exception: Optional[Exception]`: 异常信息
|
* `exception: Optional[Exception]`: 异常信息
|
||||||
|
|
||||||
|
|
||||||
## _class_ `DataclassEncoder`
|
|
||||||
|
|
||||||
基类：`json.encoder.JSONEncoder`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`
|
|
||||||
@ -14,7 +14,7 @@ NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人
|
|||||||
|
|
||||||
得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理事件的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
|
得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理事件的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
|
||||||
|
|
||||||
需要注意的是，NoneBot 仅支持 **Python 3.7+**
|
需要注意的是，NoneBot 仅支持 **Python 3.7.3 以上版本**
|
||||||
|
|
||||||
## 特色
|
## 特色
|
||||||
|
|
||||||
@ -1,5 +1,11 @@
|
|||||||
# CQHTTP 协议使用指南
|
# CQHTTP 协议使用指南
|
||||||
|
|
||||||
|
## 安装 NoneBot CQHTTP 适配器
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install nonebot-adapter-cqhttp
|
||||||
|
```
|
||||||
|
|
||||||
## 配置 CQHTTP 协议端（以 QQ 为例）
|
## 配置 CQHTTP 协议端（以 QQ 为例）
|
||||||
|
|
||||||
单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
|
单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
|
||||||
@ -7,10 +13,10 @@
|
|||||||
QQ 协议端举例:
|
QQ 协议端举例:
|
||||||
|
|
||||||
- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) (基于 [MiraiGo](https://github.com/Mrs4s/MiraiGo))
|
- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) (基于 [MiraiGo](https://github.com/Mrs4s/MiraiGo))
|
||||||
- [cqhttp-mirai-embedded](https://github.com/yyuueexxiinngg/cqhttp-mirai/tree/embedded)
|
- [onebot-kotlin](https://github.com/yyuueexxiinngg/onebot-kotlin)
|
||||||
- [Mirai](https://github.com/mamoe/mirai) + [cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai)
|
- [Mirai](https://github.com/mamoe/mirai) + [onebot-mirai](https://github.com/yyuueexxiinngg/onebot-kotlin)
|
||||||
- [Mirai](https://github.com/mamoe/mirai) + [Mirai Native](https://github.com/iTXTech/mirai-native) + [CQHTTP](https://github.com/richardchien/coolq-http-api)
|
- [Mirai](https://github.com/mamoe/mirai) + [Mirai Native](https://github.com/iTXTech/mirai-native) + [CQHTTP](https://github.com/richardchien/coolq-http-api)
|
||||||
- [OICQ-http-api](https://github.com/takayama-lily/onebot) (基于 [OICQ](https://github.com/takayama-lily/oicq))
|
- [node-onebot](https://github.com/takayama-lily/node-onebot) (基于 [abot](https://github.com/takayama-lily/abot), [OICQ](https://github.com/takayama-lily/oicq))
|
||||||
|
|
||||||
这里以 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 为例
|
这里以 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 为例
|
||||||
|
|
||||||
@ -18,65 +24,75 @@ QQ 协议端举例:
|
|||||||
2. 运行 exe 文件或者使用 `./go-cqhttp` 启动
|
2. 运行 exe 文件或者使用 `./go-cqhttp` 启动
|
||||||
3. 生成默认配置文件并修改默认配置
|
3. 生成默认配置文件并修改默认配置
|
||||||
|
|
||||||
```hjson{2,3,35-36,42}
|
### 选项 1 反向 WebSocket 连接
|
||||||
{
|
|
||||||
|
```yml{2,3,6,10}
|
||||||
|
account:
|
||||||
uin: 机器人QQ号
|
uin: 机器人QQ号
|
||||||
password: 机器人密码
|
password: "机器人密码"
|
||||||
encrypt_password: false
|
|
||||||
password_encrypted: ""
|
message:
|
||||||
enable_db: true
|
post-format: array
|
||||||
access_token: ""
|
|
||||||
relogin: {
|
servers:
|
||||||
enabled: true
|
- ws-reverse:
|
||||||
relogin_delay: 3
|
universal: ws://127.0.0.1:8080/cqhttp/ws
|
||||||
max_relogin_times: 0
|
|
||||||
}
|
|
||||||
_rate_limit: {
|
|
||||||
enabled: false
|
|
||||||
frequency: 1
|
|
||||||
bucket_size: 1
|
|
||||||
}
|
|
||||||
ignore_invalid_cqcode: false
|
|
||||||
force_fragmented: false
|
|
||||||
heartbeat_interval: 0
|
|
||||||
http_config: {
|
|
||||||
enabled: false
|
|
||||||
host: "0.0.0.0"
|
|
||||||
port: 5700
|
|
||||||
timeout: 0
|
|
||||||
post_urls: {}
|
|
||||||
}
|
|
||||||
ws_config: {
|
|
||||||
enabled: false
|
|
||||||
host: "0.0.0.0"
|
|
||||||
port: 6700
|
|
||||||
}
|
|
||||||
ws_reverse_servers: [
|
|
||||||
{
|
|
||||||
enabled: true
|
|
||||||
reverse_url: ws://127.0.0.1:8080/cqhttp/ws
|
|
||||||
reverse_api_url: ws://you_websocket_api.server
|
|
||||||
reverse_event_url: ws://you_websocket_event.server
|
|
||||||
reverse_reconnect_interval: 3000
|
|
||||||
}
|
|
||||||
]
|
|
||||||
post_message_format: array
|
|
||||||
use_sso_address: false
|
|
||||||
debug: false
|
|
||||||
log_level: ""
|
|
||||||
web_ui: {
|
|
||||||
enabled: false
|
|
||||||
host: 127.0.0.1
|
|
||||||
web_ui_port: 9999
|
|
||||||
web_input: false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||||||
|
|
||||||
`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
|
`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
|
||||||
|
|
||||||
|
### 选项 2 HTTP POST 上报
|
||||||
|
|
||||||
|
```yml{2,3,6,11}
|
||||||
|
account:
|
||||||
|
uin: 机器人QQ号
|
||||||
|
password: "机器人密码"
|
||||||
|
|
||||||
|
message:
|
||||||
|
post-format: array
|
||||||
|
|
||||||
|
servers:
|
||||||
|
- http:
|
||||||
|
post:
|
||||||
|
- url: "http://127.0.0.1:8080/cqhttp/http"
|
||||||
|
secret: ""
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 `ws://127.0.0.1:8080/cqhttp/http` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
|
||||||
|
|
||||||
|
`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
|
||||||
|
|
||||||
|
### 选项 3 正向 WebSocket 连接
|
||||||
|
|
||||||
|
```yml{2,3,6,10,11}
|
||||||
|
account:
|
||||||
|
uin: 机器人QQ号
|
||||||
|
password: "机器人密码"
|
||||||
|
|
||||||
|
message:
|
||||||
|
post-format: array
|
||||||
|
|
||||||
|
servers:
|
||||||
|
- ws:
|
||||||
|
host: 127.0.0.1
|
||||||
|
port: 6700
|
||||||
|
```
|
||||||
|
|
||||||
|
NoneBot 配置
|
||||||
|
|
||||||
|
```dotenv
|
||||||
|
CQHTTP_WS_URLS={"机器人QQ号": "ws://127.0.0.1:6700/"}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 `ws://127.0.0.1:6700/` 中的 `127.0.0.1` 和 `6700` 应分别对应 go-cqhttp 配置的 HOST 和 PORT。
|
||||||
|
|
||||||
|
正向连接可以选择支持客户端连接方式的 `Driver` 来进行连接，请根据需求进行选择：
|
||||||
|
|
||||||
|
- `nonebot.drivers.fastapi`: 同时支持正向和反向
|
||||||
|
- `nonebot.drivers.aiohttp`: 仅支持正向
|
||||||
|
|
||||||
## 历史性的第一次对话
|
## 历史性的第一次对话
|
||||||
|
|
||||||
一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
||||||
@ -43,7 +43,7 @@ async def handle_city(bot: Bot, event: Event, state: T_State):
|
|||||||
|
|
||||||
指示 NoneBot 接收一条新的用户消息后继续执行该处理函数。此时函数将会接收到新的消息而非前一条消息，之前相关信息可以存储在 state 中。
|
指示 NoneBot 接收一条新的用户消息后继续执行该处理函数。此时函数将会接收到新的消息而非前一条消息，之前相关信息可以存储在 state 中。
|
||||||
|
|
||||||
特别的，当装饰的函数前没有其他事件处理函数，那么 `receive()` 不会接收一条新的消息而是直接使用第一条接收到的消息。
|
特别地，当装饰的函数前没有其他事件处理函数，那么 `receive()` 不会接收一条新的消息而是直接使用第一条接收到的消息。
|
||||||
|
|
||||||
#### got(key, prompt, args_parser)
|
#### got(key, prompt, args_parser)
|
||||||
|
|
||||||
@ -101,6 +101,8 @@ nb plugin install nonebot_plugin_test
|
|||||||
|
|
||||||
NoneBot 内置的事件响应器中，所有 `message` 类的事件响应器默认会阻断事件传递，其他则不会。
|
NoneBot 内置的事件响应器中，所有 `message` 类的事件响应器默认会阻断事件传递，其他则不会。
|
||||||
|
|
||||||
|
在部分情况中，可以使用 `matcher.stop_propagation()` 方法动态阻止事件传播，该方法需要 `handler` 在参数中获取 `matcher` 实例后调用方法。
|
||||||
|
|
||||||
## 自定义 rule
|
## 自定义 rule
|
||||||
|
|
||||||
rule 的出现使得 nonebot 对事件的响应可以非常自由，nonebot 内置了一些规则：
|
rule 的出现使得 nonebot 对事件的响应可以非常自由，nonebot 内置了一些规则：
|
||||||
@ -8,7 +8,7 @@
|
|||||||
nb plugin new
|
nb plugin new
|
||||||
```
|
```
|
||||||
|
|
||||||
插件通常有两种形式，下面分别介绍
|
下面分别对两种通常的插件形式做具体介绍
|
||||||
|
|
||||||
## 单文件形式
|
## 单文件形式
|
||||||
|
|
||||||
@ -34,6 +34,13 @@ AweSome-Bot
|
|||||||
|
|
||||||
## 启动 Bot
|
## 启动 Bot
|
||||||
|
|
||||||
|
:::warning 提示
|
||||||
|
如果您使用如 `VSCode` / `PyCharm` 等 IDE 启动 nonebot，请检查 IDE 当前工作空间目录是否与当前侧边栏打开目录一致。
|
||||||
|
|
||||||
|
- 注意：在二者不一致的环境下可能导致 nonebot 读取配置文件和插件等不符合预期
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
通过 `nb-cli`
|
通过 `nb-cli`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -11,6 +11,16 @@
|
|||||||
- [群机器人概述](https://developers.dingtalk.com/document/app/overview-of-group-robots)
|
- [群机器人概述](https://developers.dingtalk.com/document/app/overview-of-group-robots)
|
||||||
- [开发企业内部机器人](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots)
|
- [开发企业内部机器人](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots)
|
||||||
|
|
||||||
|
钉钉官方机器人教程（Java）：
|
||||||
|
|
||||||
|
- [开发一个钉钉机器人](https://developers.dingtalk.com/document/tutorial/create-a-robot)
|
||||||
|
|
||||||
|
## 安装 NoneBot 钉钉 适配器
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install nonebot-adapter-ding
|
||||||
|
```
|
||||||
|
|
||||||
## 关于 DingAdapter 的说明
|
## 关于 DingAdapter 的说明
|
||||||
|
|
||||||
你需要显式的注册 ding 这个适配器：
|
你需要显式的注册 ding 这个适配器：
|
||||||
@ -87,6 +97,58 @@ async def raw_handler(bot: DingBot, event: MessageEvent):
|
|||||||
|
|
||||||
其他消息格式请查看 [钉钉适配器的 MessageSegment](https://github.com/nonebot/nonebot2/blob/dev/nonebot/adapters/ding/message.py#L8)，里面封装了很多有关消息的方法，比如 `code`、`image`、`feedCard` 等。
|
其他消息格式请查看 [钉钉适配器的 MessageSegment](https://github.com/nonebot/nonebot2/blob/dev/nonebot/adapters/ding/message.py#L8)，里面封装了很多有关消息的方法，比如 `code`、`image`、`feedCard` 等。
|
||||||
|
|
||||||
|
## 发送到特定群聊
|
||||||
|
|
||||||
|
钉钉也支持通过 Webhook 的方式直接将消息推送到某个群聊([参考链接](https://developers.dingtalk.com/document/app/custom-robot-access/title-zob-eyu-qse))，你可以在机器人的设置中看到当前群的 Webhook 地址。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
获取到 Webhook 地址后，用户可以向这个地址发起 HTTP POST 请求，即可实现给该钉钉群发送消息。
|
||||||
|
|
||||||
|
对于这种通过 Webhook 推送的消息，钉钉需要开发者进行安全方面的设置（目前有 3 种安全设置方式，请根据需要选择一种），如下：
|
||||||
|
|
||||||
|
1. **自定义关键词：** 最多可以设置 10 个关键词，消息中至少包含其中 1 个关键词才可以发送成功。
|
||||||
|
例如添加了一个自定义关键词：监控报警，则这个机器人所发送的消息，必须包含监控报警这个词，才能发送成功。
|
||||||
|
2. **加签：** 发送请求时带上验签的值，可以在机器人设置里看到密钥。
|
||||||
|
|
||||||
|
3. **IP 地址（段）：** 设定后，只有来自 IP 地址范围内的请求才会被正常处理。支持两种设置方式：IP 地址和 IP 地址段，暂不支持 IPv6 地址白名单。
|
||||||
|
|
||||||
|
如果你选择 1/3 两种安全设置，你需要自己确认当前网络和发送的消息能被钉钉接受，然后使用 `bot.send` 的时候将 webhook 地址传入 webhook 参数即可。
|
||||||
|
|
||||||
|
如我设置了 `打卡` 为关键词：
|
||||||
|
|
||||||
|
```python
|
||||||
|
message = MessageSegment.text("打卡成功：XXXXXX")
|
||||||
|
await hello.send(
|
||||||
|
message,
|
||||||
|
webhook=
|
||||||
|
"https://oapi.dingtalk.com/robot/send?access_token=XXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
对于第二种加签方式，你可以在 `bot.send` 的时候把 `secret` 参数传进去，Nonebot 内部会自动帮你计算发送该消息的签名并发送，如：
|
||||||
|
|
||||||
|
这里的 `secret` 参数就是加签选项给出的那个密钥。
|
||||||
|
|
||||||
|
```python
|
||||||
|
message = MessageSegment.raw({
|
||||||
|
"msgtype": "text",
|
||||||
|
"text": {
|
||||||
|
"content": 'hello from webhook,一定要注意安全方式的鉴权哦，否则可能发送失败的'
|
||||||
|
},
|
||||||
|
})
|
||||||
|
message += MessageSegment.atDingtalkIds(event.senderId)
|
||||||
|
await hello.send(
|
||||||
|
message,
|
||||||
|
webhook="https://oapi.dingtalk.com/robot/send?access_token=XXXXXXXXXXXXXX",
|
||||||
|
secret="SECXXXXXXXXXXXXXXXXXXXXXXXXX",
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
然后就可以发送成功了。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 创建机器人并连接
|
## 创建机器人并连接
|
||||||
|
|
||||||
在钉钉官方文档 [「开发企业内部机器人 -> 步骤一：创建机器人应用」](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots/title-ufs-4gh-poh) 中有详细介绍，这里就省去创建的步骤，介绍一下如何连接上程序。
|
在钉钉官方文档 [「开发企业内部机器人 -> 步骤一：创建机器人应用」](https://developers.dingtalk.com/document/app/develop-enterprise-internal-robots/title-ufs-4gh-poh) 中有详细介绍，这里就省去创建的步骤，介绍一下如何连接上程序。
|
||||||
@ -4,6 +4,5 @@
|
|||||||
|
|
||||||
- 请千万注意事件处理器的优先级设定
|
- 请千万注意事件处理器的优先级设定
|
||||||
- 在匹配规则中请勿使用耗时极长的函数
|
- 在匹配规则中请勿使用耗时极长的函数
|
||||||
- 同一个用户可以**跨群**(**私聊**)继续他的事件处理（除非做出权限限制，将在后续介绍）
|
|
||||||
|
|
||||||
如果「指南」还不能满足你，前往 [进阶](../advanced/README.md) 查看更多的功能信息。
|
如果「指南」还不能满足你，前往 [进阶](../advanced/README.md) 查看更多的功能信息。
|
||||||
102
archive/2.0.0a16/guide/feishu-guide.md
Normal file
102
archive/2.0.0a16/guide/feishu-guide.md
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
# 飞书机器人使用指南
|
||||||
|
|
||||||
|
基于飞书开放平台事件回调与 API 进行机器人适配，目前仅适配企业自建应用。
|
||||||
|
|
||||||
|
## 安装 NoneBot 飞书 适配器
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install nonebot-adapter-feishu
|
||||||
|
```
|
||||||
|
|
||||||
|
## 创建应用与启用应用“机器人”能力
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
此部分可参考[飞书开放平台-快速开发机器人-创建应用](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)部分的文档。
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## 开启应用权限
|
||||||
|
|
||||||
|
应用拥有所需权限后，才能调用飞书接口获取相关信息。如果需要用到所有飞书平台的 API，请开启所有应用权限。
|
||||||
|
|
||||||
|
在仅群聊功能的情况下，需要为应用开启用户、消息、通讯录和群聊权限组所有权限。
|
||||||
|
|
||||||
|
## 配置飞书事件订阅
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
|
||||||
|
在添加事件订阅时请注意，带有**（历史版本）**字样的事件的格式为**不受支持的旧版事件格式**，请使用对应的**新版事件（不带历史版本字样）作为替代**。
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
目前，飞书适配器支持以下事件：
|
||||||
|
| 事件名称 | 事件描述|
|
||||||
|
| ---- | ---- |
|
||||||
|
|接收消息|机器人接收到用户发送的消息。|
|
||||||
|
|消息已读|用户阅读机器人发送的单聊消息。|
|
||||||
|
|群解散|群组被解散。|
|
||||||
|
|群配置更改|群组配置被修改后触发此事件，包含：群主转移、群基本信息修改、群权限修改。|
|
||||||
|
|机器人进群|机器人被添加至群聊。|
|
||||||
|
|机器人被移出群|机器人被移出群聊。|
|
||||||
|
|用户进群|新用户进群。|
|
||||||
|
|撤销拉用户进群|撤销拉用户进群。|
|
||||||
|
|用户被移出群|用户主动退群或被移出群聊。|
|
||||||
|
|
||||||
|
## 在 NoneBot 配置中添加相应配置
|
||||||
|
|
||||||
|
在 `.env` 文件中添加以下配置
|
||||||
|
|
||||||
|
```
|
||||||
|
APP_ID=<yourAppId>
|
||||||
|
APP_SECRET=<yourAppSecret>
|
||||||
|
VERIFICATION_TOKEN=<yourVerificationToken>
|
||||||
|
```
|
||||||
|
|
||||||
|
复制所创建应用**“凭证和基础信息”**中的 **App ID** 、 **App Secret** 和 **“事件订阅”** 中的 **Verification Token** ，替换上面相应的配置的值。
|
||||||
|
|
||||||
|
此外，对于飞书平台的事件订阅加密机制，飞书适配器也提供 `ENCRYPT_KEY` 配置项。
|
||||||
|
|
||||||
|
```
|
||||||
|
ENCRYPT_KEY=<yourEncryptKey>
|
||||||
|
```
|
||||||
|
|
||||||
|
当此项不为空时，飞书适配器会认为用户启用了加密机制，并对事件上报中的密文进行解密。
|
||||||
|
|
||||||
|
对于[Lark(飞书平台海外版)](https://www.larksuite.com) 的用户，飞书适配器也提供**实验性**支持，仅需要在配置文件中添加 `IS_LARK=true` 即可。
|
||||||
|
|
||||||
|
```
|
||||||
|
IS_LARK=true
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注册飞书适配器
|
||||||
|
|
||||||
|
在 `bot.py` 中添加：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.adapters.feishu import Bot as FeishuBot
|
||||||
|
|
||||||
|
driver.register_adapter("feishu", FeishuBot)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 编写一个适用于飞书适配器的插件并加载
|
||||||
|
|
||||||
|
插件代码范例：
|
||||||
|
|
||||||
|
```python
|
||||||
|
from nonebot.plugin import on_command
|
||||||
|
from nonebot.typing import T_State
|
||||||
|
from nonebot.adapters.feishu import Bot as FeishuBot, MessageEvent
|
||||||
|
|
||||||
|
helper = on_command("say")
|
||||||
|
|
||||||
|
|
||||||
|
@helper.handle()
|
||||||
|
async def feishu_helper(bot: FeishuBot, event: MessageEvent, state: T_State):
|
||||||
|
message = event.get_message()
|
||||||
|
await helper.finish(message, at_sender=True)
|
||||||
|
```
|
||||||
|
|
||||||
|
以上代码注册了一个对飞书平台适用的`say`指令，并会提取`/say`之后的内容发送到事件所对应的群或私聊。
|
||||||
|
|
||||||
|
大功告成！现在可以试试向机器人发送类似`/say Hello, Feishu!`的消息进行测试了。
|
||||||
|
|
||||||
BIN
archive/2.0.0a16/guide/images/Handle-Event.png
Normal file
BIN
archive/2.0.0a16/guide/images/Handle-Event.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 124 KiB |
BIN
archive/2.0.0a16/guide/images/ding/jiaqian.png
Normal file
BIN
archive/2.0.0a16/guide/images/ding/jiaqian.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
BIN
archive/2.0.0a16/guide/images/ding/test_webhook.png
Normal file
BIN
archive/2.0.0a16/guide/images/ding/test_webhook.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
BIN
archive/2.0.0a16/guide/images/ding/webhook.png
Normal file
BIN
archive/2.0.0a16/guide/images/ding/webhook.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
@ -1,6 +1,6 @@
|
|||||||
# 安装
|
# 安装
|
||||||
|
|
||||||
## NoneBot
|
## 安装 NoneBot
|
||||||
|
|
||||||
:::warning 注意
|
:::warning 注意
|
||||||
请确保你的 Python 版本 >= 3.7。
|
请确保你的 Python 版本 >= 3.7。
|
||||||
@ -67,22 +67,30 @@ poetry install --no-dev # 推荐
|
|||||||
pip install . # 不推荐
|
pip install . # 不推荐
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 安装适配器
|
||||||
|
|
||||||
|
适配器可以通过 `nb-cli` 在创建项目时根据你的选择自动安装，也可以自行使用 `pip` 安装
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install <adapter-name>
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 列出所有的适配器
|
||||||
|
nb adapter list
|
||||||
|
```
|
||||||
|
|
||||||
## 安装插件
|
## 安装插件
|
||||||
|
|
||||||
插件可以通过 `nb-cli` 进行安装，也可以自行安装并加载插件。
|
插件可以通过 `nb-cli` 进行安装，也可以自行安装并加载插件。
|
||||||
|
|
||||||
:::warning 注意
|
|
||||||
如果你想直接从nb-cli安装插件，请确保你的当前目录中含有能正常工作的bot.py！
|
|
||||||
安装完成后请重启当前bot.py(假如你在运行它的话）。
|
|
||||||
:::
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 列出所有的插件
|
# 列出所有的插件
|
||||||
nb plugin list
|
nb plugin list
|
||||||
# 搜索插件
|
# 搜索插件
|
||||||
nb plugin search xxx
|
nb plugin search <plugin-name>
|
||||||
# 安装插件
|
# 安装插件
|
||||||
nb plugin install xxx
|
nb plugin install <plugin-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
如果急于上线 Bot 或想要使用现成的插件，以下插件可作为参考：
|
如果急于上线 Bot 或想要使用现成的插件，以下插件可作为参考：
|
||||||
@ -92,9 +100,16 @@ nb plugin install xxx
|
|||||||
- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs) 离线文档插件
|
- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs) 离线文档插件
|
||||||
- [NoneBot-Plugin-Test](https://github.com/nonebot/plugin-test) 本地机器人测试前端插件
|
- [NoneBot-Plugin-Test](https://github.com/nonebot/plugin-test) 本地机器人测试前端插件
|
||||||
- [NoneBot-Plugin-APScheduler](https://github.com/nonebot/plugin-apscheduler) 定时任务插件
|
- [NoneBot-Plugin-APScheduler](https://github.com/nonebot/plugin-apscheduler) 定时任务插件
|
||||||
|
- [NoneBot-Plugin-LocalStore](https://github.com/nonebot/plugin-localstore) 本地数据文件存储插件
|
||||||
- [NoneBot-Plugin-Sentry](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_sentry) Sentry 在线日志分析插件
|
- [NoneBot-Plugin-Sentry](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_sentry) Sentry 在线日志分析插件
|
||||||
- [NoneBot-Plugin-Status](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_status) 服务器状态查看插件
|
- [NoneBot-Plugin-Status](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_status) 服务器状态查看插件
|
||||||
|
|
||||||
### 其他插件
|
### 其他插件
|
||||||
|
|
||||||
还有更多的插件在 [这里](/plugin-store.md) 等着你发现～
|
还有更多的插件在 [这里](/store.html) 等着你发现～
|
||||||
|
|
||||||
|
## 安装开发环境(可选)
|
||||||
|
|
||||||
|
NoneBot v2 全程使用 `VSCode` 搭配 `Pylance` 的开发环境进行开发，在严格的类型检查下，NoneBot v2 具有完善的类型设计与声明。
|
||||||
|
|
||||||
|
在围绕 NoneBot v2 进行开发时，使用 `VSCode` 搭配 `Pylance` 进行类型检查是非常推荐的。这有利于统一代码风格及避免低级错误的发生。
|
||||||
@ -39,10 +39,11 @@ if __name__ == "__main__":
|
|||||||
|
|
||||||
在 `bot.py` 文件中添加以下行：
|
在 `bot.py` 文件中添加以下行：
|
||||||
|
|
||||||
```python{5}
|
```python{6}
|
||||||
import nonebot
|
import nonebot
|
||||||
|
|
||||||
nonebot.init()
|
nonebot.init()
|
||||||
|
|
||||||
# 加载插件目录，该目录下为各插件，以下划线开头的插件将不会被加载
|
# 加载插件目录，该目录下为各插件，以下划线开头的插件将不会被加载
|
||||||
nonebot.load_plugins("awesome_bot/plugins")
|
nonebot.load_plugins("awesome_bot/plugins")
|
||||||
|
|
||||||
@ -68,10 +69,11 @@ if __name__ == "__main__":
|
|||||||
|
|
||||||
在 `bot.py` 文件中添加以下行：
|
在 `bot.py` 文件中添加以下行：
|
||||||
|
|
||||||
```python{5,7}
|
```python{6,8}
|
||||||
import nonebot
|
import nonebot
|
||||||
|
|
||||||
nonebot.init()
|
nonebot.init()
|
||||||
|
|
||||||
# 加载一个 pip 安装的插件
|
# 加载一个 pip 安装的插件
|
||||||
nonebot.load_plugin("nonebot_plugin_status")
|
nonebot.load_plugin("nonebot_plugin_status")
|
||||||
# 加载本地的单独插件
|
# 加载本地的单独插件
|
||||||
@ -83,6 +85,63 @@ if __name__ == "__main__":
|
|||||||
nonebot.run()
|
nonebot.run()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 从 json 文件中加载插件
|
||||||
|
|
||||||
|
在 `bot.py` 文件中添加以下行：
|
||||||
|
|
||||||
|
```python{6}
|
||||||
|
import nonebot
|
||||||
|
|
||||||
|
nonebot.init()
|
||||||
|
|
||||||
|
# 从 plugin.json 加载插件
|
||||||
|
nonebot.load_from_json("plugin.json")
|
||||||
|
|
||||||
|
app = nonebot.get_asgi()
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
nonebot.run()
|
||||||
|
```
|
||||||
|
|
||||||
|
**json 文件示例**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"plugins": ["nonebot_plugin_status", "awesome_bot.plugins.xxx"],
|
||||||
|
"plugin_dirs": ["awesome_bot/plugins"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 从 toml 文件中加载插件
|
||||||
|
|
||||||
|
在 `bot.py` 文件中添加以下行：
|
||||||
|
|
||||||
|
```python{6}
|
||||||
|
import nonebot
|
||||||
|
|
||||||
|
nonebot.init()
|
||||||
|
|
||||||
|
# 从 pyproject.toml 加载插件
|
||||||
|
nonebot.load_from_toml("pyproject.toml")
|
||||||
|
|
||||||
|
app = nonebot.get_asgi()
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
nonebot.run()
|
||||||
|
```
|
||||||
|
|
||||||
|
**toml 文件示例：**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[nonebot.plugins]
|
||||||
|
plugins = ["nonebot_plugin_status", "awesome_bot.plugins.xxx"]
|
||||||
|
plugin_dirs = ["awesome_bot/plugins"]
|
||||||
|
```
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
nb-cli 默认使用 `pyproject.toml` 加载插件。
|
||||||
|
:::
|
||||||
|
|
||||||
## 子插件(嵌套插件)
|
## 子插件(嵌套插件)
|
||||||
|
|
||||||
在插件中同样可以加载子插件，例如如下插件目录结构：
|
在插件中同样可以加载子插件，例如如下插件目录结构：
|
||||||
@ -28,6 +28,12 @@ Mirai-API-HTTP 的适配器以 [AGPLv3 许可](https://opensource.org/licenses/A
|
|||||||
|
|
||||||
**为了便捷起见, 以下内容均以缩写 `MAH` 代替 `mirai-api-http`**
|
**为了便捷起见, 以下内容均以缩写 `MAH` 代替 `mirai-api-http`**
|
||||||
|
|
||||||
|
## 安装 NoneBot Mirai 适配器
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install nonebot-adapter-mirai
|
||||||
|
```
|
||||||
|
|
||||||
## 配置 MAH 客户端
|
## 配置 MAH 客户端
|
||||||
|
|
||||||
正如你可能刚刚在[CQHTTP 协议使用指南](./cqhttp-guide.md)中所读到的:
|
正如你可能刚刚在[CQHTTP 协议使用指南](./cqhttp-guide.md)中所读到的:
|
||||||
@ -86,6 +92,18 @@ Mirai-API-HTTP 的适配器以 [AGPLv3 许可](https://opensource.org/licenses/A
|
|||||||
|
|
||||||
- 这是当使用正向 Websocket 时的配置举例
|
- 这是当使用正向 Websocket 时的配置举例
|
||||||
|
|
||||||
|
正向连接可以选择支持客户端连接方式的 `Driver` 来进行连接，请根据需求进行选择：
|
||||||
|
|
||||||
|
- `nonebot.drivers.fastapi`: 同时支持正向和反向
|
||||||
|
- `nonebot.drivers.aiohttp`: 仅支持正向
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
|
||||||
|
在默认情况下, NoneBot 和 MAH 会同时监听 8080 端口, 这会导致端口冲突的错误
|
||||||
|
请确保二者配置不在同一端口下
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
- MAH 的`setting.yml`文件
|
- MAH 的`setting.yml`文件
|
||||||
|
|
||||||
- ```yaml
|
- ```yaml
|
||||||
@ -100,19 +118,26 @@ Mirai-API-HTTP 的适配器以 [AGPLv3 许可](https://opensource.org/licenses/A
|
|||||||
- `.env`文件
|
- `.env`文件
|
||||||
|
|
||||||
- ```shell
|
- ```shell
|
||||||
|
PORT=2333
|
||||||
|
|
||||||
MIRAI_AUTH_KEY=1234567890
|
MIRAI_AUTH_KEY=1234567890
|
||||||
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
||||||
MIRAI_PORT=8080 # MAH的监听端口
|
MIRAI_PORT=8080 # MAH的监听端口
|
||||||
|
PORT=2333 # 防止与MAH接口冲突
|
||||||
```
|
```
|
||||||
|
|
||||||
- `bot.py`文件
|
- `bot.py`文件
|
||||||
|
|
||||||
- ```python
|
- ```python
|
||||||
import nonebot
|
import nonebot
|
||||||
from nonebot.adapters.mirai import WebsocketBot
|
from nonebot.adapters.mirai import Bot
|
||||||
|
|
||||||
nonebot.init()
|
nonebot.init()
|
||||||
nonebot.get_driver().register_adapter('mirai-ws', WebsocketBot, qq=12345678) # qq参数需要填在mah中登录的qq
|
nonebot.get_driver().register_adapter('mirai',
|
||||||
|
Bot,
|
||||||
|
qq=12345678)
|
||||||
|
# qq参数需要填在mah中登录的qq, 如果需要多个帐号, 可以填写类似于 [123456,789100] 的数组形式
|
||||||
|
|
||||||
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
nonebot.load_builtin_plugins() # 加载 nonebot 内置插件
|
||||||
nonebot.run()
|
nonebot.run()
|
||||||
```
|
```
|
||||||
@ -149,7 +174,7 @@ Mirai-API-HTTP 的适配器以 [AGPLv3 许可](https://opensource.org/licenses/A
|
|||||||
|
|
||||||
- ```shell
|
- ```shell
|
||||||
HOST=127.0.0.1 # 当MAH运行在本机时
|
HOST=127.0.0.1 # 当MAH运行在本机时
|
||||||
PORT=2333
|
PORT=2333 # 防止与MAH接口冲突
|
||||||
|
|
||||||
MIRAI_AUTH_KEY=1234567890
|
MIRAI_AUTH_KEY=1234567890
|
||||||
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
MIRAI_HOST=127.0.0.1 # 当MAH运行在本机时
|
||||||
@ -63,7 +63,12 @@
|
|||||||
"title": "协议适配",
|
"title": "协议适配",
|
||||||
"collapsable": false,
|
"collapsable": false,
|
||||||
"sidebar": "auto",
|
"sidebar": "auto",
|
||||||
"children": ["cqhttp-guide", "ding-guide", "mirai-guide"]
|
"children": [
|
||||||
|
"cqhttp-guide",
|
||||||
|
"ding-guide",
|
||||||
|
"mirai-guide",
|
||||||
|
"feishu-guide"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"/advanced/": [
|
"/advanced/": [
|
||||||
@ -84,7 +89,9 @@
|
|||||||
"title": "发布",
|
"title": "发布",
|
||||||
"collapsable": false,
|
"collapsable": false,
|
||||||
"sidebar": "auto",
|
"sidebar": "auto",
|
||||||
"children": ["publish-plugin"]
|
"children": [
|
||||||
|
"publish-plugin"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"/api/": [
|
"/api/": [
|
||||||
@ -113,6 +120,10 @@
|
|||||||
"title": "nonebot.matcher 模块",
|
"title": "nonebot.matcher 模块",
|
||||||
"path": "matcher"
|
"path": "matcher"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"title": "nonebot.handler 模块",
|
||||||
|
"path": "handler"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "nonebot.rule 模块",
|
"title": "nonebot.rule 模块",
|
||||||
"path": "rule"
|
"path": "rule"
|
||||||
@ -149,6 +160,10 @@
|
|||||||
"title": "nonebot.drivers.quart 模块",
|
"title": "nonebot.drivers.quart 模块",
|
||||||
"path": "drivers/quart"
|
"path": "drivers/quart"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"title": "nonebot.drivers.aiohttp 模块",
|
||||||
|
"path": "drivers/aiohttp"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "nonebot.adapters 模块",
|
"title": "nonebot.adapters 模块",
|
||||||
"path": "adapters/"
|
"path": "adapters/"
|
||||||
@ -164,6 +179,10 @@
|
|||||||
{
|
{
|
||||||
"title": "nonebot.adapters.mirai 模块",
|
"title": "nonebot.adapters.mirai 模块",
|
||||||
"path": "adapters/mirai"
|
"path": "adapters/mirai"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "nonebot.adapters.feishu 模块",
|
||||||
|
"path": "adapters/feishu"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
home: true
|
|
||||||
heroImage: /logo.png
|
|
||||||
tagline: An asynchronous QQ bot framework.
|
|
||||||
actionText: 开始使用
|
|
||||||
actionLink: guide/
|
|
||||||
features:
|
|
||||||
- title: 简洁
|
|
||||||
details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
|
|
||||||
- title: 易于扩展
|
|
||||||
details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
|
|
||||||
- title: 高性能
|
|
||||||
details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
|
|
||||||
footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
|
|
||||||
---
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
# 深入
|
|
||||||
|
|
||||||
## 它如何工作？
|
|
||||||
|
|
||||||
<!-- TODO: how to work -->
|
|
||||||
|
|
||||||
~~未填坑~~
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 跨插件访问
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 权限控制
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 发布插件
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 运行时插槽
|
|
||||||
@ -1 +0,0 @@
|
|||||||
# 定时任务
|
|
||||||
@ -1,52 +0,0 @@
|
|||||||
# NoneBot Api Reference
|
|
||||||
|
|
||||||
|
|
||||||
* **模块索引**
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot](nonebot.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.config](config.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.plugin](plugin.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.message](message.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.matcher](matcher.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.rule](rule.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.permission](permission.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.log](log.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.utils](utils.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.typing](typing.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.exception](exception.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.drivers](drivers/)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.drivers.fastapi](drivers/fastapi.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.adapters](adapters/)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.adapters.cqhttp](adapters/cqhttp.html)
|
|
||||||
|
|
||||||
|
|
||||||
* [nonebot.adapters.ding](adapters/ding.html)
|
|
||||||
@ -1,362 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.adapters 模块
|
|
||||||
|
|
||||||
## 协议适配基类
|
|
||||||
|
|
||||||
各协议请继承以下基类，并使用 `driver.register_adapter` 注册适配器
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseBot`
|
|
||||||
|
|
||||||
基类：`abc.ABC`
|
|
||||||
|
|
||||||
Bot 基类。用于处理上报消息，并提供 API 调用接口。
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(driver, connection_type, config, self_id, *, websocket=None)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `driver: Driver`: Driver 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `connection_type: str`: http 或者 websocket
|
|
||||||
|
|
||||||
|
|
||||||
* `config: Config`: Config 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `self_id: str`: 机器人 ID
|
|
||||||
|
|
||||||
|
|
||||||
* `websocket: Optional[WebSocket]`: Websocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `driver`
|
|
||||||
|
|
||||||
Driver 对象
|
|
||||||
|
|
||||||
|
|
||||||
### `connection_type`
|
|
||||||
|
|
||||||
连接类型
|
|
||||||
|
|
||||||
|
|
||||||
### `config`
|
|
||||||
|
|
||||||
Config 配置对象
|
|
||||||
|
|
||||||
|
|
||||||
### `self_id`
|
|
||||||
|
|
||||||
机器人 ID
|
|
||||||
|
|
||||||
|
|
||||||
### `websocket`
|
|
||||||
|
|
||||||
Websocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `type`
|
|
||||||
|
|
||||||
Adapter 类型
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查连接请求是否合法的函数，如果合法则返回当前连接 `唯一标识符`，通常为机器人 ID；如果不合法则抛出 `RequestDenied` 异常。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `driver: Driver`: Driver 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `connection_type: str`: 连接类型
|
|
||||||
|
|
||||||
|
|
||||||
* `headers: dict`: 请求头
|
|
||||||
|
|
||||||
|
|
||||||
* `body: Optional[dict]`: 请求数据，WebSocket 连接该部分为空
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `str`: 连接唯一标识符
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `RequestDenied`: 请求非法
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `handle_message(message)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
处理上报消息的函数，转换为 `Event` 事件后调用 `nonebot.message.handle_event` 进一步处理事件。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `message: dict`: 收到的上报消息
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `call_api(api, **data)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
调用机器人 API 接口，可以通过该函数或直接通过 bot 属性进行调用
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `api: str`: API 名称
|
|
||||||
|
|
||||||
|
|
||||||
* `**data`: API 数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
await bot.call_api("send_msg", message="hello world"})
|
|
||||||
await bot.send_msg(message="hello world")
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `send(event, message, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
调用机器人基础发送消息接口
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: 上报事件
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 要发送的消息
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseEvent`
|
|
||||||
|
|
||||||
基类：`abc.ABC`, `typing.Generic`
|
|
||||||
|
|
||||||
Event 基类。提供上报信息的关键信息，其余信息可从原始上报消息获取。
|
|
||||||
|
|
||||||
|
|
||||||
### `__init__(raw_event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `raw_event: Union[dict, T]`: 原始上报消息
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `raw_event`
|
|
||||||
|
|
||||||
原始上报消息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `id`
|
|
||||||
|
|
||||||
事件 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `name`
|
|
||||||
|
|
||||||
事件名称
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `self_id`
|
|
||||||
|
|
||||||
机器人 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `time`
|
|
||||||
|
|
||||||
事件发生时间
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `type`
|
|
||||||
|
|
||||||
事件主类型
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `detail_type`
|
|
||||||
|
|
||||||
事件详细类型
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `sub_type`
|
|
||||||
|
|
||||||
事件子类型
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `user_id`
|
|
||||||
|
|
||||||
触发事件的主体 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `group_id`
|
|
||||||
|
|
||||||
触发事件的主体群 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `to_me`
|
|
||||||
|
|
||||||
事件是否为发送给机器人的消息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `message`
|
|
||||||
|
|
||||||
消息内容
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `reply`
|
|
||||||
|
|
||||||
回复的消息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `raw_message`
|
|
||||||
|
|
||||||
原始消息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `plain_text`
|
|
||||||
|
|
||||||
纯文本消息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `sender`
|
|
||||||
|
|
||||||
消息发送者信息
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseMessageSegment`
|
|
||||||
|
|
||||||
基类：`abc.ABC`
|
|
||||||
|
|
||||||
消息段基类
|
|
||||||
|
|
||||||
|
|
||||||
### `type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息段类型
|
|
||||||
|
|
||||||
|
|
||||||
### `data`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Dict[str, Union[str, list]]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息段数据
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseMessage`
|
|
||||||
|
|
||||||
基类：`list`, `abc.ABC`
|
|
||||||
|
|
||||||
消息数组
|
|
||||||
|
|
||||||
|
|
||||||
### `__init__(message=None, *args, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, dict, list, BaseModel, MessageSegment, Message]`: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `append(obj)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
添加一个消息段到消息数组末尾
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `obj: Union[str, MessageSegment]`: 要添加的消息段
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `extend(obj)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
拼接一个消息数组或多个消息段到消息数组末尾
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `reduce()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
缩减消息数组，即按 MessageSegment 的实现拼接相邻消息段
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `extract_plain_text()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
提取消息内纯文本消息
|
|
||||||
@ -1,442 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.adapters.cqhttp 模块
|
|
||||||
|
|
||||||
|
|
||||||
## `escape(s, *, escape_comma=True)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
对字符串进行 CQ 码转义。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `s: str`: 需要转义的字符串
|
|
||||||
|
|
||||||
|
|
||||||
* `escape_comma: bool`: 是否转义逗号（`,`）。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `unescape(s)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
对字符串进行 CQ 码去转义。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `s: str`: 需要转义的字符串
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `CQHTTPAdapterException`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.AdapterException`](../exception.md#nonebot.exception.AdapterException)
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ActionFailed`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求返回错误信息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `retcode: Optional[int]`: 错误码
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NetworkError`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
网络错误。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `retcode: Optional[int]`: 错误码
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ApiNotAvailable`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.cqhttp.exception.CQHTTPAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
## _async_ `_check_reply(bot, event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查消息中存在的回复，去除并赋值 `event.reply`, `event.to_me`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `_check_at_me(bot, event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查消息开头或结尾是否存在 @机器人，去除并赋值 `event.to_me`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `_check_nickname(bot, event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查消息开头是否存在，去除并赋值 `event.to_me`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `_handle_api_result(result)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
处理 API 请求返回值。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `result: Optional[Dict[str, Any]]`: API 返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: API 调用返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ActionFailed`: API 调用失败
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Bot`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
|
|
||||||
|
|
||||||
CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
|
|
||||||
* 返回: `"cqhttp"`
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
CQHTTP (OneBot) 协议鉴权。参考 [鉴权](https://github.com/howmanybots/onebot/blob/master/v11/specs/communication/authorization.md)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `handle_message(message)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
调用 [_check_reply](#async-check-reply-bot-event), [_check_at_me](#check-at-me-bot-event), [_check_nickname](#check-nickname-bot-event) 处理事件并转换为 [Event](#class-event)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `call_api(api, **data)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
调用 CQHTTP 协议 API
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `api: str`: API 名称
|
|
||||||
|
|
||||||
|
|
||||||
* `**data: Any`: API 参数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: API 调用返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `NetworkError`: 网络错误
|
|
||||||
|
|
||||||
|
|
||||||
* `ActionFailed`: API 调用失败
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `send(event, message, at_sender=False, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
根据 `event` 向触发事件的主体发送消息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 要发送的消息
|
|
||||||
|
|
||||||
|
|
||||||
* `at_sender: bool`: 是否 @ 事件主体
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 覆盖默认参数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: API 调用返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 缺少 `user_id`, `group_id`
|
|
||||||
|
|
||||||
|
|
||||||
* `NetworkError`: 网络错误
|
|
||||||
|
|
||||||
|
|
||||||
* `ActionFailed`: API 调用失败
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Event`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
|
|
||||||
|
|
||||||
CQHTTP 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[int]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件/消息 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `name`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件名称，由类型与 `.` 组合而成
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `self_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 机器人自身 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `time`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `int`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件发生时间
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `detail_type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件详细类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `sub_type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件子类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `user_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[int]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件主体 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `group_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[int]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件主体群 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `to_me`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[bool]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息是否与机器人相关
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `message`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[Message]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `reply`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[dict]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 回复消息详情
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `raw_message`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 原始消息
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `plain_text`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 纯文本消息内容
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `sender`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[dict]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息发送者信息
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `MessageSegment`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
|
|
||||||
|
|
||||||
CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Message`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
|
|
||||||
|
|
||||||
CQHTTP 协议 Message 适配。
|
|
||||||
@ -1,380 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.adapters.ding 模块
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `DingAdapterException`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.AdapterException`](../exception.md#nonebot.exception.AdapterException)
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
钉钉 Adapter 错误基类
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ActionFailed`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.ActionFailed`](../exception.md#nonebot.exception.ActionFailed), `nonebot.adapters.ding.exception.DingAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求返回错误信息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `errcode: Optional[int]`: 错误码
|
|
||||||
|
|
||||||
|
|
||||||
* `errmsg: Optional[str]`: 错误信息
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ApiNotAvailable`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.ding.exception.DingAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NetworkError`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.ding.exception.DingAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
网络错误。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `retcode: Optional[int]`: 错误码
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `SessionExpired`
|
|
||||||
|
|
||||||
基类：[`nonebot.exception.ApiNotAvailable`](../exception.md#nonebot.exception.ApiNotAvailable), `nonebot.adapters.ding.exception.DingAdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
发消息的 session 已经过期。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Bot`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseBot`](README.md#nonebot.adapters.BaseBot)
|
|
||||||
|
|
||||||
钉钉 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
|
|
||||||
* 返回: `"ding"`
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_permission(driver, connection_type, headers, body)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
钉钉协议鉴权。参考 [鉴权](https://ding-doc.dingtalk.com/doc#/serverapi2/elzz1p)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `handle_message(body)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
处理上报消息的函数，转换为 `Event` 事件后调用 `nonebot.message.handle_event` 进一步处理事件。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `message: dict`: 收到的上报消息
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `call_api(api, event=None, **data)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
调用 钉钉 协议 API
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `api: str`: API 名称
|
|
||||||
|
|
||||||
|
|
||||||
* `**data: Any`: API 参数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: API 调用返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `NetworkError`: 网络错误
|
|
||||||
|
|
||||||
|
|
||||||
* `ActionFailed`: API 调用失败
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `send(event, message, at_sender=False, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
根据 `event` 向触发事件的主体发送消息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 要发送的消息
|
|
||||||
|
|
||||||
|
|
||||||
* `at_sender: bool`: 是否 @ 事件主体
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 覆盖默认参数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: API 调用返回数据
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 缺少 `user_id`, `group_id`
|
|
||||||
|
|
||||||
|
|
||||||
* `NetworkError`: 网络错误
|
|
||||||
|
|
||||||
|
|
||||||
* `ActionFailed`: API 调用失败
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Event`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseEvent`](README.md#nonebot.adapters.BaseEvent)
|
|
||||||
|
|
||||||
钉钉 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) 。
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `raw_event`
|
|
||||||
|
|
||||||
原始上报消息
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `name`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件名称，由 type.\`detail_type\` 组合而成
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `self_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 机器人自身 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `time`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `int`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息的时间戳，单位 s
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `detail_type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件详细类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `sub_type`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `None`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 钉钉适配器无事件子类型
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `user_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 发送者 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `group_id`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 事件主体群 ID
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `to_me`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[bool]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息是否与机器人相关
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `message`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[Message]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `reply`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `None`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 回复消息详情
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `raw_message`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 原始消息
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `plain_text`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 纯文本消息内容
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `sender`
|
|
||||||
|
|
||||||
|
|
||||||
* 类型: `Optional[dict]`
|
|
||||||
|
|
||||||
|
|
||||||
* 说明: 消息发送者信息
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `MessageSegment`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseMessageSegment`](README.md#nonebot.adapters.BaseMessageSegment)
|
|
||||||
|
|
||||||
钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。
|
|
||||||
|
|
||||||
|
|
||||||
### _static_ `actionCardSingleMultiBtns(title, text, btns=[], hideAvatar=False, btnOrientation='1')`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列
|
|
||||||
|
|
||||||
|
|
||||||
* `btns`: [{ "title": title, "actionURL": actionURL }, ...]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _static_ `feedCard(links=[])`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `links`: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _static_ `empty()`
|
|
||||||
|
|
||||||
不想回复消息到群里
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Message`
|
|
||||||
|
|
||||||
基类：[`nonebot.adapters.BaseMessage`](README.md#nonebot.adapters.BaseMessage)
|
|
||||||
|
|
||||||
钉钉 协议 Message 适配。
|
|
||||||
@ -1,285 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.config 模块
|
|
||||||
|
|
||||||
## 配置
|
|
||||||
|
|
||||||
NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 以及 [python-dotenv](https://saurabh-kumar.com/python-dotenv/) 来读取配置。
|
|
||||||
|
|
||||||
配置项需符合特殊格式或 json 序列化格式。详情见 [pydantic Field Type](https://pydantic-docs.helpmanual.io/usage/types/) 文档。
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Env`
|
|
||||||
|
|
||||||
基类：`pydantic.env_settings.BaseSettings`
|
|
||||||
|
|
||||||
运行环境配置。大小写不敏感。
|
|
||||||
|
|
||||||
将会从 `nonebot.init 参数` > `环境变量` > `.env 环境配置文件` 的优先级读取配置。
|
|
||||||
|
|
||||||
|
|
||||||
### `environment`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `"prod"`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
当前环境名。 NoneBot 将从 `.env.{environment}` 文件中加载配置。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Config`
|
|
||||||
|
|
||||||
基类：`nonebot.config.BaseConfig`
|
|
||||||
|
|
||||||
NoneBot 主要配置。大小写不敏感。
|
|
||||||
|
|
||||||
除了 NoneBot 的配置项外，还可以自行添加配置项到 `.env.{environment}` 文件中。
|
|
||||||
这些配置将会在 json 反序列化后一起带入 `Config` 类中。
|
|
||||||
|
|
||||||
|
|
||||||
### `driver`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `str`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `"nonebot.drivers.fastapi"`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `host`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `IPvAnyAddress`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `127.0.0.1`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `port`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `int`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `8080`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `debug`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `bool`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `False`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
是否以调试模式运行 NoneBot。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `api_root`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Dict[str, str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `{}`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
以机器人 ID 为键，上报地址为值的字典，环境变量或文件中应使用 json 序列化。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```default
|
|
||||||
API_ROOT={"123456": "http://127.0.0.1:5700"}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `api_timeout`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Optional[float]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `30.`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求超时时间，单位: 秒。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `access_token`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `None`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求以及上报所需密钥，在请求头中携带。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```http
|
|
||||||
POST /cqhttp/ HTTP/1.1
|
|
||||||
Authorization: Bearer kSLuTF2GC2Q4q4ugm3
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `secret`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `None`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
HTTP POST 形式上报所需签名，在请求头中携带。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```http
|
|
||||||
POST /cqhttp/ HTTP/1.1
|
|
||||||
X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `superusers`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Set[int]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `set()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
机器人超级用户。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```default
|
|
||||||
SUPER_USERS=[12345789]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `nickname`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Set[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `set()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
机器人昵称。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `command_start`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Set[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `{"/"}`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
命令的起始标记，用于判断一条消息是不是命令。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `command_sep`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `Set[str]`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `{"."}`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
命令的分隔标记，用于将文本形式的命令切分为元组（实际的命令名）。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `session_expire_timeout`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**: `timedelta`
|
|
||||||
|
|
||||||
|
|
||||||
* **默认值**: `timedelta(minutes=2)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
等待用户回复的超时时间。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```default
|
|
||||||
SESSION_EXPIRE_TIMEOUT=120 # 单位: 秒
|
|
||||||
SESSION_EXPIRE_TIMEOUT=[DD ][HH:MM]SS[.ffffff]
|
|
||||||
SESSION_EXPIRE_TIMEOUT=P[DD]DT[HH]H[MM]M[SS]S # ISO 8601
|
|
||||||
```
|
|
||||||
@ -1,246 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.drivers 模块
|
|
||||||
|
|
||||||
## 后端驱动适配基类
|
|
||||||
|
|
||||||
各驱动请继承以下基类
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseDriver`
|
|
||||||
|
|
||||||
基类：`abc.ABC`
|
|
||||||
|
|
||||||
Driver 基类。将后端框架封装，以满足适配器使用。
|
|
||||||
|
|
||||||
|
|
||||||
### `_adapters`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Type[Bot]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
已注册的适配器列表
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(env, config)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `env: Env`: 包含环境信息的 Env 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `config: Config`: 包含配置信息的 Config 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `env`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`str`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
环境名称
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `config`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Config`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
配置对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_clients`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Bot]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
已连接的 Bot
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `register_adapter(name, adapter)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
注册一个协议适配器
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `name: str`: 适配器名称，用于在连接时进行识别
|
|
||||||
|
|
||||||
|
|
||||||
* `adapter: Type[Bot]`: 适配器 Class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `type`
|
|
||||||
|
|
||||||
驱动类型名称
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `server_app`
|
|
||||||
|
|
||||||
驱动 APP 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `asgi`
|
|
||||||
|
|
||||||
驱动 ASGI 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `logger`
|
|
||||||
|
|
||||||
驱动专属 logger 日志记录器
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `bots`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[str, Bot]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取当前所有已连接的 Bot
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `on_startup(func)`
|
|
||||||
|
|
||||||
注册一个在驱动启动时运行的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `on_shutdown(func)`
|
|
||||||
|
|
||||||
注册一个在驱动停止时运行的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `run(host=None, port=None, *args, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
启动驱动框架
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `host: Optional[str]`: 驱动绑定 IP
|
|
||||||
|
|
||||||
|
|
||||||
* `post: Optional[int]`: 驱动绑定端口
|
|
||||||
|
|
||||||
|
|
||||||
* `*args`
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `_handle_http()`
|
|
||||||
|
|
||||||
用于处理 HTTP 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `_handle_ws_reverse()`
|
|
||||||
|
|
||||||
用于处理 WebSocket 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `BaseWebSocket`
|
|
||||||
|
|
||||||
基类：`object`
|
|
||||||
|
|
||||||
WebSocket 连接封装，统一接口方便外部调用。
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract_ `__init__(websocket)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `websocket: Any`: WebSocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `websocket`
|
|
||||||
|
|
||||||
WebSocket 连接对象
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract property_ `closed`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
连接是否已经关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `accept()`
|
|
||||||
|
|
||||||
接受 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `close(code)`
|
|
||||||
|
|
||||||
关闭 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `receive()`
|
|
||||||
|
|
||||||
接收一条 WebSocket 信息
|
|
||||||
|
|
||||||
|
|
||||||
### _abstract async_ `send(data)`
|
|
||||||
|
|
||||||
发送一条 WebSocket 信息
|
|
||||||
@ -1,118 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.drivers.fastapi 模块
|
|
||||||
|
|
||||||
## FastAPI 驱动适配
|
|
||||||
|
|
||||||
后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Driver`
|
|
||||||
|
|
||||||
基类：[`nonebot.drivers.BaseDriver`](README.md#nonebot.drivers.BaseDriver)
|
|
||||||
|
|
||||||
FastAPI 驱动框架
|
|
||||||
|
|
||||||
|
|
||||||
* **上报地址**
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/`: HTTP POST 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/http/`: HTTP POST 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/ws`: WebSocket 上报
|
|
||||||
|
|
||||||
|
|
||||||
* `/{adapter name}/ws/`: WebSocket 上报
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `type`
|
|
||||||
|
|
||||||
驱动名称: `fastapi`
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `server_app`
|
|
||||||
|
|
||||||
`FastAPI APP` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `asgi`
|
|
||||||
|
|
||||||
`FastAPI APP` 对象
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `logger`
|
|
||||||
|
|
||||||
fastapi 使用的 logger
|
|
||||||
|
|
||||||
|
|
||||||
### `on_startup(func)`
|
|
||||||
|
|
||||||
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
|
||||||
|
|
||||||
|
|
||||||
### `on_shutdown(func)`
|
|
||||||
|
|
||||||
参考文档: [Events](https://fastapi.tiangolo.com/advanced/events/#startup-event)
|
|
||||||
|
|
||||||
|
|
||||||
### `run(host=None, port=None, *, app=None, **kwargs)`
|
|
||||||
|
|
||||||
使用 `uvicorn` 启动 FastAPI
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `_handle_http(adapter, request, data=Body(Ellipsis))`
|
|
||||||
|
|
||||||
用于处理 HTTP 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `_handle_ws_reverse(adapter, websocket)`
|
|
||||||
|
|
||||||
用于处理 WebSocket 类型请求的函数
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `WebSocket`
|
|
||||||
|
|
||||||
基类：[`nonebot.drivers.BaseWebSocket`](README.md#nonebot.drivers.BaseWebSocket)
|
|
||||||
|
|
||||||
|
|
||||||
### _property_ `closed`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
连接是否已经关闭
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `accept()`
|
|
||||||
|
|
||||||
接受 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `close(code=1000)`
|
|
||||||
|
|
||||||
关闭 WebSocket 连接请求
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `receive()`
|
|
||||||
|
|
||||||
接收一条 WebSocket 信息
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `send(data)`
|
|
||||||
|
|
||||||
发送一条 WebSocket 信息
|
|
||||||
@ -1,182 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.exception 模块
|
|
||||||
|
|
||||||
## 异常
|
|
||||||
|
|
||||||
下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
|
|
||||||
这些异常并非所有需要用户处理，在 NoneBot 内部运行时被捕获，并进行对应操作。
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NoneBotException`
|
|
||||||
|
|
||||||
基类：`Exception`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 NoneBot 发生的异常基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `IgnoredException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `reason`: 忽略事件的原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `PausedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
|
|
||||||
可用于用户输入新信息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `RejectedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
|
|
||||||
可用于用户重新输入。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `FinishedException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
|
|
||||||
可用于结束用户会话。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `StopPropagation`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
指示 NoneBot 终止事件向下层传播。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
在 `Matcher.block == True` 时抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `RequestDenied`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Bot 连接请求不合法。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `status_code: int`: HTTP 状态码
|
|
||||||
|
|
||||||
|
|
||||||
* `reason: str`: 拒绝原因
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `AdapterException`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.NoneBotException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
代表 `Adapter` 抛出的异常，所有的 `Adapter` 都要在内部继承自这个 `Exception`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `adapter_name: str`: 标识 adapter
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ApiNotAvailable`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在 API 连接不可用时抛出。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `NetworkError`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在网络出现问题时抛出，如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _exception_ `ActionFailed`
|
|
||||||
|
|
||||||
基类：`nonebot.exception.AdapterException`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
API 请求成功返回数据，但 API 操作失败。
|
|
||||||
@ -1,55 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.log 模块
|
|
||||||
|
|
||||||
## 日志
|
|
||||||
|
|
||||||
NoneBot 使用 [loguru](https://github.com/Delgan/loguru) 来记录日志信息。
|
|
||||||
|
|
||||||
自定义 logger 请参考 [loguru](https://github.com/Delgan/loguru) 文档。
|
|
||||||
|
|
||||||
|
|
||||||
## `logger`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
NoneBot 日志记录器对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **默认信息**
|
|
||||||
|
|
||||||
|
|
||||||
* 格式: `[%(asctime)s %(name)s] %(levelname)s: %(message)s`
|
|
||||||
|
|
||||||
|
|
||||||
* 等级: `DEBUG` / `INFO` ，根据 config 配置改变
|
|
||||||
|
|
||||||
|
|
||||||
* 输出: 输出至 stdout
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
from nonebot.log import logger
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `LoguruHandler`
|
|
||||||
|
|
||||||
基类：`logging.Handler`
|
|
||||||
|
|
||||||
|
|
||||||
### `emit(record)`
|
|
||||||
|
|
||||||
Do whatever it takes to actually log the specified logging record.
|
|
||||||
|
|
||||||
This version is intended to be implemented by subclasses and so
|
|
||||||
raises a NotImplementedError.
|
|
||||||
@ -1,452 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.matcher 模块
|
|
||||||
|
|
||||||
## 事件响应器
|
|
||||||
|
|
||||||
该模块实现事件响应器的创建与运行，并提供一些快捷方法来帮助用户更好的与机器人进行 对话 。
|
|
||||||
|
|
||||||
|
|
||||||
## `matchers`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Dict[int, List[Type[Matcher]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
用于存储当前所有的事件响应器
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Matcher`
|
|
||||||
|
|
||||||
基类：`object`
|
|
||||||
|
|
||||||
事件响应器类
|
|
||||||
|
|
||||||
|
|
||||||
### `module`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[str]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器所在模块名称
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `type`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`str`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `rule`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Rule`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器匹配规则
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `permission`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Permission`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器触发权限
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `priority`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`int`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器优先级
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `block`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器是否阻止事件传播
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `temp`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器是否为临时
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `expire_time`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[datetime]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器过期时间点
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_default_state`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`dict`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器默认状态
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `_default_parser`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Optional[ArgsParser]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器默认参数解析函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `__init__()`
|
|
||||||
|
|
||||||
实例化 Matcher 以便运行
|
|
||||||
|
|
||||||
|
|
||||||
### `handlers`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`List[Handler]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器拥有的事件处理函数列表
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, expire_time=None)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
创建一个新的事件响应器，并存储至 [matchers](#matchers)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `type_: str`: 事件响应器类型，与 `event.type` 一致时触发，空字符串表示任意
|
|
||||||
|
|
||||||
|
|
||||||
* `rule: Optional[Rule]`: 匹配规则
|
|
||||||
|
|
||||||
|
|
||||||
* `permission: Optional[Permission]`: 权限
|
|
||||||
|
|
||||||
|
|
||||||
* `handlers: Optional[List[Handler]]`: 事件处理函数列表
|
|
||||||
|
|
||||||
|
|
||||||
* `temp: bool`: 是否为临时事件响应器，即触发一次后删除
|
|
||||||
|
|
||||||
|
|
||||||
* `priority: int`: 响应优先级
|
|
||||||
|
|
||||||
|
|
||||||
* `block: bool`: 是否阻止事件向更低优先级的响应器传播
|
|
||||||
|
|
||||||
|
|
||||||
* `module: Optional[str]`: 事件响应器所在模块名称
|
|
||||||
|
|
||||||
|
|
||||||
* `default_state: Optional[dict]`: 默认状态 `state`
|
|
||||||
|
|
||||||
|
|
||||||
* `expire_time: Optional[datetime]`: 事件响应器最终有效时间点，过时即被删除
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Type[Matcher]`: 新的事件响应器类
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_perm(bot, event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查是否满足触发权限
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: 上报事件
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `bool`: 是否满足权限
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `check_rule(bot, event, state)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查是否满足匹配规则
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: 上报事件
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前状态
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `bool`: 是否满足匹配规则
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `args_parser(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数来更改当前事件响应器的默认参数解析函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `func: ArgsParser`: 参数解析函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `handle()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数来向事件响应器直接添加一个处理函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* 无
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `receive()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数来指示 NoneBot 在接收用户新的一条消息后继续运行该函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* 无
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _classmethod_ `got(key, prompt=None, args_parser=None)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
装饰一个函数来指示 NoneBot 当要获取的 `key` 不存在时接收用户新的一条消息并经过 `ArgsParser` 处理后再运行该函数，如果 `key` 已存在则直接继续运行
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `key: str`: 参数名
|
|
||||||
|
|
||||||
|
|
||||||
* `prompt: Optional[Union[str, Message, MessageSegment]]`: 在参数不存在时向用户发送的消息
|
|
||||||
|
|
||||||
|
|
||||||
* `args_parser: Optional[ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `send(message, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
发送一条消息给当前交互用户
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `finish(message=None, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
发送一条消息给当前交互用户并结束当前事件响应器
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `pause(prompt=None, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后继续下一个处理函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `prompt: Union[str, Message, MessageSegment]`: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async classmethod_ `reject(prompt=None, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后重新运行当前处理函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `prompt: Union[str, Message, MessageSegment]`: 消息内容
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
|
||||||
@ -1,143 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.message 模块
|
|
||||||
|
|
||||||
## 事件处理
|
|
||||||
|
|
||||||
NoneBot 内部处理并按优先级分发事件给所有事件响应器，提供了多个插槽以进行事件的预处理等。
|
|
||||||
|
|
||||||
|
|
||||||
## `event_preprocessor(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件预处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之前执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
事件预处理函数接收三个参数。
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前 State
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `event_postprocessor(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件后处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之后执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
事件后处理函数接收三个参数。
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前事件运行前 State
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `run_preprocessor(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
运行预处理。装饰一个函数，使它在每次事件响应器运行前执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
运行预处理函数接收四个参数。
|
|
||||||
|
|
||||||
|
|
||||||
* `matcher: Matcher`: 当前要运行的事件响应器
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前 State
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `run_postprocessor(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
运行后处理。装饰一个函数，使它在每次事件响应器运行后执行。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
运行后处理函数接收五个参数。
|
|
||||||
|
|
||||||
|
|
||||||
* `matcher: Matcher`: 运行完毕的事件响应器
|
|
||||||
|
|
||||||
|
|
||||||
* `exception: Optional[Exception]`: 事件响应器运行错误（如果存在）
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前 State
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _async_ `handle_event(bot, event)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
处理一个事件。调用该函数以实现分发事件。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
import asyncio
|
|
||||||
asyncio.create_task(handle_event(bot, event))
|
|
||||||
```
|
|
||||||
@ -1,266 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot 模块
|
|
||||||
|
|
||||||
## 快捷导入
|
|
||||||
|
|
||||||
为方便使用，`nonebot` 模块从子模块导入了部分内容
|
|
||||||
|
|
||||||
|
|
||||||
* `on_message` => `nonebot.plugin.on_message`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_notice` => `nonebot.plugin.on_notice`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_request` => `nonebot.plugin.on_request`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_metaevent` => `nonebot.plugin.on_metaevent`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_startswith` => `nonebot.plugin.on_startswith`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_endswith` => `nonebot.plugin.on_endswith`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_keyword` => `nonebot.plugin.on_keyword`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_command` => `nonebot.plugin.on_command`
|
|
||||||
|
|
||||||
|
|
||||||
* `on_regex` => `nonebot.plugin.on_regex`
|
|
||||||
|
|
||||||
|
|
||||||
* `CommandGroup` => `nonebot.plugin.CommandGroup`
|
|
||||||
|
|
||||||
|
|
||||||
* `MatcherGroup` => `nonebot.plugin.MatcherGroup`
|
|
||||||
|
|
||||||
|
|
||||||
* `load_plugin` => `nonebot.plugin.load_plugin`
|
|
||||||
|
|
||||||
|
|
||||||
* `load_plugins` => `nonebot.plugin.load_plugins`
|
|
||||||
|
|
||||||
|
|
||||||
* `load_builtin_plugins` => `nonebot.plugin.load_builtin_plugins`
|
|
||||||
|
|
||||||
|
|
||||||
* `get_plugin` => `nonebot.plugin.get_plugin`
|
|
||||||
|
|
||||||
|
|
||||||
* `get_loaded_plugins` => `nonebot.plugin.get_loaded_plugins`
|
|
||||||
|
|
||||||
|
|
||||||
* `export` => `nonebot.plugin.export`
|
|
||||||
|
|
||||||
|
|
||||||
* `require` => `nonebot.plugin.require`
|
|
||||||
|
|
||||||
|
|
||||||
## `get_driver()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取全局 Driver 对象。可用于在计划任务的回调中获取当前 Driver 对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Driver`: 全局 Driver 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
driver = nonebot.get_driver()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## `get_app()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取全局 Driver 对应 Server App 对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: Server App 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
app = nonebot.get_app()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## `get_asgi()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取全局 Driver 对应 Asgi 对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Any`: Asgi 对象
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
asgi = nonebot.get_asgi()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## `get_bots()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
获取所有通过 ws 连接 NoneBot 的 Bot 对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Dict[str, Bot]`: 一个以字符串 ID 为键，Bot 对象为值的字典
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **异常**
|
|
||||||
|
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
bots = nonebot.get_bots()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## `init(*, _env_file=None, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
初始化 NoneBot 以及 全局 Driver 对象。
|
|
||||||
|
|
||||||
NoneBot 将会从 .env 文件中读取环境信息，并使用相应的 env 文件配置。
|
|
||||||
|
|
||||||
你也可以传入自定义的 _env_file 来指定 NoneBot 从该文件读取配置。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `_env_file: Optional[str]`: 配置文件名，默认从 .env.{env_name} 中读取配置
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 任意变量，将会存储到 Config 对象里
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `None`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
nonebot.init(database=Database(...))
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## `run(host=None, port=None, *args, **kwargs)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
启动 NoneBot，即运行全局 Driver 对象。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `host: Optional[str]`: 主机名／IP，若不传入则使用配置文件中指定的值
|
|
||||||
|
|
||||||
|
|
||||||
* `port: Optional[int]`: 端口，若不传入则使用配置文件中指定的值
|
|
||||||
|
|
||||||
|
|
||||||
* `*args`: 传入 Driver.run 的位置参数
|
|
||||||
|
|
||||||
|
|
||||||
* `**kwargs`: 传入 Driver.run 的命名参数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `None`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **用法**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
nonebot.run(host="127.0.0.1", port=8080)
|
|
||||||
```
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,210 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.rule 模块
|
|
||||||
|
|
||||||
## 规则
|
|
||||||
|
|
||||||
每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ，其中是 **异步** `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
`RuleChecker` 既可以是 async function 也可以是 sync function，但在最终会被 `nonebot.utils.run_sync` 转换为 async function
|
|
||||||
:::
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `Rule`
|
|
||||||
|
|
||||||
基类：`object`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
`Matcher` 规则类，当事件传递时，在 `Matcher` 运行前进行检查。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
|
||||||
Rule(async_function) & sync_function
|
|
||||||
# 等价于
|
|
||||||
from nonebot.utils import run_sync
|
|
||||||
Rule(async_function, run_sync(sync_function))
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `__init__(*checkers)`
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `*checkers: Callable[[Bot, Event, dict], Awaitable[bool]]`: **异步** RuleChecker
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### `checkers`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
存储 `RuleChecker`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
|
|
||||||
* `Set[Callable[[Bot, Event, dict], Awaitable[bool]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### _async_ `__call__(bot, event, state)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
检查是否符合所有规则
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `event: Event`: Event 对象
|
|
||||||
|
|
||||||
|
|
||||||
* `state: dict`: 当前 State
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `bool`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `startswith(msg)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
匹配消息开头
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 消息开头字符串
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `endswith(msg)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
匹配消息结尾
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `msg: str`: 消息结尾字符串
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `keyword(*keywords)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
匹配消息关键词
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `*keywords: str`: 关键词
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `command(*cmds)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
命令形式匹配，根据配置里提供的 `command_start`, `command_sep` 判断消息是否为命令。
|
|
||||||
|
|
||||||
可以通过 `state["_prefix"]["command"]` 获取匹配成功的命令（例：`("test",)`），通过 `state["_prefix"]["raw_command"]` 获取匹配成功的原始命令文本（例：`"/test"`）。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `*cmds: Union[str, Tuple[str, ...]]`: 命令内容
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **示例**
|
|
||||||
|
|
||||||
使用默认 `command_start`, `command_sep` 配置
|
|
||||||
|
|
||||||
命令 `("test",)` 可以匹配：`/test` 开头的消息
|
|
||||||
命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息
|
|
||||||
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
命令内容与后续消息间无需空格！
|
|
||||||
:::
|
|
||||||
|
|
||||||
|
|
||||||
## `regex(regex, flags=0)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
根据正则表达式进行匹配。
|
|
||||||
|
|
||||||
可以通过 `state["_matched"]` 获取正则表达式匹配成功的文本。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `regex: str`: 正则表达式
|
|
||||||
|
|
||||||
|
|
||||||
* `flags: Union[int, re.RegexFlag]`: 正则标志
|
|
||||||
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 来确保匹配开头
|
|
||||||
:::
|
|
||||||
|
|
||||||
|
|
||||||
## `to_me()`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
通过 `event.to_me` 判断消息是否是发送给机器人
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* 无
|
|
||||||
@ -1,300 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.typing 模块
|
|
||||||
|
|
||||||
## 类型
|
|
||||||
|
|
||||||
下面的文档中，「类型」部分使用 Python 的 Type Hint 语法，见 [PEP 484](https://www.python.org/dev/peps/pep-0484/)、[PEP 526](https://www.python.org/dev/peps/pep-0526/) 和 [typing](https://docs.python.org/3/library/typing.html)。
|
|
||||||
|
|
||||||
除了 Python 内置的类型，下面还出现了如下 NoneBot 自定类型，实际上它们是 Python 内置类型的别名。
|
|
||||||
|
|
||||||
以下类型均可从 nonebot.typing 模块导入。
|
|
||||||
|
|
||||||
|
|
||||||
## `Driver`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseDriver`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 Driver 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `WebSocket`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseWebSocket`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 WebSocket 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Bot`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseBot`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 Bot 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Event`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseEvent`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 Event 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Message`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseMessage`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 Message 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `MessageSegment`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`BaseMessageSegment`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
所有 MessageSegment 的基类。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `EventPreProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件预处理函数 EventPreProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `EventPostProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件预处理函数 EventPostProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `RunPreProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Matcher, Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPreProcessor 类型
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `RunPostProcessor`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Matcher, Optional[Exception], Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Matcher`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Matcher`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Matcher 即响应事件的处理类。通过 Rule 判断是否响应事件，运行 Handler。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `MatcherGroup`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`MatcherGroup`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
MatcherGroup 为 Matcher 的集合。可以共享 Handler。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Rule`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Rule`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Rule 即判断是否响应事件的处理类。内部存储 RuleChecker ，返回全为 True 则响应事件。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `RuleChecker`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, dict], Union[bool, Awaitable[bool]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
RuleChecker 即判断是否响应事件的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Permission`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Permission`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Permission 即判断是否响应消息的处理类。内部存储 PermissionChecker ，返回只要有一个 True 则响应消息。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `PermissionChecker`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event], Union[bool, Awaitable[bool]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
RuleChecker 即判断是否响应消息的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `Handler`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
Handler 即事件的处理函数。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `ArgsParser`
|
|
||||||
|
|
||||||
|
|
||||||
* **类型**
|
|
||||||
|
|
||||||
`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。
|
|
||||||
@ -1,60 +0,0 @@
|
|||||||
---
|
|
||||||
contentSidebar: true
|
|
||||||
sidebarDepth: 0
|
|
||||||
---
|
|
||||||
|
|
||||||
# NoneBot.utils 模块
|
|
||||||
|
|
||||||
|
|
||||||
## `escape_tag(s)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
用于记录带颜色日志时转义 `<tag>` 类型特殊标签
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `s: str`: 需要转义的字符串
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `str`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `run_sync(func)`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
一个用于包装 sync function 为 async function 的装饰器
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **参数**
|
|
||||||
|
|
||||||
|
|
||||||
* `func: Callable[..., Any]`: 被装饰的同步函数
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **返回**
|
|
||||||
|
|
||||||
|
|
||||||
* `Callable[..., Awaitable[Any]]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## _class_ `DataclassEncoder`
|
|
||||||
|
|
||||||
|
|
||||||
* **说明**
|
|
||||||
|
|
||||||
在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
# 概览
|
|
||||||
|
|
||||||
<!-- :::tip 提示
|
|
||||||
如果在阅读本文档时遇到难以理解的词汇，请随时查阅 [术语表](../glossary.md) 或使用 [Google 搜索](https://www.google.com/)。
|
|
||||||
::: -->
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
初次使用时可能会觉得这里的概览过于枯燥，可以先简单略读之后直接前往 [安装](./installation.md) 查看安装方法，并进行后续的基础使用教程。
|
|
||||||
:::
|
|
||||||
|
|
||||||
## 简介
|
|
||||||
|
|
||||||
NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的事件进行解析和处理，并以插件化的形式，按优先级分发给事件所对应的事件响应器，来完成具体的功能。
|
|
||||||
|
|
||||||
除了起到解析事件的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制。对于命令处理，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。
|
|
||||||
|
|
||||||
得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理事件的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
|
|
||||||
|
|
||||||
需要注意的是，NoneBot 仅支持 **Python 3.7+**
|
|
||||||
|
|
||||||
## 特色
|
|
||||||
|
|
||||||
NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义**，并且可以作为插件进行**替换/添加**！
|
|
||||||
|
|
||||||
- 提供使用简易的脚手架
|
|
||||||
- 提供丰富的官方插件
|
|
||||||
- 提供可添加/替换的驱动以及协议选项
|
|
||||||
- 基于异步 I/O
|
|
||||||
- 同时支持 HTTP 和反向 WebSocket 通信方式
|
|
||||||
- 支持多个机器人账号负载均衡
|
|
||||||
- 提供直观的交互式会话接口
|
|
||||||
- 提供可自定义的权限控制机制
|
|
||||||
- 多种方式渲染要发送的消息内容，使对话足够自然
|
|
||||||
@ -1,68 +0,0 @@
|
|||||||
# 基本配置
|
|
||||||
|
|
||||||
到目前为止我们还在使用 NoneBot 的默认行为，在开始编写自己的插件之前，我们先尝试在配置文件上动动手脚，让 NoneBot 表现出不同的行为。
|
|
||||||
|
|
||||||
在上一章节中，我们创建了默认的项目结构，其中 `.env`, `.env.*` 均为项目的配置文件，下面将介绍几种 NoneBot 配置方式。
|
|
||||||
|
|
||||||
:::danger 警告
|
|
||||||
请勿将敏感信息写入配置文件并提交至开源仓库！
|
|
||||||
:::
|
|
||||||
|
|
||||||
## .env 文件
|
|
||||||
|
|
||||||
NoneBot 在启动时将会从系统环境变量或者 `.env` 文件中寻找变量 `ENVIRONMENT` (大小写不敏感)，默认值为 `prod`。
|
|
||||||
这将引导 NoneBot 从系统环境变量或者 `.env.{ENVIRONMENT}` 文件中进一步加载具体配置。
|
|
||||||
|
|
||||||
现在，我们在 `.env` 文件中写入当前环境信息
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# .env
|
|
||||||
ENVIRONMENT=dev
|
|
||||||
```
|
|
||||||
|
|
||||||
## .env.\* 文件
|
|
||||||
|
|
||||||
详细配置文件，使用 [pydantic](https://pydantic-docs.helpmanual.io/) 加载配置。在 NoneBot 初始化时可以指定忽略 `.env` 中的环境信息转而加载某个配置文件: `nonebot.init(_env_file=".env.dev")`。
|
|
||||||
|
|
||||||
:::warning 提示
|
|
||||||
由于 `pydantic` 使用 JSON 加载配置项，请确保配置项值为 JSON 能够解析的数据。如果 JSON 解析失败将作为字符串处理。
|
|
||||||
:::
|
|
||||||
|
|
||||||
示例及说明：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
HOST=0.0.0.0 # 配置 NoneBot 监听的 IP/主机名
|
|
||||||
PORT=8080 # 配置 NoneBot 监听的端口
|
|
||||||
DEBUG=true # 开启 debug 模式 **请勿在生产环境开启**
|
|
||||||
SUPERUSERS=["123456789", "987654321"] # 配置 NoneBot 超级用户
|
|
||||||
NICKNAME=["awesome", "bot"] # 配置机器人的昵称
|
|
||||||
COMMAND_START=["/", ""] # 配置命令起始字符
|
|
||||||
COMMAND_SEP=["."] # 配置命令分割字符
|
|
||||||
|
|
||||||
# Custom Configs
|
|
||||||
CUSTOM_CONFIG1="config in env file"
|
|
||||||
CUSTOM_CONFIG2= # 留空则从系统环境变量读取，如不存在则为空字符串
|
|
||||||
```
|
|
||||||
|
|
||||||
详细的配置项参考 [Config Reference](../api/config.md) 。
|
|
||||||
|
|
||||||
## bot.py 文件
|
|
||||||
|
|
||||||
配置项也可以在 NoneBot 初始化时传入。此处可以传入任意合法 Python 变量。当然也可以在初始化完成后修改或新增。
|
|
||||||
|
|
||||||
示例：
|
|
||||||
|
|
||||||
```python
|
|
||||||
# bot.py
|
|
||||||
import nonebot
|
|
||||||
|
|
||||||
nonebot.init(custom_config3="config on init")
|
|
||||||
|
|
||||||
config = nonebot.get_driver().config
|
|
||||||
config.custom_config3 = "changed after init"
|
|
||||||
config.custom_config4 = "new config after init"
|
|
||||||
```
|
|
||||||
|
|
||||||
## 优先级
|
|
||||||
|
|
||||||
`bot.py init` > `env file` > `system env`
|
|
||||||
@ -1,159 +0,0 @@
|
|||||||
# 事件处理
|
|
||||||
|
|
||||||
在上一章中，我们已经注册了事件响应器，现在我们可以正式编写事件处理逻辑了！
|
|
||||||
|
|
||||||
## [事件处理函数](../api/typing.md#handler)
|
|
||||||
|
|
||||||
```python{1,2,8,9}
|
|
||||||
@weather.handle()
|
|
||||||
async def handle_first_receive(bot: Bot, event: Event, state: dict):
|
|
||||||
args = str(event.message).strip() # 首次发送命令时跟随的参数，例：/天气 上海，则args为上海
|
|
||||||
if args:
|
|
||||||
state["city"] = args # 如果用户发送了参数则直接赋值
|
|
||||||
|
|
||||||
|
|
||||||
@weather.got("city", prompt="你想查询哪个城市的天气呢？")
|
|
||||||
async def handle_city(bot: Bot, event: Event, state: dict):
|
|
||||||
city = state["city"]
|
|
||||||
if city not in ["上海", "北京"]:
|
|
||||||
await weather.reject("你想查询的城市暂不支持，请重新输入！")
|
|
||||||
city_weather = await get_weather(city)
|
|
||||||
await weather.finish(city_weather)
|
|
||||||
```
|
|
||||||
|
|
||||||
在之前的样例中，我们定义了两个函数 `handle_first_receive`, `handle_city`，他们被事件响应器的装饰器装饰从而成为事件响应器的事件处理函数。
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
在事件响应器中，事件处理函数是**顺序**执行的！
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 添加一个事件处理函数
|
|
||||||
|
|
||||||
事件响应器提供了三种装饰事件处理函数的装饰器，分别是：
|
|
||||||
|
|
||||||
1. [handle()](../api/matcher.md#classmethod-handle)
|
|
||||||
2. [receive()](../api/matcher.md#classmethod-receive)
|
|
||||||
3. [got(key, prompt, args_parser)](../api/matcher.md#classmethod-got-key-prompt-none-args-parser-none)
|
|
||||||
|
|
||||||
#### handle()
|
|
||||||
|
|
||||||
简单的为事件响应器添加一个事件处理函数，这个函数将会在上一个处理函数正常返回执行完毕后立即执行。
|
|
||||||
|
|
||||||
#### receive()
|
|
||||||
|
|
||||||
指示 NoneBot 接收一条新的用户消息后继续执行该处理函数。此时函数将会接收到新的消息而非前一条消息，之前相关信息可以存储在 state 中。
|
|
||||||
|
|
||||||
特别的，当装饰的函数前没有其他事件处理函数，那么 `receive()` 不会接收一条新的消息而是直接使用第一条接收到的消息。
|
|
||||||
|
|
||||||
#### got(key, prompt, args_parser)
|
|
||||||
|
|
||||||
指示 NoneBot 当 `state` 中不存在 `key` 时向用户发送 `prompt` 等待用户回复并赋值给 `state[key]`。
|
|
||||||
|
|
||||||
`prompt` 可以为 `str`, `Message`, `MessageSegment`，若为空则不会向用户发送，若不为空则会在 format 之后发送，即 `prompt.format(**state)`，注意对 `{}` 进行转义。示例：
|
|
||||||
|
|
||||||
```python
|
|
||||||
@matcher.receive()
|
|
||||||
async def handle(bot: Bot, event: Event, state: dict):
|
|
||||||
state["key"] = "hello"
|
|
||||||
|
|
||||||
|
|
||||||
@matcher.got("key2", prompt="{key}!")
|
|
||||||
async def handle2(bot: Bot, event: Event, state: dict):
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
`args_parser` 为参数处理函数，在这里传入一个新的函数以覆盖默认的参数处理。详情参照 [args_parser](#参数处理函数-args-parser)
|
|
||||||
|
|
||||||
特别的，这些装饰器都可以套娃使用：
|
|
||||||
|
|
||||||
```python
|
|
||||||
@matcher.got("key1")
|
|
||||||
@matcher.got("key2")
|
|
||||||
async def handle(bot: Bot, event: Event, state: dict):
|
|
||||||
pass
|
|
||||||
```
|
|
||||||
|
|
||||||
### 事件处理函数参数
|
|
||||||
|
|
||||||
事件处理函数类型为 `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]` 。
|
|
||||||
|
|
||||||
参数分别为：
|
|
||||||
|
|
||||||
1. [nonebot.typing.Bot](../api/typing.md#bot): 即事件上报连接对应的 Bot 对象，为 BaseBot 的子类。特别注意，此处的类型注释可以替换为指定的 Bot 类型，例如：`nonebot.adapters.cqhttp.Bot`，只有在上报事件的 Bot 类型与类型注释相符时才会执行该处理函数！可用于多平台进行不同的处理。
|
|
||||||
2. [nonebot.typing.Event](../api/typing.md#event): 即上报事件对象，可以获取到上报的所有信息。
|
|
||||||
3. `state`: 状态字典，可以存储任意的信息，其中还包含一些特殊的值以获取 NoneBot 内部处理时的一些信息，如：
|
|
||||||
|
|
||||||
- `state["_current_key"]`: 存储当前 `got` 获取的参数名
|
|
||||||
- `state["_prefix"]`, `state["_suffix"]`: 存储当前 TRIE 匹配的前缀/后缀，可以通过该值获取用户命令的原始命令
|
|
||||||
|
|
||||||
### 参数处理函数 args_parser
|
|
||||||
|
|
||||||
在使用 `got` 获取用户输入参数时，需要对用户的消息进行处理以转换为我们所需要的信息。在默认情况下，NoneBot 会把用户的消息字符串原封不动的赋值给 `state[key]` 。可以通过以下两种方式修改默认处理逻辑：
|
|
||||||
|
|
||||||
- `@matcher.args_parser` 装饰器：直接装饰一个函数作为参数处理器
|
|
||||||
- `got(key, prompt, args_parser)`：直接把函数作为参数传入
|
|
||||||
|
|
||||||
参数处理函数类型为：`Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`，即：
|
|
||||||
|
|
||||||
```python
|
|
||||||
async def parser(bot: Bot, event: Event, state: dict):
|
|
||||||
state[state["_current_key"]] = str(event.message)
|
|
||||||
```
|
|
||||||
|
|
||||||
特别的，`state["_current_key"]` 中存储了当前获取的参数名
|
|
||||||
|
|
||||||
### 逻辑控制
|
|
||||||
|
|
||||||
NoneBot 也为事件处理函数提供了一些便捷的逻辑控制函数：
|
|
||||||
|
|
||||||
#### `matcher.send`
|
|
||||||
|
|
||||||
这个函数用于发送一条消息给当前交互的用户。~~其实这并不是一个逻辑控制函数，只是不知道放在哪里……~~
|
|
||||||
|
|
||||||
#### `matcher.pause`
|
|
||||||
|
|
||||||
这个函数用于结束当前事件处理函数，强制接收一条新的消息再运行**下一个消息处理函数**。
|
|
||||||
|
|
||||||
#### `matcher.reject`
|
|
||||||
|
|
||||||
这个函数用于结束当前事件处理函数，强制接收一条新的消息再**再次运行当前消息处理函数**。常用于用户输入信息不符合预期。
|
|
||||||
|
|
||||||
#### `matcher.finish`
|
|
||||||
|
|
||||||
这个函数用于直接结束当前事件处理。
|
|
||||||
|
|
||||||
以上三个函数都拥有一个参数 `message` / `prompt`，用于向用户发送一条消息。以及 `**kwargs` 直接传递给 `bot.send` 的额外参数。
|
|
||||||
|
|
||||||
## 常用事件处理结构
|
|
||||||
|
|
||||||
```python
|
|
||||||
matcher = on_command("test")
|
|
||||||
|
|
||||||
# 修改默认参数处理
|
|
||||||
@matcher.args_parser
|
|
||||||
async def parse(bot: Bot, event: Event, state: dict):
|
|
||||||
print(state["_current_key"], ":", str(event.message))
|
|
||||||
state[state["_current_key"]] = str(event.message)
|
|
||||||
|
|
||||||
@matcher.handle()
|
|
||||||
async def first_receive(bot: Bot, event: Event, state: dict):
|
|
||||||
# 获取用户原始命令，如：/test
|
|
||||||
print(state["_prefix"]["raw_command"])
|
|
||||||
# 处理用户输入参数，如：/test arg1 arg2
|
|
||||||
raw_args = str(event.message).strip()
|
|
||||||
if raw_args:
|
|
||||||
arg_list = raw_args.split()
|
|
||||||
# 将参数存入state以阻止后续再向用户询问参数
|
|
||||||
state["arg1"] = arg_list[0]
|
|
||||||
|
|
||||||
|
|
||||||
@matcher.got("arg1", prompt="参数？")
|
|
||||||
async def arg_handle(bot: Bot, event: Event, state: dict):
|
|
||||||
# 在这里对参数进行验证
|
|
||||||
if state["arg1"] not in ["allow", "list"]:
|
|
||||||
await matcher.reject("参数不正确！请重新输入")
|
|
||||||
# 发送一些信息
|
|
||||||
await bot.send(event, "message")
|
|
||||||
await matcher.send("message")
|
|
||||||
await matcher.finish("message")
|
|
||||||
```
|
|
||||||
@ -1,144 +0,0 @@
|
|||||||
# 注册事件响应器
|
|
||||||
|
|
||||||
好了，现在插件已经创建完毕，我们可以开始编写实际代码了，下面将以一个简易单文件天气查询插件为例。
|
|
||||||
|
|
||||||
在插件目录下 `weather.py` 中添加如下代码：
|
|
||||||
|
|
||||||
```python
|
|
||||||
from nonebot import on_command
|
|
||||||
from nonebot.rule import to_me
|
|
||||||
from nonebot.adapters.cqhttp import Bot, Event
|
|
||||||
|
|
||||||
weather = on_command("天气", rule=to_me(), priority=5)
|
|
||||||
|
|
||||||
|
|
||||||
@weather.handle()
|
|
||||||
async def handle_first_receive(bot: Bot, event: Event, state: dict):
|
|
||||||
args = str(event.message).strip() # 首次发送命令时跟随的参数，例：/天气 上海，则args为上海
|
|
||||||
if args:
|
|
||||||
state["city"] = args # 如果用户发送了参数则直接赋值
|
|
||||||
|
|
||||||
|
|
||||||
@weather.got("city", prompt="你想查询哪个城市的天气呢？")
|
|
||||||
async def handle_city(bot: Bot, event: Event, state: dict):
|
|
||||||
city = state["city"]
|
|
||||||
if city not in ["上海", "北京"]:
|
|
||||||
await weather.reject("你想查询的城市暂不支持，请重新输入！")
|
|
||||||
city_weather = await get_weather(city)
|
|
||||||
await weather.finish(city_weather)
|
|
||||||
|
|
||||||
|
|
||||||
async def get_weather(city: str):
|
|
||||||
return f"{city}的天气是..."
|
|
||||||
```
|
|
||||||
|
|
||||||
为了简单起见，我们在这里的例子中没有接入真实的天气数据，但要接入也非常简单，你可以使用中国天气网、和风天气等网站提供的 API。
|
|
||||||
|
|
||||||
接下来我们来说明这段代码是如何工作的。
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
从这里开始，你需要对 Python 的 asyncio 编程有所了解，因为 NoneBot 是完全基于 asyncio 的，具体可以参考 [廖雪峰的 Python 教程](https://www.liaoxuefeng.com/wiki/1016959663602400/1017959540289152)
|
|
||||||
:::
|
|
||||||
|
|
||||||
## [事件响应器](../api/matcher.md)
|
|
||||||
|
|
||||||
```python{4}
|
|
||||||
from nonebot import on_command
|
|
||||||
from nonebot.rule import to_me
|
|
||||||
from nonebot.permission import Permission
|
|
||||||
|
|
||||||
weather = on_command("天气", rule=to_me(), permission=Permission(), priority=5)
|
|
||||||
```
|
|
||||||
|
|
||||||
在上方代码中，我们注册了一个事件响应器 `Matcher`，它由几个部分组成：
|
|
||||||
|
|
||||||
1. `on_command` 注册一个消息类型的命令处理器
|
|
||||||
2. `"天气"` 指定 command 参数 - 命令名
|
|
||||||
3. `rule` 补充事件响应器的匹配规则
|
|
||||||
4. `priority` 事件响应器优先级
|
|
||||||
5. `block` 是否阻止事件传递
|
|
||||||
|
|
||||||
其他详细配置可以参考 API 文档，下面我们详细说明各个部分：
|
|
||||||
|
|
||||||
### 事件响应器类型 type
|
|
||||||
|
|
||||||
事件响应器类型其实就是对应事件的类型 `Event.type` ，NoneBot 提供了一个基础类型事件响应器 `on()` 以及一些其他内置的事件响应器。
|
|
||||||
|
|
||||||
以下所有类型的事件响应器都是由 `on(type, rule)` 的形式进行了简化封装。
|
|
||||||
|
|
||||||
- `on("事件类型")`: 基础事件响应器，第一个参数为事件类型，空字符串表示不限
|
|
||||||
- `on_metaevent()` ~ `on("meta_event")`: 元事件响应器
|
|
||||||
- `on_message()` ~ `on("message")`: 消息事件响应器
|
|
||||||
- `on_request()` ~ `on("request")`: 请求事件响应器
|
|
||||||
- `on_notice()` ~ `on("notice")`: 通知事件响应器
|
|
||||||
- `on_startswith(str)` ~ `on("message", startswith(str))`: 消息开头匹配响应器，参考 [startswith](../api/rule.md#startswith-msg)
|
|
||||||
- `on_endswith(str)` ~ `on("message", endswith(str))`: 消息结尾匹配响应器，参考 [endswith](../api/rule.md#endswith-msg)
|
|
||||||
- `on_keyword(set)` ~ `on("message", keyword(str))`: 消息关键词匹配响应器，参考 [keyword](../api/rule.md#keyword-keywords)
|
|
||||||
- `on_command(str|tuple)` ~ `on("message", command(str|tuple))`: 命令响应器，参考 [command](../api/rule.md#command-cmds)
|
|
||||||
- `on_regex(pattern_str)` ~ `on("message", regex(pattern_str))`: 正则匹配处理器，参考 [regex](../api/rule.md#regex-regex-flags-0)
|
|
||||||
|
|
||||||
### 匹配规则 rule
|
|
||||||
|
|
||||||
事件响应器的匹配规则即 `Rule`，详细内容在下方介绍。[直达](#自定义-rule)
|
|
||||||
|
|
||||||
### 优先级 priority
|
|
||||||
|
|
||||||
事件响应器的优先级代表事件响应器的执行顺序，同一优先级的事件响应器会 **同时执行！**，优先级数字**越小**越先响应！优先级请从 `1` 开始排序！
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
使用 `nonebot-test` 可以看到当前所有事件响应器的执行流程，有助理解事件响应流程！
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install nonebot2[test]
|
|
||||||
```
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 阻断 block
|
|
||||||
|
|
||||||
当有任意事件响应器发出了阻止事件传递信号时，该事件将不再会传递给下一优先级，直接结束处理。
|
|
||||||
|
|
||||||
NoneBot 内置的事件响应器中，所有 `message` 类的事件响应器默认会阻断事件传递，其他则不会。
|
|
||||||
|
|
||||||
## 自定义 rule
|
|
||||||
|
|
||||||
rule 的出现使得 nonebot 对事件的响应可以非常自由，nonebot 内置了一些规则：
|
|
||||||
|
|
||||||
- [startswith(msg)](../api/rule.md#startswith-msg)
|
|
||||||
- [endswith(msg)](../api/rule.md#endswith-msg)
|
|
||||||
- [keyword(\*keywords)](../api/rule.md#keyword-keywords)
|
|
||||||
- [command(\*cmds)](../api/rule.md#command-cmds)
|
|
||||||
- [regex(regex, flag)](../api/rule.md#regex-regex-flags-0)
|
|
||||||
|
|
||||||
以上规则都是返回类型为 `Rule` 的函数，`Rule` 由非负个 `RuleChecker` 组成，当所有 `RuleChecker` 返回 `True` 时匹配成功。这些 `Rule`, `RuleChecker` 的形式如下：
|
|
||||||
|
|
||||||
```python
|
|
||||||
from nonebot.rule import Rule
|
|
||||||
|
|
||||||
async def async_checker(bot: Bot, event: Event, state: dict) -> bool:
|
|
||||||
return True
|
|
||||||
|
|
||||||
def sync_checker(bot: Bot, event: Event, state: dict) -> bool:
|
|
||||||
return True
|
|
||||||
|
|
||||||
def check(arg1, args2):
|
|
||||||
|
|
||||||
async def _checker(bot: Bot, event: Event, state: dict) -> bool:
|
|
||||||
return bool(arg1 + arg2)
|
|
||||||
|
|
||||||
return Rule(_check)
|
|
||||||
```
|
|
||||||
|
|
||||||
`Rule` 和 `RuleChecker` 之间可以使用 `与 &` 互相组合：
|
|
||||||
|
|
||||||
```python
|
|
||||||
from nonebot.rule import Rule
|
|
||||||
|
|
||||||
Rule(async_checker1) & sync_checker & async_checker2
|
|
||||||
```
|
|
||||||
|
|
||||||
**_请勿将事件处理的逻辑写入 `rule` 中，这会使得事件处理返回奇怪的响应。_**
|
|
||||||
|
|
||||||
:::danger 警告
|
|
||||||
`Rule(*checkers)` 只接受 async function，或使用 `nonebot.utils.run_sync` 自行包裹 sync function。在使用 `与 &` 时，NoneBot 会自动包裹 sync function
|
|
||||||
:::
|
|
||||||
@ -1,119 +0,0 @@
|
|||||||
# 创建插件
|
|
||||||
|
|
||||||
如果之前使用 `nb-cli` 生成了项目结构，那我们已经有了一个空的插件目录 `Awesome-Bot/awesome_bot/plugins`，并且它已在 `bot.py` 中被加载，我们现在可以开始创建插件了！
|
|
||||||
|
|
||||||
使用 `nb-cli` 创建包形式插件，或自行创建文件(夹)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nb plugin new
|
|
||||||
```
|
|
||||||
|
|
||||||
插件通常有两种形式，下面分别介绍
|
|
||||||
|
|
||||||
## 单文件形式
|
|
||||||
|
|
||||||
在插件目录下创建名为 `foo.py` 的 Python 文件，暂时留空，此时目录结构如下：
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
:::vue
|
|
||||||
AweSome-Bot
|
|
||||||
├── awesome_bot
|
|
||||||
│ └── plugins
|
|
||||||
│ └── `foo.py`
|
|
||||||
├── .env
|
|
||||||
├── .env.dev
|
|
||||||
├── .env.prod
|
|
||||||
├── .gitignore
|
|
||||||
├── bot.py
|
|
||||||
├── docker-compose.yml
|
|
||||||
├── Dockerfile
|
|
||||||
├── pyproject.toml
|
|
||||||
└── README.md
|
|
||||||
:::
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
这个时候它已经可以被称为一个插件了，尽管它还什么都没做。
|
|
||||||
|
|
||||||
## 包形式(推荐)
|
|
||||||
|
|
||||||
在插件目录下创建文件夹 `foo`，并在该文件夹下创建文件 `__init__.py`，此时目录结构如下：
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
:::vue
|
|
||||||
AweSome-Bot
|
|
||||||
├── awesome_bot
|
|
||||||
│ └── plugins
|
|
||||||
│ └── `foo`
|
|
||||||
│ └── `__init__.py`
|
|
||||||
├── .env
|
|
||||||
├── .env.dev
|
|
||||||
├── .env.prod
|
|
||||||
├── .gitignore
|
|
||||||
├── bot.py
|
|
||||||
├── docker-compose.yml
|
|
||||||
├── Dockerfile
|
|
||||||
├── pyproject.toml
|
|
||||||
└── README.md
|
|
||||||
:::
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
这个时候 `foo` 就是一个合法的 Python 包了，同时也是合法的 NoneBot 插件，插件内容可以在 `__init__.py` 中编写。
|
|
||||||
|
|
||||||
### 推荐结构(仅供参考)
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
:::vue
|
|
||||||
foo
|
|
||||||
├── `__init__.py`
|
|
||||||
├── `config.py`
|
|
||||||
├── `data_source.py`
|
|
||||||
└── `model.py`
|
|
||||||
:::
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
#### \_\_init\_\_.py
|
|
||||||
|
|
||||||
在该文件中编写各类事件响应及处理逻辑。
|
|
||||||
|
|
||||||
#### config.py
|
|
||||||
|
|
||||||
在该文件中使用 `pydantic` 定义插件所需要的配置项以及类型。
|
|
||||||
|
|
||||||
示例：
|
|
||||||
|
|
||||||
```python
|
|
||||||
from pydantic import BaseSetting
|
|
||||||
|
|
||||||
|
|
||||||
class Config(BaseSetting):
|
|
||||||
|
|
||||||
# plugin custom config
|
|
||||||
plugin_setting: str = "default"
|
|
||||||
|
|
||||||
class Config:
|
|
||||||
extra = "ignore"
|
|
||||||
```
|
|
||||||
|
|
||||||
并在 `__init__.py` 文件中添加以下行
|
|
||||||
|
|
||||||
```python
|
|
||||||
import nonebot
|
|
||||||
from .config import Config
|
|
||||||
|
|
||||||
global_config = nonebot.get_driver().config
|
|
||||||
plugin_config = Config(**global_config.dict())
|
|
||||||
```
|
|
||||||
|
|
||||||
此时就可以通过 `plugin_config.plugin_setting` 获取到插件所需要的配置项了。
|
|
||||||
|
|
||||||
#### data_source.py
|
|
||||||
|
|
||||||
在该文件中编写数据获取函数。
|
|
||||||
|
|
||||||
:::warning 警告
|
|
||||||
数据获取应尽量使用**异步**处理！例如使用 [httpx](https://www.python-httpx.org/) 而非 [requests](https://requests.readthedocs.io/en/master/)
|
|
||||||
:::
|
|
||||||
|
|
||||||
#### model.py
|
|
||||||
|
|
||||||
在该文件中编写数据库模型。
|
|
||||||
@ -1,51 +0,0 @@
|
|||||||
# 创建一个完整的项目
|
|
||||||
|
|
||||||
上一章中我们已经运行了一个最小的 NoneBot 实例，在这一章，我们将从零开始一个完整的项目。
|
|
||||||
|
|
||||||
## 目录结构
|
|
||||||
|
|
||||||
首先，我们可以使用 `nb-cli` 或者自行创建完整的项目目录：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nb create
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
:::vue
|
|
||||||
AweSome-Bot
|
|
||||||
├── `awesome_bot` _(**或是 src**)_
|
|
||||||
│ └── `plugins`
|
|
||||||
├── `.env` _(**可选的**)_
|
|
||||||
├── `.env.dev` _(**可选的**)_
|
|
||||||
├── `.env.prod` _(**可选的**)_
|
|
||||||
├── .gitignore
|
|
||||||
├── `bot.py`
|
|
||||||
├── docker-compose.yml
|
|
||||||
├── Dockerfile
|
|
||||||
├── `pyproject.toml`
|
|
||||||
└── README.md
|
|
||||||
:::
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
- `awesome_bot/plugins` 或 `src/plugins`: 用于存放编写的 bot 插件
|
|
||||||
- `.env`, `.env.dev`, `.env.prod`: 各环境配置文件
|
|
||||||
- `bot.py`: bot 入口文件
|
|
||||||
- `pyproject.toml`: 项目依赖管理文件，默认使用 [poetry](https://python-poetry.org/)
|
|
||||||
|
|
||||||
## 启动 Bot
|
|
||||||
|
|
||||||
如果你使用 `nb-cli`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nb run [--file=bot.py] [--app=app]
|
|
||||||
```
|
|
||||||
|
|
||||||
或者使用
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python bot.py
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
如果在 bot 入口文件内定义了 asgi server， `nb-cli` 将会为你启动**冷重载模式**
|
|
||||||
:::
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
# 结语
|
|
||||||
|
|
||||||
至此，相信你已经能够写出一个基础的插件了，更多的用法将会在 进阶 部分进行介绍，这里给出几个小提示：
|
|
||||||
|
|
||||||
- 请千万注意事件处理器的优先级设定
|
|
||||||
- 在匹配规则中请勿使用耗时极长的函数
|
|
||||||
- 同一个用户可以**跨群**(**私聊**)继续他的事件处理（除非做出权限限制，将在后续介绍）
|
|
||||||
|
|
||||||
如果你还不能满足，前往 [进阶](../advanced/README.md) 获得更多的功能信息。
|
|
||||||
@ -1,173 +0,0 @@
|
|||||||
# 开始使用
|
|
||||||
|
|
||||||
一切都安装成功后，你就已经做好了进行简单配置以运行一个最小的 NoneBot 实例的准备。
|
|
||||||
|
|
||||||
## 最小实例
|
|
||||||
|
|
||||||
如果你已经按照推荐方式安装了 `nb-cli`，使用脚手架创建一个空项目：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nb create
|
|
||||||
```
|
|
||||||
|
|
||||||
根据脚手架引导，将在当前目录下创建一个项目目录，项目目录内包含 `bot.py`。
|
|
||||||
|
|
||||||
如果未安装 `nb-cli`，使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下：
|
|
||||||
|
|
||||||
```python{3,4,7}
|
|
||||||
import nonebot
|
|
||||||
from nonebot.adapters.cqhttp import Bot as CQHTTPBot
|
|
||||||
|
|
||||||
nonebot.init()
|
|
||||||
driver = nonebot.get_driver()
|
|
||||||
driver.register_adapter("cqhttp", CQHTTPBot)
|
|
||||||
nonebot.load_builtin_plugins()
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
nonebot.run()
|
|
||||||
```
|
|
||||||
|
|
||||||
## 解读
|
|
||||||
|
|
||||||
在上方 `bot.py` 中，这几行高亮代码将依次：
|
|
||||||
|
|
||||||
1. 使用默认配置初始化 NoneBot
|
|
||||||
2. 加载 NoneBot 内置的插件
|
|
||||||
3. 在地址 `127.0.0.1:8080` 运行 NoneBot
|
|
||||||
|
|
||||||
在命令行使用如下命令即可运行这个 NoneBot 实例：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# nb-cli
|
|
||||||
nb run
|
|
||||||
# 其他
|
|
||||||
python bot.py
|
|
||||||
```
|
|
||||||
|
|
||||||
运行后会产生如下日志：
|
|
||||||
|
|
||||||
```plain
|
|
||||||
09-14 21:02:00 [INFO] nonebot | Succeeded to import "nonebot.plugins.base"
|
|
||||||
09-14 21:02:00 [INFO] nonebot | Running NoneBot...
|
|
||||||
09-14 21:02:00 [INFO] uvicorn | Started server process [1234]
|
|
||||||
09-14 21:02:00 [INFO] uvicorn | Waiting for application startup.
|
|
||||||
09-14 21:02:00 [INFO] uvicorn | Application startup complete.
|
|
||||||
09-14 21:02:00 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 配置 QQ 协议端
|
|
||||||
|
|
||||||
单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。
|
|
||||||
|
|
||||||
目前支持的协议有:
|
|
||||||
|
|
||||||
- [OneBot(CQHTTP)](https://github.com/howmanybots/onebot/blob/master/README.md)
|
|
||||||
|
|
||||||
QQ 协议端举例:
|
|
||||||
|
|
||||||
- [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) (基于 [MiraiGo](https://github.com/Mrs4s/MiraiGo))
|
|
||||||
- [cqhttp-mirai-embedded](https://github.com/yyuueexxiinngg/cqhttp-mirai/tree/embedded)
|
|
||||||
- [Mirai](https://github.com/mamoe/mirai) + [cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai)
|
|
||||||
- [Mirai](https://github.com/mamoe/mirai) + [Mirai Native](https://github.com/iTXTech/mirai-native) + [CQHTTP](https://github.com/richardchien/coolq-http-api)
|
|
||||||
- [OICQ-http-api](https://github.com/takayama-lily/onebot) (基于 [OICQ](https://github.com/takayama-lily/oicq))
|
|
||||||
|
|
||||||
这里以 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp) 为例
|
|
||||||
|
|
||||||
1. 下载 go-cqhttp 对应平台的 release 文件，[点此前往](https://github.com/Mrs4s/go-cqhttp/releases)
|
|
||||||
2. 运行 exe 文件或者使用 `./go-cqhttp` 启动
|
|
||||||
3. 生成默认配置文件并修改默认配置
|
|
||||||
|
|
||||||
```json{2,3,35-36,42}
|
|
||||||
{
|
|
||||||
"uin": 你的QQ号,
|
|
||||||
"password": "你的密码",
|
|
||||||
"encrypt_password": false,
|
|
||||||
"password_encrypted": "",
|
|
||||||
"enable_db": true,
|
|
||||||
"access_token": "",
|
|
||||||
"relogin": {
|
|
||||||
"enabled": true,
|
|
||||||
"relogin_delay": 3,
|
|
||||||
"max_relogin_times": 0
|
|
||||||
},
|
|
||||||
"_rate_limit": {
|
|
||||||
"enabled": false,
|
|
||||||
"frequency": 0,
|
|
||||||
"bucket_size": 0
|
|
||||||
},
|
|
||||||
"ignore_invalid_cqcode": false,
|
|
||||||
"force_fragmented": true,
|
|
||||||
"heartbeat_interval": 0,
|
|
||||||
"http_config": {
|
|
||||||
"enabled": false,
|
|
||||||
"host": "0.0.0.0",
|
|
||||||
"port": 5700,
|
|
||||||
"timeout": 0,
|
|
||||||
"post_urls": {}
|
|
||||||
},
|
|
||||||
"ws_config": {
|
|
||||||
"enabled": false,
|
|
||||||
"host": "0.0.0.0",
|
|
||||||
"port": 6700
|
|
||||||
},
|
|
||||||
"ws_reverse_servers": [
|
|
||||||
{
|
|
||||||
"enabled": true,
|
|
||||||
"reverse_url": "ws://127.0.0.1:8080/cqhttp/ws",
|
|
||||||
"reverse_api_url": "",
|
|
||||||
"reverse_event_url": "",
|
|
||||||
"reverse_reconnect_interval": 3000
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"post_message_format": "array",
|
|
||||||
"use_sso_address": false,
|
|
||||||
"debug": false,
|
|
||||||
"log_level": "",
|
|
||||||
"web_ui": {
|
|
||||||
"enabled": true,
|
|
||||||
"host": "0.0.0.0",
|
|
||||||
"web_ui_port": 9999,
|
|
||||||
"web_input": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT
|
|
||||||
|
|
||||||
## 历史性的第一次对话
|
|
||||||
|
|
||||||
一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
|
|
||||||
|
|
||||||
```default
|
|
||||||
09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
|
|
||||||
09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
|
|
||||||
```
|
|
||||||
|
|
||||||
这表示 QQ 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
|
|
||||||
|
|
||||||
:::warning 注意
|
|
||||||
如果到这一步你没有看到上面这样的成功日志，CQHTTP 的日志中在不断地重连或无反应，请注意检查配置中的 IP 和端口是否确实可以访问。比较常见的出错点包括：
|
|
||||||
|
|
||||||
- NoneBot 监听 `0.0.0.0`，然后在 CQHTTP 配置中填了 `ws://0.0.0.0:8080/cqhttp/ws`
|
|
||||||
- 在 Docker 容器内运行 CQHTTP，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
|
|
||||||
- 想从公网访问，但没有修改云服务商的安全组策略或系统防火墙
|
|
||||||
- NoneBot 所监听的端口存在冲突，已被其它程序占用
|
|
||||||
- 弄混了 NoneBot 的 `host`、`port` 参数与 CQHTTP 配置中的 `host`、`port` 参数
|
|
||||||
- 使用了 `ws_reverse_api_url` 和 `ws_reverse_event_url` 而非 universal client
|
|
||||||
- `ws://` 错填为 `http://`
|
|
||||||
- CQHTTP 或 NoneBot 启动时遭到外星武器干扰
|
|
||||||
|
|
||||||
请尝试重启 CQHTTP、重启 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新 CQHTTP 和 NoneBot 到最新版本等方式来解决。
|
|
||||||
:::
|
|
||||||
|
|
||||||
现在，尝试向你的 QQ 机器人账号发送如下内容：
|
|
||||||
|
|
||||||
```default
|
|
||||||
/echo 你好，世界
|
|
||||||
```
|
|
||||||
|
|
||||||
到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
|
|
||||||
|
|
||||||
<ClientOnly>
|
|
||||||
<Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
|
|
||||||
</ClientOnly>
|
|
||||||
@ -1,87 +0,0 @@
|
|||||||
# 安装
|
|
||||||
|
|
||||||
## NoneBot
|
|
||||||
|
|
||||||
:::warning 注意
|
|
||||||
请确保你的 Python 版本 >= 3.7。
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::warning 注意
|
|
||||||
请在安装 nonebot2 之前卸载 nonebot 1.x
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip uninstall nonebot
|
|
||||||
```
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### 通过脚手架安装(推荐安装方式)
|
|
||||||
|
|
||||||
1. (可选)使用你喜欢的 Python 环境管理工具创建新的虚拟环境。
|
|
||||||
2. 使用 `pip` (或其他) 安装 NoneBot 脚手架。
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install nb-cli
|
|
||||||
```
|
|
||||||
|
|
||||||
3. 点个 star 吧
|
|
||||||
|
|
||||||
nonebot2: [](https://github.com/nonebot/nonebot2)
|
|
||||||
|
|
||||||
nb-cli: [](https://github.com/nonebot/nb-cli)
|
|
||||||
|
|
||||||
### 不使用脚手架(纯净安装)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# poetry
|
|
||||||
poetry add nonebot2
|
|
||||||
# pip
|
|
||||||
pip install nonebot2
|
|
||||||
```
|
|
||||||
|
|
||||||
如果你需要使用最新的（可能**尚未发布**的）特性，可以直接从 GitHub 仓库安装：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# master
|
|
||||||
poetry add git+https://github.com/nonebot/nonebot2.git#master
|
|
||||||
# dev
|
|
||||||
poetry add git+https://github.com/nonebot/nonebot2.git#dev
|
|
||||||
```
|
|
||||||
|
|
||||||
或者克隆 Git 仓库后手动安装：
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/nonebot/nonebot2.git
|
|
||||||
cd nonebot2
|
|
||||||
poetry install --no-dev # 推荐
|
|
||||||
pip install . # 不推荐
|
|
||||||
```
|
|
||||||
|
|
||||||
## 安装插件
|
|
||||||
|
|
||||||
插件可以通过 `nb-cli` 进行安装，也可以自行安装并加载插件。
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 列出所有的插件
|
|
||||||
nb plugin list
|
|
||||||
# 搜索插件
|
|
||||||
nb plugin search xxx
|
|
||||||
# 安装插件
|
|
||||||
nb plugin install xxx
|
|
||||||
```
|
|
||||||
|
|
||||||
如果急于上线 Bot 或想要使用现成的插件，以下插件可作为参考：
|
|
||||||
|
|
||||||
### 官方插件
|
|
||||||
|
|
||||||
~~自用插件~~ ~~确信~~
|
|
||||||
|
|
||||||
- [NoneBot-Plugin-Docs](https://github.com/nonebot/nonebot2/tree/master/packages/nonebot-plugin-docs) 离线文档插件
|
|
||||||
- [NoneBot-Plugin-Test](https://github.com/nonebot/plugin-test) 本地机器人测试前端插件
|
|
||||||
- [NoneBot-Plugin-APScheduler](https://github.com/nonebot/plugin-apscheduler) 定时任务插件
|
|
||||||
- [NoneBot-Plugin-Sentry](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_sentry) Sentry 在线日志分析插件
|
|
||||||
- [NoneBot-Plugin-Status](https://github.com/cscs181/QQ-GitHub-Bot/tree/master/src/plugins/nonebot_plugin_status) 服务器状态查看插件
|
|
||||||
|
|
||||||
### 其他插件
|
|
||||||
|
|
||||||
还有更多的插件在 [这里](/plugin-store.md) 等着你发现～
|
|
||||||
@ -1,116 +0,0 @@
|
|||||||
# 加载插件
|
|
||||||
|
|
||||||
在 [创建一个完整的项目](creating-a-project) 一章节中，我们已经创建了插件目录 `awesome_bot/plugins`，现在我们在机器人入口文件中加载它。当然，你也可以单独加载一个插件。
|
|
||||||
|
|
||||||
## 加载内置插件
|
|
||||||
|
|
||||||
在 `bot.py` 文件中添加以下行：
|
|
||||||
|
|
||||||
```python{5}
|
|
||||||
import nonebot
|
|
||||||
|
|
||||||
nonebot.init()
|
|
||||||
# 加载 nonebot 内置插件
|
|
||||||
nonebot.load_builtin_plugins()
|
|
||||||
|
|
||||||
app = nonebot.get_asgi()
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
nonebot.run()
|
|
||||||
```
|
|
||||||
|
|
||||||
这将会加载 nonebot 内置的插件，它包含：
|
|
||||||
|
|
||||||
- 命令 `say`：可由**superuser**使用，可以将消息内容由特殊纯文本转为富文本
|
|
||||||
- 命令 `echo`：可由任何人使用，将消息原样返回
|
|
||||||
|
|
||||||
以上命令均需要指定机器人，即私聊、群聊内@机器人、群聊内称呼机器人昵称。参考 [Rule: to_me](../api/rule.md#to-me)
|
|
||||||
|
|
||||||
## 加载插件目录
|
|
||||||
|
|
||||||
在 `bot.py` 文件中添加以下行：
|
|
||||||
|
|
||||||
```python{5}
|
|
||||||
import nonebot
|
|
||||||
|
|
||||||
nonebot.init()
|
|
||||||
# 加载插件目录，该目录下为各插件，以下划线开头的插件将不会被加载
|
|
||||||
nonebot.load_plugins("awesome_bot/plugins")
|
|
||||||
|
|
||||||
app = nonebot.get_asgi()
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
nonebot.run()
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip 提示
|
|
||||||
加载插件目录时，目录下以 `_` 下划线开头的插件将不会被加载！
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::warning 提示
|
|
||||||
**插件不能存在相同名称！**
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::danger 警告
|
|
||||||
插件间不应该存在过多的耦合，如果确实需要导入某个插件内的数据，可以参考 [进阶-跨插件访问](../advanced/export-and-require.md)
|
|
||||||
:::
|
|
||||||
|
|
||||||
## 加载单个插件
|
|
||||||
|
|
||||||
在 `bot.py` 文件中添加以下行：
|
|
||||||
|
|
||||||
```python{5,7}
|
|
||||||
import nonebot
|
|
||||||
|
|
||||||
nonebot.init()
|
|
||||||
# 加载一个 pip 安装的插件
|
|
||||||
nonebot.load_plugin("nonebot_plugin_status")
|
|
||||||
# 加载本地的单独插件
|
|
||||||
nonebot.load_plugin("awesome_bot.plugins.xxx")
|
|
||||||
|
|
||||||
app = nonebot.get_asgi()
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
nonebot.run()
|
|
||||||
```
|
|
||||||
|
|
||||||
## 子插件(嵌套插件)
|
|
||||||
|
|
||||||
在插件中同样可以加载子插件，例如如下插件目录结构：
|
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
:::vue
|
|
||||||
foo_plugin
|
|
||||||
├── `plugins`
|
|
||||||
│ ├── `sub_plugin1`
|
|
||||||
│ │ └── \_\_init\_\_.py
|
|
||||||
│ └── `sub_plugin2.py`
|
|
||||||
├── `__init__.py`
|
|
||||||
└── config.py
|
|
||||||
:::
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
在插件目录下的 `__init__.py` 中添加如下代码：
|
|
||||||
|
|
||||||
```python
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import nonebot
|
|
||||||
|
|
||||||
# store all subplugins
|
|
||||||
_sub_plugins = set()
|
|
||||||
# load sub plugins
|
|
||||||
_sub_plugins |= nonebot.load_plugins(
|
|
||||||
str((Path(__file__).parent / "plugins").resolve()))
|
|
||||||
```
|
|
||||||
|
|
||||||
插件将会被加载并存储于 `_sub_plugins` 中。
|
|
||||||
|
|
||||||
## 运行结果
|
|
||||||
|
|
||||||
尝试运行 `nb run` 或者 `python bot.py`，可以看到日志输出了类似如下内容：
|
|
||||||
|
|
||||||
```plain
|
|
||||||
09-19 21:51:59 [INFO] nonebot | Succeeded to import "nonebot.plugins.base"
|
|
||||||
09-19 21:51:59 [INFO] nonebot | Succeeded to import "plugin_in_folder"
|
|
||||||
```
|
|
||||||
@ -1,159 +0,0 @@
|
|||||||
{
|
|
||||||
"sidebar": {},
|
|
||||||
"locales": {
|
|
||||||
"/": {
|
|
||||||
"label": "简体中文",
|
|
||||||
"selectText": "Languages",
|
|
||||||
"editLinkText": "在 GitHub 上编辑此页",
|
|
||||||
"lastUpdated": "上次更新",
|
|
||||||
"nav": [
|
|
||||||
{
|
|
||||||
"text": "主页",
|
|
||||||
"link": "/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "指南",
|
|
||||||
"link": "/guide/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "进阶",
|
|
||||||
"link": "/advanced/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "API",
|
|
||||||
"link": "/api/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "商店",
|
|
||||||
"link": "/store"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"text": "更新日志",
|
|
||||||
"link": "/changelog"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"sidebarDepth": 2,
|
|
||||||
"sidebar": {
|
|
||||||
"/guide/": [
|
|
||||||
{
|
|
||||||
"title": "开始",
|
|
||||||
"collapsable": false,
|
|
||||||
"sidebar": "auto",
|
|
||||||
"children": [
|
|
||||||
"",
|
|
||||||
"installation",
|
|
||||||
"getting-started",
|
|
||||||
"creating-a-project",
|
|
||||||
"basic-configuration"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "编写插件",
|
|
||||||
"collapsable": false,
|
|
||||||
"sidebar": "auto",
|
|
||||||
"children": [
|
|
||||||
"loading-a-plugin",
|
|
||||||
"creating-a-plugin",
|
|
||||||
"creating-a-matcher",
|
|
||||||
"creating-a-handler",
|
|
||||||
"end-or-start"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"/advanced/": [
|
|
||||||
{
|
|
||||||
"title": "进阶",
|
|
||||||
"collapsable": false,
|
|
||||||
"sidebar": "auto",
|
|
||||||
"children": [
|
|
||||||
"",
|
|
||||||
"scheduler",
|
|
||||||
"permission",
|
|
||||||
"runtime-hook",
|
|
||||||
"export-and-require"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "发布",
|
|
||||||
"collapsable": false,
|
|
||||||
"sidebar": "auto",
|
|
||||||
"children": ["publish-plugin"]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"/api/": [
|
|
||||||
{
|
|
||||||
"title": "NoneBot Api Reference",
|
|
||||||
"path": "",
|
|
||||||
"collapsable": false,
|
|
||||||
"children": [
|
|
||||||
{
|
|
||||||
"title": "nonebot 模块",
|
|
||||||
"path": "nonebot"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.config 模块",
|
|
||||||
"path": "config"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.plugin 模块",
|
|
||||||
"path": "plugin"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.message 模块",
|
|
||||||
"path": "message"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.matcher 模块",
|
|
||||||
"path": "matcher"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.rule 模块",
|
|
||||||
"path": "rule"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.permission 模块",
|
|
||||||
"path": "permission"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.log 模块",
|
|
||||||
"path": "log"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.utils 模块",
|
|
||||||
"path": "utils"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.typing 模块",
|
|
||||||
"path": "typing"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.exception 模块",
|
|
||||||
"path": "exception"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.drivers 模块",
|
|
||||||
"path": "drivers/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.drivers.fastapi 模块",
|
|
||||||
"path": "drivers/fastapi"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.adapters 模块",
|
|
||||||
"path": "adapters/"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.adapters.cqhttp 模块",
|
|
||||||
"path": "adapters/cqhttp"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"title": "nonebot.adapters.ding 模块",
|
|
||||||
"path": "adapters/ding"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
# 深入
|
|
||||||
|
|
||||||
## 它如何工作？
|
|
||||||
|
|
||||||
<!-- TODO: how to work -->
|
|
||||||
|
|
||||||
~~未填坑~~
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user