🔖 Pre Release 2.0.0a2

archive/2.0.0a2/api/README.md

@@ -0,0 +1,34 @@
+# NoneBot Api Reference
+
+
+* **模块索引**
+
+    
+    * [nonebot](nonebot.html)
+
+
+    * [nonebot.typing](typing.html)
+
+
+    * [nonebot.config](config.html)
+
+
+    * [nonebot.sched](sched.html)
+
+
+    * [nonebot.log](log.html)
+
+
+    * [nonebot.rule](rule.html)
+
+
+    * [nonebot.permission](permission.html)
+
+
+    * [nonebot.utils](utils.html)
+
+
+    * [nonebot.exception](exception.html)
+
+
+    * [nonebot.adapters.cqhttp](adapters/cqhttp.html)

archive/2.0.0a2/api/adapters/README.md

@@ -0,0 +1,41 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.adapters 模块
+
+
+## _class_ `BaseBot`
+
+基类：`abc.ABC`
+
+
+## _class_ `BaseEvent`
+
+基类：`abc.ABC`
+
+
+### `_raw_event`
+
+原始 event
+
+
+## _class_ `BaseMessageSegment`
+
+基类：`abc.ABC`
+
+
+## _class_ `BaseMessage`
+
+基类：`list`, `abc.ABC`
+
+
+### `append(obj)`
+
+Append object to the end of the list.
+
+
+### `extend(obj)`
+
+Extend list by appending elements from the iterable.

archive/2.0.0a2/api/adapters/cqhttp.md

