API de session Flask
La session est utilisée pour sauvegarder des données entre différentes requêtes d'un même utilisateur. Flask l'implémente à l'aide de cookies signés par défaut ; les données sont stockées côté client mais ne peuvent pas être falsifiées.
Grâce àfrom flask import session, importez et utilisez comme un dictionnaire.
objet proxy session
sessionIl s'agit d'un proxy qui pointe vers l'instance SessionMixin de la requête en cours. Il n'est disponible que dans le contexte de la requête.
| Attributs/Méthodes | Description |
|---|---|
| session[key] = value | Définir la valeur de session |
| session.get(key, default) | Récupérer en toute sécurité une valeur de session, en renvoyant default lorsque la clé n'existe pas. |
| session.pop(key, default) | Supprimer et renvoyer la valeur de la clé spécifiée. |
| session.clear() | Efface toutes les données de session. |
| "key" in session | Vérifie si la clé existe |
| session.permanent | Lorsqu'il est défini sur True, la session persiste après la fermeture du navigateur (utilise PERMANENT_SESSION_LIFETIME) |
| session.modified | Lors de la modification de valeurs mutables dans la session (comme l'ajout à une liste), vous devez le définir manuellement sur True. |
| session.accessed | Lorsque la valeur est True, si la session est accédée, Flask ajoute automatiquement l'en-tête Vary: Cookie |
| session.new | Indique si la session vient d'être créée (certaines implémentations ne prennent pas en charge la détection précise). |
Lors de la modification d'objets mutables imbriqués dans la session (comme des listes, des dictionnaires), Flask ne peut pas détecter automatiquement la modification.
Il faut définir manuellementsession.modified = TrueSinon, la modification ne sera pas enregistrée dans le cookie.
Élément de configuration
| Clé de configuration | Valeur par défaut | Description |
|---|---|---|
| SECRET_KEY | Aucune | La clé secrète pour signer la session ; elle doit être définie pour utiliser la session. |
| SESSION_COOKIE_NAME | "session" | Nom du cookie de session |
| SESSION_COOKIE_DOMAIN | Aucune | L'attribut Domain du cookie |
| SESSION_COOKIE_PATH | Aucune | L'attribut Path du cookie |
| SESSION_COOKIE_HTTPONLY | True | Empêcher JavaScript d'accéder au cookie de session |
| SESSION_COOKIE_SECURE | False | Lorsque True, les cookies ne sont envoyés que via HTTPS |
| SESSION_COOKIE_SAMESITE | Aucune | "Strict", "Lax", ou None |
| PERMANENT_SESSION_LIFETIME | timedelta(days=31) | La période de validité d'une session permanente. |
| SESSION_REFRESH_EACH_REQUEST | True | Actualiser la période de validité du cookie de session à chaque requête. |
Exemples de code
Exemple
from flask import Flask, session, redirect, url_for
app = Flask(__name__)
app.secret_key = "your-secret-key"
@app.route("/")
def index():
if "username" in session:
return f'Connecté en tant que {session["username"]}'
return 'Vous n’êtes pas connecté'
@app.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
session["username"] = request.form["username"]
# Définir une session permanente (conservée pendant 31 jours après la fermeture du navigateur)
session.permanent = True
return redirect(url_for("index"))
return '<form method="post"><input name="username"></form>'
@app.route("/appends")
def append_to_list():
# Remarque : modifier des listes imbriquées nécessite de marquer manuellement comme modifié
if "items" not in session:
session["items"] = []
session["items"].append("new_item")
session.modified = True # Doit être marqué manuellement !
return f'Items: {session["items"]}'
@app.route("/logout")
def logout():
session.clear()
return redirect(url_for("index"))
app = Flask(__name__)
app.secret_key = "your-secret-key"
@app.route("/")
def index():
if "username" in session:
return f'Connecté en tant que {session["username"]}'
return 'Vous n’êtes pas connecté'
@app.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
session["username"] = request.form["username"]
# Définir une session permanente (conservée pendant 31 jours après la fermeture du navigateur)
session.permanent = True
return redirect(url_for("index"))
return '<form method="post"><input name="username"></form>'
@app.route("/appends")
def append_to_list():
# Remarque : modifier des listes imbriquées nécessite de marquer manuellement comme modifié
if "items" not in session:
session["items"] = []
session["items"].append("new_item")
session.modified = True # Doit être marqué manuellement !
return f'Items: {session["items"]}'
@app.route("/logout")
def logout():
session.clear()
return redirect(url_for("index"))