PythonのFlaskでのユーザー定義関数呼び出し

Question

遭遇しているトラブルの概要

初めてFlaskを使用してREST APIの学習用のコードを書いて試しています。
以下コード（抜粋）において、get_item() 関数内で find_item_by() 関数を呼び出しているコードを書いているのですが、なぜか find_item_by() 関数が呼び出されず困っています。

該当のソースコード

def find_item_by(id):
    return list(filter(lambda item: item["id"] == id, items))

@app.route('/items/', methods=['GET'])
def get_items():
    return jsonify(items), 200

@app.route('/items/<string:id>', methods=['GET'])
def get_item(id):

    item = find_item_by(request.form["id"])

    if not item:
        abort(404)
    
    return jsonify(item)

試したこと

• get_items() はきちんと動作しており、クライアントのWebブラウザに Items の内容がきちんと表示されます。
• クライアントからのリクエストに対する get_item() の呼び出しは成功しており、find_item_by() の呼び出しの直前に print('OK') を記述すると、コンソールに「OK」が表示されます。
• find_item_by() 関数内の先頭に print('OK') を記述したのですが、コンソールに「OK」が表示されないため関数が呼び出されていないようです。
• find_item_by() 関数呼び出しの部分を削除して、処理をインラインで記述すれば、問題なくクライアントに正しい Item の内容が表示されます。
• サーバー側ではエラー･メッセージは表示されていませんが、クライアント側は400の「Bad request」が表示されます。
• 該当のコード部分をFlaskではなく main() 関数を書いた通常のスクリプトとしてファイルで実行すると、問題なく動作します。

当方PythonもFlaskも最近学習しだしたばかりで、わかっていないことがあるのかもしれませんが、ユーザー定義の関数が通常のファイルだと呼び出せて、Flask上だと呼び出せない理由が調べてもわかりませんでした。

どなたか何かわかりましたらアドバイスを頂けると幸いです。

補足情報（FW/ツールのバージョンなど）

Python 3.7.3
Flask 1.0.3

Answer 1

◯ 改善策

対話モード >>> にコピペで実行できます。

from flask import Flask, jsonify, abort, request

app = Flask('__main__')
items = [
    {'id': 0, 'name': 'hello'},
    {'id': 1, 'name': 'nihao'},
    {'id': 2, 'name': 'konnichiwa'}
]


def find_item_by(id):
    return list(filter(lambda item: item['id'] == id, items))


@app.route('/items/', methods=['GET'])
def get_items():
    return jsonify(items), 200


@app.route('/items/<string:id>', methods=['GET'])
def get_item(id):
    # 原因
    # find_item_by(request.form["id"])
    # 改善策 1
    item = find_item_by(int(id))
    # 改善策 2
    # item = find_item_by(int(request.view_args['id']))
    if not item:
        abort(404)
    return jsonify(item)


app.run()

引数からそのまま取ってこれるので、あとは str から int にキャストすれば OK です。

◯ デバッグで気づけなかった原因

そして頑張ってデバッグ時で気づけなかったのは request.form に間違ったキーを入れても None を返して来るからです。間違った箇所を静かに通り過ぎていきます。本来は、例外を投げ返してほしいです。ちょうど今日自分もハマってました笑

• None ってなに？

◯ ちなみに...

request.form は POST メソッドから値を取り出すときに使います。

Comments

[nagomisan]

早速の回答ありがとうございました。PythonもFlaskも学習し始めたばかりで、勝手な思い込みからPythonの言語仕様やFlaskの仕様ばかりに目が行き、request.formはPOSTメソッドから値を取り出すという基本的な部分が盲点となっていました。request.form["id"]の値をきちんと確かめていたら気付けていたかもしれませんね。やはりデバッグは先入観を捨てて客観的に診ていくことが大切だと改めて勉強になりました。
そうですね、当方もJavaやC#といった静的型付け言語中心にやってきたので例外を投げてほしいところです。動的型付け言語の嵌りポイントにまだまだ慣れていませんが、学習を進めて対応できるようにしていきます。ありがとうございました。

[nagomisan]

【追伸】
リンクのページのNoneに関する説明、非常にわかりやすくためになる内容ですね。改めてお礼申し上げます。

[nico25]

そう言っていただけると嬉しいです。
ありがとうございます！