Flask Application Globals - g オブジェクト API
gリクエストレベルのグローバル名前空間であり、同じリクエスト内の複数の関数間でデータを共有するために使われます。
を通じてfrom flask import gインポートされ、アプリケーションコンテキストがアクティブな場合にのみ使用できます。
g オブジェクトの説明
| 特徴 | 説明 |
|---|---|
| 型 | flask.ctx._AppCtxGlobals インスタンス |
| ライフサイクル | アプリケーションコンテキストとともに作成され、アプリケーションコンテキストとともに破棄される |
| スレッドセーフ | 各リクエスト/コンテキストが独立した g オブジェクトを持つ |
| 使い方 | 普通のオブジェクトのように属性を読み書きできます:g.user = ...、g.db = ... |
_AppCtxGlobals のメソッド
| メソッド | 説明 |
|---|---|
| get(name, default=None) | 属性の値を取得し、属性が存在しない場合はデフォルト値を返します。 |
| pop(name, default=None) | 属性値を削除して返します。 |
| setdefault(name, default=None) | 属性が存在しない場合はデフォルト値を設定して返します。 |
| __contains__(name) | hasattr(g, "name") または "name" in g をサポートします。 |
典型的な使用パターン
実例
from flask import Flask, g
app = Flask(__name__)
def get_db():
"""データベース接続は一度だけ作成され、g に格納して再利用する"""
if "db" not in g:
g.db = connect_to_database()
return g.db
@app.before_request
def load_user():
"""リクエスト開始前にユーザー情報を g に読み込む"""
user_id = session.get("user_id")
if user_id:
g.user = query_user(user_id) # ビュー関数内で g.user を直接使用できる
else:
g.user = None
@app.route("/profile")
def profile():
if g.user is None:
return "Not logged in"
return f"Hello, {g.user.name}"
@app.teardown_appcontext
def close_db(error):
"""リクエスト終了時にリソースをクリーンアップする"""
db = g.pop("db", None)
if db is not None:
db.close()
app = Flask(__name__)
def get_db():
"""データベース接続は一度だけ作成され、g に格納して再利用する"""
if "db" not in g:
g.db = connect_to_database()
return g.db
@app.before_request
def load_user():
"""リクエスト開始前にユーザー情報を g に読み込む"""
user_id = session.get("user_id")
if user_id:
g.user = query_user(user_id) # ビュー関数内で g.user を直接使用できる
else:
g.user = None
@app.route("/profile")
def profile():
if g.user is None:
return "Not logged in"
return f"Hello, {g.user.name}"
@app.teardown_appcontext
def close_db(error):
"""リクエスト終了時にリソースをクリーンアップする"""
db = g.pop("db", None)
if db is not None:
db.close()
他の拡張核心原則:g オブジェクトは同じリクエスト内のデータ共有にのみ使用します。リクエストをまたぐデータや、永続化が必要な情報を g に保存しないでください。