diff --git a/archive/2.0.0a2/api/adapters/README.md b/archive/2.0.0a2/api/adapters/README.md deleted file mode 100644 index b6529990..00000000 --- a/archive/2.0.0a2/api/adapters/README.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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. diff --git a/archive/2.0.0a2/README.md b/archive/2.0.0a3/README.md similarity index 100% rename from archive/2.0.0a2/README.md rename to archive/2.0.0a3/README.md diff --git a/archive/2.0.0a2/api/README.md b/archive/2.0.0a3/api/README.md similarity index 72% rename from archive/2.0.0a2/api/README.md rename to archive/2.0.0a3/api/README.md index 1c8acf1b..52c6e9f6 100644 --- a/archive/2.0.0a2/api/README.md +++ b/archive/2.0.0a3/api/README.md @@ -7,16 +7,10 @@ * [nonebot](nonebot.html) - * [nonebot.typing](typing.html) - - * [nonebot.config](config.html) - * [nonebot.sched](sched.html) - - - * [nonebot.log](log.html) + * [nonebot.matcher](matcher.html) * [nonebot.rule](rule.html) @@ -25,10 +19,28 @@ * [nonebot.permission](permission.html) + * [nonebot.sched](sched.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) diff --git a/archive/2.0.0a3/api/adapters/README.md b/archive/2.0.0a3/api/adapters/README.md new file mode 100644 index 00000000..f3f937ec --- /dev/null +++ b/archive/2.0.0a3/api/adapters/README.md @@ -0,0 +1,323 @@ +--- +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_ `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", data={"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` + +Event 基类。提供上报信息的关键信息，其余信息可从原始上报消息获取。 + + +### `__init__(raw_event)` + + +* **参数** + + + * `raw_event: dict`: 原始上报消息 + + + +### _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, MessageSegment, Message]`: 消息内容 + + + +### `append(obj)` + + +* **说明** + + 添加一个消息段到消息数组末尾 + + + +* **参数** + + + * `obj: Union[str, MessageSegment]`: 要添加的消息段 + + + +### `extend(obj)` + + +* **说明** + + 拼接一个消息数组或多个消息段到消息数组末尾 + + + +* **参数** + + + * `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组 + + + +### `reduce()` + + +* **说明** + + 缩减消息数组，即拼接相邻纯文本消息段 + + + +### `extract_plain_text()` + + +* **说明** + + 提取消息内纯文本消息 diff --git a/archive/2.0.0a2/api/adapters/cqhttp.md b/archive/2.0.0a3/api/adapters/cqhttp.md similarity index 98% rename from archive/2.0.0a2/api/adapters/cqhttp.md rename to archive/2.0.0a3/api/adapters/cqhttp.md index 53fa04f9..aae78f86 100644 --- a/archive/2.0.0a2/api/adapters/cqhttp.md +++ b/archive/2.0.0a3/api/adapters/cqhttp.md @@ -323,10 +323,10 @@ CQHTTP 协议 Event 适配。继承属性参考 [BaseEvent](./#class-baseevent) ### _property_ `sub_type` -* 类型: `str` +* 类型: `Optional[str]` -* 说明: 事件类型 +* 说明: 事件子类型 ### _property_ `user_id` diff --git a/archive/2.0.0a2/api/config.md b/archive/2.0.0a3/api/config.md similarity index 98% rename from archive/2.0.0a2/api/config.md rename to archive/2.0.0a3/api/config.md index fd90f50e..6943427b 100644 --- a/archive/2.0.0a2/api/config.md +++ b/archive/2.0.0a3/api/config.md @@ -194,10 +194,10 @@ SUPER_USERS=[12345789] ### `nickname` -* 类型: `Union[str, Set[str]]` +* 类型: `Set[str]` -* 默认值: `""` +* 默认值: `set()` * 说明: diff --git a/archive/2.0.0a3/api/drivers/README.md b/archive/2.0.0a3/api/drivers/README.md new file mode 100644 index 00000000..f78812f0 --- /dev/null +++ b/archive/2.0.0a3/api/drivers/README.md @@ -0,0 +1,37 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +# NoneBot.drivers 模块 + +## 后端驱动适配基类 + +各驱动请继承以下基类 + + +## _class_ `BaseDriver` + +基类：`abc.ABC` + +Driver 基类。将后端框架封装，以满足适配器使用。 + + +### `_adapters` + + +* **类型** + + `Dict[str, Type[Bot]]` + + + +* **说明** + + 已注册的适配器列表 + + + +### _abstract_ `__init__(env, config)` + +Initialize self. See help(type(self)) for accurate signature. diff --git a/archive/2.0.0a3/api/drivers/fastapi.md b/archive/2.0.0a3/api/drivers/fastapi.md new file mode 100644 index 00000000..029c9bc8 --- /dev/null +++ b/archive/2.0.0a3/api/drivers/fastapi.md @@ -0,0 +1,16 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +# NoneBot.drivers.fastapi 模块 + + +## _class_ `Driver` + +基类：[`nonebot.drivers.BaseDriver`](#None) + + +### `__init__(env, config)` + +Initialize self. See help(type(self)) for accurate signature. diff --git a/archive/2.0.0a2/api/exception.md b/archive/2.0.0a3/api/exception.md similarity index 100% rename from archive/2.0.0a2/api/exception.md rename to archive/2.0.0a3/api/exception.md diff --git a/archive/2.0.0a2/api/log.md b/archive/2.0.0a3/api/log.md similarity index 100% rename from archive/2.0.0a2/api/log.md rename to archive/2.0.0a3/api/log.md diff --git a/archive/2.0.0a3/api/matcher.md b/archive/2.0.0a3/api/matcher.md new file mode 100644 index 00000000..c1176030 --- /dev/null +++ b/archive/2.0.0a3/api/matcher.md @@ -0,0 +1,485 @@ +--- +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)` + + +* **说明** + + 发送一条消息给当前交互用户 + + + +* **参数** + + + * `message: Union[str, Message, MessageSegment]`: 消息内容 + + + +### _async classmethod_ `finish(message=None)` + + +* **说明** + + 发送一条消息给当前交互用户并结束当前事件响应器 + + + +* **参数** + + + * `message: Union[str, Message, MessageSegment]`: 消息内容 + + + +### _async classmethod_ `pause(prompt=None)` + + +* **说明** + + 发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后继续下一个处理函数 + + + +* **参数** + + + * `prompt: Union[str, Message, MessageSegment]`: 消息内容 + + + +### _async classmethod_ `reject(prompt=None)` + + +* **说明** + + 发送一条消息给当前交互用户并暂停事件响应器，在接收用户新的一条消息后重新运行当前处理函数 + + + +* **参数** + + + * `prompt: Union[str, Message, MessageSegment]`: 消息内容 + + + +## _class_ `MatcherGroup` + +基类：`object` + +事件响应器组合，统一管理。用法同 `Matcher` + + +### `__init__(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, expire_time=None)` + + +* **说明** + + 创建一个事件响应器组合，参数为默认值，与 `Matcher.new` 一致 + + + +### `matchers` + + +* **类型** + + `List[Type[Matcher]]` + + + +* **说明** + + 组内事件响应器列表 + + + +### `new(type_='', rule=None, permission=None, handlers=None, temp=False, priority=1, block=False, *, module=None, default_state=None, expire_time=None)` + + +* **说明** + + 在组中创建一个新的事件响应器，参数留空则使用组合默认值 + + +:::danger 警告 +如果使用 handlers 参数覆盖组合默认值则该事件响应器不会随组合一起添加新的事件处理函数 +::: diff --git a/archive/2.0.0a2/api/nonebot.md b/archive/2.0.0a3/api/nonebot.md similarity index 74% rename from archive/2.0.0a2/api/nonebot.md rename to archive/2.0.0a3/api/nonebot.md index 3c278a5c..7c89c882 100644 --- a/archive/2.0.0a2/api/nonebot.md +++ b/archive/2.0.0a3/api/nonebot.md @@ -5,6 +5,55 @@ 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_command` => `nonebot.plugin.on_command` + + +* `on_regex` => `nonebot.plugin.on_regex` + + +* `on_regex` => `nonebot.plugin.on_regex` + + +* `on_regex` => `nonebot.plugin.on_regex` + + +* `CommandGroup` => `nonebot.plugin.CommandGroup` + + +* `load_plugin` => `nonebot.plugin.load_plugin` + + +* `load_plugins` => `nonebot.plugin.load_plugins` + + +* `load_builtin_plugins` => `nonebot.plugin.load_builtin_plugins` + + +* `get_loaded_plugins` => `nonebot.plugin.get_loaded_plugins` + ## `get_driver()` diff --git a/archive/2.0.0a2/api/permission.md b/archive/2.0.0a3/api/permission.md similarity index 100% rename from archive/2.0.0a2/api/permission.md rename to archive/2.0.0a3/api/permission.md diff --git a/archive/2.0.0a2/api/rule.md b/archive/2.0.0a3/api/rule.md similarity index 51% rename from archive/2.0.0a2/api/rule.md rename to archive/2.0.0a3/api/rule.md index 269abc57..2054d04b 100644 --- a/archive/2.0.0a2/api/rule.md +++ b/archive/2.0.0a3/api/rule.md @@ -7,10 +7,10 @@ sidebarDepth: 0 ## 规则 -每个 `Matcher` 拥有一个 `Rule` ，其中是 **异步** `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。 +每个事件响应器 `Matcher` 拥有一个匹配规则 `Rule` ，其中是 **异步** `RuleChecker` 的集合，只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行。 :::tip 提示 -`RuleChecker` 既可以是 async function 也可以是 sync function +`RuleChecker` 既可以是 async function 也可以是 sync function，但在最终会被 `nonebot.utils.run_sync` 转换为 async function ::: @@ -120,3 +120,83 @@ Rule(async_function, run_sync(sync_function)) * `msg: str`: 消息结尾字符串 + + + +## `keyword(msg)` + + +* **说明** + + 匹配消息关键词 + + + +* **参数** + + + * `msg: str`: 关键词 + + + +## `command(command)` + + +* **说明** + + 命令形式匹配，根据配置里提供的 `command_start`, `command_sep` 判断消息是否为命令。 + + + +* **参数** + + + * `command: Tuples[str, ...]`: 命令内容 + + + +* **示例** + + 使用默认 `command_start`, `command_sep` 配置 + + 命令 `("test",)` 可以匹配：`/test` 开头的消息 + 命令 `("test", "sub")` 可以匹配”`/test.sub` 开头的消息 + + +:::tip 提示 +命令内容与后续消息间无需空格！ +::: + + +## `regex(regex, flags=0)` + + +* **说明** + + 根据正则表达式进行匹配 + + + +* **参数** + + + * `regex: str`: 正则表达式 + + + * `flags: Union[int, re.RegexFlag]`: 正则标志 + + + +## `to_me()` + + +* **说明** + + 通过 `event.to_me` 判断消息是否是发送给机器人 + + + +* **参数** + + + * 无 diff --git a/archive/2.0.0a2/api/sched.md b/archive/2.0.0a3/api/sched.md similarity index 100% rename from archive/2.0.0a2/api/sched.md rename to archive/2.0.0a3/api/sched.md diff --git a/archive/2.0.0a2/api/typing.md b/archive/2.0.0a3/api/typing.md similarity index 100% rename from archive/2.0.0a2/api/typing.md rename to archive/2.0.0a3/api/typing.md diff --git a/archive/2.0.0a2/api/utils.md b/archive/2.0.0a3/api/utils.md similarity index 100% rename from archive/2.0.0a2/api/utils.md rename to archive/2.0.0a3/api/utils.md diff --git a/archive/2.0.0a2/guide/README.md b/archive/2.0.0a3/guide/README.md similarity index 63% rename from archive/2.0.0a2/guide/README.md rename to archive/2.0.0a3/guide/README.md index 6cf31e90..86397ee2 100644 --- a/archive/2.0.0a2/guide/README.md +++ b/archive/2.0.0a3/guide/README.md @@ -20,11 +20,7 @@ NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人 ## 它如何工作？ -NoneBot 的运行离不开 酷 Q 和 CQHTTP 插件。酷 Q 扮演着「无头 QQ 客户端」的角色，它进行实际的消息、通知、请求的接收和发送，当 酷 Q 收到消息时，它将这个消息包装为一个事件（通知和请求同理），并通过它自己的插件机制将事件传送给 CQHTTP 插件，后者再根据其配置中的 `post_url` 或 `ws_reverse_url` 等项来将事件发送至 NoneBot。 - -在 NoneBot 收到事件前，它底层的 aiocqhttp 实际已经先看到了事件，aiocqhttp 根据事件的类型信息，通知到 NoneBot 的相应函数。特别地，对于消息类型的事件，还将消息内容转换成了 `aiocqhttp.message.Message` 类型，以便处理。 - -NoneBot 的事件处理函数收到通知后，对于不同类型的事件，再做相应的预处理和解析，然后调用对应的插件，并向其提供适合此类事件的会话（Session）对象。NoneBot 插件的编写者要做的，就是利用 Session 对象中提供的数据，在插件的处理函数中实现所需的功能。 +~~未填坑~~ ## 特色 diff --git a/archive/2.0.0a2/guide/basic-configuration.md b/archive/2.0.0a3/guide/basic-configuration.md similarity index 100% rename from archive/2.0.0a2/guide/basic-configuration.md rename to archive/2.0.0a3/guide/basic-configuration.md diff --git a/archive/2.0.0a2/guide/creating-a-project.md b/archive/2.0.0a3/guide/creating-a-project.md similarity index 100% rename from archive/2.0.0a2/guide/creating-a-project.md rename to archive/2.0.0a3/guide/creating-a-project.md diff --git a/archive/2.0.0a2/guide/getting-started.md b/archive/2.0.0a3/guide/getting-started.md similarity index 100% rename from archive/2.0.0a2/guide/getting-started.md rename to archive/2.0.0a3/guide/getting-started.md diff --git a/archive/2.0.0a2/guide/installation.md b/archive/2.0.0a3/guide/installation.md similarity index 100% rename from archive/2.0.0a2/guide/installation.md rename to archive/2.0.0a3/guide/installation.md diff --git a/archive/2.0.0a2/guide/writing-a-plugin.md b/archive/2.0.0a3/guide/writing-a-plugin.md similarity index 100% rename from archive/2.0.0a2/guide/writing-a-plugin.md rename to archive/2.0.0a3/guide/writing-a-plugin.md diff --git a/archive/2.0.0a2/sidebar.config.json b/archive/2.0.0a3/sidebar.config.json similarity index 86% rename from archive/2.0.0a2/sidebar.config.json rename to archive/2.0.0a3/sidebar.config.json index bec088a6..c68d09ef 100644 --- a/archive/2.0.0a2/sidebar.config.json +++ b/archive/2.0.0a3/sidebar.config.json @@ -47,21 +47,13 @@ "title": "nonebot 模块", "path": "nonebot" }, - { - "title": "nonebot.typing 模块", - "path": "typing" - }, { "title": "nonebot.config 模块", "path": "config" }, { - "title": "nonebot.sched 模块", - "path": "sched" - }, - { - "title": "nonebot.log 模块", - "path": "log" + "title": "nonebot.matcher 模块", + "path": "matcher" }, { "title": "nonebot.rule 模块", @@ -71,14 +63,34 @@ "title": "nonebot.permission 模块", "path": "permission" }, + { + "title": "nonebot.sched 模块", + "path": "sched" + }, + { + "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/" diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 673e2d0c..863b0d64 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -124,6 +124,14 @@ module.exports = context => ({ title: "nonebot.exception 模块", path: "exception" }, + { + title: "nonebot.drivers 模块", + path: "drivers/" + }, + { + title: "nonebot.drivers.fastapi 模块", + path: "drivers/fastapi" + }, { title: "nonebot.adapters 模块", path: "adapters/" diff --git a/docs/.vuepress/versions.json b/docs/.vuepress/versions.json index 386fcf77..65abfcfd 100644 --- a/docs/.vuepress/versions.json +++ b/docs/.vuepress/versions.json @@ -1,3 +1,3 @@ [ - "2.0.0a2" + "2.0.0a3" ] \ No newline at end of file diff --git a/docs/api/README.md b/docs/api/README.md index 252513d8..52c6e9f6 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -34,6 +34,12 @@ * [nonebot.exception](exception.html) + * [nonebot.drivers](drivers/) + + + * [nonebot.drivers.fastapi](drivers/fastapi.html) + + * [nonebot.adapters](adapters/) diff --git a/docs/api/drivers/README.md b/docs/api/drivers/README.md new file mode 100644 index 00000000..f78812f0 --- /dev/null +++ b/docs/api/drivers/README.md @@ -0,0 +1,37 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +# NoneBot.drivers 模块 + +## 后端驱动适配基类 + +各驱动请继承以下基类 + + +## _class_ `BaseDriver` + +基类：`abc.ABC` + +Driver 基类。将后端框架封装，以满足适配器使用。 + + +### `_adapters` + + +* **类型** + + `Dict[str, Type[Bot]]` + + + +* **说明** + + 已注册的适配器列表 + + + +### _abstract_ `__init__(env, config)` + +Initialize self. See help(type(self)) for accurate signature. diff --git a/docs/api/drivers/fastapi.md b/docs/api/drivers/fastapi.md new file mode 100644 index 00000000..029c9bc8 --- /dev/null +++ b/docs/api/drivers/fastapi.md @@ -0,0 +1,16 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +# NoneBot.drivers.fastapi 模块 + + +## _class_ `Driver` + +基类：[`nonebot.drivers.BaseDriver`](#None) + + +### `__init__(env, config)` + +Initialize self. See help(type(self)) for accurate signature. diff --git a/docs_build/README.rst b/docs_build/README.rst index 9ce6ced7..20439caa 100644 --- a/docs_build/README.rst +++ b/docs_build/README.rst @@ -12,5 +12,7 @@ NoneBot Api Reference - `nonebot.utils `_ - `nonebot.typing `_ - `nonebot.exception `_ + - `nonebot.drivers `_ + - `nonebot.drivers.fastapi `_ - `nonebot.adapters `_ - `nonebot.adapters.cqhttp `_ diff --git a/docs_build/drivers/README.rst b/docs_build/drivers/README.rst new file mode 100644 index 00000000..e4bf6104 --- /dev/null +++ b/docs_build/drivers/README.rst @@ -0,0 +1,13 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +NoneBot.drivers 模块 +===================== + +.. automodule:: nonebot.drivers + :members: + :private-members: + :special-members: __init__ + :show-inheritance: diff --git a/docs_build/drivers/fastapi.rst b/docs_build/drivers/fastapi.rst new file mode 100644 index 00000000..bbc67caf --- /dev/null +++ b/docs_build/drivers/fastapi.rst @@ -0,0 +1,13 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + +NoneBot.drivers.fastapi 模块 +===================== + +.. automodule:: nonebot.drivers.fastapi + :members: + :private-members: + :special-members: __init__ + :show-inheritance: