Rooba
/
starlette
mirror of https://github.com/encode/starlette.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Explain 'TestClient(app) as client' vs 'client = TestClient(app)' (#1… (#1747) 

* Explain 'TestClient(app) as client' vs 'client = TestClient(app)' (#1733)

* Nit (#1733)

* Update docs/testclient.md (#1733)

Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>

* Update docs/testclient.md

Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>

* Update docs/testclient.md

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>

* Update docs/testclient.md

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>

Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
This commit is contained in:
Redowan Delowar 2022-07-10 18:23:40 +06:00 committed by GitHub
parent e7717af33c
commit 643c3f20e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/testclient.md
View File

@ -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 responses, rather than allowing client to raise the server exception. In this
case you should use `client = TestClient(app, raise_server_exceptions=False)`. 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 ### Selecting the Async backend
`TestClient` takes arguments `backend` (a string) and `backend_options` (a dictionary). `TestClient` takes arguments `backend` (a string) and `backend_options` (a dictionary).