Flask Response レスポンスオブジェクト API
Response クラスは、Flask ビュー関数が返す HTTP レスポンスを表します。ほとんどの場合、それを直接作成する必要はありません。Flask はビュー関数の戻り値を自動的に Response に変換します。
手動で制御する必要がある場合は、make_response()関数を使用します。
コンストラクタ
| 引数 | 型 | デフォルト値 | 説明 |
|---|---|---|---|
| response | str / bytes / iterator | 必須 | レスポンスボディの内容 |
| status | int / str | 200 | HTTP ステータスコードまたはステータステキスト (例: 404 または "404 Not Found") |
| headers | dict / list | None | レスポンスヘッダー。dict または (key, value) タプルのリスト |
| mimetype | str | None | MIME タイプ (例: "application/json") |
| content_type | str | None | Content-Type ヘッダー。エンコーディングを含む (例: "text/html; charset=utf-8") |
| direct_passthrough | bool | False | True の場合、レスポンスボディを直接渡し、何も処理しません |
コア属性
| 属性 | 型 | 説明 |
|---|---|---|
| status | str | レスポンスステータス (テキスト形式)。例: "200 OK"、"404 Not Found" |
| status_code | int | HTTP ステータスコード。例: 200、404 |
| headers | Headers | レスポンスヘッダーオブジェクト。辞書形式の操作をサポート |
| data | bytes | レスポンスボディのバイト表現 |
| mimetype | str | MIME タイプ (エンコーディングなし)。例: "text/html" |
| content_type | str | Content-Type (エンコーディングを含む)。例: "text/html; charset=utf-8" |
| content_length | int | レスポンスボディのバイト長 |
レスポンスヘッダー操作
| メソッド | 説明 |
|---|---|
| headers.get(key) | 指定したレスポンスヘッダーの値を取得 |
| headers[key] = value | レスポンスヘッダーを設定 |
| headers.update(dict) | レスポンスヘッダーを一括更新 |
Cookie 操作
| メソッド | 説明 |
|---|---|
| set_cookie(key, value, max_age, expires, path, domain, secure, httponly, samesite) | Cookie を設定します。max_age は秒数、expires は datetime、secure は HTTPS のみ |
| delete_cookie(key, path, domain) | 指定した Cookie を削除 |
| set_cookie 引数: max_age | Cookie の有効秒数。例: max_age=3600 は 1 時間を意味します |
| set_cookie 引数: secure | デフォルトは SESSION_COOKIE_SECURE 設定値。True の場合、HTTPS でのみ送信 |
| set_cookie 引数: httponly | デフォルトは True。JavaScript からこの Cookie へのアクセスを禁止 |
| set_cookie 引数: samesite | "Strict"、"Lax" または None。クロスサイト Cookie 送信動作を制御 |
その他のメソッド
| メソッド | 説明 |
|---|---|
| get_json(force=False, silent=False) | レスポンスボディを JSON として解析 (主にテスト用) |
| freeze() | レスポンスを不変状態にフリーズ |
| force_type(response, environ) | クラスメソッド。他のタイプのレスポンスを Response タイプに強制変換 |
コード例
例
from flask import Flask, make_response
app = Flask(__name__)
@app.route("/custom")
def custom_response():
# make_response を使用してレスポンスを手動で構築
resp = make_response("<h1>Hello, サンプル!</h1>")
# ステータスコードを設定
resp.status_code = 201
# カスタムレスポンスヘッダーを設定
resp.headers["X-Custom-Header"] = "my-value"
# Cookie を設定
resp.set_cookie("theme", "dark", max_age=86400) # 24 時間有効
resp.set_cookie("lang", "zh-CN", samesite="Lax") # SameSite 制限
return resp
@app.route("/delete-cookie")
def delete_cookie():
resp = make_response("Cookie は削除されました")
resp.delete_cookie("theme")
return resp
@app.route("/api/data")
def api_data():
# dict を直接返すと、Flask が自動的に JSON Response にシリアライズ
return {"status": "ok", "data": [1, 2, 3]}
app = Flask(__name__)
@app.route("/custom")
def custom_response():
# make_response を使用してレスポンスを手動で構築
resp = make_response("<h1>Hello, サンプル!</h1>")
# ステータスコードを設定
resp.status_code = 201
# カスタムレスポンスヘッダーを設定
resp.headers["X-Custom-Header"] = "my-value"
# Cookie を設定
resp.set_cookie("theme", "dark", max_age=86400) # 24 時間有効
resp.set_cookie("lang", "zh-CN", samesite="Lax") # SameSite 制限
return resp
@app.route("/delete-cookie")
def delete_cookie():
resp = make_response("Cookie は削除されました")
resp.delete_cookie("theme")
return resp
@app.route("/api/data")
def api_data():
# dict を直接返すと、Flask が自動的に JSON Response にシリアライズ
return {"status": "ok", "data": [1, 2, 3]}