Flask Response-Objekt-API

Die Response-Klasse stellt die von Flask-View-Funktionen zurückgegebene HTTP-Antwort dar. In den meisten Fällen müssen Sie sie nicht direkt erstellen – Flask konvertiert die Rückgabewerte von View-Funktionen automatisch in Response-Objekte.

Wenn manuelle Steuerung erforderlich ist, verwenden Sie diemake_response()-Funktion.


Konstruktor

Parameter Type Standardwert Beschreibung
response str / bytes / iterator Erforderlich Antwortkörper-Inhalt
status int / str 200 HTTP-Statuscode oder Statustext, z. B. 404 oder "404 Not Found"
headers dict / list Keine Antwort-Header, ein dict oder eine Liste von (key, value)-Tupeln
mimetype str Keine MIME-Typ, z. B. "application/json"
content_type str Keine Content-Type-Header, inklusive charset, z. B. "text/html; charset=utf-8"
direct_passthrough bool False Wenn True, wird der Antwortkörper direkt ohne jegliche Verarbeitung durchgereicht.

Kernattribute

Eigenschaft Type Beschreibung
status str Antwortstatus (in Textform), z. B. "200 OK" oder "404 Not Found"
status_code int HTTP-Statuscodes, z. B. 200, 404
headers Headers Antwort-Header-Objekt, unterstützt Operationen im Dictionary-Stil
data bytes Byte-Darstellung des Antwort-Bodys
mimetype str MIME-Typ (ohne Kodierung), z. B. "text/html"
content_type str Content-Type (einschließlich Charset), z. B. "text/html; charset=utf-8"
content_length int Byte-Länge des Antwort-Bodys

Antwort-Header-Operationen

Methoden Beschreibung
headers.get(key) Wert des angegebenen Antwort-Headers abrufen
headers[key] = value Antwort-Header setzen
headers.update(dict) Antwort-Header stapelweise aktualisieren

Cookie-Operationen

Methoden Beschreibung
set_cookie(key, value, max_age, expires, path, domain, secure, httponly, samesite) Setzt ein Cookie: max_age ist in Sekunden, expires ist ein datetime, secure ist nur über HTTPS
delete_cookie(key, path, domain) Löscht das angegebene Cookie
set_cookie-Parameter: max_age Cookie-Lebensdauer in Sekunden, z. B. max_age=3600 bedeutet 1 Stunde
set_cookie-Parameter: secure Standardmäßig der Konfigurationswert von SESSION_COOKIE_SECURE; wenn True, nur über HTTPS
set_cookie-Parameter: httponly Standardmäßig True, was verhindert, dass JavaScript auf dieses Cookie zugreift
set_cookie-Parameter: samesite "Strict", "Lax" oder None, steuert das Sendeverhalten von Cross-Site-Cookies

Andere Methoden

Methoden Beschreibung
get_json(force=False, silent=False) Den Antworttext als JSON parsen (hauptsächlich zum Testen verwendet).
freeze() Die Antwort in einen unveränderlichen Zustand einfrieren
force_type(response, environ) Klassenmethode, die andere Antworttypen zwangsweise in den Response-Typ konvertiert.

Codebeispiele

Beispiel

from flask import Flask, make_response

app = Flask(__name__)

@app.route("/custom")
def custom_response():
    # Verwende make_response, um manuell eine Antwort zu konstruieren
    resp = make_response("<h1>Hallo, EXAMPLE!</h1>")

    # Statuscode festlegen
    resp.status_code = 201

    # Benutzerdefinierte Antwort-Header festlegen
    resp.headers["X-Custom-Header"] = "my-value"

    # Ein Cookie setzen
    resp.set_cookie("theme", "dark", max_age=86400)    # 24 Stunden gültig
    resp.set_cookie("lang", "zh-CN", samesite="Lax")   # SameSite-Einschränkung

    return resp

@app.route("/delete-cookie")
def delete_cookie():
    resp = make_response("Cookie deleted")
    resp.delete_cookie("theme")
    return resp

@app.route("/api/data")
def api_data():
    # Ein dict direkt zurückgeben; Flask serialisiert es automatisch in eine JSON-Response
    return {"status": "ok", "data": [1, 2, 3]}
Weitere Erweiterungen