Flask JSON
Das JSON-Modul von Flask bietet Funktionen zur Serialisierung/Deserialisierung und verwendet standardmäßig die Python-Standardbibliothek json, die über JSONProvider ersetzt werden kann.
Importmethode:
from flask import jsonify
oder
from flask.json import dumps, loads
jsonify-Funktion
Die am häufigsten verwendete Funktion zur Erstellung von JSON-Antworten. Serialisiert Python-Objekte in eine JSON-Antwort.
| Nutzung | Beschreibung |
|---|---|
| jsonify(*args, **kwargs) | Serialisiert Parameter zu JSON, gibt Response zurück (Content-Type: application/json) |
| jsonify(dict) | Serialisiert ein Dictionary in eine JSON-Antwort |
| jsonify(key=value, ...) | Serialisiert Schlüsselwortargumente in eine JSON-Antwort |
dumps / loads / dump / load
| Funktion | Signatur | Beschreibung |
|---|---|---|
| dumps | (obj, *, skipkeys=False, ensure_ascii=True, ...) | Serialisiert Python-Objekte in einen JSON-String |
| loads | (s, *, ...) | Deserialisiert einen JSON-String in ein Python-Objekt |
| dump | (obj, fp, *, ...) | Serialisiert ein Python-Objekt und schreibt es in eine Datei |
| load | (fp, *, ...) | Liest aus einer Datei und deserialisiert JSON |
JSONProvider-Klasse
Anpassbare Basisklasse für JSON-Handler. Um die Standard-JSON-Implementierung zu ersetzen, erben Sie von dieser Klasse und überschreiben Sie die relevanten Methoden.
| Methoden | Beschreibung |
|---|---|
| dumps(obj, **kwargs) | Serialisiert ein Objekt in einen JSON-String |
| loads(s, **kwargs) | Deserialisiert aus einem JSON-String in ein Python-Objekt |
| response(obj) | Konvertiert das Objekt in eine JSON-Antwort. Wird für jsonify und bei der Rückgabe von dict/list verwendet. |
DefaultJSONProvider
Die Standardimplementierung von JSONProvider, basierend auf der Python-Standardbibliothek json.
| Attribute/Methoden | Beschreibung |
|---|---|
| ensure_ascii | Ob Nicht-ASCII-Zeichen maskiert werden sollen. Kann auf False gesetzt werden, um chinesische Ausgabe zu unterstützen |
| sort_keys | Ob die Ausgabe nach Schlüssel sortiert werden soll. Standard ist True |
| compact | Ob kompakt ausgegeben werden soll (ohne Leerzeichen). Standard ist False |
JSON-Tag-Serialisierung
flask.json.tagDas Modul unterstützt die Serialisierung weiterer Python-Typen, wie datetime, tuple, set usw.
| Tags | Entsprechende Python-Typen |
|---|---|
| JSONTaggedJSONSerializer | Erweiterter Serializer, standardmäßig von Session verwendet. Unterstützt das getaggte JSON-Format |
Codebeispiele
Beispiel
from flask import Flask, jsonify
app = Flask(__name__)
@app.get("/api/me")
def me():
# dict zurückgeben, Flask ruft automatisch jsonify auf
return {
"username": "example",
"email": "test@example.com",
"roles": ["admin", "editor"]
}
@app.get("/api/users")
def users():
# list zurückgeben, Flask ruft automatisch jsonify auf
return [
{"id": 1, "name": "example"},
{"id": 2, "name": "admin"}
]
@app.get("/api/status")
def status():
# jsonify explizit verwenden
return jsonify(status="ok", version="1.0")
# Chinesische JSON-Ausgabe konfigurieren
app.json.ensure_ascii = False
# {"username": "example", "description": "chinesischer Beschreibungstext"}
app = Flask(__name__)
@app.get("/api/me")
def me():
# dict zurückgeben, Flask ruft automatisch jsonify auf
return {
"username": "example",
"email": "test@example.com",
"roles": ["admin", "editor"]
}
@app.get("/api/users")
def users():
# list zurückgeben, Flask ruft automatisch jsonify auf
return [
{"id": 1, "name": "example"},
{"id": 2, "name": "admin"}
]
@app.get("/api/status")
def status():
# jsonify explizit verwenden
return jsonify(status="ok", version="1.0")
# Chinesische JSON-Ausgabe konfigurieren
app.json.ensure_ascii = False
# {"username": "example", "description": "chinesischer Beschreibungstext"}