Flask 内部オブジェクト API

Flask は、アクティブなアプリケーションコンテキストとブループリントの登録状態にアクセスするための、いくつかの低レベル内部オブジェクトを提供します。ほとんどのアプリケーションはこれらを直接使用する必要はありません。


AppContext アプリケーションコンテキスト

メソッド/属性 説明
AppContext(app) アプリケーションコンテキストのインスタンスを作成します。通常は手動で作成せず、app.app_context() を使用します。
push() コンテキストスタックにプッシュします。current_app、g などのプロキシがこのコンテキストを指すようにします。
pop(error=None) コンテキストスタックからポップします。teardown コールバックを実行します。error は未処理の例外オブジェクトです。
app このコンテキストに関連付けられた Flask アプリケーション
g このコンテキストの g オブジェクト(_AppCtxGlobals インスタンス)
url_adapter URL アダプター(MapAdapter)。URL 構築に使用します。
request 現在のリクエストオブジェクト(Request)。リクエストコンテキスト内でのみ使用可能です。
session 現在の Session オブジェクト。リクエストコンテキスト内でのみ使用可能です。

app_ctx プロキシ

属性 説明
flask.globals.app_ctx 現在アクティブな AppContext を指すプロキシです。内部使用向けで、ほとんどの場合は current_app と g で十分です。

BlueprintSetupState

ブループリント登録時の状態オブジェクトです。record コールバック内で使用できます。

属性 説明
app ブループリントが登録された Flask アプリケーション
blueprint 登録された Blueprint インスタンス
url_prefix ブループリントの URL プレフィックス
subdomain ブループリントのサブドメイン
url_defaults ブループリントの URL デフォルト値
options ブループリント登録時に渡された追加オプション

非推奨の RequestContext

Flask 3.2 以降、RequestContextに統合されました。AppContext。関連するrequest_ctxプロキシも統合されました。app_ctx。旧名称は Flask 4.0 で削除される予定です。


コード例

例

from flask import Flask
from flask.ctx import AppContext

app = Flask(__name__)

# アプリケーションコンテキストを手動で管理
ctx = app.app_context()
ctx.push()
# current_app と g が利用可能になる
from flask import current_app, g
g.user = "サンプル"
# 操作を実行...
ctx.pop()  # teardown コールバックが実行され、g がクリーンアップされる

# with ステートメント方式(推奨)
with app.app_context():
    g.temp_data = 42
# with を抜けると自動的に pop される
その他の拡張