Flask Session API
Session は、同じユーザーの異なるリクエスト間でデータを保存するために使用されます。Flask はデフォルトで署名付き Cookie を使用して実装されており、データはクライアント側に保存されますが、改ざんすることはできません。
を使ってfrom flask import sessionインポートし、辞書のように使用します。
session プロキシオブジェクト
session現在のリクエストの SessionMixin インスタンスを指すプロキシです。リクエストコンテキスト内でのみ使用できます。
| 属性/メソッド | 説明 |
|---|---|
| session[key] = value | session の値を設定する |
| session.get(key, default) | session の値を安全に取得し、キーが存在しない場合は default を返す |
| session.pop(key, default) | 指定したキーの値を削除して返す |
| session.clear() | すべての session データをクリアする |
| "key" in session | キーが存在するかどうかを確認する |
| session.permanent | True に設定すると、ブラウザを閉じた後も Session が保持されます(PERMANENT_SESSION_LIFETIME を使用) |
| session.modified | session 内の可変な値を変更する場合(例:リストの append)、手動で True に設定する必要があります。 |
| session.accessed | session がアクセスされると True になり、Flask は自動的に Vary: Cookie ヘッダーを追加します。 |
| session.new | session が新しく作成されたかどうか(一部の実装では正確な判断をサポートしていません) |
session 内のネストされた可変オブジェクト(リスト、辞書など)を変更する場合、Flask は変更を自動的に検出できません。
手動で設定する必要がありますsession.modified = Trueそうしないと、変更は Cookie に保存されません。
設定項目
| 設定キー | デフォルト値 | 説明 |
|---|---|---|
| SECRET_KEY | None | 署名付き Session の秘密鍵。Session を使用するには設定が必須です。 |
| SESSION_COOKIE_NAME | "session" | Session Cookie の名前 |
| SESSION_COOKIE_DOMAIN | None | Cookie の Domain 属性 |
| SESSION_COOKIE_PATH | None | Cookie の Path 属性 |
| SESSION_COOKIE_HTTPONLY | True | JavaScript による Session Cookie へのアクセスを禁止する |
| SESSION_COOKIE_SECURE | False | True の場合、HTTPS 経由でのみ Cookie を送信する |
| SESSION_COOKIE_SAMESITE | None | "Strict"、"Lax" または None |
| PERMANENT_SESSION_LIFETIME | timedelta(days=31) | 永続 Session の有効期限 |
| SESSION_REFRESH_EACH_REQUEST | True | リクエストごとに Session Cookie の有効期限を更新する |
コード例
サンプル
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'Logged in as {session["username"]}'
return 'You are not logged in'
@app.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
session["username"] = request.form["username"]
# 永続 session を設定(ブラウザを閉じた後も31日間保持)
session.permanent = True
return redirect(url_for("index"))
return '<form method="post"><input name="username"></form>'
@app.route("/appends")
def append_to_list():
# 注意:ネストされたリストを変更するには、modified を手動でマークする必要があります
if "items" not in session:
session["items"] = []
session["items"].append("new_item")
session.modified = True # 手動でのマークが必須です!
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'Logged in as {session["username"]}'
return 'You are not logged in'
@app.route("/login", methods=["GET", "POST"])
def login():
if request.method == "POST":
session["username"] = request.form["username"]
# 永続 session を設定(ブラウザを閉じた後も31日間保持)
session.permanent = True
return redirect(url_for("index"))
return '<form method="post"><input name="username"></form>'
@app.route("/appends")
def append_to_list():
# 注意:ネストされたリストを変更するには、modified を手動でマークする必要があります
if "items" not in session:
session["items"] = []
session["items"].append("new_item")
session.modified = True # 手動でのマークが必須です!
return f'Items: {session["items"]}'
@app.route("/logout")
def logout():
session.clear()
return redirect(url_for("index"))