Flask ビュー関数 API
ビュー関数には、ルーティング動作を制御する特別な属性を付与できます。これらの属性は通常、手動で設定する必要はありませんが、一部の高度なシナリオでは非常に役立ちます。
ビュー関数属性
| 属性 | 型 | デフォルト値 | 説明 |
|---|---|---|---|
| __name__ | str | 関数名 | endpoint 名として使用されます。ブループリント内では自動的にブループリント名のプレフィックスが付加されます。 |
| methods | list | None | ビュー関数が受け付ける HTTP メソッド。add_url_rule で指定されていない場合は、この値が使用されます。 |
| required_methods | set | None | 必ず追加される HTTP メソッド。add_url_rule で methods が明示的に指定されていても、これらのメソッドは強制的に追加されます。 |
| provide_automatic_options | bool | None | OPTIONS リクエストを自動処理するかどうか。False に設定すると、OPTIONS 応答をカスタマイズできます。 |
使用シーン
| シーン | 使用する属性 | 説明 |
|---|---|---|
| OPTIONS 応答のカスタマイズ | provide_automatic_options=False | Flask が自動的に OPTIONS を生成するのを防ぎ、ビュー関数自体で処理します。 |
| デコレータでメソッドを設定する | methods | デコレータでビュー関数のメソッドリストを事前に設定できます。 |
| メソッドの強制追加 | required_methods | 特定のメソッドが常に登録されるようにします。 |
コード例
例
from flask import Flask, request
app = Flask(__name__)
# 例1: OPTIONS 応答のカスタマイズ
def custom_endpoint():
if request.method == "OPTIONS":
# カスタムの OPTIONS 応答を返す
return "", 200, {"Allow": "GET, POST"}
return "Hello, サンプル!"
# 自動 OPTIONS を無効にする
custom_endpoint.provide_automatic_options = False
custom_endpoint.methods = ["GET", "POST", "OPTIONS"]
app.add_url_rule("/custom", view_func=custom_endpoint)
# 例2: デコレータを定義してメソッドを自動設定する
def api_view(func):
"""カスタムデコレータ: ビュー関数にメソッドを自動設定する"""
func.methods = ["GET", "POST"]
return func
@api_view
def api_handler():
return {"status": "ok"}
app.add_url_rule("/api", view_func=api_handler)
# このとき、methods は関数属性から自動的に読み取られます。
app = Flask(__name__)
# 例1: OPTIONS 応答のカスタマイズ
def custom_endpoint():
if request.method == "OPTIONS":
# カスタムの OPTIONS 応答を返す
return "", 200, {"Allow": "GET, POST"}
return "Hello, サンプル!"
# 自動 OPTIONS を無効にする
custom_endpoint.provide_automatic_options = False
custom_endpoint.methods = ["GET", "POST", "OPTIONS"]
app.add_url_rule("/custom", view_func=custom_endpoint)
# 例2: デコレータを定義してメソッドを自動設定する
def api_view(func):
"""カスタムデコレータ: ビュー関数にメソッドを自動設定する"""
func.methods = ["GET", "POST"]
return func
@api_view
def api_handler():
return {"status": "ok"}
app.add_url_rule("/api", view_func=api_handler)
# このとき、methods は関数属性から自動的に読み取られます。