ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2025-07-28 00:31:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

🔖 Release 2.0.0-beta.2

Browse Source
This commit is contained in:
github-actions
2022-02-14 16:27:11 +00:00
parent 14703fce8d
commit cee96d8ab6
72 changed files with 9781 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

504
website/versioned_docs/version-2.0.0-beta.2/api/drivers/index.md Normal file
View File

@ -0,0 +1,504 @@
---
sidebar_position: 0
description: nonebot.drivers 模块
---
# nonebot.drivers
本模块定义了驱动适配器基类。
各驱动请继承以下基类。
## _abstract class_ `Driver(env, config)` {#Driver}
- **说明**
Driver 基类。
- **参数**
- `env` ([Env](../config.md#Env)): 包含环境信息的 Env 对象
- `config` ([Config](../config.md#Config)): 包含配置信息的 Config 对象
### _property_ `bots` {#Driver-bots}
- **类型:** dict[str, Bot]
- **说明:** 获取当前所有已连接的 Bot
### _abstract property_ `logger` {#Driver-logger}
- **类型:**
- **说明:** 驱动专属 logger 日志记录器
### _abstract property_ `type` {#Driver-type}
- **类型:** str
- **说明:** 驱动类型名称
### _classmethod_ `on_bot_connect(cls, func)` {#Driver-on_bot_connect}
- **说明**
装饰一个函数使他在 bot 连接成功时执行。
钩子函数参数:
- bot: 当前连接上的 Bot 对象
- **参数**
- `func` ((\*Any, \*\*Any) -> Awaitable[Any])
- **返回**
- (\*Any, \*\*Any) -> Awaitable[Any]
### _classmethod_ `on_bot_disconnect(cls, func)` {#Driver-on_bot_disconnect}
- **说明**
装饰一个函数使他在 bot 连接断开时执行。
钩子函数参数:
- bot: 当前连接上的 Bot 对象
- **参数**
- `func` ((\*Any, \*\*Any) -> Awaitable[Any])
- **返回**
- (\*Any, \*\*Any) -> Awaitable[Any]
### _abstract method_ `on_shutdown(self, func)` {#Driver-on_shutdown}
- **说明**
注册一个在驱动器停止时执行的函数
- **参数**
- `func` (Callable)
- **返回**
- Callable
### _abstract method_ `on_startup(self, func)` {#Driver-on_startup}
- **说明**
注册一个在驱动器启动时执行的函数
- **参数**
- `func` (Callable)
- **返回**
- Callable
### _method_ `register_adapter(self, adapter, **kwargs)` {#Driver-register_adapter}
- **说明**
注册一个协议适配器
- **参数**
- `adapter` (Type[Adapter]): 适配器类
- `**kwargs`: 其他传递给适配器的参数
- **返回**
- None
### _abstract method_ `run(self, *args, **kwargs)` {#Driver-run}
- **说明**
启动驱动框架
- **参数**
- `*args`
- `**kwargs`
- **返回**
- Unknown
## _class_ `Cookies(cookies=None)` {#Cookies}
- **参数**
- `cookies` (NoneType | Cookies | http.cookiejar.CookieJar | dict[str, str] | list[tuple[str, str]])
### _method_ `clear(self, domain=None, path=None)` {#Cookies-clear}
- **参数**
- `domain` (str | None)
- `path` (str | None)
- **返回**
- None
### _method_ `delete(self, name, domain=None, path=None)` {#Cookies-delete}
- **参数**
- `name` (str)
- `domain` (str | None)
- `path` (str | None)
- **返回**
- None
### _method_ `get(self, name, default=None, domain=None, path=None)` {#Cookies-get}
- **参数**
- `name` (str)
- `default` (str | None)
- `domain` (str)
- `path` (str)
- **返回**
- str | None
### _method_ `set(self, name, value, domain='', path='/')` {#Cookies-set}
- **参数**
- `name` (str)
- `value` (str)
- `domain` (str)
- `path` (str)
- **返回**
- None
### _method_ `update(self, cookies=None)` {#Cookies-update}
- **参数**
- `cookies` (NoneType | Cookies | http.cookiejar.CookieJar | dict[str, str] | list[tuple[str, str]])
- **返回**
- None
## _class_ `Request(method, url, *, params=None, headers=None, cookies=None, content=None, data=None, json=None, files=None, version=HTTPVersion.H11, timeout=None, proxy=None)` {#Request}
- **参数**
- `method` (str | bytes)
- `url` (URL | str | tuple[bytes, bytes, int | None, bytes])
- `params` (NoneType | str | Mapping[str, str | int | float | list[str | int | float]] | list[tuple[str, str | int | float | list[str | int | float]]])
- `headers` (NoneType | multidict.\_multidict.CIMultiDict[str] | dict[str, str] | list[tuple[str, str]])
- `cookies` (NoneType | Cookies | http.cookiejar.CookieJar | dict[str, str] | list[tuple[str, str]])
- `content` (str | bytes | NoneType)
- `data` (dict | None)
- `json` (Any)
- `files` (dict[str, IO[bytes] | bytes | tuple[str | None, IO[bytes] | bytes] | tuple[str | None, IO[bytes] | bytes, str | None]] | list[tuple[str, IO[bytes] | bytes | tuple[str | None, IO[bytes] | bytes] | tuple[str | None, IO[bytes] | bytes, str | None]]] | NoneType)
- `version` (str | nonebot.internal.driver.model.HTTPVersion)
- `timeout` (float | None)
- `proxy` (str | None)
## _class_ `Response(status_code, *, headers=None, content=None, request=None)` {#Response}
- **参数**
- `status_code` (int)
- `headers` (NoneType | multidict.\_multidict.CIMultiDict[str] | dict[str, str] | list[tuple[str, str]])
- `content` (str | bytes | NoneType)
- `request` (nonebot.internal.driver.model.Request | None)
## _abstract class_ `WebSocket(*, request)` {#WebSocket}
- **参数**
- `request` (nonebot.internal.driver.model.Request)
### _abstract property_ `closed` {#WebSocket-closed}
- **类型:** bool
- **说明:** 连接是否已经关闭
### _abstract async method_ `accept(self)` {#WebSocket-accept}
- **说明**
接受 WebSocket 连接请求
- **返回**
- None
### _abstract async method_ `close(self, code=1000, reason='')` {#WebSocket-close}
- **说明**
关闭 WebSocket 连接请求
- **参数**
- `code` (int)
- `reason` (str)
- **返回**
- None
### _abstract async method_ `receive(self)` {#WebSocket-receive}
- **说明**
接收一条 WebSocket text 信息
- **返回**
- str
### _abstract async method_ `receive_bytes(self)` {#WebSocket-receive_bytes}
- **说明**
接收一条 WebSocket binary 信息
- **返回**
- bytes
### _abstract async method_ `send(self, data)` {#WebSocket-send}
- **说明**
发送一条 WebSocket text 信息
- **参数**
- `data` (str)
- **返回**
- None
### _abstract async method_ `send_bytes(self, data)` {#WebSocket-send_bytes}
- **说明**
发送一条 WebSocket binary 信息
- **参数**
- `data` (bytes)
- **返回**
- None
## _enum_ `HTTPVersion` {#HTTPVersion}
- **说明**
An enumeration.
- **枚举成员**
- `H10`
- `H11`
- `H2`
## _abstract class_ `ForwardMixin()` {#ForwardMixin}
- **说明**
客户端混入基类。
### _abstract property_ `type` {#ForwardMixin-type}
- **类型:** str
- **说明:** 客户端驱动类型名称
### _abstract async method_ `request(self, setup)` {#ForwardMixin-request}
- **说明**
发送一个 HTTP 请求
- **参数**
- `setup` (nonebot.internal.driver.model.Request)
- **返回**
- nonebot.internal.driver.model.Response
### _abstract method_ `websocket(self, setup)` {#ForwardMixin-websocket}
- **说明**
发起一个 WebSocket 连接
- **参数**
- `setup` (nonebot.internal.driver.model.Request)
- **返回**
- AsyncGenerator[nonebot.internal.driver.model.WebSocket, NoneType]
## _abstract class_ `ForwardDriver(env, config)` {#ForwardDriver}
- **说明**
客户端基类。将客户端框架封装，以满足适配器使用。
- **参数**
- `env` ([Env](../config.md#Env))
- `config` ([Config](../config.md#Config))
## _abstract class_ `ReverseDriver(env, config)` {#ReverseDriver}
- **说明**
服务端基类。将后端框架封装，以满足适配器使用。
- **参数**
- `env` ([Env](../config.md#Env))
- `config` ([Config](../config.md#Config))
### _abstract property_ `asgi` {#ReverseDriver-asgi}
- **类型:** Any
- **说明:** 驱动 ASGI 对象
### _abstract property_ `server_app` {#ReverseDriver-server_app}
- **类型:** Any
- **说明:** 驱动 APP 对象
### _abstract method_ `setup_http_server(self, setup)` {#ReverseDriver-setup_http_server}
- **说明**
设置一个 HTTP 服务器路由配置
- **参数**
- `setup` (HTTPServerSetup)
- **返回**
- None
### _abstract method_ `setup_websocket_server(self, setup)` {#ReverseDriver-setup_websocket_server}
- **说明**
设置一个 WebSocket 服务器路由配置
- **参数**
- `setup` (WebSocketServerSetup)
- **返回**
- None
## _def_ `combine_driver(driver, *mixins)` {#combine_driver}
- **说明**
将一个驱动器和多个混入类合并。
- **参数**
- `driver` (Type[nonebot.internal.driver.driver.Driver])
- `*mixins` (Type[nonebot.internal.driver.driver.ForwardMixin])
- **返回**
- Type[nonebot.internal.driver.driver.Driver]
## _class_ `HTTPServerSetup(path, method, name, handle_func)` {#HTTPServerSetup}
- **说明**
HTTP 服务器路由配置。
- **参数**
- `path` (yarl.URL)
- `method` (str)
- `name` (str)
- `handle_func` ((nonebot.internal.driver.model.Request) -> Awaitable[nonebot.internal.driver.model.Response])
## _class_ `WebSocketServerSetup(path, name, handle_func)` {#WebSocketServerSetup}
- **说明**
WebSocket 服务器路由配置。
- **参数**
- `path` (yarl.URL)
- `name` (str)
- `handle_func` ((nonebot.internal.driver.model.WebSocket) -> Awaitable[Any])
## _library-attr_ `URL`
三方库 API