Flask Test Client API
FlaskClient ist ein simulierter Browser, der Anfragen senden und Antworten überprüfen kann, ohne einen Server zu starten.
Überapp.test_client()eine Instanz erstellen.
Testclient erstellen
| Methode | Beschreibung |
|---|---|
| app.test_client(use_cookies=True) | Standardmethode zur Erstellung. use_cookies=False deaktiviert die Cookie-Verarbeitung |
| with app.test_client() as client: | Kontextmanager. Bereinigt den Anfragekontext beim Verlassen automatisch. |
Anfragemethode
Alle Methoden gebenTestResponseObjekt zurück (erbt von Response).
| Methoden | Beschreibung |
|---|---|
| get(path, **kwargs) | GET-Anfrage senden |
| post(path, **kwargs) | POST-Anfrage senden |
| put(path, **kwargs) | PUT-Anfrage senden |
| delete(path, **kwargs) | DELETE-Anfrage senden |
| patch(path, **kwargs) | PATCH-Anfrage senden |
| open(path, method, **kwargs) | Allgemeine Anfragemethode; die Methode muss explizit angegeben werden. |
Anfrageparameter (kwargs)
| Parameter | Beschreibung |
|---|---|
| data | Anfragekörper (String oder Bytes). Wird zur Formularübermittlung verwendet. |
| json | JSON-Daten, automatisch serialisiert mit gesetztem Content-Type: application/json |
| query_string | URL-Abfrageparameter als String oder Dictionary |
| headers | Anfrage-Header-Dictionary |
| content_type | Benutzerdefinierter Content-Type |
| follow_redirects | bool, ob Weiterleitungen automatisch gefolgt wird. Standardwert ist False. |
| buffered | bool, ob die Antwort gepuffert werden soll. Standard ist False. |
Response-Objekt (TestResponse)
| Attribute/Methoden | Beschreibung |
|---|---|
| status_code | HTTP-Statuscode (int) |
| status | HTTP-Statustext, wie "200 OK" |
| data | Response-Body (bytes) |
| text | Den Response-Body als Text (str) abrufen. |
| get_json() | Response-Body als JSON parsen. Gibt ein dict oder eine list zurück. |
| headers | Response-Header (Headers-Objekt) |
| location | Ziel-URL der Weiterleitung (nur für 3xx-Antworten). |
| json_module | Modul, das für die JSON-Serialisierung verwendet wird (Standard ist app.json). |
Session-Test
| Methoden | Beschreibung |
|---|---|
| session_transaction(**kwargs) | Kontextmanager zum direkten Lesen und Schreiben der Session. Gibt ein SessionMixin-Objekt zurück. |
Codebeispiele
Beispiel
from app import create_app
app = create_app()
app.config["TESTING"] = True
def test_api():
with app.test_client() as client:
# GET-Anfrage
resp = client.get("/api/posts")
assert resp.status_code == 200
data = resp.get_json()
assert isinstance(data, list)
# POST JSON-Anfrage
resp = client.post("/api/posts", json={
"title": "BEISPIEL Tutorial",
"body": "Inhalt für den Einstieg"
})
assert resp.status_code == 201
assert resp.get_json()["title"] == "BEISPIEL Tutorial"
# Anfrage mit Query-Parametern
resp = client.get("/search?q=flask")
assert b"flask" in resp.data
# Angemeldeten Zustand simulieren
with client.session_transaction() as sess:
sess["username"] = "beispiel"
resp = client.get("/dashboard")
assert b"example" in resp.data
# Weiterleitungen folgen
resp = client.post("/login", data={
"username": "admin"
}, follow_redirects=True)
assert resp.status_code == 200
app = create_app()
app.config["TESTING"] = True
def test_api():
with app.test_client() as client:
# GET-Anfrage
resp = client.get("/api/posts")
assert resp.status_code == 200
data = resp.get_json()
assert isinstance(data, list)
# POST JSON-Anfrage
resp = client.post("/api/posts", json={
"title": "BEISPIEL Tutorial",
"body": "Inhalt für den Einstieg"
})
assert resp.status_code == 201
assert resp.get_json()["title"] == "BEISPIEL Tutorial"
# Anfrage mit Query-Parametern
resp = client.get("/search?q=flask")
assert b"flask" in resp.data
# Angemeldeten Zustand simulieren
with client.session_transaction() as sess:
sess["username"] = "beispiel"
resp = client.get("/dashboard")
assert b"example" in resp.data
# Weiterleitungen folgen
resp = client.post("/login", data={
"username": "admin"
}, follow_redirects=True)
assert resp.status_code == 200