Flask内関数をインタープリタで確認しながらスクリプティング/デバッグを行いたい

Question

前提・実現したいこと

Flaskを使って、機械学習による推論結果を返すWebアプリを作りたいと思っています（機械学習モデルは別スクリプトで作成済）

この時、Flaskの各関数内の処理を、インタプリタで実行結果を確認しながらスクリプトを書いたり、デバッグをしたいのですが、どのように実施したらいいでしょうか？IDEはPyCharmを利用していますが、IDE非依存の方法でも助かります。よろしくお願いいたします。

検証したこと

【Python】Flask + PyCharm でいい感じにデバッグする方法を参考に、app.runを実行するファイルに対して、

application.run(passthrough_errors=True, use_reloader=True)

とすることで、PyCharmのデバッガでブレイクポイントを設定すると、その後インタプリタで操作できるのですが、当該処理に行くまでWebページを操作する必要があったり、定期的に変数がリセットされたり（おそらく、変更を検知してreloadするため）、処理途中で動かなくなることも多々あり、もっと簡便な方法でプログラムを修正できるようにしたいと思っています。

サンプルスクリプト

以下のスクリプトを引用させていただいております。例えば、predict関数内のy_pred内の平均値を計算したい場合、計算結果を見ながら(異常値やnanが発生していないかなど)、スクリプトを書いていきたいと思っています。

スクリプトの引用元のGithub

from flask import Flask, request, jsonify, abort
import pandas as pd
import pickle
from datetime import datetime
import sys
sys.path.append("./model")  # 前処理で使った自作モジュール「pipeline」を読み込むためPYTHONPATHに追加
app = Flask(__name__)

# アプリ起動時に前処理パイプラインと予測モデルを読み込んでおく
preprocess = pickle.load(open("model/preprocess.pkl", "rb"))
model = pickle.load(open("model/model.pkl", "rb"))


@app.route('/api/predict', methods=["POST"])
def predict():
    """/api/predict にPOSTリクエストされたら予測値を返す関数"""
    try:
        # APIにJSON形式で送信された特徴量
        X = pd.DataFrame(request.json, index=[0])
        # 特徴量を追加
        X["trade_date"] = datetime.now()
        # 前処理
        X = preprocess.transform(X)
        # 予測
        y_pred = model.predict(X, num_iteration=model.best_iteration_)
        response = {"status": "OK", "predicted": y_pred[0]}
        return jsonify(response), 200
    except Exception as e:
        print(e)  # デバッグ用
        abort(400)


@app.errorhandler(400)
def error_handler(error):
    """abort(400) した時のレスポンス"""
    response = {"status": "Error", "message": "Invalid Parameters"}
    return jsonify(response), error.code


if __name__ == "__main__":
    app.run(debug=True)  # 開発用サーバーの起動

Answer 1

pytestでテストコードを記載し、そこからデバッガで読み込むことで対応できました。

Answer 2

そちらのURLは、エラーの際に止まってくれるという説明が書かれてますが、やりたいケースはエラーじゃない通常挙動のデバッグですかね？

https://pleiades.io/help/pycharm/run-debug-configuration-flask-server.html
そちらより新しいこちらの記事もありますが、Professional専用の機能との事なので、そもそものPycharmの無料版だと限界があるかもですね。。

Comments

[MagMag]

デバッガを使えればブレークポイントを設定できるので、その場でインタープリターで操作すれば、通常のデバッグとしても活用できるという意図です。ただ、それが使いにくいのでこのような質問をしました。有料版に頼らない場合、どういった対応をするのでしょうか？

[riyo]

基本的に、有料版というものは便利になるために存在するのであって、それと同等の事をしようとすると、既存のツールで何か良いものを探してくるかになると思います。見つからないならば、そう言ったツールはないのかもしれません。
私は普段print+exitを同時に行う関数を作ったりして対処してますが、Xcodeなどみたいに、PycharmでFlaskのブラウザからの動かした挙動をブレークポイントで追う事は難しかった記憶があります。