Flask Session-Schnittstellen-API
SessionInterface ist die Low-Level-Abstraktion von Session, mit der Sie den Standard-Cookie-Speicher von Flask durch externen Speicher wie Redis, Datenbanken usw. ersetzen können.
Benutzerdefinierte Implementierungen müssen nurSessionInterfaceerben und zwei Methoden implementieren.
SessionInterface abstrakte Basisklasse
| Attribute/Methoden | Beschreibung |
|---|---|
| null_session_class | Die Klasse, die verwendet wird, wenn Session nicht verfügbar ist. Standardmäßig NullSession |
| pickle_based | bool, ob Session auf pickle-Serialisierung basiert. Standard ist False |
| open_session(app, request) | Liest Session-Daten aus der Anfrage. Gibt eine SessionMixin-Instanz oder None zurück |
| save_session(app, session, response) | Speichert Session-Daten in der Antwort |
| make_null_session(app) | Erstellt eine leere Session (wird automatisch aufgerufen, wenn open_session None zurückgibt) |
| is_null_session(obj) | Bestimmen, ob es sich um eine NullSession-Instanz handelt |
Cookie-Optionen-Methode
Die folgenden Methoden werden verwendet, um Attribute des Session-Cookies abzurufen, und können überschrieben werden:
| Methoden | Beschreibung |
|---|---|
| get_cookie_name(app) | Ruft den Cookie-Namen ab. Standardmäßig wird die Konfiguration SESSION_COOKIE_NAME gelesen |
| get_cookie_domain(app) | Ruft die Cookie-Domain ab. Standardmäßig wird die Konfiguration SESSION_COOKIE_DOMAIN gelesen |
| get_cookie_path(app) | Ruft den Cookie-Pfad ab. Standardmäßig wird SESSION_COOKIE_PATH oder APPLICATION_ROOT gelesen |
| get_cookie_httponly(app) | Ruft das HttpOnly-Flag ab. Standardmäßig wird SESSION_COOKIE_HTTPONLY gelesen |
| get_cookie_secure(app) | Ruft das Secure-Flag ab. Standardmäßig wird SESSION_COOKIE_SECURE gelesen |
| get_cookie_samesite(app) | Ruft den SameSite-Wert ab. Standardmäßig wird SESSION_COOKIE_SAMESITE gelesen |
| get_cookie_partitioned(app) | Ruft das Partitioned-Flag ab. Standardmäßig wird SESSION_COOKIE_PARTITIONED gelesen (v3.1+) |
| get_expiration_time(app, session) | Ruft die Ablaufzeit der Session ab. Eine permanente Session gibt now + lifetime zurück |
| should_set_cookie(app, session) | Bestimmt, ob ein Cookie gesetzt werden muss. Gibt True zurück, wenn die Session geändert wurde oder permanent + SESSION_REFRESH_EACH_REQUEST |
Integrierte Implementierungen
| Klasse | Beschreibung |
|---|---|
| SecureCookieSessionInterface | Standardimplementierung. Verwendet signiertes Cookie von itsdangerous, um Session-Daten zu speichern. key_derivation="hmac", digest_method=sha1 |
| SecureCookieSession | Session-Klasse basierend auf CallbackDict. Erkennt Änderungen an Schlüsseln der obersten Ebene und setzt automatisch modified=True |
| NullSession | Eine Platzhalter-Session, die verwendet wird, wenn SECRET_KEY nicht gesetzt ist. Lesen funktioniert normal, Ändern löst einen Fehler aus. |
| SessionMixin | Mixin für Session-Klassen. Stellt die Eigenschaften permanent, new, modified und accessed bereit |
Die Standard-Session-Implementierung ersetzen
Beispiel
from flask import Flask
from flask.sessions import SessionInterface, SessionMixin
# Benutzerdefinierte Session-Klasse
class MySession(dict, SessionMixin):
pass
# Benutzerdefinierte Session-Schnittstelle
class MySessionInterface(SessionInterface):
def open_session(self, app, request):
# Session aus request laden
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):
# Session in response speichern
if "user_id" in session:
response.headers["X-Session-ID"] = session["user_id"]
app = Flask(__name__)
# Die Standard-Session-Implementierung ersetzen
app.session_interface = MySessionInterface()
from flask.sessions import SessionInterface, SessionMixin
# Benutzerdefinierte Session-Klasse
class MySession(dict, SessionMixin):
pass
# Benutzerdefinierte Session-Schnittstelle
class MySessionInterface(SessionInterface):
def open_session(self, app, request):
# Session aus request laden
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):
# Session in response speichern
if "user_id" in session:
response.headers["X-Session-ID"] = session["user_id"]
app = Flask(__name__)
# Die Standard-Session-Implementierung ersetzen
app.session_interface = MySessionInterface()