docs: Added debug=True in Testing to display exception stack trace (#…

…3860)

* docs: added `debug==True` in Testing to display exception stack trace

* docs: ruff-format

* docs: add `app.debug = True` to the fixture sample code

docs/examples/testing/test_get_session_data.py

@@ -10,7 +10,7 @@ def set_session_data(request: Request) -> None:
     request.session["foo"] = "bar"
 
 
-app = Litestar(route_handlers=[set_session_data], middleware=[session_config.middleware])
+app = Litestar(route_handlers=[set_session_data], middleware=[session_config.middleware], debug=True)
 
 with TestClient(app=app, session_config=session_config) as client:
     client.post("/test").json()

docs/examples/testing/test_get_session_data_async.py

@@ -10,7 +10,7 @@ def set_session_data(request: Request) -> None:
     request.session["foo"] = "bar"
 
 
-app = Litestar(route_handlers=[set_session_data], middleware=[session_config.middleware])
+app = Litestar(route_handlers=[set_session_data], middleware=[session_config.middleware], debug=True)
 
 
 async def test_set_session_data() -> None:

docs/examples/testing/test_health_check_async.py

@@ -12,7 +12,7 @@ def health_check() -> str:
     return "healthy"
 
 
-app = Litestar(route_handlers=[health_check])
+app = Litestar(route_handlers=[health_check], debug=True)
 
 
 @pytest.fixture(scope="function")

docs/examples/testing/test_health_check_sync.py

@@ -12,7 +12,7 @@ def health_check() -> str:
     return "healthy"
 
 
-app = Litestar(route_handlers=[health_check])
+app = Litestar(route_handlers=[health_check], debug=True)
 
 
 @pytest.fixture(scope="function")

docs/examples/testing/test_set_session_data.py

@@ -12,7 +12,7 @@ def get_session_data(request: Request) -> Dict[str, Any]:
     return request.session
 
 
-app = Litestar(route_handlers=[get_session_data], middleware=[session_config.middleware])
+app = Litestar(route_handlers=[get_session_data], middleware=[session_config.middleware], debug=True)
 
 
 def test_get_session_data() -> None:

docs/examples/testing/test_set_session_data_async.py

@@ -12,7 +12,7 @@ def get_session_data(request: Request) -> Dict[str, Any]:
     return request.session
 
 
-app = Litestar(route_handlers=[get_session_data], middleware=[session_config.middleware])
+app = Litestar(route_handlers=[get_session_data], middleware=[session_config.middleware], debug=True)
 
 
 async def test_get_session_data() -> None:

docs/usage/testing.rst

@@ -42,6 +42,8 @@ We would then test it using the test client like so:
 
             from my_app.main import app
 
+            app.debug = True
+
 
             def test_health_check():
                 with TestClient(app=app) as client:
@@ -60,6 +62,8 @@ We would then test it using the test client like so:
 
             from my_app.main import app
 
+            app.debug = True
+
 
             async def test_health_check():
                 async with AsyncTestClient(app=app) as client:
@@ -90,6 +94,8 @@ Since we would probably need to use the client in multiple places, it's better t
             if TYPE_CHECKING:
                 from litestar import Litestar
 
+            app.debug = True
+
 
             @pytest.fixture(scope="function")
             def test_client() -> Iterator[TestClient[Litestar]]:
@@ -114,6 +120,8 @@ Since we would probably need to use the client in multiple places, it's better t
             if TYPE_CHECKING:
                 from litestar import Litestar
 
+            app.debug = True
+
 
             @pytest.fixture(scope="function")
             async def test_client() -> AsyncIterator[AsyncTestClient[Litestar]]: