This commit is contained in:
Saeid Noormohammadi 2026-02-06 19:06:38 +00:00 committed by GitHub
commit afb703f5bc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 0 deletions

View File

@ -517,6 +517,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[
Optional[Sequence[Callable[[], Any]]],
@ -530,6 +538,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[
Optional[Lifespan[AppType]],

View File

@ -893,6 +893,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[
Optional[Sequence[Callable[[], Any]]],
@ -906,6 +914,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