migrate startup/shutdown events to lifespan API

docs_src/app_testing/tutorial003_py39.py

@@ -1,15 +1,19 @@
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 from fastapi.testclient import TestClient
 
-app = FastAPI()
-
 items = {}
 
 
-@app.on_event("startup")
+@asynccontextmanager
-async def startup_event():
+async def lifespan(app):
     items["foo"] = {"name": "Fighters"}
     items["bar"] = {"name": "Tenders"}
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.get("/items/{item_id}")

docs_src/body/tutorial001_py310.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 from pydantic import BaseModel
 
@@ -9,7 +11,12 @@ class Item(BaseModel):
     tax: float | None = None
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/items/")

docs_src/body/tutorial001_py39.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Union
 
 from fastapi import FastAPI
@@ -11,7 +12,12 @@ class Item(BaseModel):
     tax: Union[float, None] = None
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/items/")

docs_src/body/tutorial002_py310.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 from pydantic import BaseModel
 
@@ -9,7 +11,12 @@ class Item(BaseModel):
     tax: float | None = None
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/items/")

docs_src/body/tutorial002_py39.py

@@ -1,3 +1,5 @@
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
 from typing import Union
 
 from fastapi import FastAPI
@@ -11,7 +13,12 @@ class Item(BaseModel):
     tax: Union[float, None] = None
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/items/")

docs_src/events/tutorial001_py39.py

@@ -1,14 +1,18 @@
-from fastapi import FastAPI
+from contextlib import asynccontextmanager
 
-app = FastAPI()
+from fastapi import FastAPI
 
 items = {}
 
 
-@app.on_event("startup")
+@asynccontextmanager
-async def startup_event():
+async def lifespan(app):
     items["foo"] = {"name": "Fighters"}
     items["bar"] = {"name": "Tenders"}
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.get("/items/{item_id}")

docs_src/events/tutorial002_py39.py

@@ -1,14 +1,18 @@
-from fastapi import FastAPI
+from contextlib import asynccontextmanager
 
-app = FastAPI()
+from fastapi import FastAPI
 
 
-@app.on_event("shutdown")
+@asynccontextmanager
-def shutdown_event():
+async def lifespan(app):
+    yield
     with open("log.txt", mode="a") as log:
         log.write("Application shutdown")
 
 
+app = FastAPI(lifespan=lifespan)
+
+
 @app.get("/items/")
 async def read_items():
     return [{"name": "Foo"}]

docs_src/security/tutorial001_an_py39.py

@@ -1,9 +1,16 @@
+from contextlib import asynccontextmanager
 from typing import Annotated
 
 from fastapi import Depends, FastAPI
 from fastapi.security import OAuth2PasswordBearer
 
-app = FastAPI()
+
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
 

docs_src/security/tutorial002_an_py310.py

@@ -1,10 +1,17 @@
+from contextlib import asynccontextmanager
 from typing import Annotated
 
 from fastapi import Depends, FastAPI
 from fastapi.security import OAuth2PasswordBearer
 from pydantic import BaseModel
 
-app = FastAPI()
+
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
 

docs_src/security/tutorial002_py310.py

@@ -1,8 +1,16 @@
+from contextlib import asynccontextmanager
+
 from fastapi import Depends, FastAPI
 from fastapi.security import OAuth2PasswordBearer
 from pydantic import BaseModel
 
-app = FastAPI()
+
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
 

docs_src/security/tutorial002_py39.py

@@ -1,10 +1,17 @@
+from contextlib import asynccontextmanager
 from typing import Union
 
 from fastapi import Depends, FastAPI
 from fastapi.security import OAuth2PasswordBearer
 from pydantic import BaseModel
 
-app = FastAPI()
+
+@asynccontextmanager
+async def lifespan(app):
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
 

docs_src/sql_databases/tutorial001_an_py310.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Annotated
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -29,12 +30,14 @@ def get_session():
 
 SessionDep = Annotated[Session, Depends(get_session)]
 
-app = FastAPI()
 
-
+@asynccontextmanager
-@app.on_event("startup")
+async def lifespan(app):
-def on_startup():
     create_db_and_tables()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/heroes/")

docs_src/sql_databases/tutorial001_an_py39.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Annotated, Union
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -29,12 +30,14 @@ def get_session():
 
 SessionDep = Annotated[Session, Depends(get_session)]
 
-app = FastAPI()
 
-
+@asynccontextmanager
-@app.on_event("startup")
+async def lifespan(app):
-def on_startup():
     create_db_and_tables()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/heroes/")

docs_src/sql_databases/tutorial001_py310.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
 
@@ -25,12 +27,13 @@ def get_session():
         yield session
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    create_db_and_tables()
+    yield
 
 
-@app.on_event("startup")
+app = FastAPI(lifespan=lifespan)
-def on_startup():
-    create_db_and_tables()
 
 
 @app.post("/heroes/")

docs_src/sql_databases/tutorial001_py39.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Union
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -27,12 +28,13 @@ def get_session():
         yield session
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    create_db_and_tables()
+    yield
 
 
-@app.on_event("startup")
+app = FastAPI(lifespan=lifespan)
-def on_startup():
-    create_db_and_tables()
 
 
 @app.post("/heroes/")

docs_src/sql_databases/tutorial002_an_py310.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Annotated
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -45,12 +46,15 @@ def get_session():
 
 
 SessionDep = Annotated[Session, Depends(get_session)]
-app = FastAPI()
 
 
-@app.on_event("startup")
+@asynccontextmanager
-def on_startup():
+async def lifespan(app):
     create_db_and_tables()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/heroes/", response_model=HeroPublic)

docs_src/sql_databases/tutorial002_an_py39.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Annotated, Union
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -45,12 +46,15 @@ def get_session():
 
 
 SessionDep = Annotated[Session, Depends(get_session)]
-app = FastAPI()
 
 
-@app.on_event("startup")
+@asynccontextmanager
-def on_startup():
+async def lifespan(app):
     create_db_and_tables()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.post("/heroes/", response_model=HeroPublic)

docs_src/sql_databases/tutorial002_py310.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import Depends, FastAPI, HTTPException, Query
 from sqlmodel import Field, Session, SQLModel, create_engine, select
 
@@ -42,12 +44,13 @@ def get_session():
         yield session
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    create_db_and_tables()
+    yield
 
 
-@app.on_event("startup")
+app = FastAPI(lifespan=lifespan)
-def on_startup():
-    create_db_and_tables()
 
 
 @app.post("/heroes/", response_model=HeroPublic)

docs_src/sql_databases/tutorial002_py39.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Union
 
 from fastapi import Depends, FastAPI, HTTPException, Query
@@ -44,12 +45,13 @@ def get_session():
         yield session
 
 
-app = FastAPI()
+@asynccontextmanager
+async def lifespan(app):
+    create_db_and_tables()
+    yield
 
 
-@app.on_event("startup")
+app = FastAPI(lifespan=lifespan)
-def on_startup():
-    create_db_and_tables()
 
 
 @app.post("/heroes/", response_model=HeroPublic)