diff --git a/archive/2.0.0a7/README.md b/archive/2.0.0a7/README.md deleted file mode 100644 index c093eb5c..00000000 --- a/archive/2.0.0a7/README.md +++ /dev/null @@ -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 ---- diff --git a/archive/2.0.0a7/advanced/README.md b/archive/2.0.0a7/advanced/README.md deleted file mode 100644 index 92c6af3e..00000000 --- a/archive/2.0.0a7/advanced/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# 深入 - -## 它如何工作？ - - - -~~未填坑~~ diff --git a/archive/2.0.0a7/advanced/export-and-require.md b/archive/2.0.0a7/advanced/export-and-require.md deleted file mode 100644 index 832b0e75..00000000 --- a/archive/2.0.0a7/advanced/export-and-require.md +++ /dev/null @@ -1 +0,0 @@ -# 跨插件访问 diff --git a/archive/2.0.0a7/advanced/permission.md b/archive/2.0.0a7/advanced/permission.md deleted file mode 100644 index 7190bcdd..00000000 --- a/archive/2.0.0a7/advanced/permission.md +++ /dev/null @@ -1 +0,0 @@ -# 权限控制 diff --git a/archive/2.0.0a7/advanced/publish-plugin.md b/archive/2.0.0a7/advanced/publish-plugin.md deleted file mode 100644 index 68e2e6f9..00000000 --- a/archive/2.0.0a7/advanced/publish-plugin.md +++ /dev/null @@ -1 +0,0 @@ -# 发布插件 diff --git a/archive/2.0.0a7/advanced/runtime-hook.md b/archive/2.0.0a7/advanced/runtime-hook.md deleted file mode 100644 index 58bca681..00000000 --- a/archive/2.0.0a7/advanced/runtime-hook.md +++ /dev/null @@ -1 +0,0 @@ -# 运行时插槽 diff --git a/archive/2.0.0a7/advanced/scheduler.md b/archive/2.0.0a7/advanced/scheduler.md deleted file mode 100644 index 53e6cedc..00000000 --- a/archive/2.0.0a7/advanced/scheduler.md +++ /dev/null @@ -1 +0,0 @@ -# 定时任务 diff --git a/archive/2.0.0a7/api/README.md b/archive/2.0.0a7/api/README.md deleted file mode 100644 index 243733f8..00000000 --- a/archive/2.0.0a7/api/README.md +++ /dev/null @@ -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) diff --git a/archive/2.0.0a7/api/adapters/README.md b/archive/2.0.0a7/api/adapters/README.md deleted file mode 100644 index 1a1dd85b..00000000 --- a/archive/2.0.0a7/api/adapters/README.md +++ /dev/null @@ -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()` - - -* **说明** - - 提取消息内纯文本消息 diff --git a/archive/2.0.0a7/api/adapters/cqhttp.md b/archive/2.0.0a7/api/adapters/cqhttp.md deleted file mode 100644 index b80d6ad1..00000000 --- a/archive/2.0.0a7/api/adapters/cqhttp.md +++ /dev/null @@ -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 适配。 diff --git a/archive/2.0.0a7/api/adapters/ding.md b/archive/2.0.0a7/api/adapters/ding.md deleted file mode 100644 index 0bbdd6d8..00000000 --- a/archive/2.0.0a7/api/adapters/ding.md +++ /dev/null @@ -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 适配。 diff --git a/archive/2.0.0a7/api/config.md b/archive/2.0.0a7/api/config.md deleted file mode 100644 index f2eaa4d4..00000000 --- a/archive/2.0.0a7/api/config.md +++ /dev/null @@ -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 -``` diff --git a/archive/2.0.0a7/api/drivers/README.md b/archive/2.0.0a7/api/drivers/README.md deleted file mode 100644 index 624220ba..00000000 --- a/archive/2.0.0a7/api/drivers/README.md +++ /dev/null @@ -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 信息 diff --git a/archive/2.0.0a7/api/drivers/fastapi.md b/archive/2.0.0a7/api/drivers/fastapi.md deleted file mode 100644 index b4f5c6fb..00000000 --- a/archive/2.0.0a7/api/drivers/fastapi.md +++ /dev/null @@ -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 信息 diff --git a/archive/2.0.0a7/api/exception.md b/archive/2.0.0a7/api/exception.md deleted file mode 100644 index 0c584f75..00000000 --- a/archive/2.0.0a7/api/exception.md +++ /dev/null @@ -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 操作失败。 diff --git a/archive/2.0.0a7/api/log.md b/archive/2.0.0a7/api/log.md deleted file mode 100644 index 77ce3609..00000000 --- a/archive/2.0.0a7/api/log.md +++ /dev/null @@ -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. diff --git a/archive/2.0.0a7/api/matcher.md b/archive/2.0.0a7/api/matcher.md deleted file mode 100644 index 9e72b658..00000000 --- a/archive/2.0.0a7/api/matcher.md +++ /dev/null @@ -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 diff --git a/archive/2.0.0a7/api/message.md b/archive/2.0.0a7/api/message.md deleted file mode 100644 index c9d7c158..00000000 --- a/archive/2.0.0a7/api/message.md +++ /dev/null @@ -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)) -``` diff --git a/archive/2.0.0a7/api/nonebot.md b/archive/2.0.0a7/api/nonebot.md deleted file mode 100644 index 93ede67e..00000000 --- a/archive/2.0.0a7/api/nonebot.md +++ /dev/null @@ -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) -``` diff --git a/archive/2.0.0a7/api/permission.md b/archive/2.0.0a7/api/permission.md deleted file mode 100644 index 26d3cd34..00000000 --- a/archive/2.0.0a7/api/permission.md +++ /dev/null @@ -1,121 +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=)` - - -* **说明** - - 在白名单内且满足 perm - - - -* **参数** - - - * `*user: int`: 白名单 - - - * `perm: Permission`: 需要同时满足的权限 - - - -## `PRIVATE` - - -* **说明**: 匹配任意私聊消息类型事件 - - -## `PRIVATE_FRIEND` - - -* **说明**: 匹配任意好友私聊消息类型事件 - - -## `PRIVATE_GROUP` - - -* **说明**: 匹配任意群临时私聊消息类型事件 - - -## `PRIVATE_OTHER` - - -* **说明**: 匹配任意其他私聊消息类型事件 - - -## `GROUP` - - -* **说明**: 匹配任意群聊消息类型事件 - - -## `GROUP_MEMBER` - - -* **说明**: 匹配任意群员群聊消息类型事件 - -:::warning 警告 -该权限通过 event.sender 进行判断且不包含管理员以及群主！ -::: - - -## `GROUP_ADMIN` - - -* **说明**: 匹配任意群管理员群聊消息类型事件 - - -## `GROUP_OWNER` - - -* **说明**: 匹配任意群主群聊消息类型事件 - - -## `SUPERUSER` - - -* **说明**: 匹配任意超级用户消息类型事件 - - -## `EVERYBODY` - - -* **说明**: 匹配任意消息类型事件 diff --git a/archive/2.0.0a7/api/plugin.md b/archive/2.0.0a7/api/plugin.md deleted file mode 100644 index 91d7320e..00000000 --- a/archive/2.0.0a7/api/plugin.md +++ /dev/null @@ -1,1201 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.plugin 模块 - -## 插件 - -为 NoneBot 插件开发提供便携的定义函数。 - - -## `plugins` - - -* **类型** - - `Dict[str, Plugin]` - - - -* **说明** - - 已加载的插件 - - - -## _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` - -基类：`object` - -存储插件信息 - - -### `name` - - -* **类型**: `str` - - -* **说明**: 插件名称，使用 文件/文件夹 名称作为插件名 - - -### `module` - - -* **类型**: `ModuleType` - - -* **说明**: 插件模块对象 - - -### `matcher` - - -* **类型**: `Set[Type[Matcher]]` - - -* **说明**: 插件内定义的 `Matcher` - - -### `export` - - -* **类型**: `Export` - - -* **说明**: 插件内定义的导出内容 - - -## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None)` - - -* **说明** - - 注册一个基础事件响应器，可自定义类型。 - - - -* **参数** - - - * `type: str`: 事件响应器类型 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_metaevent(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)` - - -* **说明** - - 注册一个元事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_message(rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=True, state=None)` - - -* **说明** - - 注册一个消息事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_notice(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)` - - -* **说明** - - 注册一个通知事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_request(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None)` - - -* **说明** - - 注册一个请求事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_startswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容开头时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息开头内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_endswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容结尾时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息结尾内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_keyword(keywords, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。 - - - -* **参数** - - - * `keywords: Set[str]`: 关键词列表 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_command(cmd, rule=None, aliases=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息以指定命令开头时响应。 - - 命令匹配规则参考: [命令形式匹配](rule.html#command-command) - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_regex(pattern, flags=0, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息匹配正则表达式时响应。 - - 命令匹配规则参考: [正则匹配](rule.html#regex-regex-flags-0) - - - -* **参数** - - - * `pattern: str`: 正则表达式 - - - * `flags: Union[int, re.RegexFlag]`: 正则匹配标志 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## _class_ `CommandGroup` - -基类：`object` - -命令组，用于声明一组有相同名称前缀的命令。 - - -### `__init__(cmd, **kwargs)` - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 命令前缀 - - - * `**kwargs`: 其他传递给 `on_command` 的参数默认值，参考 [on_command](#on-command-cmd-rule-none-aliases-none-kwargs) - - - -### `basecmd` - - -* **类型**: `Tuple[str, ...]` - - -* **说明**: 命令前缀 - - -### `base_kwargs` - - -* **类型**: `Dict[str, Any]` - - -* **说明**: 其他传递给 `on_command` 的参数默认值 - - -### `command(cmd, **kwargs)` - - -* **说明** - - 注册一个新的命令。 - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 命令前缀 - - - * `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值 - - - -* **返回** - - - * `Type[Matcher]` - - - -## _class_ `MatcherGroup` - -基类：`object` - -事件响应器组合，统一管理。为 `Matcher` 创建提供默认属性。 - - -### `__init__(**kwargs)` - - -* **说明** - - 创建一个事件响应器组合，参数为默认值，与 `on` 一致 - - - -### `matchers` - - -* **类型** - - `List[Type[Matcher]]` - - - -* **说明** - - 组内事件响应器列表 - - - -### `base_kwargs` - - -* **类型**: `Dict[str, Any]` - - -* **说明**: 其他传递给 `on` 的参数默认值 - - -### `on(**kwargs)` - - -* **说明** - - 注册一个基础事件响应器，可自定义类型。 - - - -* **参数** - - - * `type: str`: 事件响应器类型 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_metaevent(**kwargs)` - - -* **说明** - - 注册一个元事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_message(**kwargs)` - - -* **说明** - - 注册一个消息事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_notice(**kwargs)` - - -* **说明** - - 注册一个通知事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_request(**kwargs)` - - -* **说明** - - 注册一个请求事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_startswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容开头时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息开头内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_endswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容结尾时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息结尾内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_keyword(keywords, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。 - - - -* **参数** - - - * `keywords: Set[str]`: 关键词列表 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_command(cmd, rule=None, aliases=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息以指定命令开头时响应。 - - 命令匹配规则参考: [命令形式匹配](rule.html#command-command) - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_regex(pattern, flags=0, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息匹配正则表达式时响应。 - - 命令匹配规则参考: [正则匹配](rule.html#regex-regex-flags-0) - - - -* **参数** - - - * `pattern: str`: 正则表达式 - - - * `flags: Union[int, re.RegexFlag]`: 正则匹配标志 - - - * `rule: Optional[Union[Rule, RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[dict]`: 默认的 state - - - -* **返回** - - - * `Type[Matcher]` - - - -## `load_plugin(module_path)` - - -* **说明** - - 使用 `importlib` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。 - - - -* **参数** - - - * `module_path: str`: 插件名称 `path.to.your.plugin` - - - -* **返回** - - - * `Optional[Plugin]` - - - -## `load_plugins(*plugin_dir)` - - -* **说明** - - 导入目录下多个插件，以 `_` 开头的插件不会被导入！ - - - -* **参数** - - - * `*plugin_dir: str`: 插件路径 - - - -* **返回** - - - * `Set[Plugin]` - - - -## `load_builtin_plugins()` - - -* **说明** - - 导入 NoneBot 内置插件 - - - -* **返回** - - - * `Plugin` - - - -## `get_plugin(name)` - - -* **说明** - - 获取当前导入的某个插件。 - - - -* **参数** - - - * `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。 - - - -* **返回** - - - * `Optional[Plugin]` - - - -## `get_loaded_plugins()` - - -* **说明** - - 获取当前已导入的所有插件。 - - - -* **返回** - - - * `Set[Plugin]` - - - -## `export()` - - -* **说明** - - 获取插件的导出内容对象 - - - -* **返回** - - - * `Export` - - - -## `require(name)` - - -* **说明** - - 获取一个插件的导出内容 - - - -* **参数** - - - * `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。 - - - -* **返回** - - - * `Optional[Export]` diff --git a/archive/2.0.0a7/api/rule.md b/archive/2.0.0a7/api/rule.md deleted file mode 100644 index dade2a5b..00000000 --- a/archive/2.0.0a7/api/rule.md +++ /dev/null @@ -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` 判断消息是否是发送给机器人 - - - -* **参数** - - - * 无 diff --git a/archive/2.0.0a7/api/typing.md b/archive/2.0.0a7/api/typing.md deleted file mode 100644 index 8f8a2223..00000000 --- a/archive/2.0.0a7/api/typing.md +++ /dev/null @@ -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 获取参数时被运行。 diff --git a/archive/2.0.0a7/api/utils.md b/archive/2.0.0a7/api/utils.md deleted file mode 100644 index 52cf5766..00000000 --- a/archive/2.0.0a7/api/utils.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.utils 模块 - - -## `escape_tag(s)` - - -* **说明** - - 用于记录带颜色日志时转义 `` 类型特殊标签 - - - -* **参数** - - - * `s: str`: 需要转义的字符串 - - - -* **返回** - - - * `str` - - - -## `run_sync(func)` - - -* **说明** - - 一个用于包装 sync function 为 async function 的装饰器 - - - -* **参数** - - - * `func: Callable[..., Any]`: 被装饰的同步函数 - - - -* **返回** - - - * `Callable[..., Awaitable[Any]]` - - - -## _class_ `DataclassEncoder` - - -* **说明** - - 在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder` diff --git a/archive/2.0.0a7/guide/README.md b/archive/2.0.0a7/guide/README.md deleted file mode 100644 index 4326ac1b..00000000 --- a/archive/2.0.0a7/guide/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 概览 - - - -:::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 通信方式 -- 支持多个机器人账号负载均衡 -- 提供直观的交互式会话接口 -- 提供可自定义的权限控制机制 -- 多种方式渲染要发送的消息内容，使对话足够自然 diff --git a/archive/2.0.0a7/guide/basic-configuration.md b/archive/2.0.0a7/guide/basic-configuration.md deleted file mode 100644 index e4c4449f..00000000 --- a/archive/2.0.0a7/guide/basic-configuration.md +++ /dev/null @@ -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` diff --git a/archive/2.0.0a7/guide/creating-a-handler.md b/archive/2.0.0a7/guide/creating-a-handler.md deleted file mode 100644 index ca65b1a6..00000000 --- a/archive/2.0.0a7/guide/creating-a-handler.md +++ /dev/null @@ -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") -``` diff --git a/archive/2.0.0a7/guide/creating-a-matcher.md b/archive/2.0.0a7/guide/creating-a-matcher.md deleted file mode 100644 index b603449a..00000000 --- a/archive/2.0.0a7/guide/creating-a-matcher.md +++ /dev/null @@ -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 -::: diff --git a/archive/2.0.0a7/guide/creating-a-plugin.md b/archive/2.0.0a7/guide/creating-a-plugin.md deleted file mode 100644 index 0a6678db..00000000 --- a/archive/2.0.0a7/guide/creating-a-plugin.md +++ /dev/null @@ -1,119 +0,0 @@ -# 创建插件 - -如果之前使用 `nb-cli` 生成了项目结构，那我们已经有了一个空的插件目录 `Awesome-Bot/awesome_bot/plugins`，并且它已在 `bot.py` 中被加载，我们现在可以开始创建插件了！ - -使用 `nb-cli` 创建包形式插件，或自行创建文件(夹) - -```bash -nb plugin new -``` - -插件通常有两种形式，下面分别介绍 - -## 单文件形式 - -在插件目录下创建名为 `foo.py` 的 Python 文件，暂时留空，此时目录结构如下： - - -:::vue -AweSome-Bot -├── awesome_bot -│ └── plugins -│ └── `foo.py` -├── .env -├── .env.dev -├── .env.prod -├── .gitignore -├── bot.py -├── docker-compose.yml -├── Dockerfile -├── pyproject.toml -└── README.md -::: - - -这个时候它已经可以被称为一个插件了，尽管它还什么都没做。 - -## 包形式(推荐) - -在插件目录下创建文件夹 `foo`，并在该文件夹下创建文件 `__init__.py`，此时目录结构如下： - - -:::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 -::: - - -这个时候 `foo` 就是一个合法的 Python 包了，同时也是合法的 NoneBot 插件，插件内容可以在 `__init__.py` 中编写。 - -### 推荐结构(仅供参考) - - -:::vue -foo -├── `__init__.py` -├── `config.py` -├── `data_source.py` -└── `model.py` -::: - - -#### \_\_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 - -在该文件中编写数据库模型。 diff --git a/archive/2.0.0a7/guide/creating-a-project.md b/archive/2.0.0a7/guide/creating-a-project.md deleted file mode 100644 index b8ac3b77..00000000 --- a/archive/2.0.0a7/guide/creating-a-project.md +++ /dev/null @@ -1,51 +0,0 @@ -# 创建一个完整的项目 - -上一章中我们已经运行了一个最小的 NoneBot 实例，在这一章，我们将从零开始一个完整的项目。 - -## 目录结构 - -首先，我们可以使用 `nb-cli` 或者自行创建完整的项目目录： - -```bash -nb create -``` - - -:::vue -AweSome-Bot -├── `awesome_bot` _(**或是 src**)_ -│ └── `plugins` -├── `.env` _(**可选的**)_ -├── `.env.dev` _(**可选的**)_ -├── `.env.prod` _(**可选的**)_ -├── .gitignore -├── `bot.py` -├── docker-compose.yml -├── Dockerfile -├── `pyproject.toml` -└── README.md -::: - - -- `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` 将会为你启动**冷重载模式** -::: diff --git a/archive/2.0.0a7/guide/end-or-start.md b/archive/2.0.0a7/guide/end-or-start.md deleted file mode 100644 index 11780114..00000000 --- a/archive/2.0.0a7/guide/end-or-start.md +++ /dev/null @@ -1,9 +0,0 @@ -# 结语 - -至此，相信你已经能够写出一个基础的插件了，更多的用法将会在 进阶 部分进行介绍，这里给出几个小提示： - -- 请千万注意事件处理器的优先级设定 -- 在匹配规则中请勿使用耗时极长的函数 -- 同一个用户可以**跨群**(**私聊**)继续他的事件处理（除非做出权限限制，将在后续介绍） - -如果你还不能满足，前往 [进阶](../advanced/README.md) 获得更多的功能信息。 diff --git a/archive/2.0.0a7/guide/getting-started.md b/archive/2.0.0a7/guide/getting-started.md deleted file mode 100644 index 8ed182eb..00000000 --- a/archive/2.0.0a7/guide/getting-started.md +++ /dev/null @@ -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 机器人的创意之旅！ - - - - diff --git a/archive/2.0.0a7/guide/installation.md b/archive/2.0.0a7/guide/installation.md deleted file mode 100644 index b7259254..00000000 --- a/archive/2.0.0a7/guide/installation.md +++ /dev/null @@ -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: [![nb-cli](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2) - - nb-cli: [![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](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) 等着你发现～ diff --git a/archive/2.0.0a7/guide/loading-a-plugin.md b/archive/2.0.0a7/guide/loading-a-plugin.md deleted file mode 100644 index e69c52a8..00000000 --- a/archive/2.0.0a7/guide/loading-a-plugin.md +++ /dev/null @@ -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() -``` - -## 子插件(嵌套插件) - -在插件中同样可以加载子插件，例如如下插件目录结构： - - -:::vue -foo_plugin -├── `plugins` -│ ├── `sub_plugin1` -│ │ └── \_\_init\_\_.py -│ └── `sub_plugin2.py` -├── `__init__.py` -└── config.py -::: - - -在插件目录下的 `__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" -``` diff --git a/archive/2.0.0a7/sidebar.config.json b/archive/2.0.0a7/sidebar.config.json deleted file mode 100644 index 1e615846..00000000 --- a/archive/2.0.0a7/sidebar.config.json +++ /dev/null @@ -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" - } - ] - } - ] - } - } - } -} diff --git a/archive/2.0.0a8.post2/README.md b/archive/2.0.0a8.post2/README.md deleted file mode 100644 index 78cb0fc4..00000000 --- a/archive/2.0.0a8.post2/README.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -home: true -heroImage: /logo.png -tagline: An asynchronous bot framework. -actionText: 开始使用 -actionLink: guide/ -features: - - title: 简洁 - details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。 - - title: 易于扩展 - details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。 - - title: 高性能 - details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。 -footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team ---- diff --git a/archive/2.0.0a8.post2/advanced/README.md b/archive/2.0.0a8.post2/advanced/README.md deleted file mode 100644 index 92c6af3e..00000000 --- a/archive/2.0.0a8.post2/advanced/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# 深入 - -## 它如何工作？ - - - -~~未填坑~~ diff --git a/archive/2.0.0a8.post2/advanced/export-and-require.md b/archive/2.0.0a8.post2/advanced/export-and-require.md deleted file mode 100644 index 832b0e75..00000000 --- a/archive/2.0.0a8.post2/advanced/export-and-require.md +++ /dev/null @@ -1 +0,0 @@ -# 跨插件访问 diff --git a/archive/2.0.0a8.post2/advanced/overloaded-handlers.md b/archive/2.0.0a8.post2/advanced/overloaded-handlers.md deleted file mode 100644 index 97ff3116..00000000 --- a/archive/2.0.0a8.post2/advanced/overloaded-handlers.md +++ /dev/null @@ -1 +0,0 @@ -# 事件处理函数重载 diff --git a/archive/2.0.0a8.post2/advanced/permission.md b/archive/2.0.0a8.post2/advanced/permission.md deleted file mode 100644 index 7190bcdd..00000000 --- a/archive/2.0.0a8.post2/advanced/permission.md +++ /dev/null @@ -1 +0,0 @@ -# 权限控制 diff --git a/archive/2.0.0a8.post2/advanced/publish-plugin.md b/archive/2.0.0a8.post2/advanced/publish-plugin.md deleted file mode 100644 index 68e2e6f9..00000000 --- a/archive/2.0.0a8.post2/advanced/publish-plugin.md +++ /dev/null @@ -1 +0,0 @@ -# 发布插件 diff --git a/archive/2.0.0a8.post2/advanced/runtime-hook.md b/archive/2.0.0a8.post2/advanced/runtime-hook.md deleted file mode 100644 index 58bca681..00000000 --- a/archive/2.0.0a8.post2/advanced/runtime-hook.md +++ /dev/null @@ -1 +0,0 @@ -# 运行时插槽 diff --git a/archive/2.0.0a8.post2/advanced/scheduler.md b/archive/2.0.0a8.post2/advanced/scheduler.md deleted file mode 100644 index 4071a093..00000000 --- a/archive/2.0.0a8.post2/advanced/scheduler.md +++ /dev/null @@ -1,135 +0,0 @@ -# 定时任务 - -[`APScheduler`](https://apscheduler.readthedocs.io/en/latest/index.html) —— 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. - -## 从 v1 迁移 - -`APScheduler` 作为 `nonebot` v1 的可选依赖，为众多 bot 提供了方便的定时任务功能。`nonebot2` 已将 `APScheduler` 独立为 `nonebot_plugin_apscheduler` 插件，你可以在 [插件广场](https://v2.nonebot.dev/store.html) 中找到它。 - -相比于 `nonebot` v1 ，只需要安装插件并修改 `scheduler` 的导入方式即可完成迁移。 - -## 安装插件 - -### 通过 nb-cli - -如正在使用 `nb-cli` 构建项目，你可以从插件市场复制安装命令或手动输入以下命令以添加 `nonebot_plugin_apscheduler`。 - -```bash -nb plugin install nonebot_plugin_apscheduler -``` - -:::tip 提示 -`nb-cli` 默认通过 `pypi` 安装，你可以使用 `-i [mirror]` 或 `--index [mirror]` 来使用镜像源安装。 -::: - -### 通过 poetry - -执行以下命令以添加 `nonebot_plugin_apscheduler` - -```bash -poetry add nonebot-plugin-apscheduler -``` - -:::tip 提示 -由于稍后我们将使用 `nonebot.require()` 方法进行导入，所以无需额外的 `nonebot.load_plugin()` -::: - -## 快速上手 - -1. 在需要设置定时任务的插件中，通过 `nonebot.require` 从 `nonebot_plugin_apscheduler` 导入 `scheduler` 对象 - -2. 在该对象的基础上，根据 `APScheduler` 的使用方法进一步配置定时任务 - -将上述步骤归纳为最小实现的代码如下： - -```python -from nonebot import require - -scheduler = require('nonebot_plugin_apscheduler').scheduler - -@scheduler.scheduled_job('cron', hour='*/2', id='xxx', args=[1], kwargs={arg2: 2}) -async def run_every_2_hour(arg1, arg2): - pass - -scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx") -``` - -## 分步进行 - -### 导入 scheduler 对象 - -为了使插件能够实现定时任务，需要先将 `scheduler` 对象导入插件。 - -`nonebot2` 提供了 `nonebot.require` 方法来实现导入其他插件的内容，此处我们使用这个方法来导入 `scheduler` 对象。 - -`nonebot` 使用的 `scheduler` 对象为 `AsyncScheduler` 。 - -> 使用该方法传入的插件本身也需要有对应实现，关于该方法的更多介绍可以参阅 [这里](./export-and-require.md) - -```python -from nonebot import require - -scheduler = require('nonebot_plugin_apscheduler').scheduler -``` - -### 编写定时任务 - -由于本部分为标准的通过 `APScheduler` 配置定时任务，有关指南请参阅 [APScheduler 官方文档](https://apscheduler.readthedocs.io/en/latest/userguide.html#adding-jobs)。 - -### 配置插件选项 - -根据项目的 `.env` 文件设置，向 `.env.*` 或 `bot.py` 文件添加 `nonebot_plugin_apscheduler` 的可选配置项 - -:::warning 注意 -`.env.*` 文件的编写应遵循 nonebot2 对 `.env.*` 文件的编写要求 -::: - -#### `apscheduler_autostart` - -类型：`bool` - -默认值：`True` - -是否自动启动 `APScheduler`。 - -对于大多数情况，我们需要在 `nonebot2` 项目被启动时启动定时任务，则此处设为 `true` - -### 在 `.env` 中添加 - -```bash -APSCHEDULER_AUTOSTART=true -``` - -### 在 `bot.py` 中添加 - -```python -nonebot.init(apscheduler_autostart=True) -``` - -#### `apscheduler_config` - -类型：`dict` - -默认值：`{"apscheduler.timezone": "Asia/Shanghai"}` - -`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) - -> 官方文档在绝大多数时候能提供最准确和最具时效性的指南 - -### 在 `.env` 中添加 - -```bash -APSCHEDULER_CONFIG={"apscheduler.timezone": "Asia/Shanghai"} -``` - -### 在 `bot.py` 中添加 - -```python -nonebot.init(apscheduler_config={ - "apscheduler.timezone": "Asia/Shanghai" -}) -``` diff --git a/archive/2.0.0a8.post2/api/README.md b/archive/2.0.0a8.post2/api/README.md deleted file mode 100644 index 243733f8..00000000 --- a/archive/2.0.0a8.post2/api/README.md +++ /dev/null @@ -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) diff --git a/archive/2.0.0a8.post2/api/adapters/README.md b/archive/2.0.0a8.post2/api/adapters/README.md deleted file mode 100644 index 96638ad5..00000000 --- a/archive/2.0.0a8.post2/api/adapters/README.md +++ /dev/null @@ -1,423 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.adapters 模块 - -## 协议适配基类 - -各协议请继承以下基类，并使用 `driver.register_adapter` 注册适配器 - - -## _class_ `Bot` - -基类：`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_ `MessageSegment` - -基类：`abc.ABC` - -消息段基类 - - -### `type` - - -* 类型: `str` - - -* 说明: 消息段类型 - - -### `data` - - -* 类型: `Dict[str, Union[str, list]]` - - -* 说明: 消息段数据 - - -## _class_ `Message` - -基类：`list`, `abc.ABC` - -消息数组 - - -### `__init__(message=None, *args, **kwargs)` - - -* **参数** - - - * `message: Union[str, list, dict, MessageSegment, Message, Any]`: 消息内容 - - - -### `append(obj)` - - -* **说明** - - 添加一个消息段到消息数组末尾 - - - -* **参数** - - - * `obj: Union[str, MessageSegment]`: 要添加的消息段 - - - -### `extend(obj)` - - -* **说明** - - 拼接一个消息数组或多个消息段到消息数组末尾 - - - -* **参数** - - - * `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组 - - - -### `reduce()` - - -* **说明** - - 缩减消息数组，即按 MessageSegment 的实现拼接相邻消息段 - - - -### `extract_plain_text()` - - -* **说明** - - 提取消息内纯文本消息 - - - -## _class_ `Event` - -基类：`abc.ABC`, `pydantic.main.BaseModel` - -Event 基类。提供获取关键信息的方法，其余信息可直接获取。 - - -### _abstract_ `get_type()` - - -* **说明** - - 获取事件类型的方法，类型通常为 NoneBot 内置的四种类型。 - - - -* **返回** - - - * `Literal["message", "notice", "request", "meta_event"]` - - - -### _abstract_ `get_event_name()` - - -* **说明** - - 获取事件名称的方法。 - - - -* **返回** - - - * `str` - - - -### _abstract_ `get_event_description()` - - -* **说明** - - 获取事件描述的方法，通常为事件具体内容。 - - - -* **返回** - - - * `str` - - - -### `get_log_string()` - - -* **说明** - - 获取事件日志信息的方法，通常你不需要修改这个方法，只有当希望 NoneBot 隐藏该事件日志时，可以抛出 `NoLogException` 异常。 - - - -* **返回** - - - * `str` - - - -* **异常** - - - * `NoLogException` - - - -### _abstract_ `get_user_id()` - - -* **说明** - - 获取事件主体 id 的方法，通常是用户 id 。 - - - -* **返回** - - - * `str` - - - -### _abstract_ `get_session_id()` - - -* **说明** - - 获取会话 id 的方法，用于判断当前事件属于哪一个会话，通常是用户 id、群组 id 组合。 - - - -* **返回** - - - * `str` - - - -### _abstract_ `get_message()` - - -* **说明** - - 获取事件消息内容的方法。 - - - -* **返回** - - - * `Message` - - - -### `get_plaintext()` - - -* **说明** - - 获取消息纯文本的方法，通常不需要修改，默认通过 `get_message().extract_plain_text` 获取。 - - - -* **返回** - - - * `str` - - - -### _abstract_ `is_tome()` - - -* **说明** - - 获取事件是否与机器人有关的方法。 - - - -* **返回** - - - * `bool` diff --git a/archive/2.0.0a8.post2/api/adapters/cqhttp.md b/archive/2.0.0a8.post2/api/adapters/cqhttp.md deleted file mode 100644 index ca5d91cb..00000000 --- a/archive/2.0.0a8.post2/api/adapters/cqhttp.md +++ /dev/null @@ -1,564 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.adapters.cqhttp 模块 - -## CQHTTP (OneBot) v11 协议适配 - -协议详情请看: [CQHTTP](https://github.com/howmanybots/onebot/blob/master/README.md) | [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md) - -# NoneBot.adapters.cqhttp.utils 模块 - - -## `escape(s, *, escape_comma=True)` - - -* **说明** - - 对字符串进行 CQ 码转义。 - - - -* **参数** - - - * `s: str`: 需要转义的字符串 - - - * `escape_comma: bool`: 是否转义逗号（`,`）。 - - - -## `unescape(s)` - - -* **说明** - - 对字符串进行 CQ 码去转义。 - - - -* **参数** - - - * `s: str`: 需要转义的字符串 - - -# NoneBot.adapters.cqhttp.exception 模块 - - -## _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]`: 错误码 - - -# NoneBot.adapters.cqhttp.bot 模块 - - -## _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.Bot`](README.md#nonebot.adapters.Bot) - -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 调用失败 - - -# NoneBot.adapters.cqhttp.message 模块 - - -## _class_ `MessageSegment` - -基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment) - -CQHTTP 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。 - - -## _class_ `Message` - -基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message) - -CQHTTP 协议 Message 适配。 - -# NoneBot.adapters.cqhttp.permission 模块 - - -## `PRIVATE` - - -* **说明**: 匹配任意私聊消息类型事件 - - -## `PRIVATE_FRIEND` - - -* **说明**: 匹配任意好友私聊消息类型事件 - - -## `PRIVATE_GROUP` - - -* **说明**: 匹配任意群临时私聊消息类型事件 - - -## `PRIVATE_OTHER` - - -* **说明**: 匹配任意其他私聊消息类型事件 - - -## `GROUP` - - -* **说明**: 匹配任意群聊消息类型事件 - - -## `GROUP_MEMBER` - - -* **说明**: 匹配任意群员群聊消息类型事件 - -:::warning 警告 -该权限通过 event.sender 进行判断且不包含管理员以及群主！ -::: - - -## `GROUP_ADMIN` - - -* **说明**: 匹配任意群管理员群聊消息类型事件 - - -## `GROUP_OWNER` - - -* **说明**: 匹配任意群主群聊消息类型事件 - -# NoneBot.adapters.cqhttp.event 模块 - - -## _class_ `Event` - -基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event) - -CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 [CQHTTP 文档](https://github.com/howmanybots/onebot/blob/master/README.md) - - -## _class_ `MessageEvent` - -基类：`nonebot.adapters.cqhttp.event.Event` - -消息事件 - - -### `to_me` - - -* **说明** - - 消息是否与机器人有关 - - - -* **类型** - - `bool` - - - -### `reply` - - -* **说明** - - 消息中提取的回复消息，内容为 `get_msg` API 返回结果 - - - -* **类型** - - `Optional[Reply]` - - - -## _class_ `PrivateMessageEvent` - -基类：`nonebot.adapters.cqhttp.event.MessageEvent` - -私聊消息 - - -## _class_ `GroupMessageEvent` - -基类：`nonebot.adapters.cqhttp.event.MessageEvent` - -群消息 - - -## _class_ `NoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.Event` - -通知事件 - - -## _class_ `GroupUploadNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群文件上传事件 - - -## _class_ `GroupAdminNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群管理员变动 - - -## _class_ `GroupDecreaseNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群成员减少事件 - - -## _class_ `GroupIncreaseNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群成员增加事件 - - -## _class_ `GroupBanNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群禁言事件 - - -## _class_ `FriendAddNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -好友添加事件 - - -## _class_ `GroupRecallNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -群消息撤回事件 - - -## _class_ `FriendRecallNoticeEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -好友消息撤回事件 - - -## _class_ `NotifyEvent` - -基类：`nonebot.adapters.cqhttp.event.NoticeEvent` - -提醒事件 - - -## _class_ `PokeNotifyEvent` - -基类：`nonebot.adapters.cqhttp.event.NotifyEvent` - -戳一戳提醒事件 - - -## _class_ `LuckyKingNotifyEvent` - -基类：`nonebot.adapters.cqhttp.event.NotifyEvent` - -群红包运气王提醒事件 - - -## _class_ `HonorNotifyEvent` - -基类：`nonebot.adapters.cqhttp.event.NotifyEvent` - -群荣誉变更提醒事件 - - -## _class_ `RequestEvent` - -基类：`nonebot.adapters.cqhttp.event.Event` - -请求事件 - - -## _class_ `FriendRequestEvent` - -基类：`nonebot.adapters.cqhttp.event.RequestEvent` - -加好友请求事件 - - -## _class_ `GroupRequestEvent` - -基类：`nonebot.adapters.cqhttp.event.RequestEvent` - -加群请求/邀请事件 - - -## _class_ `MetaEvent` - -基类：`nonebot.adapters.cqhttp.event.Event` - -元事件 - - -## _class_ `LifecycleMetaEvent` - -基类：`nonebot.adapters.cqhttp.event.MetaEvent` - -生命周期元事件 - - -## _class_ `HeartbeatMetaEvent` - -基类：`nonebot.adapters.cqhttp.event.MetaEvent` - -心跳元事件 - - -## `get_event_model(event_name)` - - -* **说明** - - 根据事件名获取对应 `Event Model` 及 `FallBack Event Model` 列表 - - - -* **返回** - - - * `List[Type[Event]]` diff --git a/archive/2.0.0a8.post2/api/adapters/ding.md b/archive/2.0.0a8.post2/api/adapters/ding.md deleted file mode 100644 index 32fbb891..00000000 --- a/archive/2.0.0a8.post2/api/adapters/ding.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.adapters.ding 模块 - -## 钉钉群机器人 协议适配 - -协议详情请看: [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p) - -# NoneBot.adapters.ding.exception 模块 - - -## _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_ `NetworkError` - -基类：[`nonebot.exception.NetworkError`](../exception.md#nonebot.exception.NetworkError), `nonebot.adapters.ding.exception.DingAdapterException` - - -* **说明** - - 网络错误。 - - - -* **参数** - - - * `retcode: Optional[int]`: 错误码 - - - -## _exception_ `SessionExpired` - -基类：`nonebot.adapters.ding.exception.ApiNotAvailable`, `nonebot.adapters.ding.exception.DingAdapterException` - - -* **说明** - - 发消息的 session 已经过期。 - - -# NoneBot.adapters.ding.bot 模块 - - -## _class_ `Bot` - -基类：[`nonebot.adapters.Bot`](README.md#nonebot.adapters.Bot) - -钉钉 协议 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_ `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 调用失败 - - -# NoneBot.adapters.ding.message 模块 - - -## _class_ `MessageSegment` - -基类：[`nonebot.adapters.MessageSegment`](README.md#nonebot.adapters.MessageSegment) - -钉钉 协议 MessageSegment 适配。具体方法参考协议消息段类型或源码。 - - -### _static_ `atAll()` - -@全体 - - -### _static_ `atMobiles(*mobileNumber)` - -@指定手机号人员 - - -### _static_ `text(text)` - -发送 `text` 类型消息 - - -### _static_ `image(picURL)` - -发送 `image` 类型消息 - - -### _static_ `extension(dict_)` - -"标记 text 文本的 extension 属性，需要与 text 消息段相加。 - - -### _static_ `markdown(title, text)` - -发送 `markdown` 类型消息 - - -### _static_ `actionCardSingleBtn(title, text, singleTitle, singleURL)` - -发送 `actionCardSingleBtn` 类型消息 - - -### _static_ `actionCardMultiBtns(title, text, btns, hideAvatar=False, btnOrientation='1')` - -发送 `actionCardMultiBtn` 类型消息 - - -* **参数** - - - * `btnOrientation`: 0：按钮竖直排列 1：按钮横向排列 - - - * `btns`: [{ "title": title, "actionURL": actionURL }, ...] - - - -### _static_ `feedCard(links)` - -发送 `feedCard` 类型消息 - - -* **参数** - - - * `links`: [{ "title": xxx, "messageURL": xxx, "picURL": xxx }, ...] - - - -## _class_ `Message` - -基类：[`nonebot.adapters.Message`](README.md#nonebot.adapters.Message) - -钉钉 协议 Message 适配。 - -# NoneBot.adapters.ding.event 模块 - - -## _class_ `Event` - -基类：[`nonebot.adapters.Event`](README.md#nonebot.adapters.Event) - -钉钉协议事件。各事件字段参考 [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p) - - -## _class_ `ConversationType` - -基类：`str`, `enum.Enum` - -An enumeration. - - -## _class_ `MessageEvent` - -基类：`nonebot.adapters.ding.event.Event` - -消息事件 - - -## _class_ `PrivateMessageEvent` - -基类：`nonebot.adapters.ding.event.MessageEvent` - -私聊消息事件 - - -## _class_ `GroupMessageEvent` - -基类：`nonebot.adapters.ding.event.MessageEvent` - -群消息事件 diff --git a/archive/2.0.0a8.post2/api/config.md b/archive/2.0.0a8.post2/api/config.md deleted file mode 100644 index 2e7c6a4d..00000000 --- a/archive/2.0.0a8.post2/api/config.md +++ /dev/null @@ -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[str]` - - -* **默认值**: `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 -``` diff --git a/archive/2.0.0a8.post2/api/drivers/README.md b/archive/2.0.0a8.post2/api/drivers/README.md deleted file mode 100644 index 313717cb..00000000 --- a/archive/2.0.0a8.post2/api/drivers/README.md +++ /dev/null @@ -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 - - - -### _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)` - -注册一个在驱动停止时运行的函数 - - -### `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 信息 diff --git a/archive/2.0.0a8.post2/api/drivers/fastapi.md b/archive/2.0.0a8.post2/api/drivers/fastapi.md deleted file mode 100644 index edd8e474..00000000 --- a/archive/2.0.0a8.post2/api/drivers/fastapi.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.drivers.fastapi 模块 - -## FastAPI 驱动适配 - -后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/) - - -## _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 diff --git a/archive/2.0.0a8.post2/api/exception.md b/archive/2.0.0a8.post2/api/exception.md deleted file mode 100644 index ac2d28b2..00000000 --- a/archive/2.0.0a8.post2/api/exception.md +++ /dev/null @@ -1,193 +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_ `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 操作失败。 diff --git a/archive/2.0.0a8.post2/api/log.md b/archive/2.0.0a8.post2/api/log.md deleted file mode 100644 index e6096cff..00000000 --- a/archive/2.0.0a8.post2/api/log.md +++ /dev/null @@ -1,42 +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 -``` diff --git a/archive/2.0.0a8.post2/api/matcher.md b/archive/2.0.0a8.post2/api/matcher.md deleted file mode 100644 index 22eabc3b..00000000 --- a/archive/2.0.0a8.post2/api/matcher.md +++ /dev/null @@ -1,470 +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` - - -* **类型** - - `T_State` - - - -* **说明** - - 事件响应器默认状态 - - - -### `_default_state_factory` - - -* **类型** - - `Optional[T_State]` - - - -* **说明** - - 事件响应器默认工厂函数 - - - -### `_default_parser` - - -* **类型** - - `Optional[T_ArgsParser]` - - - -* **说明** - - 事件响应器默认参数解析函数 - - - -### `__init__()` - -实例化 Matcher 以便运行 - - -### `handlers` - - -* **类型** - - `List[T_Handler]` - - - -* **说明** - - 事件响应器拥有的事件处理函数列表 - - - -### _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)` - - -* **说明** - - 创建一个新的事件响应器，并存储至 [matchers](#matchers) - - - -* **参数** - - - * `type_: str`: 事件响应器类型，与 `event.get_type()` 一致时触发，空字符串表示任意 - - - * `rule: Optional[Rule]`: 匹配规则 - - - * `permission: Optional[Permission]`: 权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器，即触发一次后删除 - - - * `priority: int`: 响应优先级 - - - * `block: bool`: 是否阻止事件向更低优先级的响应器传播 - - - * `module: Optional[str]`: 事件响应器所在模块名称 - - - * `default_state: Optional[T_State]`: 默认状态 `state` - - - * `default_state_factory: Optional[T_StateFactory]`: 默认状态 `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: T_State`: 当前状态 - - - -* **返回** - - - * `bool`: 是否满足匹配规则 - - - -### _classmethod_ `args_parser(func)` - - -* **说明** - - 装饰一个函数来更改当前事件响应器的默认参数解析函数 - - - -* **参数** - - - * `func: T_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[T_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 diff --git a/archive/2.0.0a8.post2/api/message.md b/archive/2.0.0a8.post2/api/message.md deleted file mode 100644 index 5bd6c332..00000000 --- a/archive/2.0.0a8.post2/api/message.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.message 模块 - -## 事件处理 - -NoneBot 内部处理并按优先级分发事件给所有事件响应器，提供了多个插槽以进行事件的预处理等。 - - -## `event_preprocessor(func)` - - -* **说明** - - 事件预处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之前执行。 - - - -* **参数** - - 事件预处理函数接收三个参数。 - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - * `state: T_State`: 当前 State - - - -## `event_postprocessor(func)` - - -* **说明** - - 事件后处理。装饰一个函数，使它在每次接收到事件并分发给各响应器之后执行。 - - - -* **参数** - - 事件后处理函数接收三个参数。 - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - * `state: T_State`: 当前事件运行前 State - - - -## `run_preprocessor(func)` - - -* **说明** - - 运行预处理。装饰一个函数，使它在每次事件响应器运行前执行。 - - - -* **参数** - - 运行预处理函数接收四个参数。 - - - * `matcher: Matcher`: 当前要运行的事件响应器 - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - * `state: T_State`: 当前 State - - - -## `run_postprocessor(func)` - - -* **说明** - - 运行后处理。装饰一个函数，使它在每次事件响应器运行后执行。 - - - -* **参数** - - 运行后处理函数接收五个参数。 - - - * `matcher: Matcher`: 运行完毕的事件响应器 - - - * `exception: Optional[Exception]`: 事件响应器运行错误（如果存在） - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - * `state: T_State`: 当前 State - - - -## _async_ `handle_event(bot, event)` - - -* **说明** - - 处理一个事件。调用该函数以实现分发事件。 - - - -* **参数** - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - -* **示例** - - -```python -import asyncio -asyncio.create_task(handle_event(bot, event)) -``` diff --git a/archive/2.0.0a8.post2/api/nonebot.md b/archive/2.0.0a8.post2/api/nonebot.md deleted file mode 100644 index d2ef4eb4..00000000 --- a/archive/2.0.0a8.post2/api/nonebot.md +++ /dev/null @@ -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) -``` diff --git a/archive/2.0.0a8.post2/api/permission.md b/archive/2.0.0a8.post2/api/permission.md deleted file mode 100644 index 1c42b2c8..00000000 --- a/archive/2.0.0a8.post2/api/permission.md +++ /dev/null @@ -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=)` - - -* **说明** - - 在白名单内且满足 perm - - - -* **参数** - - - * `*user: str`: 白名单 - - - * `perm: Permission`: 需要同时满足的权限 - - - -## `SUPERUSER` - - -* **说明**: 匹配任意超级用户消息类型事件 diff --git a/archive/2.0.0a8.post2/api/plugin.md b/archive/2.0.0a8.post2/api/plugin.md deleted file mode 100644 index 91e3e763..00000000 --- a/archive/2.0.0a8.post2/api/plugin.md +++ /dev/null @@ -1,1261 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.plugin 模块 - -## 插件 - -为 NoneBot 插件开发提供便携的定义函数。 - - -## `plugins` - - -* **类型** - - `Dict[str, Plugin]` - - - -* **说明** - - 已加载的插件 - - - -## _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` - -基类：`object` - -存储插件信息 - - -### `name` - - -* **类型**: `str` - - -* **说明**: 插件名称，使用 文件/文件夹 名称作为插件名 - - -### `module` - - -* **类型**: `ModuleType` - - -* **说明**: 插件模块对象 - - -### `matcher` - - -* **类型**: `Set[Type[Matcher]]` - - -* **说明**: 插件内定义的 `Matcher` - - -### `export` - - -* **类型**: `Export` - - -* **说明**: 插件内定义的导出内容 - - -## `on(type='', rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个基础事件响应器，可自定义类型。 - - - -* **参数** - - - * `type: str`: 事件响应器类型 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_metaevent(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个元事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_message(rule=None, permission=None, *, handlers=None, temp=False, priority=1, block=True, state=None, state_factory=None)` - - -* **说明** - - 注册一个消息事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_notice(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个通知事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_request(rule=None, *, handlers=None, temp=False, priority=1, block=False, state=None, state_factory=None)` - - -* **说明** - - 注册一个请求事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_startswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容开头时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息开头内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_endswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容结尾时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息结尾内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_keyword(keywords, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。 - - - -* **参数** - - - * `keywords: Set[str]`: 关键词列表 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_command(cmd, rule=None, aliases=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息以指定命令开头时响应。 - - 命令匹配规则参考: [命令形式匹配](rule.html#command-command) - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `on_regex(pattern, flags=0, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息匹配正则表达式时响应。 - - 命令匹配规则参考: [正则匹配](rule.html#regex-regex-flags-0) - - - -* **参数** - - - * `pattern: str`: 正则表达式 - - - * `flags: Union[int, re.RegexFlag]`: 正则匹配标志 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## _class_ `CommandGroup` - -基类：`object` - -命令组，用于声明一组有相同名称前缀的命令。 - - -### `__init__(cmd, **kwargs)` - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 命令前缀 - - - * `**kwargs`: 其他传递给 `on_command` 的参数默认值，参考 [on_command](#on-command-cmd-rule-none-aliases-none-kwargs) - - - -### `basecmd` - - -* **类型**: `Tuple[str, ...]` - - -* **说明**: 命令前缀 - - -### `base_kwargs` - - -* **类型**: `Dict[str, Any]` - - -* **说明**: 其他传递给 `on_command` 的参数默认值 - - -### `command(cmd, **kwargs)` - - -* **说明** - - 注册一个新的命令。 - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 命令前缀 - - - * `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值 - - - -* **返回** - - - * `Type[Matcher]` - - - -## _class_ `MatcherGroup` - -基类：`object` - -事件响应器组合，统一管理。为 `Matcher` 创建提供默认属性。 - - -### `__init__(**kwargs)` - - -* **说明** - - 创建一个事件响应器组合，参数为默认值，与 `on` 一致 - - - -### `matchers` - - -* **类型** - - `List[Type[Matcher]]` - - - -* **说明** - - 组内事件响应器列表 - - - -### `base_kwargs` - - -* **类型**: `Dict[str, Any]` - - -* **说明**: 其他传递给 `on` 的参数默认值 - - -### `on(**kwargs)` - - -* **说明** - - 注册一个基础事件响应器，可自定义类型。 - - - -* **参数** - - - * `type: str`: 事件响应器类型 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_metaevent(**kwargs)` - - -* **说明** - - 注册一个元事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_message(**kwargs)` - - -* **说明** - - 注册一个消息事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_notice(**kwargs)` - - -* **说明** - - 注册一个通知事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_request(**kwargs)` - - -* **说明** - - 注册一个请求事件响应器。 - - - -* **参数** - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_startswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容开头时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息开头内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_endswith(msg, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息的\*\*文本部分\*\*以指定内容结尾时响应。 - - - -* **参数** - - - * `msg: str`: 指定消息结尾内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_keyword(keywords, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息纯文本部分包含关键词时响应。 - - - -* **参数** - - - * `keywords: Set[str]`: 关键词列表 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_command(cmd, rule=None, aliases=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息以指定命令开头时响应。 - - 命令匹配规则参考: [命令形式匹配](rule.html#command-command) - - - -* **参数** - - - * `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -### `on_regex(pattern, flags=0, rule=None, **kwargs)` - - -* **说明** - - 注册一个消息事件响应器，并且当消息匹配正则表达式时响应。 - - 命令匹配规则参考: [正则匹配](rule.html#regex-regex-flags-0) - - - -* **参数** - - - * `pattern: str`: 正则表达式 - - - * `flags: Union[int, re.RegexFlag]`: 正则匹配标志 - - - * `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则 - - - * `permission: Optional[Permission]`: 事件响应权限 - - - * `handlers: Optional[List[T_Handler]]`: 事件处理函数列表 - - - * `temp: bool`: 是否为临时事件响应器（仅执行一次） - - - * `priority: int`: 事件响应器优先级 - - - * `block: bool`: 是否阻止事件向更低优先级传递 - - - * `state: Optional[T_State]`: 默认 state - - - * `state_factory: Optional[T_StateFactory]`: 默认 state 的工厂函数 - - - -* **返回** - - - * `Type[Matcher]` - - - -## `load_plugin(module_path)` - - -* **说明** - - 使用 `importlib` 加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。 - - - -* **参数** - - - * `module_path: str`: 插件名称 `path.to.your.plugin` - - - -* **返回** - - - * `Optional[Plugin]` - - - -## `load_plugins(*plugin_dir)` - - -* **说明** - - 导入目录下多个插件，以 `_` 开头的插件不会被导入！ - - - -* **参数** - - - * `*plugin_dir: str`: 插件路径 - - - -* **返回** - - - * `Set[Plugin]` - - - -## `load_builtin_plugins()` - - -* **说明** - - 导入 NoneBot 内置插件 - - - -* **返回** - - - * `Plugin` - - - -## `get_plugin(name)` - - -* **说明** - - 获取当前导入的某个插件。 - - - -* **参数** - - - * `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。 - - - -* **返回** - - - * `Optional[Plugin]` - - - -## `get_loaded_plugins()` - - -* **说明** - - 获取当前已导入的所有插件。 - - - -* **返回** - - - * `Set[Plugin]` - - - -## `export()` - - -* **说明** - - 获取插件的导出内容对象 - - - -* **返回** - - - * `Export` - - - -## `require(name)` - - -* **说明** - - 获取一个插件的导出内容 - - - -* **参数** - - - * `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。 - - - -* **返回** - - - * `Optional[Export]` diff --git a/archive/2.0.0a8.post2/api/rule.md b/archive/2.0.0a8.post2/api/rule.md deleted file mode 100644 index cb3fd05f..00000000 --- a/archive/2.0.0a8.post2/api/rule.md +++ /dev/null @@ -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, T_State], Awaitable[bool]]`: **异步** RuleChecker - - - -### `checkers` - - -* **说明** - - 存储 `RuleChecker` - - - -* **类型** - - - * `Set[Callable[[Bot, Event, T_State], Awaitable[bool]]]` - - - -### _async_ `__call__(bot, event, state)` - - -* **说明** - - 检查是否符合所有规则 - - - -* **参数** - - - * `bot: Bot`: Bot 对象 - - - * `event: Event`: Event 对象 - - - * `state: T_State`: 当前 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.is_tome()` 判断事件是否与机器人有关 - - - -* **参数** - - - * 无 diff --git a/archive/2.0.0a8.post2/api/typing.md b/archive/2.0.0a8.post2/api/typing.md deleted file mode 100644 index 5d1b3d7b..00000000 --- a/archive/2.0.0a8.post2/api/typing.md +++ /dev/null @@ -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 获取参数时被运行。 diff --git a/archive/2.0.0a8.post2/api/utils.md b/archive/2.0.0a8.post2/api/utils.md deleted file mode 100644 index ab3ea0c2..00000000 --- a/archive/2.0.0a8.post2/api/utils.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -contentSidebar: true -sidebarDepth: 0 ---- - -# NoneBot.utils 模块 - - -## `escape_tag(s)` - - -* **说明** - - 用于记录带颜色日志时转义 `` 类型特殊标签 - - - -* **参数** - - - * `s: str`: 需要转义的字符串 - - - -* **返回** - - - * `str` - - - -## `run_sync(func)` - - -* **说明** - - 一个用于包装 sync function 为 async function 的装饰器 - - - -* **参数** - - - * `func: Callable[..., Any]`: 被装饰的同步函数 - - - -* **返回** - - - * `Callable[..., Awaitable[Any]]` - - - -## `logger_wrapper` - - -* **说明** - - -用于打印 adapter 的日志。 - - -* **Log 参数** - - - -* `level: Literal['WARNING', 'DEBUG', 'INFO']`: 日志等级 - - -* `message: str`: 日志信息 - - -* `exception: Optional[Exception]`: 异常信息 - - -## _class_ `DataclassEncoder` - -基类：`json.encoder.JSONEncoder` - - -* **说明** - - 在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder` diff --git a/archive/2.0.0a8.post2/guide/README.md b/archive/2.0.0a8.post2/guide/README.md deleted file mode 100644 index 4326ac1b..00000000 --- a/archive/2.0.0a8.post2/guide/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 概览 - - - -:::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 通信方式 -- 支持多个机器人账号负载均衡 -- 提供直观的交互式会话接口 -- 提供可自定义的权限控制机制 -- 多种方式渲染要发送的消息内容，使对话足够自然 diff --git a/archive/2.0.0a8.post2/guide/basic-configuration.md b/archive/2.0.0a8.post2/guide/basic-configuration.md deleted file mode 100644 index 0cd9156a..00000000 --- a/archive/2.0.0a8.post2/guide/basic-configuration.md +++ /dev/null @@ -1,83 +0,0 @@ -# 基本配置 - -到目前为止我们还在使用 NoneBot 的默认行为，在开始编写自己的插件之前，我们先尝试在配置文件上动动手脚，让 NoneBot 表现出不同的行为。 - -在上一章节中，我们创建了默认的项目结构，其中 `.env`, `.env.*` 均为项目的配置文件，下面将介绍几种 NoneBot 配置方式。 - -:::danger 警告 -请勿将敏感信息写入配置文件并提交至开源仓库！ -::: - -## .env 文件 - -NoneBot 在启动时将会从系统环境变量或者 `.env` 文件中寻找变量 `ENVIRONMENT` (大小写不敏感)，默认值为 `prod`。 -这将引导 NoneBot 从系统环境变量或者 `.env.{ENVIRONMENT}` 文件中进一步加载具体配置。 - -现在，我们在 `.env` 文件中写入当前环境信息： - -```bash -# .env -ENVIRONMENT=dev -``` - -如你所想，之后 NoneBot 就会从 `.env.dev` 文件中加载环境变量。 - -## .env.\* 文件 - -NoneBot 使用 [pydantic](https://pydantic-docs.helpmanual.io/) 进行配置管理，会从 `.env.{ENVIRONMENT}` 文件中获悉环境配置。 - -可以在 NoneBot 初始化时指定加载某个环境配置文件: `nonebot.init(_env_file=".env.dev")`，这将忽略你在 `.env` 中设置的环境信息。 - -:::warning 提示 -由于 `pydantic` 使用 JSON 解析配置项，请确保配置项值为 JSON 格式的数据。如： - -```bash -list=["123456789", "987654321", 1] -test={"hello": "world"} -``` - -如果配置项值解析失败将作为字符串处理。 -::: - -示例及说明： - -```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` > `system env` > `env file` diff --git a/archive/2.0.0a8.post2/guide/cqhttp-guide.md b/archive/2.0.0a8.post2/guide/cqhttp-guide.md deleted file mode 100644 index 356fa6c3..00000000 --- a/archive/2.0.0a8.post2/guide/cqhttp-guide.md +++ /dev/null @@ -1,101 +0,0 @@ -# CQHTTP 协议使用指南 - -## 配置 CQHTTP 协议端（以 QQ 为例） - -单纯运行 NoneBot 实例并不会产生任何效果，因为此刻 QQ 这边还不知道 NoneBot 的存在，也就无法把消息发送给它，因此现在需要使用一个无头 QQ 来把消息等事件上报给 NoneBot。 - -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. 生成默认配置文件并修改默认配置 - -```hjson{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: 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。 - -`cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。 - -## 历史性的第一次对话 - -一旦新的配置文件正确生效之后，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! -``` - -这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。 - -现在，尝试向你的机器人账号发送如下内容： - -```default -/echo 你好，世界 -``` - -到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！ - - - - diff --git a/archive/2.0.0a8.post2/guide/creating-a-handler.md b/archive/2.0.0a8.post2/guide/creating-a-handler.md deleted file mode 100644 index 723aeeff..00000000 --- a/archive/2.0.0a8.post2/guide/creating-a-handler.md +++ /dev/null @@ -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") -``` diff --git a/archive/2.0.0a8.post2/guide/creating-a-matcher.md b/archive/2.0.0a8.post2/guide/creating-a-matcher.md deleted file mode 100644 index ac74f6c1..00000000 --- a/archive/2.0.0a8.post2/guide/creating-a-matcher.md +++ /dev/null @@ -1,146 +0,0 @@ -# 注册事件响应器 - -好了，现在插件已经创建完毕，我们可以开始编写实际代码了，下面将以一个简易单文件天气查询插件为例。 - -在插件目录下 `weather.py` 中添加如下代码： - -```python -from nonebot import on_command -from nonebot.rule import to_me -from nonebot.typing import T_State -from nonebot.adapters import Bot, Event - -weather = on_command("天气", rule=to_me(), priority=5) - - -@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) - - -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{5} -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.get_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-plugin-test` 可以在网页端查看当前所有事件响应器的执行流程，有助理解事件响应流程！ - -```bash -nb plugin install nonebot_plugin_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 -from nonebot.typing import T_State - -async def async_checker(bot: Bot, event: Event, state: T_State) -> bool: - return True - -def sync_checker(bot: Bot, event: Event, state: T_State) -> bool: - return True - -def check(arg1, args2): - - async def _checker(bot: Bot, event: Event, state: T_State) -> bool: - return bool(arg1 + arg2) - - return Rule(_checker) -``` - -`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 -::: diff --git a/archive/2.0.0a8.post2/guide/creating-a-plugin.md b/archive/2.0.0a8.post2/guide/creating-a-plugin.md deleted file mode 100644 index 5ce12a28..00000000 --- a/archive/2.0.0a8.post2/guide/creating-a-plugin.md +++ /dev/null @@ -1,119 +0,0 @@ -# 创建插件 - -如果之前使用 `nb-cli` 生成了项目结构，那我们已经有了一个空的插件目录 `Awesome-Bot/awesome_bot/plugins`，并且它已在 `bot.py` 中被加载，我们现在可以开始创建插件了！ - -使用 `nb-cli` 创建包形式插件，或自行创建文件(夹) - -```bash -nb plugin new -``` - -插件通常有两种形式，下面分别介绍 - -## 单文件形式 - -在插件目录下创建名为 `foo.py` 的 Python 文件，暂时留空，此时目录结构如下： - - -:::vue -AweSome-Bot -├── awesome_bot -│ └── plugins -│ └── `foo.py` -├── .env -├── .env.dev -├── .env.prod -├── .gitignore -├── bot.py -├── docker-compose.yml -├── Dockerfile -├── pyproject.toml -└── README.md -::: - - -这个时候它已经可以被称为一个插件了，尽管它还什么都没做。 - -## 包形式(推荐) - -在插件目录下创建文件夹 `foo`，并在该文件夹下创建文件 `__init__.py`，此时目录结构如下： - - -:::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 -::: - - -这个时候 `foo` 就是一个合法的 Python 包了，同时也是合法的 NoneBot 插件，插件内容可以在 `__init__.py` 中编写。 - -### 推荐结构(仅供参考) - - -:::vue -foo -├── `__init__.py` -├── `config.py` -├── `data_source.py` -└── `model.py` -::: - - -#### \_\_init\_\_.py - -在该文件中编写各类事件响应及处理逻辑。 - -#### config.py - -在该文件中使用 `pydantic` 定义插件所需要的配置项以及类型。 - -示例： - -```python -from pydantic import BaseSettings - - -class Config(BaseSettings): - - # 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 - -在该文件中编写数据库模型。 diff --git a/archive/2.0.0a8.post2/guide/creating-a-project.md b/archive/2.0.0a8.post2/guide/creating-a-project.md deleted file mode 100644 index 5933b5fa..00000000 --- a/archive/2.0.0a8.post2/guide/creating-a-project.md +++ /dev/null @@ -1,51 +0,0 @@ -# 创建一个完整的项目 - -上一章中我们已经运行了一个简单的 NoneBot 实例，在这一章，我们将从零开始一个完整的项目。 - -## 目录结构 - -可以使用 `nb-cli` 或者自行创建完整的项目目录： - -```bash -nb create -``` - - -:::vue -AweSome-Bot -├── `awesome_bot` _(**或是 src**)_ -│ └── `plugins` -├── `.env` _(**可选的**)_ -├── `.env.dev` _(**可选的**)_ -├── `.env.prod` _(**可选的**)_ -├── .gitignore -├── `bot.py` -├── docker-compose.yml -├── Dockerfile -├── `pyproject.toml` -└── README.md -::: - - -- `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` 将会为你启动**冷重载模式** -::: diff --git a/archive/2.0.0a8.post2/guide/ding-guide.md b/archive/2.0.0a8.post2/guide/ding-guide.md deleted file mode 100644 index 88c62ca9..00000000 --- a/archive/2.0.0a8.post2/guide/ding-guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# 钉钉机器人使用指南 - -~~TODO~~ diff --git a/archive/2.0.0a8.post2/guide/end-or-start.md b/archive/2.0.0a8.post2/guide/end-or-start.md deleted file mode 100644 index 9587c4bb..00000000 --- a/archive/2.0.0a8.post2/guide/end-or-start.md +++ /dev/null @@ -1,9 +0,0 @@ -# 结语 - -至此，相信你已经能够写出一个基础的插件了。这里给出几个小提示： - -- 请千万注意事件处理器的优先级设定 -- 在匹配规则中请勿使用耗时极长的函数 -- 同一个用户可以**跨群**(**私聊**)继续他的事件处理（除非做出权限限制，将在后续介绍） - -如果「指南」还不能满足你，前往 [进阶](../advanced/README.md) 查看更多的功能信息。 diff --git a/archive/2.0.0a8.post2/guide/getting-started.md b/archive/2.0.0a8.post2/guide/getting-started.md deleted file mode 100644 index d35665a2..00000000 --- a/archive/2.0.0a8.post2/guide/getting-started.md +++ /dev/null @@ -1,86 +0,0 @@ -# 开始使用 - -一切都安装成功后，你就已经做好了进行简单配置以运行一个最小的 NoneBot 实例的准备。 - -## 最小实例 - -如果你已经按照推荐方式安装了 `nb-cli`，使用脚手架创建一个空项目： - -```bash -nb create -``` - -根据脚手架引导，将在当前目录下创建一个项目目录，项目目录内包含 `bot.py`。 - -如果未安装 `nb-cli`，使用你最熟悉的编辑器或 IDE，创建一个名为 `bot.py` 的文件，内容如下（这里以 CQHTTP 为例）： - -```python{4,6,7,10} -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 内置的 CQHTTP 协议适配组件 - `register_adapter` 的第一个参数我们传入了一个字符串，该字符串将会在后文 [配置 CQHTTP 协议端](#配置-cqhttp-协议端-以-qq-为例) 时使用。 -3. 加载 NoneBot 内置的插件 -4. 在地址 `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) -``` - -## 配置协议端上报 - -在 `bot.py` 文件中使用 `register_adapter` 注册协议适配之后即可配置协议端来完成与 NoneBot 的通信，详细配置方法参考： - -- [配置 CQHTTP](./cqhttp-guide.md) -- [配置钉钉](./ding-guide.md) - -NoneBot 接受的上报地址与 `Driver` 有关，默认使用的 `FastAPI Driver` 所接受的上报地址有： - -- `/{adapter name}/`: HTTP POST 上报 -- `/{adapter name}/http/`: HTTP POST 上报 -- `/{adapter name}/ws`: WebSocket 上报 -- `/{adapter name}/ws/`: WebSocket 上报 - -:::warning 注意 -如果到这一步你没有在 NoneBot 看到连接成功日志，比较常见的出错点包括： - -- NoneBot 监听 `0.0.0.0`，然后在协议端上报配置中填了 `ws://0.0.0.0:8080/***/ws` -- 在 Docker 容器内运行协议端，并通过 `127.0.0.1` 访问宿主机上的 NoneBot -- 想从公网访问，但没有修改云服务商的安全组策略或系统防火墙 -- NoneBot 所监听的端口存在冲突，已被其它程序占用 -- 弄混了 NoneBot 的 `host`、`port` 参数与协议端上报配置中的 `host`、`port` 参数 -- `ws://` 错填为 `http://` -- 协议端或 NoneBot 启动时遭到外星武器干扰 - -请尝试重启协议端 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新协议端 和 NoneBot 到最新版本等方式来解决。 -::: diff --git a/archive/2.0.0a8.post2/guide/installation.md b/archive/2.0.0a8.post2/guide/installation.md deleted file mode 100644 index 9beedaaa..00000000 --- a/archive/2.0.0a8.post2/guide/installation.md +++ /dev/null @@ -1,91 +0,0 @@ -# 安装 - -## NoneBot - -:::warning 注意 -请确保你的 Python 版本 >= 3.7。 -::: - -:::warning 注意 -请在安装 nonebot2 之前卸载 nonebot 1.x - -```bash -pip uninstall nonebot -``` - -::: - -### 通过脚手架安装(推荐安装方式) - -1. (推荐)使用你喜欢的 Python 环境管理工具(如 `poetry`)创建新的虚拟环境。 -2. 使用 `pip` (或其他包管理工具) 安装 nb-cli，nonebot2 作为其依赖会一起被安装。 - - ```bash - pip install nb-cli - ``` - -3. 点个 star 吧 - - nonebot2: [![nb-cli](https://img.shields.io/github/stars/nonebot/nonebot2?style=social)](https://github.com/nonebot/nonebot2) - - nb-cli: [![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](https://github.com/nonebot/nb-cli) - -### 不使用脚手架(纯净安装) - -```bash -pip install nonebot2 -# 也可以通过 poetry 安装 -poetry add nonebot2 -``` - -如果你需要使用最新的（可能**尚未发布**的）特性，可以直接从 GitHub 仓库安装： - -:::warning 注意 -直接从 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) 等着你发现～ diff --git a/archive/2.0.0a8.post2/guide/loading-a-plugin.md b/archive/2.0.0a8.post2/guide/loading-a-plugin.md deleted file mode 100644 index f026bbe0..00000000 --- a/archive/2.0.0a8.post2/guide/loading-a-plugin.md +++ /dev/null @@ -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() -``` - -## 子插件(嵌套插件) - -在插件中同样可以加载子插件，例如如下插件目录结构： - - -:::vue -foo_plugin -├── `plugins` -│ ├── `sub_plugin1` -│ │ └── \_\_init\_\_.py -│ └── `sub_plugin2.py` -├── `__init__.py` -└── config.py -::: - - -在插件目录下的 `__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" -``` diff --git a/archive/2.0.0a8.post2/sidebar.config.json b/archive/2.0.0a8.post2/sidebar.config.json deleted file mode 100644 index 0d0103e1..00000000 --- a/archive/2.0.0a8.post2/sidebar.config.json +++ /dev/null @@ -1,166 +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" - ] - }, - { - "title": "协议适配", - "collapsable": false, - "sidebar": "auto", - "children": ["cqhttp-guide", "ding-guide"] - } - ], - "/advanced/": [ - { - "title": "进阶", - "collapsable": false, - "sidebar": "auto", - "children": [ - "", - "scheduler", - "permission", - "runtime-hook", - "export-and-require", - "overloaded-handlers" - ] - }, - { - "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" - } - ] - } - ] - } - } - } -}