diff --git a/docs/en/docs/tutorial/sql-databases.md b/docs/en/docs/tutorial/sql-databases.md index 1f4b12ca9..2fc27e64b 100644 --- a/docs/en/docs/tutorial/sql-databases.md +++ b/docs/en/docs/tutorial/sql-databases.md @@ -55,7 +55,7 @@ Later we'll improve it increasing security and versatility with **multiple model Import `SQLModel` and create a database model: -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[1:11] hl[7:11] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[1:13] hl[8:12] *} The `Hero` class is very similar to a Pydantic model (in fact, underneath, it actually *is a Pydantic model*). @@ -77,7 +77,7 @@ A SQLModel `engine` (underneath it's actually a SQLAlchemy `engine`) is what **h You would have **one single `engine` object** for all your code to connect to the same database. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[14:18] hl[14:15,17:18] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[15:19] hl[15:16,18:19] *} Using `check_same_thread=False` allows FastAPI to use the same SQLite database in different threads. This is necessary as **one single request** could use **more than one thread** (for example in dependencies). @@ -87,7 +87,7 @@ Don't worry, with the way the code is structured, we'll make sure we use **a sin We then add a function that uses `SQLModel.metadata.create_all(engine)` to **create the tables** for all the *table models*. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[21:22] hl[21:22] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[22:23] hl[22:23] *} ### Create a Session Dependency { #create-a-session-dependency } @@ -97,15 +97,15 @@ We will create a FastAPI **dependency** with `yield` that will provide a new `Se Then we create an `Annotated` dependency `SessionDep` to simplify the rest of the code that will use this dependency. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[25:30] hl[25:27,30] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[26:31] hl[26:28,31] *} ### Create Database Tables on Startup { #create-database-tables-on-startup } We will create the database tables when the application starts. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[33:39] hl[33:37] *} -Here we create the tables on an application startup event. +Here we create the tables using a `lifespan` event. For production you would probably use a migration script that runs before you start your app. 🤓 @@ -123,7 +123,7 @@ For example, if you declare a parameter of type `Hero`, it will be read from the The same way, you can declare it as the function's **return type**, and then the shape of the data will show up in the automatic API docs UI. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[40:45] hl[40:45] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[42:47] hl[42:47] *} Here we use the `SessionDep` dependency (a `Session`) to add the new `Hero` to the `Session` instance, commit the changes to the database, refresh the data in the `hero`, and then return it. @@ -131,19 +131,19 @@ Here we use the `SessionDep` dependency (a `Session`) to add the new `Hero` to t We can **read** `Hero`s from the database using a `select()`. We can include a `limit` and `offset` to paginate the results. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[48:55] hl[51:52,54] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[50:57] hl[53:54,56] *} ### Read One Hero { #read-one-hero } We can **read** a single `Hero`. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[58:63] hl[60] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[60:65] hl[62] *} ### Delete a Hero { #delete-a-hero } We can also **delete** a `Hero`. -{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[66:73] hl[71] *} +{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[68:75] hl[73] *} ### Run the App { #run-the-app } @@ -192,7 +192,7 @@ Let's start with a `HeroBase` model that has all the **fields that are shared** * `name` * `age` -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:9] hl[7:9] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:10] hl[7:10] *} #### `Hero` - the *table model* { #hero-the-table-model } @@ -208,7 +208,7 @@ Because `Hero` inherits from `HeroBase`, it **also** has the **fields** declared * `age` * `secret_name` -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:14] hl[12:14] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:15] hl[12:15] *} #### `HeroPublic` - the public *data model* { #heropublic-the-public-data-model } @@ -234,7 +234,7 @@ All the fields in `HeroPublic` are the same as in `HeroBase`, with `id` declared * `name` * `age` -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:18] hl[17:18] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:19] hl[17:19] *} #### `HeroCreate` - the *data model* to create a hero { #herocreate-the-data-model-to-create-a-hero } @@ -258,7 +258,7 @@ The fields of `HeroCreate` are: * `age` * `secret_name` -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:22] hl[21:22] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:23] hl[21:23] *} #### `HeroUpdate` - the *data model* to update a hero { #heroupdate-the-data-model-to-update-a-hero } @@ -276,7 +276,7 @@ The fields of `HeroUpdate` are: * `age` * `secret_name` -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:28] hl[25:28] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[7:29] hl[25:29] *} ### Create with `HeroCreate` and return a `HeroPublic` { #create-with-herocreate-and-return-a-heropublic } @@ -288,7 +288,7 @@ This new *table model* `Hero` will have the fields sent by the client, and will Then we return the same *table model* `Hero` as is from the function. But as we declare the `response_model` with the `HeroPublic` *data model*, **FastAPI** will use `HeroPublic` to validate and serialize the data. -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[56:62] hl[56:58] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[57:63] hl[57:59] *} /// tip @@ -304,13 +304,13 @@ By declaring it in `response_model` we are telling **FastAPI** to do its thing, We can do the same as before to **read** `Hero`s, again, we use `response_model=list[HeroPublic]` to ensure that the data is validated and serialized correctly. -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[65:72] hl[65] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[66:73] hl[66] *} ### Read One Hero with `HeroPublic` { #read-one-hero-with-heropublic } We can **read** a single hero: -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[75:80] hl[77] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[76:81] hl[78] *} ### Update a Hero with `HeroUpdate` { #update-a-hero-with-heroupdate } @@ -320,7 +320,7 @@ And in the code, we get a `dict` with all the data sent by the client, **only th Then we use `hero_db.sqlmodel_update(hero_data)` to update the `hero_db` with the data from `hero_data`. -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[83:93] hl[83:84,88:89] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[84:94] hl[84:85,89:90] *} ### Delete a Hero Again { #delete-a-hero-again } @@ -328,7 +328,7 @@ Then we use `hero_db.sqlmodel_update(hero_data)` to update the `hero_db` with th We won't satisfy the desire to refactor everything in this one. 😅 -{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[96:103] hl[101] *} +{* ../../docs_src/sql_databases/tutorial002_an_py310.py ln[97:104] hl[102] *} ### Run the App Again { #run-the-app-again } diff --git a/docs_src/sql_databases/tutorial001_an_py310.py b/docs_src/sql_databases/tutorial001_an_py310.py index de1fb81fa..6e35d4ccb 100644 --- a/docs_src/sql_databases/tutorial001_an_py310.py +++ b/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,13 @@ def get_session(): SessionDep = Annotated[Session, Depends(get_session)] -app = FastAPI() +@asynccontextmanager +async def lifespan(app: FastAPI): + create_db_and_tables() + yield -@app.on_event("startup") -def on_startup(): - create_db_and_tables() +app = FastAPI(lifespan=lifespan) @app.post("/heroes/") diff --git a/docs_src/sql_databases/tutorial001_py310.py b/docs_src/sql_databases/tutorial001_py310.py index b58462e6a..a38000caf 100644 --- a/docs_src/sql_databases/tutorial001_py310.py +++ b/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: FastAPI): + create_db_and_tables() + yield -@app.on_event("startup") -def on_startup(): - create_db_and_tables() +app = FastAPI(lifespan=lifespan) @app.post("/heroes/") diff --git a/docs_src/sql_databases/tutorial002_an_py310.py b/docs_src/sql_databases/tutorial002_an_py310.py index 64c554b8a..8c07d4433 100644 --- a/docs_src/sql_databases/tutorial002_an_py310.py +++ b/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,13 @@ def get_session(): SessionDep = Annotated[Session, Depends(get_session)] -app = FastAPI() +@asynccontextmanager +async def lifespan(app: FastAPI): + create_db_and_tables() + yield -@app.on_event("startup") -def on_startup(): - create_db_and_tables() +app = FastAPI(lifespan=lifespan) @app.post("/heroes/", response_model=HeroPublic) diff --git a/docs_src/sql_databases/tutorial002_py310.py b/docs_src/sql_databases/tutorial002_py310.py index ec3d68db5..c2efe088c 100644 --- a/docs_src/sql_databases/tutorial002_py310.py +++ b/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: FastAPI): + create_db_and_tables() + yield -@app.on_event("startup") -def on_startup(): - create_db_and_tables() +app = FastAPI(lifespan=lifespan) @app.post("/heroes/", response_model=HeroPublic) diff --git a/tests/test_tutorial/test_sql_databases/test_tutorial001.py b/tests/test_tutorial/test_sql_databases/test_tutorial001.py index ef556b868..568f4420c 100644 --- a/tests/test_tutorial/test_sql_databases/test_tutorial001.py +++ b/tests/test_tutorial/test_sql_databases/test_tutorial001.py @@ -30,12 +30,9 @@ def clear_sqlmodel(): ) def get_client(request: pytest.FixtureRequest): clear_sqlmodel() - # TODO: remove when updating SQL tutorial to use new lifespan API - with warnings.catch_warnings(record=True): - warnings.simplefilter("always") - mod = importlib.import_module(f"docs_src.sql_databases.{request.param}") - clear_sqlmodel() - importlib.reload(mod) + mod = importlib.import_module(f"docs_src.sql_databases.{request.param}") + clear_sqlmodel() + importlib.reload(mod) mod_any = cast(Any, mod) mod_any.sqlite_url = "sqlite://" mod_any.engine = create_engine( diff --git a/tests/test_tutorial/test_sql_databases/test_tutorial002.py b/tests/test_tutorial/test_sql_databases/test_tutorial002.py index cf8822b13..d93b37f7b 100644 --- a/tests/test_tutorial/test_sql_databases/test_tutorial002.py +++ b/tests/test_tutorial/test_sql_databases/test_tutorial002.py @@ -30,12 +30,9 @@ def clear_sqlmodel(): ) def get_client(request: pytest.FixtureRequest): clear_sqlmodel() - # TODO: remove when updating SQL tutorial to use new lifespan API - with warnings.catch_warnings(record=True): - warnings.simplefilter("always") - mod = importlib.import_module(f"docs_src.sql_databases.{request.param}") - clear_sqlmodel() - importlib.reload(mod) + mod = importlib.import_module(f"docs_src.sql_databases.{request.param}") + clear_sqlmodel() + importlib.reload(mod) mod_any = cast(Any, mod) mod_any.sqlite_url = "sqlite://" mod_any.engine = create_engine(