assert行の入ったコードをAPI化する際、assertionエラー内容をAPIからも返せるようにしたい

Question

前提

• Python+FlaskでWebアプリケーションを作成している
• このWebアプリケーションは同じくPython+Flaskで作成したAPIにREST API接続で値を送る
• APIには計算ロジックをもっており、Webアプリケーションから受け取った値を用いて計算して、値を返す
• 計算ロジック中に異常値が発生しないよう、現在はassertでガードしている

課題

APIに仕上げるときに、assertでエラーとさせず、JSONでエラー内容をWebアプリケーションを返したいのですが、こういう場合、assertをどのように変えたるのがいいでしょうか？また、assertは複数あるので、returnを多用したくないと思っています。

コード例

# API側のロジック（実際は別ライブラリ内で実装）
class MyData:
    def __init__(self, value):
        self.value = value
    
    def calculate(self):
        result = self.value*2
        # 以下のassertで引っかかる場合、エラー内容をapiからreturnできるようにしたい
        assert result < 100
        return self.value * 2

# Webアプリケーションとのやりとり部分
def api():
    value = request.form['value']
    mydata = MyData(value)
    result = mydata.calculate()
    return jsonify({'result': result})

Answer 1

assertでエラーとさせず、JSONでエラー内容をWebアプリケーションを返したい

そもそもなのですがassertionはデータなどの例外ケースをチェックするものではなく、コードの正しさをチェックするためのものです。
つまりassertionにひっかかった場合は、そのコードの実行を止めてコードを修正しなければいけません。

よってこの場合はreturnでエラー内容を返すか例外を投げるべきです。

詳細はPythonで本当に役立つ機能「アサーション」の使い方を解説！『Pythonトリック』からを参照ください。

Comments

[MagMag]

ありがとうございます。なるほど、assertではだめですね。では、データを確認したい部分をtry, exceptにして、except時に例外を投げて、Flaskの機能で例外を補足することで目的は達成できますでしょうか？

[can110]

コード詳細わかりませんがcalculate関数など各処理内でraiseしてapi関数内のtry/exceptでキャッチしてはどうでしょうか。

[MagMag]

できました。ありがとうございます！

[MagMag]

AssertionErrorではNGかと思いますが、今後見る人の記録のため、記載しておきます。

@api.errorhandler(AssertionError)
def exception_handler(e):
return jsonify({'result': 'error'})

Answer 2

assertを使わなくてもいいのでは？

        if result < 100:
            cause = 'Value Error'
        else:
            cause = "OK"
        return cause, self.value * 2

assertは処理の異常を検知してプログラムを止めるために使うものなので、想定範囲内のチェックなら、ifや try-except などで処理するのが適切だと思います。

Comments

[MagMag]

ありがとうございます。ただ、assertは複数あるので、いちいちreturnしたくないです（assertを含んでいないメソッドにもcauseを返さないといけない）。

[TakaiY]

それは残念です。

参考までにお聞きしたいのですが、couseを返さないとした場合、処理が異常終了したことをどのように対向に伝えるのですか？

[MagMag]

can110さんのアドバイスを踏まえ、Errorをraiseさせて（もしくはabortを発生させ）、api側でerrorhandlerでデコレートし、デコレート側で独自のJSONを返そうと思います。