Flask ユーティリティ関数とクラス API

Flask は、URL の生成、リクエストの終了、レスポンスの構築などの一般的な操作に使用できる一連のグローバル関数を提供します。

すべてはfrom flask import ...インポートで


グローバルプロキシオブジェクト

オブジェクト 型 説明
current_app プロキシ → Flask 現在アクティブな Flask アプリケーションインスタンスを指します。アプリケーションコンテキストで使用できます。

URL とリダイレクト

関数 シグネチャ 説明
url_for (endpoint, *, _anchor, _method, _scheme, _external, **values) ビュー関数名に基づいて URL を生成します。_external=True で絶対 URL を生成します。
redirect (location, code=303, Response=None) リダイレクトレスポンスを作成します。code のデフォルトは 303(See Other)です。

リクエスト終了とレスポンス構築

関数 シグネチャ 説明
abort (code, *args, **kwargs) リクエストを即座に終了し、HTTP エラーを返します。code はステータスコード、description は説明です。
make_response (*args) ビューの戻り値を Response オブジェクトに変換します。複数の引数を渡すとタプルとして扱われます。
after_this_request (func) 現在のリクエストの後に一度だけ実行される関数を登録します。after_request を動的に追加するために使用します。

コンテキストチェック

関数 説明
has_request_context() 現在アクティブなリクエストコンテキストがある場合に True を返します。
has_app_context() 現在アクティブなアプリケーションコンテキストがある場合に True を返します。
copy_current_request_context(func) デコレータ。現在のリクエストコンテキストをコピーし、デコレートされた関数がコンテキスト外で実行されても request、g などにアクセスできるようにします。

ファイル送信

関数 シグネチャ 説明
send_file (path_or_file, mimetype, as_attachment, download_name, conditional, etag, last_modified, max_age) ファイルの内容を送信します。as_attachment=True でダウンロードがトリガーされます。条件付きリクエストと ETag をサポートします。
send_from_directory (directory, path, **kwargs) 指定したディレクトリから安全にファイルを送信します。safe_join を使用してパストラバーサル攻撃を防ぎます。

コード例

サンプル

from flask import (Flask, current_app, url_for, redirect,
                   abort, make_response, after_this_request,
                   has_request_context, send_file, send_from_directory)

app = Flask(__name__)

@app.route("/")
def index():
    # url_for で URL を生成
    login_url = url_for("login")
    # 絶対 URL を生成(ドメイン名を含む)
    full_url = url_for("profile", username="サンプル", _external=True)
    return f'<a href="{login_url}">Login</a>'

@app.route("/redirect-me")
def redirect_me():
    # ホームページにリダイレクト
    return redirect(url_for("index"))

@app.route("/profile/<username>")
def profile(username):
    return f"Profile: {username}"

@app.route("/admin")
def admin():
    # 未認可アクセス、403 を返す
    abort(403, description="Access denied")

@app.route("/download")
def download():
    # ファイルを送信(ブラウザのダウンロードをトリガー)
    return send_from_directory("uploads", "report.pdf",
                               as_attachment=True,
                               download_name="サンプル_report.pdf")

@app.route("/custom-response")
def custom_response():
    # レスポンスオブジェクトを手動で構築
    resp = make_response("<h1>Custom</h1>")
    resp.headers["X-Powered-By"] = "サンプル"

    @after_this_request
    def log_response(response):
        app.logger.info(f"Request to {request.path} done, status={response.status_code}")
        return response

    return resp
その他の拡張