Sebastián Ramírez
6 months ago
committed by
GitHub
GitHub
70 changed files with 2154 additions and 6336 deletions
@ -1,101 +0,0 @@ |
|||
# 🔬 💽 |
|||
|
|||
👆 💪 ⚙️ 🎏 🔗 🔐 ⚪️➡️ [🔬 🔗 ⏮️ 🔐](testing-dependencies.md){.internal-link target=_blank} 📉 💽 🔬. |
|||
|
|||
👆 💪 💚 ⚒ 🆙 🎏 💽 🔬, 💾 💽 ⏮️ 💯, 🏤-🥧 ⚫️ ⏮️ 🔬 💽, ♒️. |
|||
|
|||
👑 💭 ⚫️❔ 🎏 👆 👀 👈 ⏮️ 📃. |
|||
|
|||
## 🚮 💯 🗄 📱 |
|||
|
|||
➡️ ℹ 🖼 ⚪️➡️ [🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank} ⚙️ 🔬 💽. |
|||
|
|||
🌐 📱 📟 🎏, 👆 💪 🚶 🔙 👈 📃 ✅ ❔ ⚫️. |
|||
|
|||
🕴 🔀 📥 🆕 🔬 📁. |
|||
|
|||
👆 😐 🔗 `get_db()` 🔜 📨 💽 🎉. |
|||
|
|||
💯, 👆 💪 ⚙️ 🔗 🔐 📨 👆 *🛃* 💽 🎉 ↩️ 1️⃣ 👈 🔜 ⚙️ 🛎. |
|||
|
|||
👉 🖼 👥 🔜 ✍ 🍕 💽 🕴 💯. |
|||
|
|||
## 📁 📊 |
|||
|
|||
👥 ✍ 🆕 📁 `sql_app/tests/test_sql_app.py`. |
|||
|
|||
🆕 📁 📊 👀 💖: |
|||
|
|||
``` hl_lines="9-11" |
|||
. |
|||
└── sql_app |
|||
├── __init__.py |
|||
├── crud.py |
|||
├── database.py |
|||
├── main.py |
|||
├── models.py |
|||
├── schemas.py |
|||
└── tests |
|||
├── __init__.py |
|||
└── test_sql_app.py |
|||
``` |
|||
|
|||
## ✍ 🆕 💽 🎉 |
|||
|
|||
🥇, 👥 ✍ 🆕 💽 🎉 ⏮️ 🆕 💽. |
|||
|
|||
💯 👥 🔜 ⚙️ 📁 `test.db` ↩️ `sql_app.db`. |
|||
|
|||
✋️ 🎂 🎉 📟 🌅 ⚖️ 🌘 🎏, 👥 📁 ⚫️. |
|||
|
|||
```Python hl_lines="8-13" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
👆 💪 📉 ❎ 👈 📟 🚮 ⚫️ 🔢 & ⚙️ ⚫️ ⚪️➡️ 👯♂️ `database.py` & `tests/test_sql_app.py`. |
|||
|
|||
🦁 & 🎯 🔛 🎯 🔬 📟, 👥 🖨 ⚫️. |
|||
|
|||
/// |
|||
|
|||
## ✍ 💽 |
|||
|
|||
↩️ 🔜 👥 🔜 ⚙️ 🆕 💽 🆕 📁, 👥 💪 ⚒ 💭 👥 ✍ 💽 ⏮️: |
|||
|
|||
```Python |
|||
Base.metadata.create_all(bind=engine) |
|||
``` |
|||
|
|||
👈 🛎 🤙 `main.py`, ✋️ ⏸ `main.py` ⚙️ 💽 📁 `sql_app.db`, & 👥 💪 ⚒ 💭 👥 ✍ `test.db` 💯. |
|||
|
|||
👥 🚮 👈 ⏸ 📥, ⏮️ 🆕 📁. |
|||
|
|||
```Python hl_lines="16" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
## 🔗 🔐 |
|||
|
|||
🔜 👥 ✍ 🔗 🔐 & 🚮 ⚫️ 🔐 👆 📱. |
|||
|
|||
```Python hl_lines="19-24 27" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
📟 `override_get_db()` 🌖 ⚫️❔ 🎏 `get_db()`, ✋️ `override_get_db()` 👥 ⚙️ `TestingSessionLocal` 🔬 💽 ↩️. |
|||
|
|||
/// |
|||
|
|||
## 💯 📱 |
|||
|
|||
⤴️ 👥 💪 💯 📱 🛎. |
|||
|
|||
```Python hl_lines="32-47" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
& 🌐 🛠️ 👥 ⚒ 💽 ⏮️ 💯 🔜 `test.db` 💽 ↩️ 👑 `sql_app.db`. |
|||
@ -1,576 +0,0 @@ |
|||
# 🗄 (🔗) 💽 ⏮️ 🏒 |
|||
|
|||
/// warning |
|||
|
|||
🚥 👆 ▶️, 🔰 [🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank} 👈 ⚙️ 🇸🇲 🔜 🥃. |
|||
|
|||
💭 🆓 🚶 👉. |
|||
|
|||
/// |
|||
|
|||
🚥 👆 ▶️ 🏗 ⚪️➡️ 🖌, 👆 🎲 👻 📆 ⏮️ 🇸🇲 🐜 ([🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank}), ⚖️ 🙆 🎏 🔁 🐜. |
|||
|
|||
🚥 👆 ⏪ ✔️ 📟 🧢 👈 ⚙️ <a href="https://docs.peewee-orm.com/en/latest/" class="external-link" target="_blank">🏒 🐜</a>, 👆 💪 ✅ 📥 ❔ ⚙️ ⚫️ ⏮️ **FastAPI**. |
|||
|
|||
/// warning | "🐍 3️⃣.7️⃣ ➕ ✔" |
|||
|
|||
👆 🔜 💪 🐍 3️⃣.7️⃣ ⚖️ 🔛 🔒 ⚙️ 🏒 ⏮️ FastAPI. |
|||
|
|||
/// |
|||
|
|||
## 🏒 🔁 |
|||
|
|||
🏒 🚫 🔧 🔁 🛠️, ⚖️ ⏮️ 👫 🤯. |
|||
|
|||
🏒 ✔️ 🏋️ 🔑 🔃 🚮 🔢 & 🔃 ❔ ⚫️ 🔜 ⚙️. |
|||
|
|||
🚥 👆 🛠️ 🈸 ⏮️ 🗝 🚫-🔁 🛠️, & 💪 👷 ⏮️ 🌐 🚮 🔢, **⚫️ 💪 👑 🧰**. |
|||
|
|||
✋️ 🚥 👆 💪 🔀 🔢, 🐕🦺 🌖 🌘 1️⃣ 🔁 💽, 👷 ⏮️ 🔁 🛠️ (💖 FastAPI), ♒️, 👆 🔜 💪 🚮 🏗 ➕ 📟 🔐 👈 🔢. |
|||
|
|||
👐, ⚫️ 💪 ⚫️, & 📥 👆 🔜 👀 ⚫️❔ ⚫️❔ 📟 👆 ✔️ 🚮 💪 ⚙️ 🏒 ⏮️ FastAPI. |
|||
|
|||
/// note | "📡 ℹ" |
|||
|
|||
👆 💪 ✍ 🌅 🔃 🏒 🧍 🔃 🔁 🐍 <a href="https://docs.peewee-orm.com/en/latest/peewee/database.html#async-with-gevent" class="external-link" target="_blank">🩺</a>, <a href="https://github.com/coleifer/peewee/issues/263#issuecomment-517347032" class="external-link" target="_blank">❔</a>, <a href="https://github.com/coleifer/peewee/pull/2072#issuecomment-563215132" class="external-link" target="_blank">🇵🇷</a>. |
|||
|
|||
/// |
|||
|
|||
## 🎏 📱 |
|||
|
|||
👥 🔜 ✍ 🎏 🈸 🇸🇲 🔰 ([🗄 (🔗) 💽](../tutorial/sql-databases.md){.internal-link target=_blank}). |
|||
|
|||
🌅 📟 🤙 🎏. |
|||
|
|||
, 👥 🔜 🎯 🕴 🔛 🔺. |
|||
|
|||
## 📁 📊 |
|||
|
|||
➡️ 💬 👆 ✔️ 📁 📛 `my_super_project` 👈 🔌 🎧-📁 🤙 `sql_app` ⏮️ 📊 💖 👉: |
|||
|
|||
``` |
|||
. |
|||
└── sql_app |
|||
├── __init__.py |
|||
├── crud.py |
|||
├── database.py |
|||
├── main.py |
|||
└── schemas.py |
|||
``` |
|||
|
|||
👉 🌖 🎏 📊 👥 ✔️ 🇸🇲 🔰. |
|||
|
|||
🔜 ➡️ 👀 ⚫️❔ 🔠 📁/🕹 🔨. |
|||
|
|||
## ✍ 🏒 🍕 |
|||
|
|||
➡️ 🔗 📁 `sql_app/database.py`. |
|||
|
|||
### 🐩 🏒 📟 |
|||
|
|||
➡️ 🥇 ✅ 🌐 😐 🏒 📟, ✍ 🏒 💽: |
|||
|
|||
```Python hl_lines="3 5 22" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
✔️ 🤯 👈 🚥 👆 💚 ⚙️ 🎏 💽, 💖 ✳, 👆 🚫 🚫 🔀 🎻. 👆 🔜 💪 ⚙️ 🎏 🏒 💽 🎓. |
|||
|
|||
/// |
|||
|
|||
#### 🗒 |
|||
|
|||
❌: |
|||
|
|||
```Python |
|||
check_same_thread=False |
|||
``` |
|||
|
|||
🌓 1️⃣ 🇸🇲 🔰: |
|||
|
|||
```Python |
|||
connect_args={"check_same_thread": False} |
|||
``` |
|||
|
|||
...⚫️ 💪 🕴 `SQLite`. |
|||
|
|||
/// info | "📡 ℹ" |
|||
|
|||
⚫️❔ 🎏 📡 ℹ [🗄 (🔗) 💽](../tutorial/sql-databases.md#_7){.internal-link target=_blank} ✔. |
|||
|
|||
/// |
|||
|
|||
### ⚒ 🏒 🔁-🔗 `PeeweeConnectionState` |
|||
|
|||
👑 ❔ ⏮️ 🏒 & FastAPI 👈 🏒 ⚓️ 🙇 🔛 <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">🐍 `threading.local`</a>, & ⚫️ 🚫 ✔️ 🎯 🌌 🔐 ⚫️ ⚖️ ➡️ 👆 🍵 🔗/🎉 🔗 (🔨 🇸🇲 🔰). |
|||
|
|||
& `threading.local` 🚫 🔗 ⏮️ 🆕 🔁 ⚒ 🏛 🐍. |
|||
|
|||
/// note | "📡 ℹ" |
|||
|
|||
`threading.local` ⚙️ ✔️ "🎱" 🔢 👈 ✔️ 🎏 💲 🔠 🧵. |
|||
|
|||
👉 ⚠ 🗝 🛠️ 🏗 ✔️ 1️⃣ 👁 🧵 📍 📨, 🙅♂ 🌖, 🙅♂ 🌘. |
|||
|
|||
⚙️ 👉, 🔠 📨 🔜 ✔️ 🚮 👍 💽 🔗/🎉, ❔ ☑ 🏁 🥅. |
|||
|
|||
✋️ FastAPI, ⚙️ 🆕 🔁 ⚒, 💪 🍵 🌅 🌘 1️⃣ 📨 🔛 🎏 🧵. & 🎏 🕰, 👁 📨, ⚫️ 💪 🏃 💗 👜 🎏 🧵 (🧵), ⚓️ 🔛 🚥 👆 ⚙️ `async def` ⚖️ 😐 `def`. 👉 ⚫️❔ 🤝 🌐 🎭 📈 FastAPI. |
|||
|
|||
/// |
|||
|
|||
✋️ 🐍 3️⃣.7️⃣ & 🔛 🚚 🌖 🏧 🎛 `threading.local`, 👈 💪 ⚙️ 🥉 🌐❔ `threading.local` 🔜 ⚙️, ✋️ 🔗 ⏮️ 🆕 🔁 ⚒. |
|||
|
|||
👥 🔜 ⚙️ 👈. ⚫️ 🤙 <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a>. |
|||
|
|||
👥 🔜 🔐 🔗 🍕 🏒 👈 ⚙️ `threading.local` & ❎ 👫 ⏮️ `contextvars`, ⏮️ 🔗 ℹ. |
|||
|
|||
👉 5️⃣📆 😑 🍖 🏗 (& ⚫️ 🤙), 👆 🚫 🤙 💪 🍕 🤔 ❔ ⚫️ 👷 ⚙️ ⚫️. |
|||
|
|||
👥 🔜 ✍ `PeeweeConnectionState`: |
|||
|
|||
```Python hl_lines="10-19" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
👉 🎓 😖 ⚪️➡️ 🎁 🔗 🎓 ⚙️ 🏒. |
|||
|
|||
⚫️ ✔️ 🌐 ⚛ ⚒ 🏒 ⚙️ `contextvars` ↩️ `threading.local`. |
|||
|
|||
`contextvars` 👷 🍖 🎏 🌘 `threading.local`. ✋️ 🎂 🏒 🔗 📟 🤔 👈 👉 🎓 👷 ⏮️ `threading.local`. |
|||
|
|||
, 👥 💪 ➕ 🎱 ⚒ ⚫️ 👷 🚥 ⚫️ ⚙️ `threading.local`. `__init__`, `__setattr__`, & `__getattr__` 🛠️ 🌐 ✔ 🎱 👉 ⚙️ 🏒 🍵 🤔 👈 ⚫️ 🔜 🔗 ⏮️ FastAPI. |
|||
|
|||
/// tip |
|||
|
|||
👉 🔜 ⚒ 🏒 🎭 ☑ 🕐❔ ⚙️ ⏮️ FastAPI. 🚫 🎲 📂 ⚖️ 📪 🔗 👈 ➖ ⚙️, 🏗 ❌, ♒️. |
|||
|
|||
✋️ ⚫️ 🚫 🤝 🏒 🔁 💎-🏋️. 👆 🔜 ⚙️ 😐 `def` 🔢 & 🚫 `async def`. |
|||
|
|||
/// |
|||
|
|||
### ⚙️ 🛃 `PeeweeConnectionState` 🎓 |
|||
|
|||
🔜, 📁 `._state` 🔗 🔢 🏒 💽 `db` 🎚 ⚙️ 🆕 `PeeweeConnectionState`: |
|||
|
|||
```Python hl_lines="24" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
⚒ 💭 👆 📁 `db._state` *⏮️* 🏗 `db`. |
|||
|
|||
/// |
|||
|
|||
/// tip |
|||
|
|||
👆 🔜 🎏 🙆 🎏 🏒 💽, 🔌 `PostgresqlDatabase`, `MySQLDatabase`, ♒️. |
|||
|
|||
/// |
|||
|
|||
## ✍ 💽 🏷 |
|||
|
|||
➡️ 🔜 👀 📁 `sql_app/models.py`. |
|||
|
|||
### ✍ 🏒 🏷 👆 💽 |
|||
|
|||
🔜 ✍ 🏒 🏷 (🎓) `User` & `Item`. |
|||
|
|||
👉 🎏 👆 🔜 🚥 👆 ⏩ 🏒 🔰 & ℹ 🏷 ✔️ 🎏 💽 🇸🇲 🔰. |
|||
|
|||
/// tip |
|||
|
|||
🏒 ⚙️ ⚖ "**🏷**" 🔗 👉 🎓 & 👐 👈 🔗 ⏮️ 💽. |
|||
|
|||
✋️ Pydantic ⚙️ ⚖ "**🏷**" 🔗 🕳 🎏, 💽 🔬, 🛠️, & 🧾 🎓 & 👐. |
|||
|
|||
/// |
|||
|
|||
🗄 `db` ⚪️➡️ `database` (📁 `database.py` ⚪️➡️ 🔛) & ⚙️ ⚫️ 📥. |
|||
|
|||
```Python hl_lines="3 6-12 15-21" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/models.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
🏒 ✍ 📚 🎱 🔢. |
|||
|
|||
⚫️ 🔜 🔁 🚮 `id` 🔢 🔢 👑 🔑. |
|||
|
|||
⚫️ 🔜 ⚒ 📛 🏓 ⚓️ 🔛 🎓 📛. |
|||
|
|||
`Item`, ⚫️ 🔜 ✍ 🔢 `owner_id` ⏮️ 🔢 🆔 `User`. ✋️ 👥 🚫 📣 ⚫️ 🙆. |
|||
|
|||
/// |
|||
|
|||
## ✍ Pydantic 🏷 |
|||
|
|||
🔜 ➡️ ✅ 📁 `sql_app/schemas.py`. |
|||
|
|||
/// tip |
|||
|
|||
❎ 😨 🖖 🏒 *🏷* & Pydantic *🏷*, 👥 🔜 ✔️ 📁 `models.py` ⏮️ 🏒 🏷, & 📁 `schemas.py` ⏮️ Pydantic 🏷. |
|||
|
|||
👫 Pydantic 🏷 🔬 🌅 ⚖️ 🌘 "🔗" (☑ 📊 💠). |
|||
|
|||
👉 🔜 ℹ 👥 ❎ 😨 ⏪ ⚙️ 👯♂️. |
|||
|
|||
/// |
|||
|
|||
### ✍ Pydantic *🏷* / 🔗 |
|||
|
|||
✍ 🌐 🎏 Pydantic 🏷 🇸🇲 🔰: |
|||
|
|||
```Python hl_lines="16-18 21-22 25-30 34-35 38-39 42-48" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
📥 👥 🏗 🏷 ⏮️ `id`. |
|||
|
|||
👥 🚫 🎯 ✔ `id` 🔢 🏒 🏷, ✋️ 🏒 🚮 1️⃣ 🔁. |
|||
|
|||
👥 ❎ 🎱 `owner_id` 🔢 `Item`. |
|||
|
|||
/// |
|||
|
|||
### ✍ `PeeweeGetterDict` Pydantic *🏷* / 🔗 |
|||
|
|||
🕐❔ 👆 🔐 💛 🏒 🎚, 💖 `some_user.items`, 🏒 🚫 🚚 `list` `Item`. |
|||
|
|||
⚫️ 🚚 🎁 🛃 🎚 🎓 `ModelSelect`. |
|||
|
|||
⚫️ 💪 ✍ `list` 🚮 🏬 ⏮️ `list(some_user.items)`. |
|||
|
|||
✋️ 🎚 ⚫️ 🚫 `list`. & ⚫️ 🚫 ☑ 🐍 <a href="https://docs.python.org/3/glossary.html#term-generator" class="external-link" target="_blank">🚂</a>. ↩️ 👉, Pydantic 🚫 💭 🔢 ❔ 🗜 ⚫️ `list` Pydantic *🏷* / 🔗. |
|||
|
|||
✋️ ⏮️ ⏬ Pydantic ✔ 🚚 🛃 🎓 👈 😖 ⚪️➡️ `pydantic.utils.GetterDict`, 🚚 🛠️ ⚙️ 🕐❔ ⚙️ `orm_mode = True` 🗃 💲 🐜 🏷 🔢. |
|||
|
|||
👥 🔜 ✍ 🛃 `PeeweeGetterDict` 🎓 & ⚙️ ⚫️ 🌐 🎏 Pydantic *🏷* / 🔗 👈 ⚙️ `orm_mode`: |
|||
|
|||
```Python hl_lines="3 8-13 31 49" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
📥 👥 ✅ 🚥 🔢 👈 ➖ 🔐 (✅ `.items` `some_user.items`) 👐 `peewee.ModelSelect`. |
|||
|
|||
& 🚥 👈 💼, 📨 `list` ⏮️ ⚫️. |
|||
|
|||
& ⤴️ 👥 ⚙️ ⚫️ Pydantic *🏷* / 🔗 👈 ⚙️ `orm_mode = True`, ⏮️ 📳 🔢 `getter_dict = PeeweeGetterDict`. |
|||
|
|||
/// tip |
|||
|
|||
👥 🕴 💪 ✍ 1️⃣ `PeeweeGetterDict` 🎓, & 👥 💪 ⚙️ ⚫️ 🌐 Pydantic *🏷* / 🔗. |
|||
|
|||
/// |
|||
|
|||
## 💩 🇨🇻 |
|||
|
|||
🔜 ➡️ 👀 📁 `sql_app/crud.py`. |
|||
|
|||
### ✍ 🌐 💩 🇨🇻 |
|||
|
|||
✍ 🌐 🎏 💩 🇨🇻 🇸🇲 🔰, 🌐 📟 📶 🎏: |
|||
|
|||
```Python hl_lines="1 4-5 8-9 12-13 16-20 23-24 27-30" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/crud.py!} |
|||
``` |
|||
|
|||
📤 🔺 ⏮️ 📟 🇸🇲 🔰. |
|||
|
|||
👥 🚫 🚶♀️ `db` 🔢 🤭. ↩️ 👥 ⚙️ 🏷 🔗. 👉 ↩️ `db` 🎚 🌐 🎚, 👈 🔌 🌐 🔗 ⚛. 👈 ⚫️❔ 👥 ✔️ 🌐 `contextvars` ℹ 🔛. |
|||
|
|||
🆖, 🕐❔ 🛬 📚 🎚, 💖 `get_users`, 👥 🔗 🤙 `list`, 💖: |
|||
|
|||
```Python |
|||
list(models.User.select()) |
|||
``` |
|||
|
|||
👉 🎏 🤔 👈 👥 ✔️ ✍ 🛃 `PeeweeGetterDict`. ✋️ 🛬 🕳 👈 ⏪ `list` ↩️ `peewee.ModelSelect` `response_model` *➡ 🛠️* ⏮️ `List[models.User]` (👈 👥 🔜 👀 ⏪) 🔜 👷 ☑. |
|||
|
|||
## 👑 **FastAPI** 📱 |
|||
|
|||
& 🔜 📁 `sql_app/main.py` ➡️ 🛠️ & ⚙️ 🌐 🎏 🍕 👥 ✍ ⏭. |
|||
|
|||
### ✍ 💽 🏓 |
|||
|
|||
📶 🙃 🌌 ✍ 💽 🏓: |
|||
|
|||
```Python hl_lines="9-11" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### ✍ 🔗 |
|||
|
|||
✍ 🔗 👈 🔜 🔗 💽 ▶️️ ▶️ 📨 & 🔌 ⚫️ 🔚: |
|||
|
|||
```Python hl_lines="23-29" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
📥 👥 ✔️ 🛁 `yield` ↩️ 👥 🤙 🚫 ⚙️ 💽 🎚 🔗. |
|||
|
|||
⚫️ 🔗 💽 & ♻ 🔗 💽 🔗 🔢 👈 🔬 🔠 📨 (⚙️ `contextvars` 🎱 ⚪️➡️ 🔛). |
|||
|
|||
↩️ 💽 🔗 ⚠ 👤/🅾 🚧, 👉 🔗 ✍ ⏮️ 😐 `def` 🔢. |
|||
|
|||
& ⤴️, 🔠 *➡ 🛠️ 🔢* 👈 💪 🔐 💽 👥 🚮 ⚫️ 🔗. |
|||
|
|||
✋️ 👥 🚫 ⚙️ 💲 👐 👉 🔗 (⚫️ 🤙 🚫 🤝 🙆 💲, ⚫️ ✔️ 🛁 `yield`). , 👥 🚫 🚮 ⚫️ *➡ 🛠️ 🔢* ✋️ *➡ 🛠️ 👨🎨* `dependencies` 🔢: |
|||
|
|||
```Python hl_lines="32 40 47 59 65 72" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### 🔑 🔢 🎧-🔗 |
|||
|
|||
🌐 `contextvars` 🍕 👷, 👥 💪 ⚒ 💭 👥 ✔️ 🔬 💲 `ContextVar` 🔠 📨 👈 ⚙️ 💽, & 👈 💲 🔜 ⚙️ 💽 🇵🇸 (🔗, 💵, ♒️) 🎂 📨. |
|||
|
|||
👈, 👥 💪 ✍ ➕1️⃣ `async` 🔗 `reset_db_state()` 👈 ⚙️ 🎧-🔗 `get_db()`. ⚫️ 🔜 ⚒ 💲 🔑 🔢 (⏮️ 🔢 `dict`) 👈 🔜 ⚙️ 💽 🇵🇸 🎂 📨. & ⤴️ 🔗 `get_db()` 🔜 🏪 ⚫️ 💽 🇵🇸 (🔗, 💵, ♒️). |
|||
|
|||
```Python hl_lines="18-20" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
**⏭ 📨**, 👥 🔜 ⏲ 👈 🔑 🔢 🔄 `async` 🔗 `reset_db_state()` & ⤴️ ✍ 🆕 🔗 `get_db()` 🔗, 👈 🆕 📨 🔜 ✔️ 🚮 👍 💽 🇵🇸 (🔗, 💵, ♒️). |
|||
|
|||
/// tip |
|||
|
|||
FastAPI 🔁 🛠️, 1️⃣ 📨 💪 ▶️ ➖ 🛠️, & ⏭ 🏁, ➕1️⃣ 📨 💪 📨 & ▶️ 🏭 👍, & ⚫️ 🌐 💪 🛠️ 🎏 🧵. |
|||
|
|||
✋️ 🔑 🔢 🤔 👫 🔁 ⚒,, 🏒 💽 🇵🇸 ⚒ `async` 🔗 `reset_db_state()` 🔜 🚧 🚮 👍 💽 🎂 🎂 📨. |
|||
|
|||
& 🎏 🕰, 🎏 🛠️ 📨 🔜 ✔️ 🚮 👍 💽 🇵🇸 👈 🔜 🔬 🎂 📨. |
|||
|
|||
/// |
|||
|
|||
#### 🏒 🗳 |
|||
|
|||
🚥 👆 ⚙️ <a href="https://docs.peewee-orm.com/en/latest/peewee/database.html#dynamically-defining-a-database" class="external-link" target="_blank">🏒 🗳</a>, ☑ 💽 `db.obj`. |
|||
|
|||
, 👆 🔜 ⏲ ⚫️ ⏮️: |
|||
|
|||
```Python hl_lines="3-4" |
|||
async def reset_db_state(): |
|||
database.db.obj._state._state.set(db_state_default.copy()) |
|||
database.db.obj._state.reset() |
|||
``` |
|||
|
|||
### ✍ 👆 **FastAPI** *➡ 🛠️* |
|||
|
|||
🔜, 😒, 📥 🐩 **FastAPI** *➡ 🛠️* 📟. |
|||
|
|||
```Python hl_lines="32-37 40-43 46-53 56-62 65-68 71-79" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### 🔃 `def` 🆚 `async def` |
|||
|
|||
🎏 ⏮️ 🇸🇲, 👥 🚫 🔨 🕳 💖: |
|||
|
|||
```Python |
|||
user = await models.User.select().first() |
|||
``` |
|||
|
|||
...✋️ ↩️ 👥 ⚙️: |
|||
|
|||
```Python |
|||
user = models.User.select().first() |
|||
``` |
|||
|
|||
, 🔄, 👥 🔜 📣 *➡ 🛠️ 🔢* & 🔗 🍵 `async def`, ⏮️ 😐 `def`,: |
|||
|
|||
```Python hl_lines="2" |
|||
# Something goes here |
|||
def read_users(skip: int = 0, limit: int = 100): |
|||
# Something goes here |
|||
``` |
|||
|
|||
## 🔬 🏒 ⏮️ 🔁 |
|||
|
|||
👉 🖼 🔌 ➕ *➡ 🛠️* 👈 🔬 📏 🏭 📨 ⏮️ `time.sleep(sleep_time)`. |
|||
|
|||
⚫️ 🔜 ✔️ 💽 🔗 📂 ▶️ & 🔜 ⌛ 🥈 ⏭ 🙇 🔙. & 🔠 🆕 📨 🔜 ⌛ 🕐 🥈 🌘. |
|||
|
|||
👉 🔜 💪 ➡️ 👆 💯 👈 👆 📱 ⏮️ 🏒 & FastAPI 🎭 ☑ ⏮️ 🌐 💩 🔃 🧵. |
|||
|
|||
🚥 👆 💚 ✅ ❔ 🏒 🔜 💔 👆 📱 🚥 ⚙️ 🍵 🛠️, 🚶 `sql_app/database.py` 📁 & 🏤 ⏸: |
|||
|
|||
```Python |
|||
# db._state = PeeweeConnectionState() |
|||
``` |
|||
|
|||
& 📁 `sql_app/main.py` 📁, 🏤 💪 `async` 🔗 `reset_db_state()` & ❎ ⚫️ ⏮️ `pass`: |
|||
|
|||
```Python |
|||
async def reset_db_state(): |
|||
# database.db._state._state.set(db_state_default.copy()) |
|||
# database.db._state.reset() |
|||
pass |
|||
``` |
|||
|
|||
⤴️ 🏃 👆 📱 ⏮️ Uvicorn: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uvicorn sql_app.main:app --reload |
|||
|
|||
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
📂 👆 🖥 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a> & ✍ 👩❤👨 👩💻. |
|||
|
|||
⤴️ 📂 1️⃣0️⃣ 📑 <a href="http://127.0.0.1:8000/docs#/default/read_slow_users_slowusers__get" class="external-link" target="_blank">http://127.0.0.1:8000/docs#/default/read_🐌_👩💻_slowusers_ = </a> 🎏 🕰. |
|||
|
|||
🚶 *➡ 🛠️* "🤚 `/slowusers/`" 🌐 📑. ⚙️ "🔄 ⚫️ 👅" 🔼 & 🛠️ 📨 🔠 📑, 1️⃣ ▶️️ ⏮️ 🎏. |
|||
|
|||
📑 🔜 ⌛ 🍖 & ⤴️ 👫 🔜 🎦 `Internal Server Error`. |
|||
|
|||
### ⚫️❔ 🔨 |
|||
|
|||
🥇 📑 🔜 ⚒ 👆 📱 ✍ 🔗 💽 & ⌛ 🥈 ⏭ 🙇 🔙 & 📪 💽 🔗. |
|||
|
|||
⤴️, 📨 ⏭ 📑, 👆 📱 🔜 ⌛ 🕐 🥈 🌘, & 🔛. |
|||
|
|||
👉 ⛓ 👈 ⚫️ 🔜 🔚 🆙 🏁 🏁 📑' 📨 ⏪ 🌘 ⏮️ 🕐. |
|||
|
|||
⤴️ 1️⃣ 🏁 📨 👈 ⌛ 🌘 🥈 🔜 🔄 📂 💽 🔗, ✋️ 1️⃣ 📚 ⏮️ 📨 🎏 📑 🔜 🎲 🍵 🎏 🧵 🥇 🕐, ⚫️ 🔜 ✔️ 🎏 💽 🔗 👈 ⏪ 📂, & 🏒 🔜 🚮 ❌ & 👆 🔜 👀 ⚫️ 📶, & 📨 🔜 ✔️ `Internal Server Error`. |
|||
|
|||
👉 🔜 🎲 🔨 🌅 🌘 1️⃣ 📚 📑. |
|||
|
|||
🚥 👆 ✔️ 💗 👩💻 💬 👆 📱 ⚫️❔ 🎏 🕰, 👉 ⚫️❔ 💪 🔨. |
|||
|
|||
& 👆 📱 ▶️ 🍵 🌅 & 🌖 👩💻 🎏 🕰, ⌛ 🕰 👁 📨 💪 📏 & 📏 ⏲ ❌. |
|||
|
|||
### 🔧 🏒 ⏮️ FastAPI |
|||
|
|||
🔜 🚶 🔙 📁 `sql_app/database.py`, & ✍ ⏸: |
|||
|
|||
```Python |
|||
db._state = PeeweeConnectionState() |
|||
``` |
|||
|
|||
& 📁 `sql_app/main.py` 📁, ✍ 💪 `async` 🔗 `reset_db_state()`: |
|||
|
|||
```Python |
|||
async def reset_db_state(): |
|||
database.db._state._state.set(db_state_default.copy()) |
|||
database.db._state.reset() |
|||
``` |
|||
|
|||
❎ 👆 🏃♂ 📱 & ▶️ ⚫️ 🔄. |
|||
|
|||
🔁 🎏 🛠️ ⏮️ 1️⃣0️⃣ 📑. 👉 🕰 🌐 👫 🔜 ⌛ & 👆 🔜 🤚 🌐 🏁 🍵 ❌. |
|||
|
|||
...👆 🔧 ⚫️ ❗ |
|||
|
|||
## 📄 🌐 📁 |
|||
|
|||
💭 👆 🔜 ✔️ 📁 📛 `my_super_project` (⚖️ 👐 👆 💚) 👈 🔌 🎧-📁 🤙 `sql_app`. |
|||
|
|||
`sql_app` 🔜 ✔️ 📄 📁: |
|||
|
|||
* `sql_app/__init__.py`: 🛁 📁. |
|||
|
|||
* `sql_app/database.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
* `sql_app/models.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/models.py!} |
|||
``` |
|||
|
|||
* `sql_app/schemas.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
* `sql_app/crud.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/crud.py!} |
|||
``` |
|||
|
|||
* `sql_app/main.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
## 📡 ℹ |
|||
|
|||
/// warning |
|||
|
|||
👉 📶 📡 ℹ 👈 👆 🎲 🚫 💪. |
|||
|
|||
/// |
|||
|
|||
### ⚠ |
|||
|
|||
🏒 ⚙️ <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">`threading.local`</a> 🔢 🏪 ⚫️ 💽 "🇵🇸" 💽 (🔗, 💵, ♒️). |
|||
|
|||
`threading.local` ✍ 💲 🌟 ⏮️ 🧵, ✋️ 🔁 🛠️ 🔜 🏃 🌐 📟 (✅ 🔠 📨) 🎏 🧵, & 🎲 🚫 ✔. |
|||
|
|||
🔛 🔝 👈, 🔁 🛠️ 💪 🏃 🔁 📟 🧵 (⚙️ `asyncio.run_in_executor`), ✋️ 🔗 🎏 📨. |
|||
|
|||
👉 ⛓ 👈, ⏮️ 🏒 ⏮️ 🛠️, 💗 📋 💪 ⚙️ 🎏 `threading.local` 🔢 & 🔚 🆙 🤝 🎏 🔗 & 💽 (👈 👫 🚫🔜 🚫), & 🎏 🕰, 🚥 👫 🛠️ 🔁 👤/🅾-🚧 📟 🧵 (⏮️ 😐 `def` 🔢 FastAPI, *➡ 🛠️* & 🔗), 👈 📟 🏆 🚫 ✔️ 🔐 💽 🇵🇸 🔢, ⏪ ⚫️ 🍕 🎏 📨 & ⚫️ 🔜 💪 🤚 🔐 🎏 💽 🇵🇸. |
|||
|
|||
### 🔑 🔢 |
|||
|
|||
🐍 3️⃣.7️⃣ ✔️ <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a> 👈 💪 ✍ 🇧🇿 🔢 📶 🎏 `threading.local`, ✋️ 🔗 👫 🔁 ⚒. |
|||
|
|||
📤 📚 👜 ✔️ 🤯. |
|||
|
|||
`ContextVar` ✔️ ✍ 🔝 🕹, 💖: |
|||
|
|||
```Python |
|||
some_var = ContextVar("some_var", default="default value") |
|||
``` |
|||
|
|||
⚒ 💲 ⚙️ ⏮️ "🔑" (✅ ⏮️ 📨) ⚙️: |
|||
|
|||
```Python |
|||
some_var.set("new value") |
|||
``` |
|||
|
|||
🤚 💲 🙆 🔘 🔑 (✅ 🙆 🍕 🚚 ⏮️ 📨) ⚙️: |
|||
|
|||
```Python |
|||
some_var.get() |
|||
``` |
|||
|
|||
### ⚒ 🔑 🔢 `async` 🔗 `reset_db_state()` |
|||
|
|||
🚥 🍕 🔁 📟 ⚒ 💲 ⏮️ `some_var.set("updated in function")` (✅ 💖 `async` 🔗), 🎂 📟 ⚫️ & 📟 👈 🚶 ⏮️ (✅ 📟 🔘 `async` 🔢 🤙 ⏮️ `await`) 🔜 👀 👈 🆕 💲. |
|||
|
|||
, 👆 💼, 🚥 👥 ⚒ 🏒 🇵🇸 🔢 (⏮️ 🔢 `dict`) `async` 🔗, 🌐 🎂 🔗 📟 👆 📱 🔜 👀 👉 💲 & 🔜 💪 ♻ ⚫️ 🎂 📨. |
|||
|
|||
& 🔑 🔢 🔜 ⚒ 🔄 ⏭ 📨, 🚥 👫 🛠️. |
|||
|
|||
### ⚒ 💽 🇵🇸 🔗 `get_db()` |
|||
|
|||
`get_db()` 😐 `def` 🔢, **FastAPI** 🔜 ⚒ ⚫️ 🏃 🧵, ⏮️ *📁* "🔑", 🧑🤝🧑 🎏 💲 🔑 🔢 ( `dict` ⏮️ ⏲ 💽 🇵🇸). ⤴️ ⚫️ 💪 🚮 💽 🇵🇸 👈 `dict`, 💖 🔗, ♒️. |
|||
|
|||
✋️ 🚥 💲 🔑 🔢 (🔢 `dict`) ⚒ 👈 😐 `def` 🔢, ⚫️ 🔜 ✍ 🆕 💲 👈 🔜 🚧 🕴 👈 🧵 🧵, & 🎂 📟 (💖 *➡ 🛠️ 🔢*) 🚫🔜 ✔️ 🔐 ⚫️. `get_db()` 👥 💪 🕴 ⚒ 💲 `dict`, ✋️ 🚫 🎂 `dict` ⚫️. |
|||
|
|||
, 👥 💪 ✔️ `async` 🔗 `reset_db_state()` ⚒ `dict` 🔑 🔢. 👈 🌌, 🌐 📟 ✔️ 🔐 🎏 `dict` 💽 🇵🇸 👁 📨. |
|||
|
|||
### 🔗 & 🔌 🔗 `get_db()` |
|||
|
|||
⤴️ ⏭ ❔ 🔜, ⚫️❔ 🚫 🔗 & 🔌 💽 `async` 🔗 ⚫️, ↩️ `get_db()`❓ |
|||
|
|||
`async` 🔗 ✔️ `async` 🔑 🔢 🛡 🎂 📨, ✋️ 🏗 & 📪 💽 🔗 ⚠ 🚧, ⚫️ 💪 📉 🎭 🚥 ⚫️ 📤. |
|||
|
|||
👥 💪 😐 `def` 🔗 `get_db()`. |
|||
@ -1,111 +0,0 @@ |
|||
# Testing a Database |
|||
|
|||
/// info |
|||
|
|||
These docs are about to be updated. 🎉 |
|||
|
|||
The current version assumes Pydantic v1, and SQLAlchemy versions less than 2.0. |
|||
|
|||
The new docs will include Pydantic v2 and will use <a href="https://sqlmodel.tiangolo.com/" class="external-link" target="_blank">SQLModel</a> (which is also based on SQLAlchemy) once it is updated to use Pydantic v2 as well. |
|||
|
|||
/// |
|||
|
|||
You can use the same dependency overrides from [Testing Dependencies with Overrides](testing-dependencies.md){.internal-link target=_blank} to alter a database for testing. |
|||
|
|||
You could want to set up a different database for testing, rollback the data after the tests, pre-fill it with some testing data, etc. |
|||
|
|||
The main idea is exactly the same you saw in that previous chapter. |
|||
|
|||
## Add tests for the SQL app |
|||
|
|||
Let's update the example from [SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank} to use a testing database. |
|||
|
|||
All the app code is the same, you can go back to that chapter check how it was. |
|||
|
|||
The only changes here are in the new testing file. |
|||
|
|||
Your normal dependency `get_db()` would return a database session. |
|||
|
|||
In the test, you could use a dependency override to return your *custom* database session instead of the one that would be used normally. |
|||
|
|||
In this example we'll create a temporary database only for the tests. |
|||
|
|||
## File structure |
|||
|
|||
We create a new file at `sql_app/tests/test_sql_app.py`. |
|||
|
|||
So the new file structure looks like: |
|||
|
|||
``` hl_lines="9-11" |
|||
. |
|||
└── sql_app |
|||
├── __init__.py |
|||
├── crud.py |
|||
├── database.py |
|||
├── main.py |
|||
├── models.py |
|||
├── schemas.py |
|||
└── tests |
|||
├── __init__.py |
|||
└── test_sql_app.py |
|||
``` |
|||
|
|||
## Create the new database session |
|||
|
|||
First, we create a new database session with the new database. |
|||
|
|||
We'll use an in-memory database that persists during the tests instead of the local file `sql_app.db`. |
|||
|
|||
But the rest of the session code is more or less the same, we just copy it. |
|||
|
|||
```Python hl_lines="8-13" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
You could reduce duplication in that code by putting it in a function and using it from both `database.py` and `tests/test_sql_app.py`. |
|||
|
|||
For simplicity and to focus on the specific testing code, we are just copying it. |
|||
|
|||
/// |
|||
|
|||
## Create the database |
|||
|
|||
Because now we are going to use a new database in a new file, we need to make sure we create the database with: |
|||
|
|||
```Python |
|||
Base.metadata.create_all(bind=engine) |
|||
``` |
|||
|
|||
That is normally called in `main.py`, but the line in `main.py` uses the database file `sql_app.db`, and we need to make sure we create `test.db` for the tests. |
|||
|
|||
So we add that line here, with the new file. |
|||
|
|||
```Python hl_lines="16" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
## Dependency override |
|||
|
|||
Now we create the dependency override and add it to the overrides for our app. |
|||
|
|||
```Python hl_lines="19-24 27" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
The code for `override_get_db()` is almost exactly the same as for `get_db()`, but in `override_get_db()` we use the `TestingSessionLocal` for the testing database instead. |
|||
|
|||
/// |
|||
|
|||
## Test the app |
|||
|
|||
Then we can just test the app as normally. |
|||
|
|||
```Python hl_lines="32-47" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
And all the modifications we made in the database during the tests will be in the `test.db` database instead of the main `sql_app.db`. |
|||
@ -1,201 +0,0 @@ |
|||
# ~~Async SQL (Relational) Databases with Encode/Databases~~ (deprecated) |
|||
|
|||
/// info |
|||
|
|||
These docs are about to be updated. 🎉 |
|||
|
|||
The current version assumes Pydantic v1. |
|||
|
|||
The new docs will include Pydantic v2 and will use <a href="https://sqlmodel.tiangolo.com/" class="external-link" target="_blank">SQLModel</a> once it is updated to use Pydantic v2 as well. |
|||
|
|||
/// |
|||
|
|||
/// warning | "Deprecated" |
|||
|
|||
This tutorial is deprecated and will be removed in a future version. |
|||
|
|||
/// |
|||
|
|||
You can also use <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases`</a> with **FastAPI** to connect to databases using `async` and `await`. |
|||
|
|||
It is compatible with: |
|||
|
|||
* PostgreSQL |
|||
* MySQL |
|||
* SQLite |
|||
|
|||
In this example, we'll use **SQLite**, because it uses a single file and Python has integrated support. So, you can copy this example and run it as is. |
|||
|
|||
Later, for your production application, you might want to use a database server like **PostgreSQL**. |
|||
|
|||
/// tip |
|||
|
|||
You could adopt ideas from the section about SQLAlchemy ORM ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}), like using utility functions to perform operations in the database, independent of your **FastAPI** code. |
|||
|
|||
This section doesn't apply those ideas, to be equivalent to the counterpart in <a href="https://www.starlette.io/database/" class="external-link" target="_blank">Starlette</a>. |
|||
|
|||
/// |
|||
|
|||
## Import and set up `SQLAlchemy` |
|||
|
|||
* Import `SQLAlchemy`. |
|||
* Create a `metadata` object. |
|||
* Create a table `notes` using the `metadata` object. |
|||
|
|||
```Python hl_lines="4 14 16-22" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
Notice that all this code is pure SQLAlchemy Core. |
|||
|
|||
`databases` is not doing anything here yet. |
|||
|
|||
/// |
|||
|
|||
## Import and set up `databases` |
|||
|
|||
* Import `databases`. |
|||
* Create a `DATABASE_URL`. |
|||
* Create a `database` object. |
|||
|
|||
```Python hl_lines="3 9 12" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
If you were connecting to a different database (e.g. PostgreSQL), you would need to change the `DATABASE_URL`. |
|||
|
|||
/// |
|||
|
|||
## Create the tables |
|||
|
|||
In this case, we are creating the tables in the same Python file, but in production, you would probably want to create them with Alembic, integrated with migrations, etc. |
|||
|
|||
Here, this section would run directly, right before starting your **FastAPI** application. |
|||
|
|||
* Create an `engine`. |
|||
* Create all the tables from the `metadata` object. |
|||
|
|||
```Python hl_lines="25-28" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Create models |
|||
|
|||
Create Pydantic models for: |
|||
|
|||
* Notes to be created (`NoteIn`). |
|||
* Notes to be returned (`Note`). |
|||
|
|||
```Python hl_lines="31-33 36-39" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
By creating these Pydantic models, the input data will be validated, serialized (converted), and annotated (documented). |
|||
|
|||
So, you will be able to see it all in the interactive API docs. |
|||
|
|||
## Connect and disconnect |
|||
|
|||
* Create your `FastAPI` application. |
|||
* Create event handlers to connect and disconnect from the database. |
|||
|
|||
```Python hl_lines="42 45-47 50-52" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Read notes |
|||
|
|||
Create the *path operation function* to read notes: |
|||
|
|||
```Python hl_lines="55-58" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
/// note |
|||
|
|||
Notice that as we communicate with the database using `await`, the *path operation function* is declared with `async`. |
|||
|
|||
/// |
|||
|
|||
### Notice the `response_model=List[Note]` |
|||
|
|||
It uses `typing.List`. |
|||
|
|||
That documents (and validates, serializes, filters) the output data, as a `list` of `Note`s. |
|||
|
|||
## Create notes |
|||
|
|||
Create the *path operation function* to create notes: |
|||
|
|||
```Python hl_lines="61-65" |
|||
{!../../docs_src/async_sql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
/// info |
|||
|
|||
In Pydantic v1 the method was called `.dict()`, it was deprecated (but still supported) in Pydantic v2, and renamed to `.model_dump()`. |
|||
|
|||
The examples here use `.dict()` for compatibility with Pydantic v1, but you should use `.model_dump()` instead if you can use Pydantic v2. |
|||
|
|||
/// |
|||
|
|||
/// note |
|||
|
|||
Notice that as we communicate with the database using `await`, the *path operation function* is declared with `async`. |
|||
|
|||
/// |
|||
|
|||
### About `{**note.dict(), "id": last_record_id}` |
|||
|
|||
`note` is a Pydantic `Note` object. |
|||
|
|||
`note.dict()` returns a `dict` with its data, something like: |
|||
|
|||
```Python |
|||
{ |
|||
"text": "Some note", |
|||
"completed": False, |
|||
} |
|||
``` |
|||
|
|||
but it doesn't have the `id` field. |
|||
|
|||
So we create a new `dict`, that contains the key-value pairs from `note.dict()` with: |
|||
|
|||
```Python |
|||
{**note.dict()} |
|||
``` |
|||
|
|||
`**note.dict()` "unpacks" the key value pairs directly, so, `{**note.dict()}` would be, more or less, a copy of `note.dict()`. |
|||
|
|||
And then, we extend that copy `dict`, adding another key-value pair: `"id": last_record_id`: |
|||
|
|||
```Python |
|||
{**note.dict(), "id": last_record_id} |
|||
``` |
|||
|
|||
So, the final result returned would be something like: |
|||
|
|||
```Python |
|||
{ |
|||
"id": 1, |
|||
"text": "Some note", |
|||
"completed": False, |
|||
} |
|||
``` |
|||
|
|||
## Check it |
|||
|
|||
You can copy this code as is, and see the docs at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>. |
|||
|
|||
There you can see all your API documented and interact with it: |
|||
|
|||
<img src="/img/tutorial/async-sql-databases/image01.png"> |
|||
|
|||
## More info |
|||
|
|||
You can read more about <a href="https://github.com/encode/databases" class="external-link" target="_blank">`encode/databases` at its GitHub page</a>. |
|||
@ -1,178 +0,0 @@ |
|||
# ~~NoSQL (Distributed / Big Data) Databases with Couchbase~~ (deprecated) |
|||
|
|||
/// info |
|||
|
|||
These docs are about to be updated. 🎉 |
|||
|
|||
The current version assumes Pydantic v1. |
|||
|
|||
The new docs will hopefully use Pydantic v2 and will use <a href="https://art049.github.io/odmantic/" class="external-link" target="_blank">ODMantic</a> with MongoDB. |
|||
|
|||
/// |
|||
|
|||
/// warning | "Deprecated" |
|||
|
|||
This tutorial is deprecated and will be removed in a future version. |
|||
|
|||
/// |
|||
|
|||
**FastAPI** can also be integrated with any <abbr title="Distributed database (Big Data), also 'Not Only SQL'">NoSQL</abbr>. |
|||
|
|||
Here we'll see an example using **<a href="https://www.couchbase.com/" class="external-link" target="_blank">Couchbase</a>**, a <abbr title="Document here refers to a JSON object (a dict), with keys and values, and those values can also be other JSON objects, arrays (lists), numbers, strings, booleans, etc.">document</abbr> based NoSQL database. |
|||
|
|||
You can adapt it to any other NoSQL database like: |
|||
|
|||
* **MongoDB** |
|||
* **Cassandra** |
|||
* **CouchDB** |
|||
* **ArangoDB** |
|||
* **ElasticSearch**, etc. |
|||
|
|||
/// tip |
|||
|
|||
There is an official project generator with **FastAPI** and **Couchbase**, all based on **Docker**, including a frontend and more tools: <a href="https://github.com/tiangolo/full-stack-fastapi-couchbase" class="external-link" target="_blank">https://github.com/tiangolo/full-stack-fastapi-couchbase</a> |
|||
|
|||
/// |
|||
|
|||
## Import Couchbase components |
|||
|
|||
For now, don't pay attention to the rest, only the imports: |
|||
|
|||
```Python hl_lines="3-5" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Define a constant to use as a "document type" |
|||
|
|||
We will use it later as a fixed field `type` in our documents. |
|||
|
|||
This is not required by Couchbase, but is a good practice that will help you afterwards. |
|||
|
|||
```Python hl_lines="9" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Add a function to get a `Bucket` |
|||
|
|||
In **Couchbase**, a bucket is a set of documents, that can be of different types. |
|||
|
|||
They are generally all related to the same application. |
|||
|
|||
The analogy in the relational database world would be a "database" (a specific database, not the database server). |
|||
|
|||
The analogy in **MongoDB** would be a "collection". |
|||
|
|||
In the code, a `Bucket` represents the main entrypoint of communication with the database. |
|||
|
|||
This utility function will: |
|||
|
|||
* Connect to a **Couchbase** cluster (that might be a single machine). |
|||
* Set defaults for timeouts. |
|||
* Authenticate in the cluster. |
|||
* Get a `Bucket` instance. |
|||
* Set defaults for timeouts. |
|||
* Return it. |
|||
|
|||
```Python hl_lines="12-21" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Create Pydantic models |
|||
|
|||
As **Couchbase** "documents" are actually just "JSON objects", we can model them with Pydantic. |
|||
|
|||
### `User` model |
|||
|
|||
First, let's create a `User` model: |
|||
|
|||
```Python hl_lines="24-28" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
We will use this model in our *path operation function*, so, we don't include in it the `hashed_password`. |
|||
|
|||
### `UserInDB` model |
|||
|
|||
Now, let's create a `UserInDB` model. |
|||
|
|||
This will have the data that is actually stored in the database. |
|||
|
|||
We don't create it as a subclass of Pydantic's `BaseModel` but as a subclass of our own `User`, because it will have all the attributes in `User` plus a couple more: |
|||
|
|||
```Python hl_lines="31-33" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
/// note |
|||
|
|||
Notice that we have a `hashed_password` and a `type` field that will be stored in the database. |
|||
|
|||
But it is not part of the general `User` model (the one we will return in the *path operation*). |
|||
|
|||
/// |
|||
|
|||
## Get the user |
|||
|
|||
Now create a function that will: |
|||
|
|||
* Take a username. |
|||
* Generate a document ID from it. |
|||
* Get the document with that ID. |
|||
* Put the contents of the document in a `UserInDB` model. |
|||
|
|||
By creating a function that is only dedicated to getting your user from a `username` (or any other parameter) independent of your *path operation function*, you can more easily reuse it in multiple parts and also add <abbr title="Automated test, written in code, that checks if another piece of code is working correctly.">unit tests</abbr> for it: |
|||
|
|||
```Python hl_lines="36-42" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
### f-strings |
|||
|
|||
If you are not familiar with the `f"userprofile::{username}"`, it is a Python "<a href="https://docs.python.org/3/glossary.html#term-f-string" class="external-link" target="_blank">f-string</a>". |
|||
|
|||
Any variable that is put inside of `{}` in an f-string will be expanded / injected in the string. |
|||
|
|||
### `dict` unpacking |
|||
|
|||
If you are not familiar with the `UserInDB(**result.value)`, <a href="https://docs.python.org/3/glossary.html#term-argument" class="external-link" target="_blank">it is using `dict` "unpacking"</a>. |
|||
|
|||
It will take the `dict` at `result.value`, and take each of its keys and values and pass them as key-values to `UserInDB` as keyword arguments. |
|||
|
|||
So, if the `dict` contains: |
|||
|
|||
```Python |
|||
{ |
|||
"username": "johndoe", |
|||
"hashed_password": "some_hash", |
|||
} |
|||
``` |
|||
|
|||
It will be passed to `UserInDB` as: |
|||
|
|||
```Python |
|||
UserInDB(username="johndoe", hashed_password="some_hash") |
|||
``` |
|||
|
|||
## Create your **FastAPI** code |
|||
|
|||
### Create the `FastAPI` app |
|||
|
|||
```Python hl_lines="46" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
### Create the *path operation function* |
|||
|
|||
As our code is calling Couchbase and we are not using the <a href="https://docs.couchbase.com/python-sdk/2.5/async-programming.html#asyncio-python-3-5" class="external-link" target="_blank">experimental Python <code>await</code> support</a>, we should declare our function with normal `def` instead of `async def`. |
|||
|
|||
Also, Couchbase recommends not using a single `Bucket` object in multiple "<abbr title="A sequence of code being executed by the program, while at the same time, or at intervals, there can be others being executed too.">thread</abbr>s", so, we can just get the bucket directly and pass it to our utility functions: |
|||
|
|||
```Python hl_lines="49-53" |
|||
{!../../docs_src/nosql_databases/tutorial001.py!} |
|||
``` |
|||
|
|||
## Recap |
|||
|
|||
You can integrate any third party NoSQL database, just using their standard packages. |
|||
|
|||
The same applies to any other external tool, system or API. |
|||
@ -1,594 +0,0 @@ |
|||
# ~~SQL (Relational) Databases with Peewee~~ (deprecated) |
|||
|
|||
/// warning | "Deprecated" |
|||
|
|||
This tutorial is deprecated and will be removed in a future version. |
|||
|
|||
/// |
|||
|
|||
/// warning |
|||
|
|||
If you are just starting, the tutorial [SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank} that uses SQLAlchemy should be enough. |
|||
|
|||
Feel free to skip this. |
|||
|
|||
Peewee is not recommended with FastAPI as it doesn't play well with anything async Python. There are several better alternatives. |
|||
|
|||
/// |
|||
|
|||
/// info |
|||
|
|||
These docs assume Pydantic v1. |
|||
|
|||
Because Pewee doesn't play well with anything async and there are better alternatives, I won't update these docs for Pydantic v2, they are kept for now only for historical purposes. |
|||
|
|||
The examples here are no longer tested in CI (as they were before). |
|||
|
|||
/// |
|||
|
|||
If you are starting a project from scratch, you are probably better off with SQLAlchemy ORM ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}), or any other async ORM. |
|||
|
|||
If you already have a code base that uses <a href="https://docs.peewee-orm.com/en/latest/" class="external-link" target="_blank">Peewee ORM</a>, you can check here how to use it with **FastAPI**. |
|||
|
|||
/// warning | "Python 3.7+ required" |
|||
|
|||
You will need Python 3.7 or above to safely use Peewee with FastAPI. |
|||
|
|||
/// |
|||
|
|||
## Peewee for async |
|||
|
|||
Peewee was not designed for async frameworks, or with them in mind. |
|||
|
|||
Peewee has some heavy assumptions about its defaults and about how it should be used. |
|||
|
|||
If you are developing an application with an older non-async framework, and can work with all its defaults, **it can be a great tool**. |
|||
|
|||
But if you need to change some of the defaults, support more than one predefined database, work with an async framework (like FastAPI), etc, you will need to add quite some complex extra code to override those defaults. |
|||
|
|||
Nevertheless, it's possible to do it, and here you'll see exactly what code you have to add to be able to use Peewee with FastAPI. |
|||
|
|||
/// note | "Technical Details" |
|||
|
|||
You can read more about Peewee's stand about async in Python <a href="https://docs.peewee-orm.com/en/latest/peewee/database.html#async-with-gevent" class="external-link" target="_blank">in the docs</a>, <a href="https://github.com/coleifer/peewee/issues/263#issuecomment-517347032" class="external-link" target="_blank">an issue</a>, <a href="https://github.com/coleifer/peewee/pull/2072#issuecomment-563215132" class="external-link" target="_blank">a PR</a>. |
|||
|
|||
/// |
|||
|
|||
## The same app |
|||
|
|||
We are going to create the same application as in the SQLAlchemy tutorial ([SQL (Relational) Databases](../tutorial/sql-databases.md){.internal-link target=_blank}). |
|||
|
|||
Most of the code is actually the same. |
|||
|
|||
So, we are going to focus only on the differences. |
|||
|
|||
## File structure |
|||
|
|||
Let's say you have a directory named `my_super_project` that contains a sub-directory called `sql_app` with a structure like this: |
|||
|
|||
``` |
|||
. |
|||
└── sql_app |
|||
├── __init__.py |
|||
├── crud.py |
|||
├── database.py |
|||
├── main.py |
|||
└── schemas.py |
|||
``` |
|||
|
|||
This is almost the same structure as we had for the SQLAlchemy tutorial. |
|||
|
|||
Now let's see what each file/module does. |
|||
|
|||
## Create the Peewee parts |
|||
|
|||
Let's refer to the file `sql_app/database.py`. |
|||
|
|||
### The standard Peewee code |
|||
|
|||
Let's first check all the normal Peewee code, create a Peewee database: |
|||
|
|||
```Python hl_lines="3 5 22" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
Keep in mind that if you wanted to use a different database, like PostgreSQL, you couldn't just change the string. You would need to use a different Peewee database class. |
|||
|
|||
/// |
|||
|
|||
#### Note |
|||
|
|||
The argument: |
|||
|
|||
```Python |
|||
check_same_thread=False |
|||
``` |
|||
|
|||
is equivalent to the one in the SQLAlchemy tutorial: |
|||
|
|||
```Python |
|||
connect_args={"check_same_thread": False} |
|||
``` |
|||
|
|||
...it is needed only for `SQLite`. |
|||
|
|||
/// info | "Technical Details" |
|||
|
|||
Exactly the same technical details as in [SQL (Relational) Databases](../tutorial/sql-databases.md#note){.internal-link target=_blank} apply. |
|||
|
|||
/// |
|||
|
|||
### Make Peewee async-compatible `PeeweeConnectionState` |
|||
|
|||
The main issue with Peewee and FastAPI is that Peewee relies heavily on <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">Python's `threading.local`</a>, and it doesn't have a direct way to override it or let you handle connections/sessions directly (as is done in the SQLAlchemy tutorial). |
|||
|
|||
And `threading.local` is not compatible with the new async features of modern Python. |
|||
|
|||
/// note | "Technical Details" |
|||
|
|||
`threading.local` is used to have a "magic" variable that has a different value for each thread. |
|||
|
|||
This was useful in older frameworks designed to have one single thread per request, no more, no less. |
|||
|
|||
Using this, each request would have its own database connection/session, which is the actual final goal. |
|||
|
|||
But FastAPI, using the new async features, could handle more than one request on the same thread. And at the same time, for a single request, it could run multiple things in different threads (in a threadpool), depending on if you use `async def` or normal `def`. This is what gives all the performance improvements to FastAPI. |
|||
|
|||
/// |
|||
|
|||
But Python 3.7 and above provide a more advanced alternative to `threading.local`, that can also be used in the places where `threading.local` would be used, but is compatible with the new async features. |
|||
|
|||
We are going to use that. It's called <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a>. |
|||
|
|||
We are going to override the internal parts of Peewee that use `threading.local` and replace them with `contextvars`, with the corresponding updates. |
|||
|
|||
This might seem a bit complex (and it actually is), you don't really need to completely understand how it works to use it. |
|||
|
|||
We will create a `PeeweeConnectionState`: |
|||
|
|||
```Python hl_lines="10-19" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
This class inherits from a special internal class used by Peewee. |
|||
|
|||
It has all the logic to make Peewee use `contextvars` instead of `threading.local`. |
|||
|
|||
`contextvars` works a bit differently than `threading.local`. But the rest of Peewee's internal code assumes that this class works with `threading.local`. |
|||
|
|||
So, we need to do some extra tricks to make it work as if it was just using `threading.local`. The `__init__`, `__setattr__`, and `__getattr__` implement all the required tricks for this to be used by Peewee without knowing that it is now compatible with FastAPI. |
|||
|
|||
/// tip |
|||
|
|||
This will just make Peewee behave correctly when used with FastAPI. Not randomly opening or closing connections that are being used, creating errors, etc. |
|||
|
|||
But it doesn't give Peewee async super-powers. You should still use normal `def` functions and not `async def`. |
|||
|
|||
/// |
|||
|
|||
### Use the custom `PeeweeConnectionState` class |
|||
|
|||
Now, overwrite the `._state` internal attribute in the Peewee database `db` object using the new `PeeweeConnectionState`: |
|||
|
|||
```Python hl_lines="24" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
Make sure you overwrite `db._state` *after* creating `db`. |
|||
|
|||
/// |
|||
|
|||
/// tip |
|||
|
|||
You would do the same for any other Peewee database, including `PostgresqlDatabase`, `MySQLDatabase`, etc. |
|||
|
|||
/// |
|||
|
|||
## Create the database models |
|||
|
|||
Let's now see the file `sql_app/models.py`. |
|||
|
|||
### Create Peewee models for our data |
|||
|
|||
Now create the Peewee models (classes) for `User` and `Item`. |
|||
|
|||
This is the same you would do if you followed the Peewee tutorial and updated the models to have the same data as in the SQLAlchemy tutorial. |
|||
|
|||
/// tip |
|||
|
|||
Peewee also uses the term "**model**" to refer to these classes and instances that interact with the database. |
|||
|
|||
But Pydantic also uses the term "**model**" to refer to something different, the data validation, conversion, and documentation classes and instances. |
|||
|
|||
/// |
|||
|
|||
Import `db` from `database` (the file `database.py` from above) and use it here. |
|||
|
|||
```Python hl_lines="3 6-12 15-21" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/models.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
Peewee creates several magic attributes. |
|||
|
|||
It will automatically add an `id` attribute as an integer to be the primary key. |
|||
|
|||
It will chose the name of the tables based on the class names. |
|||
|
|||
For the `Item`, it will create an attribute `owner_id` with the integer ID of the `User`. But we don't declare it anywhere. |
|||
|
|||
/// |
|||
|
|||
## Create the Pydantic models |
|||
|
|||
Now let's check the file `sql_app/schemas.py`. |
|||
|
|||
/// tip |
|||
|
|||
To avoid confusion between the Peewee *models* and the Pydantic *models*, we will have the file `models.py` with the Peewee models, and the file `schemas.py` with the Pydantic models. |
|||
|
|||
These Pydantic models define more or less a "schema" (a valid data shape). |
|||
|
|||
So this will help us avoiding confusion while using both. |
|||
|
|||
/// |
|||
|
|||
### Create the Pydantic *models* / schemas |
|||
|
|||
Create all the same Pydantic models as in the SQLAlchemy tutorial: |
|||
|
|||
```Python hl_lines="16-18 21-22 25-30 34-35 38-39 42-48" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
Here we are creating the models with an `id`. |
|||
|
|||
We didn't explicitly specify an `id` attribute in the Peewee models, but Peewee adds one automatically. |
|||
|
|||
We are also adding the magic `owner_id` attribute to `Item`. |
|||
|
|||
/// |
|||
|
|||
### Create a `PeeweeGetterDict` for the Pydantic *models* / schemas |
|||
|
|||
When you access a relationship in a Peewee object, like in `some_user.items`, Peewee doesn't provide a `list` of `Item`. |
|||
|
|||
It provides a special custom object of class `ModelSelect`. |
|||
|
|||
It's possible to create a `list` of its items with `list(some_user.items)`. |
|||
|
|||
But the object itself is not a `list`. And it's also not an actual Python <a href="https://docs.python.org/3/glossary.html#term-generator" class="external-link" target="_blank">generator</a>. Because of this, Pydantic doesn't know by default how to convert it to a `list` of Pydantic *models* / schemas. |
|||
|
|||
But recent versions of Pydantic allow providing a custom class that inherits from `pydantic.utils.GetterDict`, to provide the functionality used when using the `orm_mode = True` to retrieve the values for ORM model attributes. |
|||
|
|||
We are going to create a custom `PeeweeGetterDict` class and use it in all the same Pydantic *models* / schemas that use `orm_mode`: |
|||
|
|||
```Python hl_lines="3 8-13 31 49" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
Here we are checking if the attribute that is being accessed (e.g. `.items` in `some_user.items`) is an instance of `peewee.ModelSelect`. |
|||
|
|||
And if that's the case, just return a `list` with it. |
|||
|
|||
And then we use it in the Pydantic *models* / schemas that use `orm_mode = True`, with the configuration variable `getter_dict = PeeweeGetterDict`. |
|||
|
|||
/// tip |
|||
|
|||
We only need to create one `PeeweeGetterDict` class, and we can use it in all the Pydantic *models* / schemas. |
|||
|
|||
/// |
|||
|
|||
## CRUD utils |
|||
|
|||
Now let's see the file `sql_app/crud.py`. |
|||
|
|||
### Create all the CRUD utils |
|||
|
|||
Create all the same CRUD utils as in the SQLAlchemy tutorial, all the code is very similar: |
|||
|
|||
```Python hl_lines="1 4-5 8-9 12-13 16-20 23-24 27-30" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/crud.py!} |
|||
``` |
|||
|
|||
There are some differences with the code for the SQLAlchemy tutorial. |
|||
|
|||
We don't pass a `db` attribute around. Instead we use the models directly. This is because the `db` object is a global object, that includes all the connection logic. That's why we had to do all the `contextvars` updates above. |
|||
|
|||
Aso, when returning several objects, like in `get_users`, we directly call `list`, like in: |
|||
|
|||
```Python |
|||
list(models.User.select()) |
|||
``` |
|||
|
|||
This is for the same reason that we had to create a custom `PeeweeGetterDict`. But by returning something that is already a `list` instead of the `peewee.ModelSelect` the `response_model` in the *path operation* with `List[models.User]` (that we'll see later) will work correctly. |
|||
|
|||
## Main **FastAPI** app |
|||
|
|||
And now in the file `sql_app/main.py` let's integrate and use all the other parts we created before. |
|||
|
|||
### Create the database tables |
|||
|
|||
In a very simplistic way create the database tables: |
|||
|
|||
```Python hl_lines="9-11" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### Create a dependency |
|||
|
|||
Create a dependency that will connect the database right at the beginning of a request and disconnect it at the end: |
|||
|
|||
```Python hl_lines="23-29" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
Here we have an empty `yield` because we are actually not using the database object directly. |
|||
|
|||
It is connecting to the database and storing the connection data in an internal variable that is independent for each request (using the `contextvars` tricks from above). |
|||
|
|||
Because the database connection is potentially I/O blocking, this dependency is created with a normal `def` function. |
|||
|
|||
And then, in each *path operation function* that needs to access the database we add it as a dependency. |
|||
|
|||
But we are not using the value given by this dependency (it actually doesn't give any value, as it has an empty `yield`). So, we don't add it to the *path operation function* but to the *path operation decorator* in the `dependencies` parameter: |
|||
|
|||
```Python hl_lines="32 40 47 59 65 72" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### Context variable sub-dependency |
|||
|
|||
For all the `contextvars` parts to work, we need to make sure we have an independent value in the `ContextVar` for each request that uses the database, and that value will be used as the database state (connection, transactions, etc) for the whole request. |
|||
|
|||
For that, we need to create another `async` dependency `reset_db_state()` that is used as a sub-dependency in `get_db()`. It will set the value for the context variable (with just a default `dict`) that will be used as the database state for the whole request. And then the dependency `get_db()` will store in it the database state (connection, transactions, etc). |
|||
|
|||
```Python hl_lines="18-20" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
For the **next request**, as we will reset that context variable again in the `async` dependency `reset_db_state()` and then create a new connection in the `get_db()` dependency, that new request will have its own database state (connection, transactions, etc). |
|||
|
|||
/// tip |
|||
|
|||
As FastAPI is an async framework, one request could start being processed, and before finishing, another request could be received and start processing as well, and it all could be processed in the same thread. |
|||
|
|||
But context variables are aware of these async features, so, a Peewee database state set in the `async` dependency `reset_db_state()` will keep its own data throughout the entire request. |
|||
|
|||
And at the same time, the other concurrent request will have its own database state that will be independent for the whole request. |
|||
|
|||
/// |
|||
|
|||
#### Peewee Proxy |
|||
|
|||
If you are using a <a href="https://docs.peewee-orm.com/en/latest/peewee/database.html#dynamically-defining-a-database" class="external-link" target="_blank">Peewee Proxy</a>, the actual database is at `db.obj`. |
|||
|
|||
So, you would reset it with: |
|||
|
|||
```Python hl_lines="3-4" |
|||
async def reset_db_state(): |
|||
database.db.obj._state._state.set(db_state_default.copy()) |
|||
database.db.obj._state.reset() |
|||
``` |
|||
|
|||
### Create your **FastAPI** *path operations* |
|||
|
|||
Now, finally, here's the standard **FastAPI** *path operations* code. |
|||
|
|||
```Python hl_lines="32-37 40-43 46-53 56-62 65-68 71-79" |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
### About `def` vs `async def` |
|||
|
|||
The same as with SQLAlchemy, we are not doing something like: |
|||
|
|||
```Python |
|||
user = await models.User.select().first() |
|||
``` |
|||
|
|||
...but instead we are using: |
|||
|
|||
```Python |
|||
user = models.User.select().first() |
|||
``` |
|||
|
|||
So, again, we should declare the *path operation functions* and the dependency without `async def`, just with a normal `def`, as: |
|||
|
|||
```Python hl_lines="2" |
|||
# Something goes here |
|||
def read_users(skip: int = 0, limit: int = 100): |
|||
# Something goes here |
|||
``` |
|||
|
|||
## Testing Peewee with async |
|||
|
|||
This example includes an extra *path operation* that simulates a long processing request with `time.sleep(sleep_time)`. |
|||
|
|||
It will have the database connection open at the beginning and will just wait some seconds before replying back. And each new request will wait one second less. |
|||
|
|||
This will easily let you test that your app with Peewee and FastAPI is behaving correctly with all the stuff about threads. |
|||
|
|||
If you want to check how Peewee would break your app if used without modification, go the `sql_app/database.py` file and comment the line: |
|||
|
|||
```Python |
|||
# db._state = PeeweeConnectionState() |
|||
``` |
|||
|
|||
And in the file `sql_app/main.py` file, comment the body of the `async` dependency `reset_db_state()` and replace it with a `pass`: |
|||
|
|||
```Python |
|||
async def reset_db_state(): |
|||
# database.db._state._state.set(db_state_default.copy()) |
|||
# database.db._state.reset() |
|||
pass |
|||
``` |
|||
|
|||
Then run your app with Uvicorn: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uvicorn sql_app.main:app --reload |
|||
|
|||
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
Open your browser at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a> and create a couple of users. |
|||
|
|||
Then open 10 tabs at <a href="http://127.0.0.1:8000/docs#/default/read_slow_users_slowusers__get" class="external-link" target="_blank">http://127.0.0.1:8000/docs#/default/read_slow_users_slowusers__get</a> at the same time. |
|||
|
|||
Go to the *path operation* "Get `/slowusers/`" in all of the tabs. Use the "Try it out" button and execute the request in each tab, one right after the other. |
|||
|
|||
The tabs will wait for a bit and then some of them will show `Internal Server Error`. |
|||
|
|||
### What happens |
|||
|
|||
The first tab will make your app create a connection to the database and wait for some seconds before replying back and closing the database connection. |
|||
|
|||
Then, for the request in the next tab, your app will wait for one second less, and so on. |
|||
|
|||
This means that it will end up finishing some of the last tabs' requests earlier than some of the previous ones. |
|||
|
|||
Then one the last requests that wait less seconds will try to open a database connection, but as one of those previous requests for the other tabs will probably be handled in the same thread as the first one, it will have the same database connection that is already open, and Peewee will throw an error and you will see it in the terminal, and the response will have an `Internal Server Error`. |
|||
|
|||
This will probably happen for more than one of those tabs. |
|||
|
|||
If you had multiple clients talking to your app exactly at the same time, this is what could happen. |
|||
|
|||
And as your app starts to handle more and more clients at the same time, the waiting time in a single request needs to be shorter and shorter to trigger the error. |
|||
|
|||
### Fix Peewee with FastAPI |
|||
|
|||
Now go back to the file `sql_app/database.py`, and uncomment the line: |
|||
|
|||
```Python |
|||
db._state = PeeweeConnectionState() |
|||
``` |
|||
|
|||
And in the file `sql_app/main.py` file, uncomment the body of the `async` dependency `reset_db_state()`: |
|||
|
|||
```Python |
|||
async def reset_db_state(): |
|||
database.db._state._state.set(db_state_default.copy()) |
|||
database.db._state.reset() |
|||
``` |
|||
|
|||
Terminate your running app and start it again. |
|||
|
|||
Repeat the same process with the 10 tabs. This time all of them will wait and you will get all the results without errors. |
|||
|
|||
...You fixed it! |
|||
|
|||
## Review all the files |
|||
|
|||
Remember you should have a directory named `my_super_project` (or however you want) that contains a sub-directory called `sql_app`. |
|||
|
|||
`sql_app` should have the following files: |
|||
|
|||
* `sql_app/__init__.py`: is an empty file. |
|||
|
|||
* `sql_app/database.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/database.py!} |
|||
``` |
|||
|
|||
* `sql_app/models.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/models.py!} |
|||
``` |
|||
|
|||
* `sql_app/schemas.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/schemas.py!} |
|||
``` |
|||
|
|||
* `sql_app/crud.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/crud.py!} |
|||
``` |
|||
|
|||
* `sql_app/main.py`: |
|||
|
|||
```Python |
|||
{!../../docs_src/sql_databases_peewee/sql_app/main.py!} |
|||
``` |
|||
|
|||
## Technical Details |
|||
|
|||
/// warning |
|||
|
|||
These are very technical details that you probably don't need. |
|||
|
|||
/// |
|||
|
|||
### The problem |
|||
|
|||
Peewee uses <a href="https://docs.python.org/3/library/threading.html#thread-local-data" class="external-link" target="_blank">`threading.local`</a> by default to store it's database "state" data (connection, transactions, etc). |
|||
|
|||
`threading.local` creates a value exclusive to the current thread, but an async framework would run all the code (e.g. for each request) in the same thread, and possibly not in order. |
|||
|
|||
On top of that, an async framework could run some sync code in a threadpool (using `asyncio.run_in_executor`), but belonging to the same request. |
|||
|
|||
This means that, with Peewee's current implementation, multiple tasks could be using the same `threading.local` variable and end up sharing the same connection and data (that they shouldn't), and at the same time, if they execute sync I/O-blocking code in a threadpool (as with normal `def` functions in FastAPI, in *path operations* and dependencies), that code won't have access to the database state variables, even while it's part of the same request and it should be able to get access to the same database state. |
|||
|
|||
### Context variables |
|||
|
|||
Python 3.7 has <a href="https://docs.python.org/3/library/contextvars.html" class="external-link" target="_blank">`contextvars`</a> that can create a local variable very similar to `threading.local`, but also supporting these async features. |
|||
|
|||
There are several things to keep in mind. |
|||
|
|||
The `ContextVar` has to be created at the top of the module, like: |
|||
|
|||
```Python |
|||
some_var = ContextVar("some_var", default="default value") |
|||
``` |
|||
|
|||
To set a value used in the current "context" (e.g. for the current request) use: |
|||
|
|||
```Python |
|||
some_var.set("new value") |
|||
``` |
|||
|
|||
To get a value anywhere inside of the context (e.g. in any part handling the current request) use: |
|||
|
|||
```Python |
|||
some_var.get() |
|||
``` |
|||
|
|||
### Set context variables in the `async` dependency `reset_db_state()` |
|||
|
|||
If some part of the async code sets the value with `some_var.set("updated in function")` (e.g. like the `async` dependency), the rest of the code in it and the code that goes after (including code inside of `async` functions called with `await`) will see that new value. |
|||
|
|||
So, in our case, if we set the Peewee state variable (with a default `dict`) in the `async` dependency, all the rest of the internal code in our app will see this value and will be able to reuse it for the whole request. |
|||
|
|||
And the context variable would be set again for the next request, even if they are concurrent. |
|||
|
|||
### Set database state in the dependency `get_db()` |
|||
|
|||
As `get_db()` is a normal `def` function, **FastAPI** will make it run in a threadpool, with a *copy* of the "context", holding the same value for the context variable (the `dict` with the reset database state). Then it can add database state to that `dict`, like the connection, etc. |
|||
|
|||
But if the value of the context variable (the default `dict`) was set in that normal `def` function, it would create a new value that would stay only in that thread of the threadpool, and the rest of the code (like the *path operation functions*) wouldn't have access to it. In `get_db()` we can only set values in the `dict`, but not the entire `dict` itself. |
|||
|
|||
So, we need to have the `async` dependency `reset_db_state()` to set the `dict` in the context variable. That way, all the code has access to the same `dict` for the database state for a single request. |
|||
|
|||
### Connect and disconnect in the dependency `get_db()` |
|||
|
|||
Then the next question would be, why not just connect and disconnect the database in the `async` dependency itself, instead of in `get_db()`? |
|||
|
|||
The `async` dependency has to be `async` for the context variable to be preserved for the rest of the request, but creating and closing the database connection is potentially blocking, so it could degrade performance if it was there. |
|||
|
|||
So we also need the normal `def` dependency `get_db()`. |
|||
@ -0,0 +1,7 @@ |
|||
# Testing a Database |
|||
|
|||
You can study about databases, SQL, and SQLModel in the <a href="https://sqlmodel.tiangolo.com/" class="external-link" target="_blank">SQLModel docs</a>. 🤓 |
|||
|
|||
There's a mini <a href="https://sqlmodel.tiangolo.com/tutorial/fastapi/" class="external-link" target="_blank">tutorial on using SQLModel with FastAPI</a>. ✨ |
|||
|
|||
That tutorial includes a section about <a href="https://sqlmodel.tiangolo.com/tutorial/fastapi/tests/" class="external-link" target="_blank">testing SQL databases</a>. 😎 |
|||
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 68 KiB |
File diff suppressed because it is too large
@ -1,101 +0,0 @@ |
|||
# 测试数据库 |
|||
|
|||
您还可以使用[测试依赖项](testing-dependencies.md){.internal-link target=_blank}中的覆盖依赖项方法变更测试的数据库。 |
|||
|
|||
实现设置其它测试数据库、在测试后回滚数据、或预填测试数据等操作。 |
|||
|
|||
本章的主要思路与上一章完全相同。 |
|||
|
|||
## 为 SQL 应用添加测试 |
|||
|
|||
为了使用测试数据库，我们要升级 [SQL 关系型数据库](../tutorial/sql-databases.md){.internal-link target=_blank} 一章中的示例。 |
|||
|
|||
应用的所有代码都一样，直接查看那一章的示例代码即可。 |
|||
|
|||
本章只是新添加了测试文件。 |
|||
|
|||
正常的依赖项 `get_db()` 返回数据库会话。 |
|||
|
|||
测试时使用覆盖依赖项返回自定义数据库会话代替正常的依赖项。 |
|||
|
|||
本例中，要创建仅用于测试的临时数据库。 |
|||
|
|||
## 文件架构 |
|||
|
|||
创建新文件 `sql_app/tests/test_sql_app.py`。 |
|||
|
|||
因此，新的文件架构如下： |
|||
|
|||
``` hl_lines="9-11" |
|||
. |
|||
└── sql_app |
|||
├── __init__.py |
|||
├── crud.py |
|||
├── database.py |
|||
├── main.py |
|||
├── models.py |
|||
├── schemas.py |
|||
└── tests |
|||
├── __init__.py |
|||
└── test_sql_app.py |
|||
``` |
|||
|
|||
## 创建新的数据库会话 |
|||
|
|||
首先，为新建数据库创建新的数据库会话。 |
|||
|
|||
测试时，使用 `test.db` 替代 `sql_app.db`。 |
|||
|
|||
但其余的会话代码基本上都是一样的，只要复制就可以了。 |
|||
|
|||
```Python hl_lines="8-13" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip | "提示" |
|||
|
|||
为减少代码重复，最好把这段代码写成函数，在 `database.py` 与 `tests/test_sql_app.py`中使用。 |
|||
|
|||
为了把注意力集中在测试代码上，本例只是复制了这段代码。 |
|||
|
|||
/// |
|||
|
|||
## 创建数据库 |
|||
|
|||
因为现在是想在新文件中使用新数据库，所以要使用以下代码创建数据库： |
|||
|
|||
```Python |
|||
Base.metadata.create_all(bind=engine) |
|||
``` |
|||
|
|||
一般是在 `main.py` 中调用这行代码，但在 `main.py` 里，这行代码用于创建 `sql_app.db`，但是现在要为测试创建 `test.db`。 |
|||
|
|||
因此，要在测试代码中添加这行代码创建新的数据库文件。 |
|||
|
|||
```Python hl_lines="16" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
## 覆盖依赖项 |
|||
|
|||
接下来，创建覆盖依赖项，并为应用添加覆盖内容。 |
|||
|
|||
```Python hl_lines="19-24 27" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
/// tip | "提示" |
|||
|
|||
`overrider_get_db()` 与 `get_db` 的代码几乎完全一样，只是 `overrider_get_db` 中使用测试数据库的 `TestingSessionLocal`。 |
|||
|
|||
/// |
|||
|
|||
## 测试应用 |
|||
|
|||
然后，就可以正常测试了。 |
|||
|
|||
```Python hl_lines="32-47" |
|||
{!../../docs_src/sql_databases/sql_app/tests/test_sql_app.py!} |
|||
``` |
|||
|
|||
测试期间，所有在数据库中所做的修改都在 `test.db` 里，不会影响主应用的 `sql_app.db`。 |
|||
@ -1,65 +0,0 @@ |
|||
from typing import List |
|||
|
|||
import databases |
|||
import sqlalchemy |
|||
from fastapi import FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
# SQLAlchemy specific code, as with any other app |
|||
DATABASE_URL = "sqlite:///./test.db" |
|||
# DATABASE_URL = "postgresql://user:password@postgresserver/db" |
|||
|
|||
database = databases.Database(DATABASE_URL) |
|||
|
|||
metadata = sqlalchemy.MetaData() |
|||
|
|||
notes = sqlalchemy.Table( |
|||
"notes", |
|||
metadata, |
|||
sqlalchemy.Column("id", sqlalchemy.Integer, primary_key=True), |
|||
sqlalchemy.Column("text", sqlalchemy.String), |
|||
sqlalchemy.Column("completed", sqlalchemy.Boolean), |
|||
) |
|||
|
|||
|
|||
engine = sqlalchemy.create_engine( |
|||
DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
metadata.create_all(engine) |
|||
|
|||
|
|||
class NoteIn(BaseModel): |
|||
text: str |
|||
completed: bool |
|||
|
|||
|
|||
class Note(BaseModel): |
|||
id: int |
|||
text: str |
|||
completed: bool |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
async def startup(): |
|||
await database.connect() |
|||
|
|||
|
|||
@app.on_event("shutdown") |
|||
async def shutdown(): |
|||
await database.disconnect() |
|||
|
|||
|
|||
@app.get("/notes/", response_model=List[Note]) |
|||
async def read_notes(): |
|||
query = notes.select() |
|||
return await database.fetch_all(query) |
|||
|
|||
|
|||
@app.post("/notes/", response_model=Note) |
|||
async def create_note(note: NoteIn): |
|||
query = notes.insert().values(text=note.text, completed=note.completed) |
|||
last_record_id = await database.execute(query) |
|||
return {**note.dict(), "id": last_record_id} |
|||
@ -1,53 +0,0 @@ |
|||
from typing import Union |
|||
|
|||
from couchbase import LOCKMODE_WAIT |
|||
from couchbase.bucket import Bucket |
|||
from couchbase.cluster import Cluster, PasswordAuthenticator |
|||
from fastapi import FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
USERPROFILE_DOC_TYPE = "userprofile" |
|||
|
|||
|
|||
def get_bucket(): |
|||
cluster = Cluster( |
|||
"couchbase://couchbasehost:8091?fetch_mutation_tokens=1&operation_timeout=30&n1ql_timeout=300" |
|||
) |
|||
authenticator = PasswordAuthenticator("username", "password") |
|||
cluster.authenticate(authenticator) |
|||
bucket: Bucket = cluster.open_bucket("bucket_name", lockmode=LOCKMODE_WAIT) |
|||
bucket.timeout = 30 |
|||
bucket.n1ql_timeout = 300 |
|||
return bucket |
|||
|
|||
|
|||
class User(BaseModel): |
|||
username: str |
|||
email: Union[str, None] = None |
|||
full_name: Union[str, None] = None |
|||
disabled: Union[bool, None] = None |
|||
|
|||
|
|||
class UserInDB(User): |
|||
type: str = USERPROFILE_DOC_TYPE |
|||
hashed_password: str |
|||
|
|||
|
|||
def get_user(bucket: Bucket, username: str): |
|||
doc_id = f"userprofile::{username}" |
|||
result = bucket.get(doc_id, quiet=True) |
|||
if not result.value: |
|||
return None |
|||
user = UserInDB(**result.value) |
|||
return user |
|||
|
|||
|
|||
# FastAPI specific code |
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.get("/users/{username}", response_model=User) |
|||
def read_user(username: str): |
|||
bucket = get_bucket() |
|||
user = get_user(bucket=bucket, username=username) |
|||
return user |
|||
@ -1,62 +0,0 @@ |
|||
from typing import List |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Request, Response |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.middleware("http") |
|||
async def db_session_middleware(request: Request, call_next): |
|||
response = Response("Internal server error", status_code=500) |
|||
try: |
|||
request.state.db = SessionLocal() |
|||
response = await call_next(request) |
|||
finally: |
|||
request.state.db.close() |
|||
return response |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(request: Request): |
|||
return request.state.db |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=List[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=List[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,36 +0,0 @@ |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import models, schemas |
|||
|
|||
|
|||
def get_user(db: Session, user_id: int): |
|||
return db.query(models.User).filter(models.User.id == user_id).first() |
|||
|
|||
|
|||
def get_user_by_email(db: Session, email: str): |
|||
return db.query(models.User).filter(models.User.email == email).first() |
|||
|
|||
|
|||
def get_users(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.User).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user(db: Session, user: schemas.UserCreate): |
|||
fake_hashed_password = user.password + "notreallyhashed" |
|||
db_user = models.User(email=user.email, hashed_password=fake_hashed_password) |
|||
db.add(db_user) |
|||
db.commit() |
|||
db.refresh(db_user) |
|||
return db_user |
|||
|
|||
|
|||
def get_items(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.Item).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user_item(db: Session, item: schemas.ItemCreate, user_id: int): |
|||
db_item = models.Item(**item.dict(), owner_id=user_id) |
|||
db.add(db_item) |
|||
db.commit() |
|||
db.refresh(db_item) |
|||
return db_item |
|||
@ -1,13 +0,0 @@ |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.ext.declarative import declarative_base |
|||
from sqlalchemy.orm import sessionmaker |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite:///./sql_app.db" |
|||
# SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
Base = declarative_base() |
|||
@ -1,55 +0,0 @@ |
|||
from typing import List |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(): |
|||
db = SessionLocal() |
|||
try: |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=List[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=List[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,26 +0,0 @@ |
|||
from sqlalchemy import Boolean, Column, ForeignKey, Integer, String |
|||
from sqlalchemy.orm import relationship |
|||
|
|||
from .database import Base |
|||
|
|||
|
|||
class User(Base): |
|||
__tablename__ = "users" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
email = Column(String, unique=True, index=True) |
|||
hashed_password = Column(String) |
|||
is_active = Column(Boolean, default=True) |
|||
|
|||
items = relationship("Item", back_populates="owner") |
|||
|
|||
|
|||
class Item(Base): |
|||
__tablename__ = "items" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
title = Column(String, index=True) |
|||
description = Column(String, index=True) |
|||
owner_id = Column(Integer, ForeignKey("users.id")) |
|||
|
|||
owner = relationship("User", back_populates="items") |
|||
@ -1,37 +0,0 @@ |
|||
from typing import List, Union |
|||
|
|||
from pydantic import BaseModel |
|||
|
|||
|
|||
class ItemBase(BaseModel): |
|||
title: str |
|||
description: Union[str, None] = None |
|||
|
|||
|
|||
class ItemCreate(ItemBase): |
|||
pass |
|||
|
|||
|
|||
class Item(ItemBase): |
|||
id: int |
|||
owner_id: int |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
|
|||
|
|||
class UserBase(BaseModel): |
|||
email: str |
|||
|
|||
|
|||
class UserCreate(UserBase): |
|||
password: str |
|||
|
|||
|
|||
class User(UserBase): |
|||
id: int |
|||
is_active: bool |
|||
items: List[Item] = [] |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
@ -1,50 +0,0 @@ |
|||
from fastapi.testclient import TestClient |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.orm import sessionmaker |
|||
from sqlalchemy.pool import StaticPool |
|||
|
|||
from ..database import Base |
|||
from ..main import app, get_db |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite://" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, |
|||
connect_args={"check_same_thread": False}, |
|||
poolclass=StaticPool, |
|||
) |
|||
TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
|
|||
Base.metadata.create_all(bind=engine) |
|||
|
|||
|
|||
def override_get_db(): |
|||
try: |
|||
db = TestingSessionLocal() |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
app.dependency_overrides[get_db] = override_get_db |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_create_user(): |
|||
response = client.post( |
|||
"/users/", |
|||
json={"email": "[email protected]", "password": "chimichangas4life"}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert "id" in data |
|||
user_id = data["id"] |
|||
|
|||
response = client.get(f"/users/{user_id}") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert data["id"] == user_id |
|||
@ -1,60 +0,0 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException, Request, Response |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.middleware("http") |
|||
async def db_session_middleware(request: Request, call_next): |
|||
response = Response("Internal server error", status_code=500) |
|||
try: |
|||
request.state.db = SessionLocal() |
|||
response = await call_next(request) |
|||
finally: |
|||
request.state.db.close() |
|||
return response |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(request: Request): |
|||
return request.state.db |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=list[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=list[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,36 +0,0 @@ |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import models, schemas |
|||
|
|||
|
|||
def get_user(db: Session, user_id: int): |
|||
return db.query(models.User).filter(models.User.id == user_id).first() |
|||
|
|||
|
|||
def get_user_by_email(db: Session, email: str): |
|||
return db.query(models.User).filter(models.User.email == email).first() |
|||
|
|||
|
|||
def get_users(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.User).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user(db: Session, user: schemas.UserCreate): |
|||
fake_hashed_password = user.password + "notreallyhashed" |
|||
db_user = models.User(email=user.email, hashed_password=fake_hashed_password) |
|||
db.add(db_user) |
|||
db.commit() |
|||
db.refresh(db_user) |
|||
return db_user |
|||
|
|||
|
|||
def get_items(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.Item).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user_item(db: Session, item: schemas.ItemCreate, user_id: int): |
|||
db_item = models.Item(**item.dict(), owner_id=user_id) |
|||
db.add(db_item) |
|||
db.commit() |
|||
db.refresh(db_item) |
|||
return db_item |
|||
@ -1,13 +0,0 @@ |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.ext.declarative import declarative_base |
|||
from sqlalchemy.orm import sessionmaker |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite:///./sql_app.db" |
|||
# SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
Base = declarative_base() |
|||
@ -1,53 +0,0 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(): |
|||
db = SessionLocal() |
|||
try: |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=list[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=list[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,26 +0,0 @@ |
|||
from sqlalchemy import Boolean, Column, ForeignKey, Integer, String |
|||
from sqlalchemy.orm import relationship |
|||
|
|||
from .database import Base |
|||
|
|||
|
|||
class User(Base): |
|||
__tablename__ = "users" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
email = Column(String, unique=True, index=True) |
|||
hashed_password = Column(String) |
|||
is_active = Column(Boolean, default=True) |
|||
|
|||
items = relationship("Item", back_populates="owner") |
|||
|
|||
|
|||
class Item(Base): |
|||
__tablename__ = "items" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
title = Column(String, index=True) |
|||
description = Column(String, index=True) |
|||
owner_id = Column(Integer, ForeignKey("users.id")) |
|||
|
|||
owner = relationship("User", back_populates="items") |
|||
@ -1,35 +0,0 @@ |
|||
from pydantic import BaseModel |
|||
|
|||
|
|||
class ItemBase(BaseModel): |
|||
title: str |
|||
description: str | None = None |
|||
|
|||
|
|||
class ItemCreate(ItemBase): |
|||
pass |
|||
|
|||
|
|||
class Item(ItemBase): |
|||
id: int |
|||
owner_id: int |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
|
|||
|
|||
class UserBase(BaseModel): |
|||
email: str |
|||
|
|||
|
|||
class UserCreate(UserBase): |
|||
password: str |
|||
|
|||
|
|||
class User(UserBase): |
|||
id: int |
|||
is_active: bool |
|||
items: list[Item] = [] |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
@ -1,47 +0,0 @@ |
|||
from fastapi.testclient import TestClient |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.orm import sessionmaker |
|||
|
|||
from ..database import Base |
|||
from ..main import app, get_db |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
|
|||
Base.metadata.create_all(bind=engine) |
|||
|
|||
|
|||
def override_get_db(): |
|||
try: |
|||
db = TestingSessionLocal() |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
app.dependency_overrides[get_db] = override_get_db |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_create_user(): |
|||
response = client.post( |
|||
"/users/", |
|||
json={"email": "[email protected]", "password": "chimichangas4life"}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert "id" in data |
|||
user_id = data["id"] |
|||
|
|||
response = client.get(f"/users/{user_id}") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert data["id"] == user_id |
|||
@ -1,60 +0,0 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException, Request, Response |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.middleware("http") |
|||
async def db_session_middleware(request: Request, call_next): |
|||
response = Response("Internal server error", status_code=500) |
|||
try: |
|||
request.state.db = SessionLocal() |
|||
response = await call_next(request) |
|||
finally: |
|||
request.state.db.close() |
|||
return response |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(request: Request): |
|||
return request.state.db |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=list[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=list[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,36 +0,0 @@ |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import models, schemas |
|||
|
|||
|
|||
def get_user(db: Session, user_id: int): |
|||
return db.query(models.User).filter(models.User.id == user_id).first() |
|||
|
|||
|
|||
def get_user_by_email(db: Session, email: str): |
|||
return db.query(models.User).filter(models.User.email == email).first() |
|||
|
|||
|
|||
def get_users(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.User).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user(db: Session, user: schemas.UserCreate): |
|||
fake_hashed_password = user.password + "notreallyhashed" |
|||
db_user = models.User(email=user.email, hashed_password=fake_hashed_password) |
|||
db.add(db_user) |
|||
db.commit() |
|||
db.refresh(db_user) |
|||
return db_user |
|||
|
|||
|
|||
def get_items(db: Session, skip: int = 0, limit: int = 100): |
|||
return db.query(models.Item).offset(skip).limit(limit).all() |
|||
|
|||
|
|||
def create_user_item(db: Session, item: schemas.ItemCreate, user_id: int): |
|||
db_item = models.Item(**item.dict(), owner_id=user_id) |
|||
db.add(db_item) |
|||
db.commit() |
|||
db.refresh(db_item) |
|||
return db_item |
|||
@ -1,13 +0,0 @@ |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.ext.declarative import declarative_base |
|||
from sqlalchemy.orm import sessionmaker |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite:///./sql_app.db" |
|||
# SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
Base = declarative_base() |
|||
@ -1,53 +0,0 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException |
|||
from sqlalchemy.orm import Session |
|||
|
|||
from . import crud, models, schemas |
|||
from .database import SessionLocal, engine |
|||
|
|||
models.Base.metadata.create_all(bind=engine) |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
# Dependency |
|||
def get_db(): |
|||
db = SessionLocal() |
|||
try: |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
@app.post("/users/", response_model=schemas.User) |
|||
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user_by_email(db, email=user.email) |
|||
if db_user: |
|||
raise HTTPException(status_code=400, detail="Email already registered") |
|||
return crud.create_user(db=db, user=user) |
|||
|
|||
|
|||
@app.get("/users/", response_model=list[schemas.User]) |
|||
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
users = crud.get_users(db, skip=skip, limit=limit) |
|||
return users |
|||
|
|||
|
|||
@app.get("/users/{user_id}", response_model=schemas.User) |
|||
def read_user(user_id: int, db: Session = Depends(get_db)): |
|||
db_user = crud.get_user(db, user_id=user_id) |
|||
if db_user is None: |
|||
raise HTTPException(status_code=404, detail="User not found") |
|||
return db_user |
|||
|
|||
|
|||
@app.post("/users/{user_id}/items/", response_model=schemas.Item) |
|||
def create_item_for_user( |
|||
user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db) |
|||
): |
|||
return crud.create_user_item(db=db, item=item, user_id=user_id) |
|||
|
|||
|
|||
@app.get("/items/", response_model=list[schemas.Item]) |
|||
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): |
|||
items = crud.get_items(db, skip=skip, limit=limit) |
|||
return items |
|||
@ -1,26 +0,0 @@ |
|||
from sqlalchemy import Boolean, Column, ForeignKey, Integer, String |
|||
from sqlalchemy.orm import relationship |
|||
|
|||
from .database import Base |
|||
|
|||
|
|||
class User(Base): |
|||
__tablename__ = "users" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
email = Column(String, unique=True, index=True) |
|||
hashed_password = Column(String) |
|||
is_active = Column(Boolean, default=True) |
|||
|
|||
items = relationship("Item", back_populates="owner") |
|||
|
|||
|
|||
class Item(Base): |
|||
__tablename__ = "items" |
|||
|
|||
id = Column(Integer, primary_key=True) |
|||
title = Column(String, index=True) |
|||
description = Column(String, index=True) |
|||
owner_id = Column(Integer, ForeignKey("users.id")) |
|||
|
|||
owner = relationship("User", back_populates="items") |
|||
@ -1,37 +0,0 @@ |
|||
from typing import Union |
|||
|
|||
from pydantic import BaseModel |
|||
|
|||
|
|||
class ItemBase(BaseModel): |
|||
title: str |
|||
description: Union[str, None] = None |
|||
|
|||
|
|||
class ItemCreate(ItemBase): |
|||
pass |
|||
|
|||
|
|||
class Item(ItemBase): |
|||
id: int |
|||
owner_id: int |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
|
|||
|
|||
class UserBase(BaseModel): |
|||
email: str |
|||
|
|||
|
|||
class UserCreate(UserBase): |
|||
password: str |
|||
|
|||
|
|||
class User(UserBase): |
|||
id: int |
|||
is_active: bool |
|||
items: list[Item] = [] |
|||
|
|||
class Config: |
|||
orm_mode = True |
|||
@ -1,47 +0,0 @@ |
|||
from fastapi.testclient import TestClient |
|||
from sqlalchemy import create_engine |
|||
from sqlalchemy.orm import sessionmaker |
|||
|
|||
from ..database import Base |
|||
from ..main import app, get_db |
|||
|
|||
SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db" |
|||
|
|||
engine = create_engine( |
|||
SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False} |
|||
) |
|||
TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) |
|||
|
|||
|
|||
Base.metadata.create_all(bind=engine) |
|||
|
|||
|
|||
def override_get_db(): |
|||
try: |
|||
db = TestingSessionLocal() |
|||
yield db |
|||
finally: |
|||
db.close() |
|||
|
|||
|
|||
app.dependency_overrides[get_db] = override_get_db |
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_create_user(): |
|||
response = client.post( |
|||
"/users/", |
|||
json={"email": "[email protected]", "password": "chimichangas4life"}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert "id" in data |
|||
user_id = data["id"] |
|||
|
|||
response = client.get(f"/users/{user_id}") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["email"] == "[email protected]" |
|||
assert data["id"] == user_id |
|||
@ -0,0 +1,71 @@ |
|||
from typing import List, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: Session = Depends(get_session)) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
) -> List[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,74 @@ |
|||
from typing import List, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
from typing_extensions import Annotated |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: SessionDep) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
) -> List[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: SessionDep) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,73 @@ |
|||
from typing import Annotated |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: int | None = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: int | None = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: SessionDep) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
) -> list[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: SessionDep) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,73 @@ |
|||
from typing import Annotated, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: SessionDep) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
) -> list[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: SessionDep) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,69 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: int | None = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: int | None = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: Session = Depends(get_session)) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
) -> list[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,71 @@ |
|||
from typing import Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class Hero(SQLModel, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
secret_name: str |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/") |
|||
def create_hero(hero: Hero, session: Session = Depends(get_session)) -> Hero: |
|||
session.add(hero) |
|||
session.commit() |
|||
session.refresh(hero) |
|||
return hero |
|||
|
|||
|
|||
@app.get("/heroes/") |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
) -> list[Hero]: |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}") |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)) -> Hero: |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,104 @@ |
|||
from typing import List, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: Union[str, None] = None |
|||
age: Union[int, None] = None |
|||
secret_name: Union[str, None] = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: Session = Depends(get_session)): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=List[HeroPublic]) |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero( |
|||
hero_id: int, hero: HeroUpdate, session: Session = Depends(get_session) |
|||
): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,104 @@ |
|||
from typing import List, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
from typing_extensions import Annotated |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: Union[str, None] = None |
|||
age: Union[int, None] = None |
|||
secret_name: Union[str, None] = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: SessionDep): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=List[HeroPublic]) |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero(hero_id: int, hero: HeroUpdate, session: SessionDep): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,103 @@ |
|||
from typing import Annotated |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: int | None = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: int | None = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: str | None = None |
|||
age: int | None = None |
|||
secret_name: str | None = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: SessionDep): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=list[HeroPublic]) |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero(hero_id: int, hero: HeroUpdate, session: SessionDep): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,103 @@ |
|||
from typing import Annotated, Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: Union[str, None] = None |
|||
age: Union[int, None] = None |
|||
secret_name: Union[str, None] = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
SessionDep = Annotated[Session, Depends(get_session)] |
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: SessionDep): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=list[HeroPublic]) |
|||
def read_heroes( |
|||
session: SessionDep, |
|||
offset: int = 0, |
|||
limit: Annotated[int, Query(le=100)] = 100, |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero(hero_id: int, hero: HeroUpdate, session: SessionDep): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: SessionDep): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,102 @@ |
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: int | None = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: int | None = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: str | None = None |
|||
age: int | None = None |
|||
secret_name: str | None = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: Session = Depends(get_session)): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=list[HeroPublic]) |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero( |
|||
hero_id: int, hero: HeroUpdate, session: Session = Depends(get_session) |
|||
): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,104 @@ |
|||
from typing import Union |
|||
|
|||
from fastapi import Depends, FastAPI, HTTPException, Query |
|||
from sqlmodel import Field, Session, SQLModel, create_engine, select |
|||
|
|||
|
|||
class HeroBase(SQLModel): |
|||
name: str = Field(index=True) |
|||
age: Union[int, None] = Field(default=None, index=True) |
|||
|
|||
|
|||
class Hero(HeroBase, table=True): |
|||
id: Union[int, None] = Field(default=None, primary_key=True) |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroPublic(HeroBase): |
|||
id: int |
|||
|
|||
|
|||
class HeroCreate(HeroBase): |
|||
secret_name: str |
|||
|
|||
|
|||
class HeroUpdate(HeroBase): |
|||
name: Union[str, None] = None |
|||
age: Union[int, None] = None |
|||
secret_name: Union[str, None] = None |
|||
|
|||
|
|||
sqlite_file_name = "database.db" |
|||
sqlite_url = f"sqlite:///{sqlite_file_name}" |
|||
|
|||
connect_args = {"check_same_thread": False} |
|||
engine = create_engine(sqlite_url, connect_args=connect_args) |
|||
|
|||
|
|||
def create_db_and_tables(): |
|||
SQLModel.metadata.create_all(engine) |
|||
|
|||
|
|||
def get_session(): |
|||
with Session(engine) as session: |
|||
yield session |
|||
|
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.on_event("startup") |
|||
def on_startup(): |
|||
create_db_and_tables() |
|||
|
|||
|
|||
@app.post("/heroes/", response_model=HeroPublic) |
|||
def create_hero(hero: HeroCreate, session: Session = Depends(get_session)): |
|||
db_hero = Hero.model_validate(hero) |
|||
session.add(db_hero) |
|||
session.commit() |
|||
session.refresh(db_hero) |
|||
return db_hero |
|||
|
|||
|
|||
@app.get("/heroes/", response_model=list[HeroPublic]) |
|||
def read_heroes( |
|||
session: Session = Depends(get_session), |
|||
offset: int = 0, |
|||
limit: int = Query(default=100, le=100), |
|||
): |
|||
heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() |
|||
return heroes |
|||
|
|||
|
|||
@app.get("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def read_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
return hero |
|||
|
|||
|
|||
@app.patch("/heroes/{hero_id}", response_model=HeroPublic) |
|||
def update_hero( |
|||
hero_id: int, hero: HeroUpdate, session: Session = Depends(get_session) |
|||
): |
|||
hero_db = session.get(Hero, hero_id) |
|||
if not hero_db: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
hero_data = hero.model_dump(exclude_unset=True) |
|||
hero_db.sqlmodel_update(hero_data) |
|||
session.add(hero_db) |
|||
session.commit() |
|||
session.refresh(hero_db) |
|||
return hero_db |
|||
|
|||
|
|||
@app.delete("/heroes/{hero_id}") |
|||
def delete_hero(hero_id: int, session: Session = Depends(get_session)): |
|||
hero = session.get(Hero, hero_id) |
|||
if not hero: |
|||
raise HTTPException(status_code=404, detail="Hero not found") |
|||
session.delete(hero) |
|||
session.commit() |
|||
return {"ok": True} |
|||
@ -0,0 +1,37 @@ |
|||
import subprocess |
|||
import time |
|||
|
|||
import httpx |
|||
from playwright.sync_api import Playwright, sync_playwright |
|||
|
|||
|
|||
# Run playwright codegen to generate the code below, copy paste the sections in run() |
|||
def run(playwright: Playwright) -> None: |
|||
browser = playwright.chromium.launch(headless=False) |
|||
# Update the viewport manually |
|||
context = browser.new_context(viewport={"width": 960, "height": 1080}) |
|||
page = context.new_page() |
|||
page.goto("http://localhost:8000/docs") |
|||
page.get_by_label("post /heroes/").click() |
|||
# Manually add the screenshot |
|||
page.screenshot(path="docs/en/docs/img/tutorial/sql-databases/image01.png") |
|||
|
|||
# --------------------- |
|||
context.close() |
|||
browser.close() |
|||
|
|||
|
|||
process = subprocess.Popen( |
|||
["fastapi", "run", "docs_src/sql_databases/tutorial001.py"], |
|||
) |
|||
try: |
|||
for _ in range(3): |
|||
try: |
|||
response = httpx.get("http://localhost:8000/docs") |
|||
except httpx.ConnectError: |
|||
time.sleep(1) |
|||
break |
|||
with sync_playwright() as playwright: |
|||
run(playwright) |
|||
finally: |
|||
process.terminate() |
|||
@ -0,0 +1,37 @@ |
|||
import subprocess |
|||
import time |
|||
|
|||
import httpx |
|||
from playwright.sync_api import Playwright, sync_playwright |
|||
|
|||
|
|||
# Run playwright codegen to generate the code below, copy paste the sections in run() |
|||
def run(playwright: Playwright) -> None: |
|||
browser = playwright.chromium.launch(headless=False) |
|||
# Update the viewport manually |
|||
context = browser.new_context(viewport={"width": 960, "height": 1080}) |
|||
page = context.new_page() |
|||
page.goto("http://localhost:8000/docs") |
|||
page.get_by_label("post /heroes/").click() |
|||
# Manually add the screenshot |
|||
page.screenshot(path="docs/en/docs/img/tutorial/sql-databases/image02.png") |
|||
|
|||
# --------------------- |
|||
context.close() |
|||
browser.close() |
|||
|
|||
|
|||
process = subprocess.Popen( |
|||
["fastapi", "run", "docs_src/sql_databases/tutorial002.py"], |
|||
) |
|||
try: |
|||
for _ in range(3): |
|||
try: |
|||
response = httpx.get("http://localhost:8000/docs") |
|||
except httpx.ConnectError: |
|||
time.sleep(1) |
|||
break |
|||
with sync_playwright() as playwright: |
|||
run(playwright) |
|||
finally: |
|||
process.terminate() |
|||
@ -1,146 +0,0 @@ |
|||
import pytest |
|||
from fastapi import FastAPI |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(name="app", scope="module") |
|||
def get_app(): |
|||
with pytest.warns(DeprecationWarning): |
|||
from docs_src.async_sql_databases.tutorial001 import app |
|||
yield app |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_read(app: FastAPI): |
|||
with TestClient(app) as client: |
|||
note = {"text": "Foo bar", "completed": False} |
|||
response = client.post("/notes/", json=note) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data["text"] == note["text"] |
|||
assert data["completed"] == note["completed"] |
|||
assert "id" in data |
|||
response = client.get("/notes/") |
|||
assert response.status_code == 200, response.text |
|||
assert data in response.json() |
|||
|
|||
|
|||
def test_openapi_schema(app: FastAPI): |
|||
with TestClient(app) as client: |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/notes/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Notes Notes Get", |
|||
"type": "array", |
|||
"items": { |
|||
"$ref": "#/components/schemas/Note" |
|||
}, |
|||
} |
|||
} |
|||
}, |
|||
} |
|||
}, |
|||
"summary": "Read Notes", |
|||
"operationId": "read_notes_notes__get", |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Note"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Note", |
|||
"operationId": "create_note_notes__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/NoteIn"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"NoteIn": { |
|||
"title": "NoteIn", |
|||
"required": ["text", "completed"], |
|||
"type": "object", |
|||
"properties": { |
|||
"text": {"title": "Text", "type": "string"}, |
|||
"completed": {"title": "Completed", "type": "boolean"}, |
|||
}, |
|||
}, |
|||
"Note": { |
|||
"title": "Note", |
|||
"required": ["id", "text", "completed"], |
|||
"type": "object", |
|||
"properties": { |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"text": {"title": "Text", "type": "string"}, |
|||
"completed": {"title": "Completed", "type": "boolean"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": { |
|||
"$ref": "#/components/schemas/ValidationError" |
|||
}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,419 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module") |
|||
def client(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app import main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(main) |
|||
with TestClient(main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,421 +0,0 @@ |
|||
import importlib |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module") |
|||
def client(): |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app import alt_main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(alt_main) |
|||
|
|||
with TestClient(alt_main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,433 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py310, needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module") |
|||
def client(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py310 import alt_main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(alt_main) |
|||
|
|||
with TestClient(alt_main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,433 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py39, needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module") |
|||
def client(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py39 import alt_main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(alt_main) |
|||
|
|||
with TestClient(alt_main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,432 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py310, needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module", name="client") |
|||
def get_client(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py310 import main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(main) |
|||
with TestClient(main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,432 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py39, needs_pydanticv1 |
|||
|
|||
|
|||
@pytest.fixture(scope="module", name="client") |
|||
def get_client(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./sql_app.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py39 import main |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(main) |
|||
with TestClient(main.app) as c: |
|||
yield c |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_create_user(client): |
|||
test_user = {"email": "[email protected]", "password": "secret"} |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert test_user["email"] == data["email"] |
|||
assert "id" in data |
|||
response = client.post("/users/", json=test_user) |
|||
assert response.status_code == 400, response.text |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_user(client): |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data |
|||
assert "id" in data |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_nonexistent_user(client): |
|||
response = client.get("/users/999") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_get_users(client): |
|||
response = client.get("/users/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert "email" in data[0] |
|||
assert "id" in data[0] |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_create_item(client): |
|||
item = {"title": "Foo", "description": "Something that fights"} |
|||
response = client.post("/users/1/items/", json=item) |
|||
assert response.status_code == 200, response.text |
|||
item_data = response.json() |
|||
assert item["title"] == item_data["title"] |
|||
assert item["description"] == item_data["description"] |
|||
assert "id" in item_data |
|||
assert "owner_id" in item_data |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
response = client.get("/users/1") |
|||
assert response.status_code == 200, response.text |
|||
user_data = response.json() |
|||
item_to_check = [it for it in user_data["items"] if it["id"] == item_data["id"]][0] |
|||
assert item_to_check["title"] == item["title"] |
|||
assert item_to_check["description"] == item["description"] |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add Pydantic v2 version |
|||
@needs_pydanticv1 |
|||
def test_read_items(client): |
|||
response = client.get("/items/") |
|||
assert response.status_code == 200, response.text |
|||
data = response.json() |
|||
assert data |
|||
first_item = data[0] |
|||
assert "title" in first_item |
|||
assert "description" in first_item |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == { |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/users/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Users Users Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/User"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Users", |
|||
"operationId": "read_users_users__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
}, |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create User", |
|||
"operationId": "create_user_users__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/UserCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
}, |
|||
}, |
|||
"/users/{user_id}": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/User"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read User", |
|||
"operationId": "read_user_users__user_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
} |
|||
}, |
|||
"/users/{user_id}/items/": { |
|||
"post": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Item"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Create Item For User", |
|||
"operationId": "create_item_for_user_users__user_id__items__post", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "User Id", "type": "integer"}, |
|||
"name": "user_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/ItemCreate"} |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
} |
|||
}, |
|||
"/items/": { |
|||
"get": { |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"title": "Response Read Items Items Get", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
"summary": "Read Items", |
|||
"operationId": "read_items_items__get", |
|||
"parameters": [ |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Skip", |
|||
"type": "integer", |
|||
"default": 0, |
|||
}, |
|||
"name": "skip", |
|||
"in": "query", |
|||
}, |
|||
{ |
|||
"required": False, |
|||
"schema": { |
|||
"title": "Limit", |
|||
"type": "integer", |
|||
"default": 100, |
|||
}, |
|||
"name": "limit", |
|||
"in": "query", |
|||
}, |
|||
], |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"ItemCreate": { |
|||
"title": "ItemCreate", |
|||
"required": ["title"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["title", "id", "owner_id"], |
|||
"type": "object", |
|||
"properties": { |
|||
"title": {"title": "Title", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"}, |
|||
), |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"owner_id": {"title": "Owner Id", "type": "integer"}, |
|||
}, |
|||
}, |
|||
"User": { |
|||
"title": "User", |
|||
"required": ["email", "id", "is_active"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"id": {"title": "Id", "type": "integer"}, |
|||
"is_active": {"title": "Is Active", "type": "boolean"}, |
|||
"items": { |
|||
"title": "Items", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/Item"}, |
|||
"default": [], |
|||
}, |
|||
}, |
|||
}, |
|||
"UserCreate": { |
|||
"title": "UserCreate", |
|||
"required": ["email", "password"], |
|||
"type": "object", |
|||
"properties": { |
|||
"email": {"title": "Email", "type": "string"}, |
|||
"password": {"title": "Password", "type": "string"}, |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
"HTTPValidationError": { |
|||
"title": "HTTPValidationError", |
|||
"type": "object", |
|||
"properties": { |
|||
"detail": { |
|||
"title": "Detail", |
|||
"type": "array", |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -1,27 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
|
|||
from ...utils import needs_pydanticv1 |
|||
|
|||
|
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_testing_dbs(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./test.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app.tests import test_sql_app |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(test_sql_app) |
|||
test_sql_app.test_create_user() |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
@ -1,28 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
|
|||
from ...utils import needs_py310, needs_pydanticv1 |
|||
|
|||
|
|||
@needs_py310 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_testing_dbs_py39(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./test.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py310.tests import test_sql_app |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(test_sql_app) |
|||
test_sql_app.test_create_user() |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
@ -1,28 +0,0 @@ |
|||
import importlib |
|||
import os |
|||
from pathlib import Path |
|||
|
|||
import pytest |
|||
|
|||
from ...utils import needs_py39, needs_pydanticv1 |
|||
|
|||
|
|||
@needs_py39 |
|||
# TODO: pv2 add version with Pydantic v2 |
|||
@needs_pydanticv1 |
|||
def test_testing_dbs_py39(tmp_path_factory: pytest.TempPathFactory): |
|||
tmp_path = tmp_path_factory.mktemp("data") |
|||
cwd = os.getcwd() |
|||
os.chdir(tmp_path) |
|||
test_db = Path("./test.db") |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
# Import while creating the client to create the DB after starting the test session |
|||
from docs_src.sql_databases.sql_app_py39.tests import test_sql_app |
|||
|
|||
# Ensure import side effects are re-executed |
|||
importlib.reload(test_sql_app) |
|||
test_sql_app.test_create_user() |
|||
if test_db.is_file(): # pragma: nocover |
|||
test_db.unlink() |
|||
os.chdir(cwd) |
|||
@ -0,0 +1,373 @@ |
|||
import importlib |
|||
import warnings |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict, IsInt |
|||
from fastapi.testclient import TestClient |
|||
from inline_snapshot import snapshot |
|||
from sqlalchemy import StaticPool |
|||
from sqlmodel import SQLModel, create_engine |
|||
from sqlmodel.main import default_registry |
|||
|
|||
from tests.utils import needs_py39, needs_py310 |
|||
|
|||
|
|||
def clear_sqlmodel(): |
|||
# Clear the tables in the metadata for the default base model |
|||
SQLModel.metadata.clear() |
|||
# Clear the Models associated with the registry, to avoid warnings |
|||
default_registry.dispose() |
|||
|
|||
|
|||
@pytest.fixture( |
|||
name="client", |
|||
params=[ |
|||
"tutorial001", |
|||
pytest.param("tutorial001_py39", marks=needs_py39), |
|||
pytest.param("tutorial001_py310", marks=needs_py310), |
|||
"tutorial001_an", |
|||
pytest.param("tutorial001_an_py39", marks=needs_py39), |
|||
pytest.param("tutorial001_an_py310", marks=needs_py310), |
|||
], |
|||
) |
|||
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.sqlite_url = "sqlite://" |
|||
mod.engine = create_engine( |
|||
mod.sqlite_url, connect_args={"check_same_thread": False}, poolclass=StaticPool |
|||
) |
|||
|
|||
with TestClient(mod.app) as c: |
|||
yield c |
|||
|
|||
|
|||
def test_crud_app(client: TestClient): |
|||
# TODO: this warns that SQLModel.from_orm is deprecated in Pydantic v1, refactor |
|||
# this if using obj.model_validate becomes independent of Pydantic v2 |
|||
with warnings.catch_warnings(record=True): |
|||
warnings.simplefilter("always") |
|||
# No heroes before creating |
|||
response = client.get("heroes/") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == [] |
|||
|
|||
# Create a hero |
|||
response = client.post( |
|||
"/heroes/", |
|||
json={ |
|||
"id": 999, |
|||
"name": "Dead Pond", |
|||
"age": 30, |
|||
"secret_name": "Dive Wilson", |
|||
}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"age": 30, "secret_name": "Dive Wilson", "id": 999, "name": "Dead Pond"} |
|||
) |
|||
|
|||
# Read a hero |
|||
hero_id = response.json()["id"] |
|||
response = client.get(f"/heroes/{hero_id}") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"name": "Dead Pond", "age": 30, "id": 999, "secret_name": "Dive Wilson"} |
|||
) |
|||
|
|||
# Read all heroes |
|||
# Create more heroes first |
|||
response = client.post( |
|||
"/heroes/", |
|||
json={"name": "Spider-Boy", "age": 18, "secret_name": "Pedro Parqueador"}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
response = client.post( |
|||
"/heroes/", json={"name": "Rusty-Man", "secret_name": "Tommy Sharp"} |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
|
|||
response = client.get("/heroes/") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
[ |
|||
{ |
|||
"name": "Dead Pond", |
|||
"age": 30, |
|||
"id": IsInt(), |
|||
"secret_name": "Dive Wilson", |
|||
}, |
|||
{ |
|||
"name": "Spider-Boy", |
|||
"age": 18, |
|||
"id": IsInt(), |
|||
"secret_name": "Pedro Parqueador", |
|||
}, |
|||
{ |
|||
"name": "Rusty-Man", |
|||
"age": None, |
|||
"id": IsInt(), |
|||
"secret_name": "Tommy Sharp", |
|||
}, |
|||
] |
|||
) |
|||
|
|||
response = client.get("/heroes/?offset=1&limit=1") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
[ |
|||
{ |
|||
"name": "Spider-Boy", |
|||
"age": 18, |
|||
"id": IsInt(), |
|||
"secret_name": "Pedro Parqueador", |
|||
} |
|||
] |
|||
) |
|||
|
|||
# Delete a hero |
|||
response = client.delete(f"/heroes/{hero_id}") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot({"ok": True}) |
|||
|
|||
response = client.get(f"/heroes/{hero_id}") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
response = client.delete(f"/heroes/{hero_id}") |
|||
assert response.status_code == 404, response.text |
|||
assert response.json() == snapshot({"detail": "Hero not found"}) |
|||
|
|||
|
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{ |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/heroes/": { |
|||
"post": { |
|||
"summary": "Create Hero", |
|||
"operationId": "create_hero_heroes__post", |
|||
"requestBody": { |
|||
"required": True, |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Hero"} |
|||
} |
|||
}, |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Hero"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"get": { |
|||
"summary": "Read Heroes", |
|||
"operationId": "read_heroes_heroes__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "offset", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": { |
|||
"type": "integer", |
|||
"default": 0, |
|||
"title": "Offset", |
|||
}, |
|||
}, |
|||
{ |
|||
"name": "limit", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": { |
|||
"type": "integer", |
|||
"maximum": 100, |
|||
"default": 100, |
|||
"title": "Limit", |
|||
}, |
|||
}, |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"type": "array", |
|||
"items": { |
|||
"$ref": "#/components/schemas/Hero" |
|||
}, |
|||
"title": "Response Read Heroes Heroes Get", |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"/heroes/{hero_id}": { |
|||
"get": { |
|||
"summary": "Read Hero", |
|||
"operationId": "read_hero_heroes__hero_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "hero_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": {"type": "integer", "title": "Hero Id"}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": {"$ref": "#/components/schemas/Hero"} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"delete": { |
|||
"summary": "Delete Hero", |
|||
"operationId": "delete_hero_heroes__hero_id__delete", |
|||
"parameters": [ |
|||
{ |
|||
"name": "hero_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": {"type": "integer", "title": "Hero Id"}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"HTTPValidationError": { |
|||
"properties": { |
|||
"detail": { |
|||
"items": { |
|||
"$ref": "#/components/schemas/ValidationError" |
|||
}, |
|||
"type": "array", |
|||
"title": "Detail", |
|||
} |
|||
}, |
|||
"type": "object", |
|||
"title": "HTTPValidationError", |
|||
}, |
|||
"Hero": { |
|||
"properties": { |
|||
"id": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "integer"}, {"type": "null"}], |
|||
"title": "Id", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "integer", |
|||
"title": "Id", |
|||
} |
|||
), |
|||
"name": {"type": "string", "title": "Name"}, |
|||
"age": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "integer"}, {"type": "null"}], |
|||
"title": "Age", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "integer", |
|||
"title": "Age", |
|||
} |
|||
), |
|||
"secret_name": {"type": "string", "title": "Secret Name"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["name", "secret_name"], |
|||
"title": "Hero", |
|||
}, |
|||
"ValidationError": { |
|||
"properties": { |
|||
"loc": { |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
"type": "array", |
|||
"title": "Location", |
|||
}, |
|||
"msg": {"type": "string", "title": "Message"}, |
|||
"type": {"type": "string", "title": "Error Type"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["loc", "msg", "type"], |
|||
"title": "ValidationError", |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
) |
|||
@ -0,0 +1,481 @@ |
|||
import importlib |
|||
import warnings |
|||
|
|||
import pytest |
|||
from dirty_equals import IsDict, IsInt |
|||
from fastapi.testclient import TestClient |
|||
from inline_snapshot import snapshot |
|||
from sqlalchemy import StaticPool |
|||
from sqlmodel import SQLModel, create_engine |
|||
from sqlmodel.main import default_registry |
|||
|
|||
from tests.utils import needs_py39, needs_py310 |
|||
|
|||
|
|||
def clear_sqlmodel(): |
|||
# Clear the tables in the metadata for the default base model |
|||
SQLModel.metadata.clear() |
|||
# Clear the Models associated with the registry, to avoid warnings |
|||
default_registry.dispose() |
|||
|
|||
|
|||
@pytest.fixture( |
|||
name="client", |
|||
params=[ |
|||
"tutorial002", |
|||
pytest.param("tutorial002_py39", marks=needs_py39), |
|||
pytest.param("tutorial002_py310", marks=needs_py310), |
|||
"tutorial002_an", |
|||
pytest.param("tutorial002_an_py39", marks=needs_py39), |
|||
pytest.param("tutorial002_an_py310", marks=needs_py310), |
|||
], |
|||
) |
|||
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.sqlite_url = "sqlite://" |
|||
mod.engine = create_engine( |
|||
mod.sqlite_url, connect_args={"check_same_thread": False}, poolclass=StaticPool |
|||
) |
|||
|
|||
with TestClient(mod.app) as c: |
|||
yield c |
|||
|
|||
|
|||
def test_crud_app(client: TestClient): |
|||
# TODO: this warns that SQLModel.from_orm is deprecated in Pydantic v1, refactor |
|||
# this if using obj.model_validate becomes independent of Pydantic v2 |
|||
with warnings.catch_warnings(record=True): |
|||
warnings.simplefilter("always") |
|||
# No heroes before creating |
|||
response = client.get("heroes/") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == [] |
|||
|
|||
# Create a hero |
|||
response = client.post( |
|||
"/heroes/", |
|||
json={ |
|||
"id": 9000, |
|||
"name": "Dead Pond", |
|||
"age": 30, |
|||
"secret_name": "Dive Wilson", |
|||
}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"age": 30, "id": IsInt(), "name": "Dead Pond"} |
|||
) |
|||
assert ( |
|||
response.json()["id"] != 9000 |
|||
), "The ID should be generated by the database" |
|||
|
|||
# Read a hero |
|||
hero_id = response.json()["id"] |
|||
response = client.get(f"/heroes/{hero_id}") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"name": "Dead Pond", "age": 30, "id": IsInt()} |
|||
) |
|||
|
|||
# Read all heroes |
|||
# Create more heroes first |
|||
response = client.post( |
|||
"/heroes/", |
|||
json={"name": "Spider-Boy", "age": 18, "secret_name": "Pedro Parqueador"}, |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
response = client.post( |
|||
"/heroes/", json={"name": "Rusty-Man", "secret_name": "Tommy Sharp"} |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
|
|||
response = client.get("/heroes/") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
[ |
|||
{"name": "Dead Pond", "age": 30, "id": IsInt()}, |
|||
{"name": "Spider-Boy", "age": 18, "id": IsInt()}, |
|||
{"name": "Rusty-Man", "age": None, "id": IsInt()}, |
|||
] |
|||
) |
|||
|
|||
response = client.get("/heroes/?offset=1&limit=1") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
[{"name": "Spider-Boy", "age": 18, "id": IsInt()}] |
|||
) |
|||
|
|||
# Update a hero |
|||
response = client.patch( |
|||
f"/heroes/{hero_id}", json={"name": "Dog Pond", "age": None} |
|||
) |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"name": "Dog Pond", "age": None, "id": hero_id} |
|||
) |
|||
|
|||
# Get updated hero |
|||
response = client.get(f"/heroes/{hero_id}") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{"name": "Dog Pond", "age": None, "id": hero_id} |
|||
) |
|||
|
|||
# Delete a hero |
|||
response = client.delete(f"/heroes/{hero_id}") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot({"ok": True}) |
|||
|
|||
# The hero is no longer found |
|||
response = client.get(f"/heroes/{hero_id}") |
|||
assert response.status_code == 404, response.text |
|||
|
|||
# Delete a hero that does not exist |
|||
response = client.delete(f"/heroes/{hero_id}") |
|||
assert response.status_code == 404, response.text |
|||
assert response.json() == snapshot({"detail": "Hero not found"}) |
|||
|
|||
# Update a hero that does not exist |
|||
response = client.patch(f"/heroes/{hero_id}", json={"name": "Dog Pond"}) |
|||
assert response.status_code == 404, response.text |
|||
assert response.json() == snapshot({"detail": "Hero not found"}) |
|||
|
|||
|
|||
def test_openapi_schema(client: TestClient): |
|||
response = client.get("/openapi.json") |
|||
assert response.status_code == 200, response.text |
|||
assert response.json() == snapshot( |
|||
{ |
|||
"openapi": "3.1.0", |
|||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|||
"paths": { |
|||
"/heroes/": { |
|||
"post": { |
|||
"summary": "Create Hero", |
|||
"operationId": "create_hero_heroes__post", |
|||
"requestBody": { |
|||
"required": True, |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HeroCreate" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HeroPublic" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"get": { |
|||
"summary": "Read Heroes", |
|||
"operationId": "read_heroes_heroes__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "offset", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": { |
|||
"type": "integer", |
|||
"default": 0, |
|||
"title": "Offset", |
|||
}, |
|||
}, |
|||
{ |
|||
"name": "limit", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": { |
|||
"type": "integer", |
|||
"maximum": 100, |
|||
"default": 100, |
|||
"title": "Limit", |
|||
}, |
|||
}, |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"type": "array", |
|||
"items": { |
|||
"$ref": "#/components/schemas/HeroPublic" |
|||
}, |
|||
"title": "Response Read Heroes Heroes Get", |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"/heroes/{hero_id}": { |
|||
"get": { |
|||
"summary": "Read Hero", |
|||
"operationId": "read_hero_heroes__hero_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "hero_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": {"type": "integer", "title": "Hero Id"}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HeroPublic" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"patch": { |
|||
"summary": "Update Hero", |
|||
"operationId": "update_hero_heroes__hero_id__patch", |
|||
"parameters": [ |
|||
{ |
|||
"name": "hero_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": {"type": "integer", "title": "Hero Id"}, |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"required": True, |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HeroUpdate" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HeroPublic" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"delete": { |
|||
"summary": "Delete Hero", |
|||
"operationId": "delete_hero_heroes__hero_id__delete", |
|||
"parameters": [ |
|||
{ |
|||
"name": "hero_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": {"type": "integer", "title": "Hero Id"}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"HTTPValidationError": { |
|||
"properties": { |
|||
"detail": { |
|||
"items": { |
|||
"$ref": "#/components/schemas/ValidationError" |
|||
}, |
|||
"type": "array", |
|||
"title": "Detail", |
|||
} |
|||
}, |
|||
"type": "object", |
|||
"title": "HTTPValidationError", |
|||
}, |
|||
"HeroCreate": { |
|||
"properties": { |
|||
"name": {"type": "string", "title": "Name"}, |
|||
"age": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "integer"}, {"type": "null"}], |
|||
"title": "Age", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "integer", |
|||
"title": "Age", |
|||
} |
|||
), |
|||
"secret_name": {"type": "string", "title": "Secret Name"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["name", "secret_name"], |
|||
"title": "HeroCreate", |
|||
}, |
|||
"HeroPublic": { |
|||
"properties": { |
|||
"name": {"type": "string", "title": "Name"}, |
|||
"age": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "integer"}, {"type": "null"}], |
|||
"title": "Age", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "integer", |
|||
"title": "Age", |
|||
} |
|||
), |
|||
"id": {"type": "integer", "title": "Id"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["name", "id"], |
|||
"title": "HeroPublic", |
|||
}, |
|||
"HeroUpdate": { |
|||
"properties": { |
|||
"name": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
"title": "Name", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "string", |
|||
"title": "Name", |
|||
} |
|||
), |
|||
"age": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "integer"}, {"type": "null"}], |
|||
"title": "Age", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "integer", |
|||
"title": "Age", |
|||
} |
|||
), |
|||
"secret_name": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
"title": "Secret Name", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "string", |
|||
"title": "Secret Name", |
|||
} |
|||
), |
|||
}, |
|||
"type": "object", |
|||
"title": "HeroUpdate", |
|||
}, |
|||
"ValidationError": { |
|||
"properties": { |
|||
"loc": { |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
"type": "array", |
|||
"title": "Location", |
|||
}, |
|||
"msg": {"type": "string", "title": "Message"}, |
|||
"type": {"type": "string", "title": "Error Type"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["loc", "msg", "type"], |
|||
"title": "ValidationError", |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
) |
|||
Loading…
Reference in new issue