From 86965ee06d49e4cd347de63a1d560ddd22862031 Mon Sep 17 00:00:00 2001
From: Mix <admin@yami.im>
Date: Sat, 6 Feb 2021 10:46:17 +0800
Subject: [PATCH] :bulb: add comments in quart driver

---
 docs_build/drivers/quart.rst | 12 ++++++++++++
 nonebot/drivers/quart.py     | 26 +++++++++++++++++++++++++-
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 docs_build/drivers/quart.rst

diff --git a/docs_build/drivers/quart.rst b/docs_build/drivers/quart.rst
new file mode 100644
index 00000000..189dd478
--- /dev/null
+++ b/docs_build/drivers/quart.rst
@@ -0,0 +1,12 @@
+---
+contentSidebar: true
+sidebarDepth: 0
+---
+
+NoneBot.drivers.quart 模块
+==========================
+
+.. automodule:: nonebot.drivers.quart
+   :members:
+   :private-members:
+   :show-inheritance:
\ No newline at end of file
diff --git a/nonebot/drivers/quart.py b/nonebot/drivers/quart.py
index 2ee9eb1a..7fa46f68 100644
--- a/nonebot/drivers/quart.py
+++ b/nonebot/drivers/quart.py
@@ -1,3 +1,13 @@
+"""
+Quart 驱动适配
+================
+
+后端使用方法请参考: `Quart 文档`_
+
+.. _Quart 文档:
+    https://pgjones.gitlab.io/quart/index.html
+"""
+
 import asyncio
 from json.decoder import JSONDecodeError
 from typing import (TYPE_CHECKING, Any, Callable, Coroutine, Dict, Optional,
@@ -28,6 +38,14 @@ _AsyncCallable = TypeVar("_AsyncCallable", bound=Callable[..., Coroutine])
 
 
 class Driver(BaseDriver):
+    """
+    Quart 驱动框架
+
+    :上报地址:
+
+      * ``/{adapter name}/http/``: HTTP POST 上报
+      * ``/{adapter name}/ws``: WebSocket 上报
+    """
 
     @overrides(BaseDriver)
     def __init__(self, env: Env, config: NoneBotConfig):
@@ -37,6 +55,7 @@ class Driver(BaseDriver):
 
     @overrides(BaseDriver)
     def register_adapter(self, name: str, adapter: Type["Bot"], **kwargs):
+        """向 Quart 路由添加对应 adapter 响应的 handler"""
         if name in self._adapters:
             return
 
@@ -53,32 +72,37 @@ class Driver(BaseDriver):
     @property
     @overrides(BaseDriver)
     def type(self) -> str:
+        """驱动名称: ``quart``"""
         return 'quart'
 
     @property
     @overrides(BaseDriver)
     def server_app(self) -> Quart:
+        """``Quart`` 对象"""
         return self._server_app
 
     @property
     @overrides(BaseDriver)
     def asgi(self):
+        """``Quart`` 对象"""
         return self._server_app
 
     @property
     @overrides(BaseDriver)
     def logger(self):
+        """fastapi 使用的 logger"""
         return self._server_app.logger
 
     @overrides(BaseDriver)
     def on_startup(self, func: _AsyncCallable) -> _AsyncCallable:
+        """参考文档: `Startup and Shutdown <https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html>`_"""
         return self.server_app.before_serving(func)  # type: ignore
 
     @overrides(BaseDriver)
     def on_shutdown(self, func: _AsyncCallable) -> _AsyncCallable:
+        """参考文档: `Startup and Shutdown <https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html>`_"""
         return self.server_app.after_serving(func)  # type: ignore
 
-    @overrides(BaseDriver)
     @overrides(BaseDriver)
     def run(self,
             host: Optional[str] = None,