✨ Add source examples for Python 3.10 and 3.9 with updated syntax (#842)

Co-authored-by: Esteban Maya Cadavid <emayacadavid9@gmail.com>
2026-03-13 09:29:54 +08:00 · 2024-03-21 17:49:38 -05:00
parent 4c3f242ae2
commit 9141c8a920
39 changed files with 7456 additions and 25 deletions
--- a/docs/tutorial/fastapi/multiple-models.md
+++ b/docs/tutorial/fastapi/multiple-models.md
@@ -109,6 +109,36 @@ And we want to have a `HeroRead` with the `id` field, but this time annotated wi

 The simplest way to solve it could be to create **multiple models**, each one with all the corresponding fields:

+//// tab | Python 3.10+
+
+```Python hl_lines="5-9  12-15  18-22"
+# This would work, but there's a better option below 🚨
+
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py[ln:5-22]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="5-9  12-15  18-22"
+# This would work, but there's a better option below 🚨
+
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py[ln:7-24]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="5-9  12-15  18-22"
 # This would work, but there's a better option below 🚨

@@ -119,12 +149,34 @@ The simplest way to solve it could be to create **multiple models**, each one wi
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial001.py!}
 ```

+////
+
 ///

 Here's the important detail, and probably the most important feature of **SQLModel**: only `Hero` is declared with `table = True`.
@@ -147,6 +199,32 @@ Let's now see how to use these new models in the FastAPI application.

 Let's first check how is the process to create a hero now:

+//// tab | Python 3.10+
+
+```Python hl_lines="3-4  6"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py[ln:44-51]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="3-4  6"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py[ln:46-53]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="3-4  6"
 # Code above omitted 👆

@@ -155,18 +233,66 @@ Let's first check how is the process to create a hero now:
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial001.py!}
 ```

+////
+
 ///

 Let's check that in detail.

 Now we use the type annotation `HeroCreate` for the request JSON data in the `hero` parameter of the **path operation function**.

+//// tab | Python 3.10+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py[ln:45]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py[ln:47]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="3"
 # Code above omitted 👆

@@ -175,6 +301,8 @@ Now we use the type annotation `HeroCreate` for the request JSON data in the `he
 # Code below omitted 👇
 ```

+////
+
 Then we create a new `Hero` (this is the actual **table** model that saves things to the database) using `Hero.model_validate()`.

 The method `.model_validate()` reads data from another object with attributes (or a dict) and creates a new instance of this class, in this case `Hero`.
@@ -187,6 +315,32 @@ In versions of **SQLModel** before `0.0.14` you would use the method `.from_orm(

 We can now create a new `Hero` instance (the one for the database) and put it in the variable `db_hero` from the data in the `hero` variable that is the `HeroCreate` instance we received from the request.

+//// tab | Python 3.10+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py[ln:47]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py[ln:49]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="3"
 # Code above omitted 👆

@@ -195,12 +349,40 @@ We can now create a new `Hero` instance (the one for the database) and put it in
 # Code below omitted 👇
 ```

+////
+
 Then we just `add` it to the **session**, `commit`, and `refresh` it, and finally, we return the same `db_hero` variable that has the just refreshed `Hero` instance.

 Because it is just refreshed, it has the `id` field set with a new ID taken from the database.

 And now that we return it, FastAPI will validate the data with the `response_model`, which is a `HeroRead`:

+//// tab | Python 3.10+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py310.py[ln:44]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="3"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial001_py39.py[ln:46]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="3"
 # Code above omitted 👆

@@ -209,6 +391,8 @@ And now that we return it, FastAPI will validate the data with the `response_mod
 # Code below omitted 👇
 ```

+////
+
 This will validate that all the data that we promised is there and will remove any data we didn't declare.

 /// tip
@@ -259,6 +443,32 @@ We can see from above that they all share some **base** fields:

 So let's create a **base** model `HeroBase` that the others can inherit from:

+//// tab | Python 3.10+
+
+```Python hl_lines="3-6"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py[ln:5-8]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="3-6"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py[ln:7-10]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="3-6"
 # Code above omitted 👆

@@ -267,12 +477,34 @@ So let's create a **base** model `HeroBase` that the others can inherit from:
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial002.py!}
 ```

+////
+
 ///

 As you can see, this is *not* a **table model**, it doesn't have the `table = True` config.
@@ -283,6 +515,32 @@ But now we can create the **other models inheriting from it**, they will all sha

 Let's start with the only **table model**, the `Hero`:

+//// tab | Python 3.10+
+
+```Python hl_lines="9-10"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py[ln:5-12]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="9-10"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py[ln:7-14]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="9-10"
 # Code above omitted 👆

@@ -291,12 +549,34 @@ Let's start with the only **table model**, the `Hero`:
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial002.py!}
 ```

+////
+
 ///

 Notice that `Hero` now doesn't inherit from `SQLModel`, but from `HeroBase`.
@@ -313,6 +593,32 @@ And those inherited fields will also be in the **autocompletion** and **inline e

 Notice that the parent model `HeroBase`  is not a **table model**, but still, we can declare `name` and `age` using `Field(index=True)`.

+//// tab | Python 3.10+
+
+```Python hl_lines="4  6  9"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py[ln:5-12]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="4  6  9"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py[ln:7-14]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="4  6  9"
 # Code above omitted 👆

@@ -321,12 +627,34 @@ Notice that the parent model `HeroBase`  is not a **table model**, but still, we
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial002.py!}
 ```

+////
+
 ///

 This won't affect this parent **data model** `HeroBase`.
@@ -339,6 +667,32 @@ Now let's see the `HeroCreate` model that will be used to define the data that w

 This is a fun one:

+//// tab | Python 3.10+
+
+```Python hl_lines="13-14"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py[ln:5-16]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="13-14"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py[ln:7-18]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="13-14"
 # Code above omitted 👆

@@ -347,12 +701,34 @@ This is a fun one:
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial002.py!}
 ```

+////
+
 ///

 What's happening here?
@@ -373,6 +749,32 @@ Now let's check the `HeroRead` model.

 This one just declares that the `id` field is required when reading a hero from the API, because a hero read from the API will come from the database, and in the database it will always have an ID.

+//// tab | Python 3.10+
+
+```Python hl_lines="17-18"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py[ln:5-20]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python hl_lines="17-18"
+# Code above omitted 👆
+
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py[ln:7-22]!}
+
+# Code below omitted 👇
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python hl_lines="17-18"
 # Code above omitted 👆

@@ -381,12 +783,34 @@ This one just declares that the `id` field is required when reading a hero from
 # Code below omitted 👇
 ```

+////
+
 /// details | 👀 Full file preview

+//// tab | Python 3.10+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py310.py!}
+```
+
+////
+
+//// tab | Python 3.9+
+
+```Python
+{!./docs_src/tutorial/fastapi/multiple_models/tutorial002_py39.py!}
+```
+
+////
+
+//// tab | Python 3.7+
+
 ```Python
 {!./docs_src/tutorial/fastapi/multiple_models/tutorial002.py!}
 ```

+////
+
 ///

 ## Review the Updated Docs UI