@@ -0,0 +1,411 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.adapters.cqhttp 模块
+
+## CQHTTP (OneBot) v11 协议适配
+
+协议详情请看: [CQHTTP](http://cqhttp.cc/) | [OneBot](https://github.com/howmanybots/onebot)
+
+
+## `log(level, message)`
+
+
+* **说明**
+
+    用于打印 CQHTTP 日志。
+
+
+
+* **参数**
+
+    
+    * `level: str`: 日志等级
+
+
+    * `message: str`: 日志信息
+
+
+
+## `escape(s, *, escape_comma=True)`
+
+
+* **说明**
+
+    对字符串进行 CQ 码转义。
+
+
+
+* **参数**
+
+    
+    * `s: str`: 需要转义的字符串
+
+
+    * `escape_comma: bool`: 是否转义逗号（`,`）。
+
+
+
+## `unescape(s)`
+
+
+* **说明**
+
+    对字符串进行 CQ 码去转义。
+
+
+
+* **参数**
+
+    
+    * `s: str`: 需要转义的字符串
+
+
+
+## `_b2s(b)`
+
+转换布尔值为字符串。
+
+
+## _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`](#None)
+
+CQHTTP 协议 Bot 适配。继承属性参考 [BaseBot](./#class-basebot) 。
+
+
+### _property_ `type`
+
+
+* 返回: `"cqhttp"`
+
+
+### _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`](#None)
+
+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`
+
+
+* 类型: `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`](#None)
+
+
+## _class_ `Message`
+
+基类：[`nonebot.adapters.BaseMessage`](#None)

archive/2.0.0a2/api/config.md

@@ -0,0 +1,265 @@
+---
+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`
+
+
+* 类型: `Union[str, Set[str]]`
+
+
+* 默认值: `""`
+
+
+* 说明:
+机器人昵称。
+
+
+### `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
+```
+
+
+### `apscheduler_config`
+
+
+* 类型: `dict`
+
+
+* 默认值: `{"apscheduler.timezone": "Asia/Shanghai"}`
+
+
+* 说明:
+APScheduler 的配置对象，见 [Configuring the Scheduler](https://apscheduler.readthedocs.io/en/latest/userguide.html#configuring-the-scheduler)

archive/2.0.0a2/api/exception.md

@@ -0,0 +1,156 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.exception 模块
+
+## 异常
+
+下列文档中的异常是所有 NoneBot 运行时可能会抛出的。
+这些异常并非所有需要用户处理，在 NoneBot 内部运行时被捕获，并进行对应操作。
+
+
+## _exception_ `IgnoredException`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 应该忽略该事件。可由 PreProcessor 抛出。
+
+
+
+* **参数**
+
+    
+    * `reason`: 忽略事件的原因
+
+
+
+## _exception_ `PausedException`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后继续下一个 `Handler`。
+    可用于用户输入新信息。
+
+
+
+* **用法**
+
+    可以在 `Handler` 中通过 `Matcher.pause()` 抛出。
+
+
+
+## _exception_ `RejectedException`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 结束当前 `Handler` 并等待下一条消息后重新运行当前 `Handler`。
+    可用于用户重新输入。
+
+
+
+* **用法**
+
+    可以在 `Handler` 中通过 `Matcher.reject()` 抛出。
+
+
+
+## _exception_ `FinishedException`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 结束当前 `Handler` 且后续 `Handler` 不再被运行。
+    可用于结束用户会话。
+
+
+
+* **用法**
+
+    可以在 `Handler` 中通过 `Matcher.finish()` 抛出。
+
+
+
+## _exception_ `ExpiredException`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 当前 `Matcher` 已失效。
+
+
+
+* **用法**
+
+    当 `Matcher` 运行前检查时抛出。
+
+
+
+## _exception_ `StopPropagation`
+
+基类：`Exception`
+
+
+* **说明**
+
+    指示 NoneBot 终止事件向下层传播。
+
+
+
+* **用法**
+
+    在 `Matcher.block == True` 时抛出。
+
+
+
+## _exception_ `ApiNotAvailable`
+
+基类：`Exception`
+
+
+* **说明**
+
+    在 API 连接不可用时抛出。
+
+
+
+## _exception_ `NetworkError`
+
+基类：`Exception`
+
+
+* **说明**
+
+    在网络出现问题时抛出，如: API 请求地址不正确, API 请求无返回或返回状态非正常等。
+
+
+
+## _exception_ `ActionFailed`
+
+基类：`Exception`
+
+
+* **说明**
+
+    API 请求成功返回数据，但 API 操作失败。
+
+
+
+* **参数**
+
+    
+    * `retcode`: 错误代码

archive/2.0.0a2/api/log.md

@@ -0,0 +1,55 @@
+---
+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.

archive/2.0.0a2/api/nonebot.md

@@ -0,0 +1,208 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot 模块
+
+
+## `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)
+```

archive/2.0.0a2/api/permission.md

@@ -0,0 +1,121 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.permission 模块
+
+## 权限
+
+每个 `Matcher` 拥有一个 `Permission` ，其中是 **异步** `PermissionChecker` 的集合，只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行。
+
+:::tip 提示
+`PermissionChecker` 既可以是 async function 也可以是 sync function
+:::
+
+
+## `MESSAGE`
+
+
+* **说明**: 匹配任意 `message` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 message type 的 Matcher。
+
+
+## `NOTICE`
+
+
+* **说明**: 匹配任意 `notice` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 notice type 的 Matcher。
+
+
+## `REQUEST`
+
+
+* **说明**: 匹配任意 `request` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 request type 的 Matcher。
+
+
+## `METAEVENT`
+
+
+* **说明**: 匹配任意 `meta_event` 类型事件，仅在需要同时捕获不同类型事件时使用。优先使用 meta_event type 的 Matcher。
+
+
+## `USER(*user, perm=<nonebot.permission.Permission object>)`
+
+
+* **说明**
+
+    在白名单内且满足 perm
+
+
+
+* **参数**
+
+    
+    * `*user: int`: 白名单
+
+
+    * `perm: Permission`: 需要同时满足的权限
+
+
+
+## `PRIVATE`
+
+
+* **说明**: 匹配任意私聊消息类型事件
+
+
+## `PRIVATE_FRIEND`
+
+
+* **说明**: 匹配任意好友私聊消息类型事件
+
+
+## `PRIVATE_GROUP`
+
+
+* **说明**: 匹配任意群临时私聊消息类型事件
+
+
+## `PRIVATE_OTHER`
+
+
+* **说明**: 匹配任意其他私聊消息类型事件
+
+
+## `GROUP`
+
+
+* **说明**: 匹配任意群聊消息类型事件
+
+
+## `GROUP_MEMBER`
+
+
+* **说明**: 匹配任意群员群聊消息类型事件
+
+:::warning 警告
+该权限通过 event.sender 进行判断且不包含管理员以及群主！
+:::
+
+
+## `GROUP_ADMIN`
+
+
+* **说明**: 匹配任意群管理员群聊消息类型事件
+
+
+## `GROUP_OWNER`
+
+
+* **说明**: 匹配任意群主群聊消息类型事件
+
+
+## `SUPERUSER`
+
+
+* **说明**: 匹配任意超级用户消息类型事件
+
+
+## `EVERYBODY`
+
+
+* **说明**: 匹配任意消息类型事件

archive/2.0.0a2/api/rule.md

@@ -0,0 +1,122 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.rule 模块
+
+## 规则
+
+每个 `Matcher` 拥有一个 `Rule` ，其中是 **异步** `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。
+
+:::tip 提示
+`RuleChecker` 既可以是 async function 也可以是 sync 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`: 消息结尾字符串

archive/2.0.0a2/api/sched.md

@@ -0,0 +1,41 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.sched 模块
+
+## 计划任务
+
+计划任务使用第三方库 [APScheduler](https://github.com/agronholm/apscheduler) ，使用文档请参考 [APScheduler使用文档](https://apscheduler.readthedocs.io/en/latest/) 。
+
+
+## `scheduler`
+
+
+* **类型**
+
+    `Optional[apscheduler.schedulers.asyncio.AsyncIOScheduler]`
+
+
+
+* **说明**
+
+    当可选依赖 `APScheduler` 未安装时，`scheduler` 为 None
+
+    使用 `pip install nonebot[scheduler]` 安装可选依赖
+
+
+
+* **常用示例**
+
+
+```python
+from nonebot import 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")
+```

archive/2.0.0a2/api/typing.md

@@ -0,0 +1,252 @@
+---
+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 的基类。
+
+
+
+
+## `PreProcessor`
+
+
+* **类型**
+
+    `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
+
+
+
+* **说明**
+
+    消息预处理函数 PreProcessor 类型
+
+
+
+
+## `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 获取参数时被运行。

archive/2.0.0a2/api/utils.md

@@ -0,0 +1,62 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+# NoneBot.utils 模块
+
+
+## `escape_tag(s)`
+
+
+* **说明**
+
+    用于记录带颜色日志时转义 `<tag>` 类型特殊标签
+
+
+
+* **参数**
+
+    
+    * `s: str`: 需要转义的字符串
+
+
+
+* **返回**
+
+    
+    * `str`
+
+
+
+## `run_sync(func)`
+
+
+* **说明**
+
+    一个用于包装 sync function 为 async function 的装饰器
+
+
+
+* **参数**
+
+    
+    * `func: Callable[..., Any]`: 被装饰的同步函数
+
+
+
+* **返回**
+
+    
+    * `Callable[..., Awaitable[Any]]`
+
+
+
+## _class_ `DataclassEncoder`
+
+基类：`json.encoder.JSONEncoder`
+
+
+* **说明**
+
+    在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`