This commit is contained in:
Saeid Noormohammadi 2026-03-16 10:16:58 +00:00 committed by GitHub
commit 5f2c524f2c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 0 deletions

View File

@ -509,6 +509,14 @@ class FastAPI(Starlette):
Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
"""
),
deprecated(
"""
**Attention**: This parameter is deprecated.
The recommended approach for managing startup and shutdown
is by utilizing the lifespan parameter within the FastAPI app.
"""
),
] = None,
on_shutdown: Annotated[
Sequence[Callable[[], Any]] | None,
@ -522,6 +530,14 @@ class FastAPI(Starlette):
[FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
"""
),
deprecated(
"""
**Attention**: This parameter is deprecated.
The recommended approach for managing startup and shutdown
is by utilizing the lifespan parameter within the FastAPI app.
"""
),
] = None,
lifespan: Annotated[
Lifespan[AppType] | None,

View File

@ -1173,6 +1173,14 @@ class APIRouter(routing.Router):
Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
"""
),
deprecated(
"""
**Attention**: This parameter is deprecated.
The recommended approach for managing startup and shutdown
is by utilizing the lifespan parameter within the APIRouter.
"""
),
] = None,
on_shutdown: Annotated[
Sequence[Callable[[], Any]] | None,
@ -1186,6 +1194,14 @@ class APIRouter(routing.Router):
[FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
"""
),
deprecated(
"""
**Attention**: This parameter is deprecated.
The recommended approach for managing startup and shutdown
is by utilizing the lifespan parameter within the APIRouter.
"""
),
] = None,
# the generic to Lifespan[AppType] is the type of the top level application
# which the router cannot know statically, so we use typing.Any