mirror of
https://github.com/fastapi/fastapi.git
synced 2026-03-11 03:17:23 -04:00
d4e85da18b
* 🌐 💬 🩺 🦲 * 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks * 🛠️😊 * ♻️ Rename emoji lang from emj to em, and main docs name as 😉 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Axd1x8a <26704473+FeeeeK@users.noreply.github.com> Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
189 lines
5.2 KiB
Markdown
189 lines
5.2 KiB
Markdown
# 🔬
|
||
|
||
👏 <a href="https://www.starlette.io/testclient/" class="external-link" target="_blank">💃</a>, 🔬 **FastAPI** 🈸 ⏩ & 😌.
|
||
|
||
⚫️ ⚓️ 🔛 <a href="https://www.python-httpx.org" class="external-link" target="_blank">🇸🇲</a>, ❔ 🔄 🏗 ⚓️ 🔛 📨, ⚫️ 📶 😰 & 🏋️.
|
||
|
||
⏮️ ⚫️, 👆 💪 ⚙️ <a href="https://docs.pytest.org/" class="external-link" target="_blank">✳</a> 🔗 ⏮️ **FastAPI**.
|
||
|
||
## ⚙️ `TestClient`
|
||
|
||
!!! info
|
||
⚙️ `TestClient`, 🥇 ❎ <a href="https://www.python-httpx.org" class="external-link" target="_blank">`httpx`</a>.
|
||
|
||
🤶 Ⓜ. `pip install httpx`.
|
||
|
||
🗄 `TestClient`.
|
||
|
||
✍ `TestClient` 🚶♀️ 👆 **FastAPI** 🈸 ⚫️.
|
||
|
||
✍ 🔢 ⏮️ 📛 👈 ▶️ ⏮️ `test_` (👉 🐩 `pytest` 🏛).
|
||
|
||
⚙️ `TestClient` 🎚 🎏 🌌 👆 ⏮️ `httpx`.
|
||
|
||
✍ 🙅 `assert` 📄 ⏮️ 🐩 🐍 🧬 👈 👆 💪 ✅ (🔄, 🐩 `pytest`).
|
||
|
||
```Python hl_lines="2 12 15-18"
|
||
{!../../../docs_src/app_testing/tutorial001.py!}
|
||
```
|
||
|
||
!!! tip
|
||
👀 👈 🔬 🔢 😐 `def`, 🚫 `async def`.
|
||
|
||
& 🤙 👩💻 😐 🤙, 🚫 ⚙️ `await`.
|
||
|
||
👉 ✔ 👆 ⚙️ `pytest` 🔗 🍵 🤢.
|
||
|
||
!!! note "📡 ℹ"
|
||
👆 💪 ⚙️ `from starlette.testclient import TestClient`.
|
||
|
||
**FastAPI** 🚚 🎏 `starlette.testclient` `fastapi.testclient` 🏪 👆, 👩💻. ✋️ ⚫️ 👟 🔗 ⚪️➡️ 💃.
|
||
|
||
!!! tip
|
||
🚥 👆 💚 🤙 `async` 🔢 👆 💯 ↖️ ⚪️➡️ 📨 📨 👆 FastAPI 🈸 (✅ 🔁 💽 🔢), ✔️ 👀 [🔁 💯](../advanced/async-tests.md){.internal-link target=_blank} 🏧 🔰.
|
||
|
||
## 🎏 💯
|
||
|
||
🎰 🈸, 👆 🎲 🔜 ✔️ 👆 💯 🎏 📁.
|
||
|
||
& 👆 **FastAPI** 🈸 5️⃣📆 ✍ 📚 📁/🕹, ♒️.
|
||
|
||
### **FastAPI** 📱 📁
|
||
|
||
➡️ 💬 👆 ✔️ 📁 📊 🔬 [🦏 🈸](./bigger-applications.md){.internal-link target=_blank}:
|
||
|
||
```
|
||
.
|
||
├── app
|
||
│ ├── __init__.py
|
||
│ └── main.py
|
||
```
|
||
|
||
📁 `main.py` 👆 ✔️ 👆 **FastAPI** 📱:
|
||
|
||
|
||
```Python
|
||
{!../../../docs_src/app_testing/main.py!}
|
||
```
|
||
|
||
### 🔬 📁
|
||
|
||
⤴️ 👆 💪 ✔️ 📁 `test_main.py` ⏮️ 👆 💯. ⚫️ 💪 🖖 🔛 🎏 🐍 📦 (🎏 📁 ⏮️ `__init__.py` 📁):
|
||
|
||
``` hl_lines="5"
|
||
.
|
||
├── app
|
||
│ ├── __init__.py
|
||
│ ├── main.py
|
||
│ └── test_main.py
|
||
```
|
||
|
||
↩️ 👉 📁 🎏 📦, 👆 💪 ⚙️ ⚖ 🗄 🗄 🎚 `app` ⚪️➡️ `main` 🕹 (`main.py`):
|
||
|
||
```Python hl_lines="3"
|
||
{!../../../docs_src/app_testing/test_main.py!}
|
||
```
|
||
|
||
...& ✔️ 📟 💯 💖 ⏭.
|
||
|
||
## 🔬: ↔ 🖼
|
||
|
||
🔜 ➡️ ↔ 👉 🖼 & 🚮 🌖 ℹ 👀 ❔ 💯 🎏 🍕.
|
||
|
||
### ↔ **FastAPI** 📱 📁
|
||
|
||
➡️ 😣 ⏮️ 🎏 📁 📊 ⏭:
|
||
|
||
```
|
||
.
|
||
├── app
|
||
│ ├── __init__.py
|
||
│ ├── main.py
|
||
│ └── test_main.py
|
||
```
|
||
|
||
➡️ 💬 👈 🔜 📁 `main.py` ⏮️ 👆 **FastAPI** 📱 ✔️ 🎏 **➡ 🛠️**.
|
||
|
||
⚫️ ✔️ `GET` 🛠️ 👈 💪 📨 ❌.
|
||
|
||
⚫️ ✔️ `POST` 🛠️ 👈 💪 📨 📚 ❌.
|
||
|
||
👯♂️ *➡ 🛠️* 🚚 `X-Token` 🎚.
|
||
|
||
=== "🐍 3️⃣.6️⃣ & 🔛"
|
||
|
||
```Python
|
||
{!> ../../../docs_src/app_testing/app_b/main.py!}
|
||
```
|
||
|
||
=== "🐍 3️⃣.1️⃣0️⃣ & 🔛"
|
||
|
||
```Python
|
||
{!> ../../../docs_src/app_testing/app_b_py310/main.py!}
|
||
```
|
||
|
||
### ↔ 🔬 📁
|
||
|
||
👆 💪 ⤴️ ℹ `test_main.py` ⏮️ ↔ 💯:
|
||
|
||
```Python
|
||
{!> ../../../docs_src/app_testing/app_b/test_main.py!}
|
||
```
|
||
|
||
🕐❔ 👆 💪 👩💻 🚶♀️ ℹ 📨 & 👆 🚫 💭 ❔, 👆 💪 🔎 (🇺🇸🔍) ❔ ⚫️ `httpx`, ⚖️ ❔ ⚫️ ⏮️ `requests`, 🇸🇲 🔧 ⚓️ 🔛 📨' 🔧.
|
||
|
||
⤴️ 👆 🎏 👆 💯.
|
||
|
||
🤶 Ⓜ.:
|
||
|
||
* 🚶♀️ *➡* ⚖️ *🔢* 🔢, 🚮 ⚫️ 📛 ⚫️.
|
||
* 🚶♀️ 🎻 💪, 🚶♀️ 🐍 🎚 (✅ `dict`) 🔢 `json`.
|
||
* 🚥 👆 💪 📨 *📨 💽* ↩️ 🎻, ⚙️ `data` 🔢 ↩️.
|
||
* 🚶♀️ *🎚*, ⚙️ `dict` `headers` 🔢.
|
||
* *🍪*, `dict` `cookies` 🔢.
|
||
|
||
🌖 ℹ 🔃 ❔ 🚶♀️ 💽 👩💻 (⚙️ `httpx` ⚖️ `TestClient`) ✅ <a href="https://www.python-httpx.org" class="external-link" target="_blank">🇸🇲 🧾</a>.
|
||
|
||
!!! info
|
||
🗒 👈 `TestClient` 📨 💽 👈 💪 🗜 🎻, 🚫 Pydantic 🏷.
|
||
|
||
🚥 👆 ✔️ Pydantic 🏷 👆 💯 & 👆 💚 📨 🚮 💽 🈸 ⏮️ 🔬, 👆 💪 ⚙️ `jsonable_encoder` 🔬 [🎻 🔗 🔢](encoder.md){.internal-link target=_blank}.
|
||
|
||
## 🏃 ⚫️
|
||
|
||
⏮️ 👈, 👆 💪 ❎ `pytest`:
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ pip install pytest
|
||
|
||
---> 100%
|
||
```
|
||
|
||
</div>
|
||
|
||
⚫️ 🔜 🔍 📁 & 💯 🔁, 🛠️ 👫, & 📄 🏁 🔙 👆.
|
||
|
||
🏃 💯 ⏮️:
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ pytest
|
||
|
||
================ test session starts ================
|
||
platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
|
||
rootdir: /home/user/code/superawesome-cli/app
|
||
plugins: forked-1.1.3, xdist-1.31.0, cov-2.8.1
|
||
collected 6 items
|
||
|
||
---> 100%
|
||
|
||
test_main.py <span style="color: green; white-space: pre;">...... [100%]</span>
|
||
|
||
<span style="color: green;">================= 1 passed in 0.03s =================</span>
|
||
```
|
||
|
||
</div>
|