API de l'interface de session Flask

SessionInterface est l'abstraction de bas niveau de la Session, vous permettant de remplacer le stockage de cookies par défaut de Flask par un stockage externe tel que Redis, des bases de données, etc.

Les implémentations personnalisées ont seulement besoin d'hériter deSessionInterfaceet d'implémenter deux méthodes.


Classe de base abstraite SessionInterface

Attributs/Méthodes Description
null_session_class La classe utilisée lorsque Session est indisponible. Par défaut : NullSession
pickle_based bool, indique si Session repose sur la sérialisation pickle. La valeur par défaut est False
open_session(app, request) Lire les données de Session depuis la requête. Retourne une instance SessionMixin ou None
save_session(app, session, response) Enregistrer les données de Session dans la réponse
make_null_session(app) Créer une Session vide (appelée automatiquement lorsque open_session renvoie None)
is_null_session(obj) Déterminer s'il s'agit d'une instance de NullSession

Méthode d'options de cookie

Les méthodes suivantes sont utilisées pour obtenir les attributs du cookie de session et peuvent être remplacées :

Méthodes Description
get_cookie_name(app) Obtenir le nom du cookie. Par défaut, lit la configuration SESSION_COOKIE_NAME
get_cookie_domain(app) Obtenir le domaine du cookie. Par défaut, lit la configuration SESSION_COOKIE_DOMAIN
get_cookie_path(app) Obtenir le chemin du cookie. Par défaut, lit SESSION_COOKIE_PATH ou APPLICATION_ROOT
get_cookie_httponly(app) Obtenir l'indicateur HttpOnly. Par défaut, lit SESSION_COOKIE_HTTPONLY
get_cookie_secure(app) Obtenir le drapeau Secure. Par défaut, lit SESSION_COOKIE_SECURE
get_cookie_samesite(app) Obtenir la valeur SameSite. Par défaut, lit SESSION_COOKIE_SAMESITE
get_cookie_partitioned(app) Obtenir le drapeau Partitioned. Par défaut, lit SESSION_COOKIE_PARTITIONED (v3.1+)
get_expiration_time(app, session) Obtenir le temps d'expiration de la Session. Une Session permanente renvoie maintenant + durée de vie
should_set_cookie(app, session) Déterminer si un Cookie doit être défini. Renvoie True lorsque la Session est modifiée ou permanente + SESSION_REFRESH_EACH_REQUEST

Implémentations intégrées

Classe Description
SecureCookieSessionInterface Implémentation par défaut. Utilise un Cookie signé itsdangerous pour stocker les données de Session. key_derivation="hmac", digest_method=sha1
SecureCookieSession Classe Session basée sur CallbackDict. Détecte les modifications des clés de premier niveau et définit automatiquement modified=True
NullSession Une Session factice utilisée lorsque SECRET_KEY n'est pas défini. La lecture fonctionne normalement, la modification lève une erreur.
SessionMixin Mixin pour les classes Session. Fournit les propriétés permanent, new, modified, accessed

Remplacer l'implémentation Session par défaut

Exemple

from flask import Flask
from flask.sessions import SessionInterface, SessionMixin

# Classe Session personnalisée
class MySession(dict, SessionMixin):
    pass

# Interface Session personnalisée
class MySessionInterface(SessionInterface):
    def open_session(self, app, request):
        # Charger la session depuis la requête
        user_id = request.headers.get("X-User-ID")
        if user_id:
            return MySession(user_id=user_id)
        return MySession()

    def save_session(self, app, session, response):
        # Enregistrer la session dans la réponse
        if "user_id" in session:
            response.headers["X-Session-ID"] = session["user_id"]

app = Flask(__name__)
# Remplacer l'implémentation Session par défaut
app.session_interface = MySessionInterface()
autres extensions