Flask Request リクエストオブジェクト API

Request クラスは、クライアントから送信された HTTP リクエストのすべての情報をカプセル化しています。

を通じてfrom flask import requestプロキシオブジェクトをインポートし、ビュー関数で直接使用します。


よく使う属性の早見表

属性 型 説明 サンプル値
method str HTTP リクエストメソッド "GET"、"POST"
path str URL パス部分(ドメイン名とクエリ文字列を含まない) "/search"
full_path str パス + クエリ文字列 "/search?q=サンプル"
url str 完全なリクエスト URL(クエリ文字列を含まない) "http://localhost:5000/search"
base_url str url と同じ、末尾のクエリ文字列を除いたもの "http://localhost:5000/search"
url_root str ドメイン名 + アプリケーションのルートパス "http://localhost:5000/"
host str Host ヘッダー(ポートを含む) "localhost:5000"
host_url str スキーム + ホスト + アプリケーションのルート "http://localhost:5000/"
scheme str プロトコル "http"、"https"
remote_addr str クライアント IP アドレス "127.0.0.1"
endpoint str マッチしたルートのエンドポイント "index"、"blog.show"
url_rule Rule マッチしたルートルールオブジェクト Werkzeug Rule インスタンス
view_args dict URL 内の動的変数 {"post_id": 42}
blueprint str 現在のブループリント名 "auth"、"blog"
blueprints list 現在マッチしているブループリントの階層リスト ["auth"]
is_json bool リクエストの Content-Type が JSON かどうか True / False

リクエストデータの取得

属性/メソッド 型 説明
args MultiDict URL クエリパラメータ。/search?q=flask にアクセス → request.args.get("q")
form MultiDict POST フォームデータ(application/x-www-form-urlencoded または multipart/form-data)
json dict / None JSON リクエストボディ(Python オブジェクトとして解析済み)。JSON リクエストでない場合は None を返します
data bytes 生のリクエストボディデータ
files FileMultiDict アップロードされたファイル。request.files["file"] は FileStorage オブジェクトを返します
cookies dict クライアントから送信された Cookie
headers Headers リクエストヘッダー。複数のアクセス方法をサポートしています
get_json(force=False, silent=False, cache=True) — JSON リクエストボディを解析します。force は非 JSON タイプを強制的に解析し、silent はエラー時に None を返します

に対してargs、formなどの MultiDict 型では、常に.get(key, default)メソッドで値を取得します。直接request.args["key"]存在しないキーにアクセスすると KeyError がスローされます(400 エラーが返ります)。


コンテンツネゴシエーション属性

属性/メソッド 説明
accept_mimetypes クライアントが受け入れる MIME タイプのリスト(MIMEAccept オブジェクト)
accept_charsets クライアントが受け入れる文字セット
accept_encodings クライアントが受け入れるエンコーディング方式
accept_languages クライアントが受け入れる言語
content_type リクエストの Content-Type
content_length リクエストボディの長さ(バイト)
content_md5 リクエストボディの MD5 チェックサム

コード例

実例

from flask import Flask, request

app = Flask(__name__)

@app.route("/demo", methods=["GET", "POST"])
def demo():
    # クエリパラメータを取得
    keyword = request.args.get("q", "")

    # フォームデータを取得
    username = request.form.get("username", "")

    # JSON データを取得
    if request.is_json:
        data = request.json
        name = data.get("name", "unknown")

    # リクエストヘッダーを取得
    user_agent = request.headers.get("User-Agent", "")
    accept_lang = request.accept_languages.best

    # URL 情報を取得
    url_info = {
        "method": request.method,       # "GET" または "POST"
        "path": request.path,           # "/demo"
        "url": request.url,             # 完全な URL
        "remote_addr": request.remote_addr,  # クライアント IP
    }
    return url_info
その他の拡張