Flask Signals シグナル API
Flask は Blinker ライブラリを使用して、重要なイベントの発生時にシグナルを送信します。これらのシグナルに接続して、追加のログ記録、監視などの操作を実行できます。
シグナルは Flask のコア機能ではありません。ほとんどのニーズはフック(before_request など)で満たせます。
コアリクエストシグナル
| シグナル | 発火タイミング | 渡されるパラメータ |
|---|---|---|
| request_started | リクエストコンテキスト確立後、前処理前 | sender=app |
| request_finished | レスポンス構築完了後、送信前 | sender=app, response |
| got_request_exception | リクエスト処理中に未処理の例外が発生したとき | sender=app, exception |
| request_tearing_down | リクエストコンテキスト破棄時(常に実行) | sender=app, exc(オプション) |
アプリケーションコンテキストシグナル
| シグナル | 発火タイミング | 渡されるパラメータ |
|---|---|---|
| appcontext_pushed | アプリケーションコンテキストがスタックにプッシュされたとき | sender=app |
| appcontext_popped | アプリケーションコンテキストがスタックからポップされたとき | sender=app |
| appcontext_tearing_down | アプリケーションコンテキスト破棄時(常に実行) | sender=app, exc(オプション) |
テンプレートとメッセージシグナル
| シグナル | 発火タイミング | 渡されるパラメータ |
|---|---|---|
| template_rendered | テンプレートのレンダリングが成功したとき | sender=app, template, context |
| before_render_template | テンプレートのレンダリング前 | sender=app, template, context |
| message_flashed | flash() が呼び出されたとき | sender=app, message, category |
シグナルの接続方法
| 方法 | 説明 |
|---|---|
| signal.connect(func, app) | シグナルを直接接続します。func は sender とキーワード引数を受け取ります |
| signal.connect_via(app)(func) | デコレータ形式。自動的に app を sender として渡します |
| with signal.connected_to(func, app): | コンテキストマネージャー。一時的にシグナルを接続します |
コード例
例
from flask import Flask, request_started, request_finished, template_rendered
app = Flask(__name__)
# 方法1:直接接続
def log_request_start(sender, **extra):
print(f"Request started on {sender.name}")
request_started.connect(log_request_start, app)
# 方法2:デコレータ接続
@request_finished.connect_via(app)
def log_request_end(sender, response, **extra):
print(f"Request finished with status {response.status_code}")
# 方法3:テンプレートレンダリングシグナル
@template_rendered.connect_via(app)
def log_template(sender, template, context, **extra):
print(f"Template rendered: {template.name}")
# 方法4:例外の捕捉
from flask import got_request_exception
def log_error(sender, exception, **extra):
sender.logger.error(f"Exception: {exception}")
got_request_exception.connect(log_error, app)
app = Flask(__name__)
# 方法1:直接接続
def log_request_start(sender, **extra):
print(f"Request started on {sender.name}")
request_started.connect(log_request_start, app)
# 方法2:デコレータ接続
@request_finished.connect_via(app)
def log_request_end(sender, response, **extra):
print(f"Request finished with status {response.status_code}")
# 方法3:テンプレートレンダリングシグナル
@template_rendered.connect_via(app)
def log_template(sender, template, context, **extra):
print(f"Template rendered: {template.name}")
# 方法4:例外の捕捉
from flask import got_request_exception
def log_error(sender, exception, **extra):
sender.logger.error(f"Exception: {exception}")
got_request_exception.connect(log_error, app)