nonebot2/website/versioned_docs/version-2.0.0rc2/api/drivers/quart.md
github-actions[bot] d83866f03b 🔖 Release 2.0.0rc2
2022-11-24 03:55:37 +00:00

4.5 KiB
Raw Blame History

sidebar_position description
5 nonebot.drivers.quart 模块

nonebot.drivers.quart

Quart 驱动适配

nb driver install quart
# 或者
pip install nonebot2[quart]

:::tip 提示 本驱动仅支持服务端连接 :::

class Config(_env_file='<object object>', _env_file_encoding=None, _env_nested_delimiter=None, _secrets_dir=None, *, quart_reload=False, quart_reload_dirs=None, quart_reload_delay=0.25, quart_reload_includes=None, quart_reload_excludes=None)

  • 说明

    Quart 驱动框架设置

  • 参数

    • _env_file (str | os.PathLike | list[str | os.PathLike] | tuple[str | os.PathLike, ...] | NoneType)

    • _env_file_encoding (str | None)

    • _env_nested_delimiter (str | None)

    • _secrets_dir (str | os.PathLike | NoneType)

    • quart_reload (bool)

    • quart_reload_dirs (list[str] | None)

    • quart_reload_delay (float)

    • quart_reload_includes (list[str] | None)

    • quart_reload_excludes (list[str] | None)

class-var quart_reload

  • 类型: bool

  • 说明: 开启/关闭冷重载

class-var quart_reload_dirs

  • 类型: list[str] | None

  • 说明: 重载监控文件夹列表,默认为 uvicorn 默认值

class-var quart_reload_delay

  • 类型: float

  • 说明: 重载延迟,默认为 uvicorn 默认值

class-var quart_reload_includes

  • 类型: list[str] | None

  • 说明: 要监听的文件列表,支持 glob pattern默认为 uvicorn 默认值

class-var quart_reload_excludes

  • 类型: list[str] | None

  • 说明: 不要监听的文件列表,支持 glob pattern默认为 uvicorn 默认值

class Driver(env, config)

  • 说明

    Quart 驱动框架

  • 参数

property asgi

  • 类型:

  • 说明: Quart 对象

property logger

  • 类型:

  • 说明: Quart 使用的 logger

property server_app

  • 类型: quart.app.Quart

  • 说明: Quart 对象

property type

  • 类型: str

  • 说明: 驱动名称: quart

method on_shutdown(self, func)

  • 说明

    参考文档: Startup and Shutdown

  • 参数

    • func ((~ _AsyncCallable))
  • 返回

    • (~ _AsyncCallable)

method on_startup(self, func)

  • 说明

    参考文档: Startup and Shutdown

  • 参数

    • func ((~ _AsyncCallable))
  • 返回

    • (~ _AsyncCallable)

method run(self, host=None, port=None, *, app=None, **kwargs)

  • 说明

    使用 uvicorn 启动 Quart

  • 参数

    • host (str | None)

    • port (int | None)

    • app (str | None)

    • **kwargs

  • 返回

    • Unknown

method setup_http_server(self, setup)

  • 参数

    • setup (nonebot.internal.driver.model.HTTPServerSetup)
  • 返回

    • Unknown

method setup_websocket_server(self, setup)

  • 参数

    • setup (nonebot.internal.driver.model.WebSocketServerSetup)
  • 返回

    • None

class WebSocket(*, request, websocket)

  • 说明

    Quart WebSocket Wrapper

  • 参数

    • request (nonebot.internal.driver.model.Request)

    • websocket (quart.wrappers.websocket.Websocket)

async method accept(self)

  • 返回

    • Unknown

async method close(self, code=1000, reason='')

  • 参数

    • code (int)

    • reason (str)

  • 返回

    • Unknown

async method receive(self)

  • 返回

    • str | bytes

async method receive_bytes(self)

  • 返回

    • bytes

async method receive_text(self)

  • 返回

    • str

async method send_bytes(self, data)

  • 参数

    • data (bytes)
  • 返回

    • Unknown

async method send_text(self, data)

  • 参数

    • data (str)
  • 返回

    • Unknown