Merge pull request #21 from mongkok/add-sqlalchemy-engines

Add add_engines method to SQLAlchemyPanel

Author: mongkok

debug_toolbar/panels/sqlalchemy.py

@@ -15,6 +15,10 @@
 class SQLAlchemyPanel(SQLPanel):
     title = "SQLAlchemy"
 
+    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.engines: t.Set[Engine] = set()
+
     def register(self, engine: Engine) -> None:
         event.listen(engine, "before_cursor_execute", self.before_execute)
         event.listen(engine, "after_cursor_execute", self.after_execute)
@@ -51,31 +55,31 @@ def after_execute(
         }
         self.add_query(str(conn.engine.url), query)
 
-    async def process_request(self, request: Request) -> Response:
-        engines: t.Set[Engine] = set()
+    async def add_engines(self, request: Request):
         route = request.scope["route"]
 
         if hasattr(route, "dependant"):
             if request.scope.get("fastapi_astack") is None:
                 async with AsyncExitStack() as stack:
                     request.scope["fastapi_astack"] = stack
-            try:
-                solved_result = await solve_dependencies(
-                    request=request,
-                    dependant=route.dependant,
-                    dependency_overrides_provider=route.dependency_overrides_provider,
-                )
-            except Exception:
-                pass
-            else:
-                for value in solved_result[0].values():
-                    if isinstance(value, Session):
-                        engine = value.get_bind()
-                        engines.add(engine)
-                        self.register(engine)
+
+            solved_result = await solve_dependencies(
+                request=request,
+                dependant=route.dependant,
+                dependency_overrides_provider=route.dependency_overrides_provider,
+            )
+            for value in solved_result[0].values():
+                if isinstance(value, Session):
+                    self.engines.add(value.get_bind())
+
+    async def process_request(self, request: Request) -> Response:
+        await self.add_engines(request)
+
+        for engine in self.engines:
+            self.register(engine)
         try:
             response = await super().process_request(request)
         finally:
-            for engine in engines:
+            for engine in self.engines:
                 self.unregister(engine)
         return response

docs/panels/sql.md

@@ -1,13 +1,31 @@
 ## SQLAlchemy
 
-Please make sure to use the *"Dependency Injection"* system as described in the [FastAPI docs](https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency) and add the `SQLAlchemyPanel` to your panel list:
+Add the `SQLAlchemyPanel` to your panel list:
 
 ```py hl_lines="8"
-{!src/panels/sqlalchemy.py!}
+{!src/panels/sqlalchemy/panel.py!}
 ```
 
 ![SQLAlchemy panel](../img/panels/SQLAlchemy.png)
 
+This panel records all queries using the *"Dependency Injection"* system as described in the [FastAPI docs](https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency).
+
+If you don't use dependencies then create a new class that inherits from `SQLAlchemyPanel`, override the `add_engines` method and add the class path to your panel list:
+
+```py hl_lines="8 9"
+{!src/panels/sqlalchemy/add_engines.py!}
+```
+
+# ::: debug_toolbar.panels.sqlalchemy.SQLAlchemyPanel
+    handlers: python
+    options:
+      heading_level: 3
+      show_bases: false
+      show_root_heading: true
+      members:
+        - add_engines
+
+
 ## Tortoise ORM
 
 Add the `TortoisePanel` to your panel list:

docs/src/panels/sqlalchemy/add_engines.py

@@ -0,0 +1,9 @@
+from debug_toolbar.panels.sqlalchemy import SQLAlchemyPanel as BasePanel
+from sqlalchemy import create_engine
+
+engine = create_engine("sqlite://", connect_args={"check_same_thread": False})
+
+
+class SQLAlchemyPanel(BasePanel):
+    async def add_engines(self, request: Request):
+        self.engines.add(engine)