【Python】Flaskで全てのURLを受け取る方法

投稿: 2024年09月08日

こんにちは、にわこまです！

今回はpythonのflaskというライブラリでアプリを立ち上げたとき、全てのURLを受け取る方法を紹介します。使い方としては、テスト的にflaskで簡単なアプリを立ててURLの挙動を確認したり、クエリパラメータやリクエストボディがどのように見えるかを確認することなどです。

スポンサードサーチ

結論

@app.route(“/”, defaults={“path”:””}, methods=[“GET”, “POST”, “PUT”, “DELETE”])
@app.route(“/<path:path>”, methods=[“GET”, “POST”, “PUT”, “DELETE”])

上記2行のアノテーションをメソッドに付与することで全てのURLを受け取ることができます。

1行目は、インデックスルートに全てのメソッドが通ることを設定しています。「defaults」は2行目のアノテーションの初期値を設定しています。このdefaultsを設定しないとエラーが発生します。

2行目は、インデックス以外の全てのURLに全てのメソッドが通ることを設定しています。

ソースコード

全てのURLを受け取ることができるflaskアプリのソースコードを以下に示します。

from flask import Flask, request, jsonify
import logging

app = Flask(__name__)

# ログの設定
logging.basicConfig(
    level=logging.INFO,
    format="[%(asctime)s] [%(levelname)s] %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S"
)

@app.route("/", defaults={"path":""}, methods=["GET", "POST", "PUT", "DELETE"])
@app.route("/<path:path>", methods=["GET", "POST", "PUT", "DELETE"])
def index(path):
    app.logger.info("Start.")

    # ログ出力
    headers = request.headers
    method = request.method
    url = request.url
    query_param = request.args
    data = None
    if (method in ["POST", "PUT"]):
        app.logger.info("request.is_json: {0}".format(request.is_json))
        if (request.is_json):
            data = request.get_json()
    app.logger.info("headers: " + str(headers.to_wsgi_list()))
    app.logger.info("method : {0}".format(method))
    app.logger.info("url    : {0}".format(url))
    app.logger.info("path   : {0}".format(path))
    app.logger.info("query  : " + str(query_param.to_dict()))
    app.logger.info("data   : {0}".format(data))

    app.logger.info("End.")
    return jsonify({"result": "OK"}), 200

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=5000)

コードの解説

1行目はflaskライブラリから必要なモジュールをインポートしています。

2行目はloggingライブラリをインポートしています。

4行目はflaskでアプリを立ち上げるための設定を定義しています。

7行目から11行目はログ出力用の設定を定義しています。

13行目は、インデックスルートに全てのメソッドが通ることを設定しています。「defaults」は14行目のアノテーションの初期値を設定しています。このdefaultsを設定しないとエラーが発生します。

14行目は、インデックス以外の全てのURLに全てのメソッドが通ることを設定しています。

15行目から36行目は要求を受信したときの処理を定義しています。

16行目は「Start.」という文字列をログとして出力しています。処理の開始を分かりやすくするために出力しています。

19行目はheadersにヘッダーを代入しています。

20行目はmethodにメソッドを代入しています。

21行目はurlにURLを代入しています。

22行目はquery_paramにクエリパラメータを代入しています。

23行目はdataにNoneを代入して初期化しています。

24行目から27行目はメソッドがPOSTまたはPUTである場合、リクエストボディを取得する処理を定義しています。

24行目はメソッドがPOSTまたはPUTであることを判断しています。

25行目はリクエストボディの有無をログに出力しています。

26行目はリクエストボディの有無を判断しています。

27行目はdataにリクエストボディを代入しています。

28行目はヘッダーをログに出力しています。出力する際にリストに変換しています。

29行目はメソッドをログに出力しています。

30行目はURLをログに出力しています。

31行目はパスパラメータをログに出力しています。

32行目はクエリパラメータをログに出力しています。

33行目はリクエストボディをログに出力しています。

35行目は「End.」という文字列をログとして出力しています。処理の終了を分かりやすくするために出力しています。

36行目は結果を返しています。内容は「{“result”: “OK”}」で、ステータスコードは「200」にしています。

38行目と39行目でmain.pyが実行されたときにアプリを立ち上げるように定義しています。

スポンサードサーチ