LukeParke/connexion
1
0
Fork 0
mirror of https://github.com/LukeHagar/connexion.git synced 2025-12-06 04:19:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix lifespan example (#1893)

Browse Source 
Thanks a lot for this amazing tool.

When adding a `lifespan_handler` to my server, it only works if the
handler is asynchronously. That is consistent with the
[tests](994f53fb04/tests/test_lifespan.py (L13))
but not the documentation. So this PR aims to correct the documentation
This commit is contained in:
Frédéric Collonval
2024-03-20 21:27:07 +01:00
committed by GitHub
parent b3dd9862a3
commit ee399fbfe6
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/lifespan.rst
View File

@@ -18,7 +18,7 @@ instance.
from connexion import AsyncApp, ConnexionMiddleware, request
@contextlib.asynccontextmanager
def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
async def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
"""Called at startup and shutdown, can yield state which will be available on the
request."""
client = Client()
@@ -44,7 +44,7 @@ instance.
from connexion import FlaskApp, ConnexionMiddleware, request
@contextlib.asynccontextmanager
def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
async def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
"""Called at startup and shutdown, can yield state which will be available on the
request."""
client = Client()
@@ -71,7 +71,7 @@ instance.
from connexion import ConnexionMiddleware, request
@contextlib.asynccontextmanager
def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
async def lifespan_handler(app: ConnexionMiddleware) -> typing.AsyncIterator:
"""Called at startup and shutdown, can yield state which will be available on the
request."""
client = Client()
@@ -106,4 +106,4 @@ context manager.
For more information, please refer to the `Starlette documentation`_.
.. _Starlette documentation: https://www.starlette.io/lifespan/
.. _Starlette documentation: https://www.starlette.io/lifespan/