Flask Session Interface API
SessionInterface は Session の低レベル抽象であり、Flask のデフォルトの Cookie ストレージ方式を Redis やデータベースなどの外部ストレージに置き換えることを可能にします。
カスタム実装は継承するだけでよくSessionInterface2つのメソッドを実装します。
SessionInterface 抽象基底クラス
| 属性/メソッド | 説明 |
|---|---|
| null_session_class | Session が利用できない場合に使用されるクラス。デフォルトは NullSession |
| pickle_based | bool。Session が pickle ベースのシリアライズかどうか。デフォルトは False |
| open_session(app, request) | リクエストから Session データを読み取ります。SessionMixin インスタンスまたは None を返します。 |
| save_session(app, session, response) | Session データをレスポンスに保存します。 |
| make_null_session(app) | 空の Session を作成します(open_session が None を返したときに自動的に呼び出されます)。 |
| is_null_session(obj) | NullSession インスタンスであるかどうかを判定します。 |
Cookie オプションメソッド
以下のメソッドは Session Cookie の各属性を取得するために使用され、オーバーライドできます。
| メソッド | 説明 |
|---|---|
| get_cookie_name(app) | Cookie 名を取得します。デフォルトでは SESSION_COOKIE_NAME 設定を読み取ります。 |
| get_cookie_domain(app) | Cookie の Domain を取得します。デフォルトでは SESSION_COOKIE_DOMAIN 設定を読み取ります。 |
| get_cookie_path(app) | Cookie の Path を取得します。デフォルトでは SESSION_COOKIE_PATH または APPLICATION_ROOT を読み取ります。 |
| get_cookie_httponly(app) | HttpOnly フラグを取得します。デフォルトでは SESSION_COOKIE_HTTPONLY を読み取ります。 |
| get_cookie_secure(app) | Secure フラグを取得します。デフォルトでは SESSION_COOKIE_SECURE を読み取ります。 |
| get_cookie_samesite(app) | SameSite 値を取得します。デフォルトでは SESSION_COOKIE_SAMESITE を読み取ります。 |
| get_cookie_partitioned(app) | Partitioned フラグを取得します。デフォルトでは SESSION_COOKIE_PARTITIONED(v3.1+)を読み取ります。 |
| get_expiration_time(app, session) | Session の有効期限を取得します。永続 Session の場合は now + lifetime を返します。 |
| should_set_cookie(app, session) | Cookie を設定する必要があるかどうかを判定します。Session が変更された場合、または永続化 + SESSION_REFRESH_EACH_REQUEST の場合に True を返します。 |
組み込み実装
| 类 | 説明 |
|---|---|
| SecureCookieSessionInterface | デフォルト実装。itsdangerous 署名 Cookie を使用して Session データを保存します。key_derivation="hmac"、digest_method=sha1 |
| SecureCookieSession | CallbackDict ベースの Session クラス。トップレベルのキー変更を検出し、自動的に modified=True を設定します。 |
| NullSession | SECRET_KEY が設定されていない場合に使用されるプレースホルダー Session。読み取りは正常ですが、変更するとエラーになります。 |
| SessionMixin | Session クラスの Mixin。permanent、new、modified、accessed 属性を提供します。 |
デフォルトのSession実装を置き換える
例
from flask import Flask
from flask.sessions import SessionInterface, SessionMixin
# カスタム Session クラス
class MySession(dict, SessionMixin):
pass
# カスタム Session インターフェース
class MySessionInterface(SessionInterface):
def open_session(self, app, request):
# リクエストから Session を読み込む
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 をレスポンスに保存する
if "user_id" in session:
response.headers["X-Session-ID"] = session["user_id"]
app = Flask(__name__)
# デフォルトの Session 実装を置き換える
app.session_interface = MySessionInterface()
from flask.sessions import SessionInterface, SessionMixin
# カスタム Session クラス
class MySession(dict, SessionMixin):
pass
# カスタム Session インターフェース
class MySessionInterface(SessionInterface):
def open_session(self, app, request):
# リクエストから Session を読み込む
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 をレスポンスに保存する
if "user_id" in session:
response.headers["X-Session-ID"] = session["user_id"]
app = Flask(__name__)
# デフォルトの Session 実装を置き換える
app.session_interface = MySessionInterface()