Flask JSON

Le module JSON de Flask fournit des fonctionnalités de sérialisation/désérialisation, en utilisant par défaut la bibliothèque standard json de Python en interne, qui peut être remplacée via JSONProvider.

Méthode d'import :

from flask import jsonify

ou

from flask.json import dumps, loads

Fonction jsonify

La fonction de construction de réponse JSON la plus couramment utilisée. Sérialise les objets Python en une Response JSON.

Utilisation Description
jsonify(*args, **kwargs) Sérialise les paramètres en JSON, retourne Response (Content-Type: application/json)
jsonify(dict) Sérialise un dictionnaire en réponse JSON
jsonify(key=value, ...) Sérialise les arguments nommés en réponse JSON

dumps / loads / dump / load

Fonction Signature Description
dumps (obj, *, skipkeys=False, ensure_ascii=True, ...) Sérialise des objets Python en une chaîne JSON
loads (s, *, ...) Désérialise une chaîne JSON en un objet Python
dump (obj, fp, *, ...) Sérialise un objet Python et l'écrit dans un fichier
load (fp, *, ...) Lit depuis un fichier et désérialise du JSON

Classe JSONProvider

Classe de base de gestionnaire JSON personnalisable. Pour remplacer l'implémentation JSON par défaut, héritez de cette classe et remplacez les méthodes pertinentes.

Méthodes Description
dumps(obj, **kwargs) Sérialise un objet en une chaîne JSON
loads(s, **kwargs) Désérialise depuis une chaîne JSON en un objet Python
response(obj) Convertit l'objet en une réponse JSON. Utilisé pour jsonify et lors du retour de dict/list.

DefaultJSONProvider

L'implémentation JSONProvider par défaut, basée sur le module json de la bibliothèque standard Python.

Attributs/Méthodes Description
ensure_ascii Indique s'il faut échapper les caractères non-ASCII. Peut être défini sur False pour prendre en charge la sortie en chinois
sort_keys Indique s'il faut trier la sortie par clé. La valeur par défaut est True
compact Indique s'il faut produire une sortie compacte (sans espaces). La valeur par défaut est False

Sérialisation des balises JSON

flask.json.tagLe module prend en charge la sérialisation de davantage de types Python, tels que datetime, tuple, set, etc.

Balises Types Python correspondants
JSONTaggedJSONSerializer Sérialiseur amélioré, utilisé par Session par défaut. Prend en charge le format JSON balisé

Exemples de code

Exemple

from flask import Flask, jsonify

app = Flask(__name__)

@app.get("/api/me")
def me():
    # Retourne dict, Flask appelle automatiquement jsonify
    return {
        "username": "example",
        "email": "test@example.com",
        "roles": ["admin", "editor"]
    }

@app.get("/api/users")
def users():
    # Retourne list, Flask appelle automatiquement jsonify
    return [
        {"id": 1, "name": "example"},
        {"id": 2, "name": "admin"}
    ]

@app.get("/api/status")
def status():
    # Utiliser explicitement jsonify
    return jsonify(status="ok", version="1.0")

# Configurer la sortie JSON en chinois
app.json.ensure_ascii = False
# {"username": "example", "description": "Contenu de la description en chinois"}
autres extensions