From db42bce7452a3c41083891794947ce2574911d6e Mon Sep 17 00:00:00 2001 From: z0z0r4 Date: Sun, 26 Jan 2025 08:55:25 +0800 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=8C=90=20Update=20testing=20events=20?= =?UTF-8?q?documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `lifespan` should be included in th document, instead of only `startup` and `shutdown` --- docs/en/docs/advanced/testing-events.md | 6 ++++-- docs_src/app_testing/tutorial003.py | 20 ++++++++++++++++---- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/en/docs/advanced/testing-events.md b/docs/en/docs/advanced/testing-events.md index 0c554c4ec..6c800f279 100644 --- a/docs/en/docs/advanced/testing-events.md +++ b/docs/en/docs/advanced/testing-events.md @@ -1,5 +1,7 @@ # Testing Events: startup - shutdown -When you need your event handlers (`startup` and `shutdown`) to run in your tests, you can use the `TestClient` with a `with` statement: +When you need your event handlers (`lifespan`, `startup` and `shutdown`) to run in your tests, you can use the `TestClient` with a `with` statement: -{* ../../docs_src/app_testing/tutorial003.py hl[9:12,20:24] *} +You can read more details about the ["Running lifespan in tests in the official Starlette documentation site."](https://www.starlette.io/lifespan/#running-lifespan-in-tests) + +{* ../../docs_src/app_testing/tutorial003.py hl[9:15,32:37] *} \ No newline at end of file diff --git a/docs_src/app_testing/tutorial003.py b/docs_src/app_testing/tutorial003.py index ca6b45ce0..3b952dd73 100644 --- a/docs_src/app_testing/tutorial003.py +++ b/docs_src/app_testing/tutorial003.py @@ -1,15 +1,27 @@ +from contextlib import asynccontextmanager + from fastapi import FastAPI from fastapi.testclient import TestClient -app = FastAPI() - items = {} -@app.on_event("startup") -async def startup_event(): +@asynccontextmanager +async def lifespan(app: FastAPI): items["foo"] = {"name": "Fighters"} items["bar"] = {"name": "Tenders"} + yield + # clean up items or other work + ... + + +app = FastAPI(lifespan=lifespan) + +# startup event and shutdown event are deprecated, you should use lifespan instead +# @app.on_event("startup") +# async def startup_event(): +# items["foo"] = {"name": "Fighters"} +# items["bar"] = {"name": "Tenders"} @app.get("/items/{item_id}") From fdf38af8ac093e7ffb3958959774f2787d90e4ac Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 26 Jan 2025 00:56:29 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/advanced/testing-events.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/docs/advanced/testing-events.md b/docs/en/docs/advanced/testing-events.md index 6c800f279..4312e8692 100644 --- a/docs/en/docs/advanced/testing-events.md +++ b/docs/en/docs/advanced/testing-events.md @@ -4,4 +4,4 @@ When you need your event handlers (`lifespan`, `startup` and `shutdown`) to run You can read more details about the ["Running lifespan in tests in the official Starlette documentation site."](https://www.starlette.io/lifespan/#running-lifespan-in-tests) -{* ../../docs_src/app_testing/tutorial003.py hl[9:15,32:37] *} \ No newline at end of file +{* ../../docs_src/app_testing/tutorial003.py hl[9:15,32:37] *}