diff --git a/docs/testclient.md b/docs/testclient.md index 64c766df..f64c570b 100644 --- a/docs/testclient.md +++ b/docs/testclient.md @@ -62,6 +62,13 @@ application. Occasionally you might want to test the content of 500 error responses, rather than allowing client to raise the server exception. In this case you should use `client = TestClient(app, raise_server_exceptions=False)`. +!!! note + + If you want the `TestClient` to run `lifespan` events (`on_startup`, `on_shutdown`, or `lifespan`), + you will need to use the `TestClient` as a context manager. Otherwise, the events + will not be triggered when the `TestClient` is instantiated. You can learn more about it + [here](/events/#running-event-handlers-in-tests). + ### Selecting the Async backend `TestClient` takes arguments `backend` (a string) and `backend_options` (a dictionary).