Python: flask_marshmallowを使ってjsonを返すプログラム

Question

Python: flask_marshmallowを使ってjsonを返すプログラム

表題の通り、flask、marshmallow、sqlalchemyを使って、getアクセスに対して、データベースから値を取得し、jsonを返すプログラムを作っています。

現在、データベースに接続し、値をUserオブジェクトとして取得できている状態で、marshmallowを使ってjsonに変換するところでエラーが出ております。

発生している問題・エラーメッセージ

TypeError: 'User' object is not iterable

Userオブジェクトは反復不可能であるといった旨のメッセージのようです。

router.py

@bp.route('users/edit/<int:id>', methods=['GET'])
def edit_user(id):
    usr = users.find_user(id)
    usr_schema = users.UserSchema(many=True)
    return jsonify({"users": usr_schema.dump(usr).data})

return jsonify({"users": usr_schema.dump(usr).data})のラインでエラーが起こっております。

users.py

class User(db.Model):
    __tablename__ = 'users'

    id = db.Column(db.Integer, primary_key=True, nullable=False)
    name = db.Column(db.String(255, convert_unicode=True), nullable=False)
    pwd = db.Column(db.String(255, convert_unicode=True), nullable=False)
    mail = db.Column(db.String(255, convert_unicode=True), nullable=False)
    age = db.Column(db.Integer, nullable=False)
    created_at = db.Column(db.DateTime, nullable=False, default=datetime.now)
    updated_at = db.Column(db.DateTime, nullable=False, default=datetime.now, onupdate=datetime.now)

class UserSchema(ma.SQLAlchemyAutoSchema):
    class Meta:
        model = User

def find_user(id):
    usr = db.session.query(User).filter(User.id == id).first()
    return usr

使用ツール・フレームワーク

python 3.9
flask 1.1.2
SQLAlchemy 1.3.20
Marshmallow 3.9.1

参考リンク

https://qiita.com/voygerrr/items/4c78d156fc91111798d5

Answer 1

flask、marshmallow、sqlalchemyを使って

とありますが、sqlalchemyのmodelに「db.*」という記述があるため「Flask-SQLAlchemy」を使っていると判断しました。
(db = SQLAlchemy(app)の記述があるコードが提示されていないので推測です)
同じ理屈でmarshmallowも「flask-marshmallow」だと考えて回答します。

Flask-Marshmallowのドキュメントによると、Flask-SQLAlchemyのモデルを使うにはまず以下のインストールが必要のようです。

pip install -U flask-sqlalchemy marshmallow-sqlalchemy 

(もちろんflask-marshmallowも必要です。)

ソース上での初期化は以下の順番で行う必要があるようです。

db = SQLAlchemy(app)
ma = Marshmallow(app)

flask-marshmallowのモデルでは、ma.SQLAlchemySchemaかma.SQLAlchemyAutoSchemaを指定したモデル作成が必要のようです。

class AuthorSchema(ma.SQLAlchemySchema):

# or

class BookSchema(ma.SQLAlchemyAutoSchema):

Autoがついていない方はカラム1つ1つを定義している感じで、Autoの方はinclude_fk = Trueにすれば勝手にやってくれる感じでしょうか？

Marshmallowは使ったことがないので、適当なテーブルを作成して動かしてみました。
質問文にあるモデルだとカラムが多くて面倒だったので、適当なモデルを作っています。

以下が動かしてみたソースです。
tableはdb.create_all()で先に作成しました。
実行方法は以下です。[2]を実行すると、all()で取得した結果が表示されます。

1. ブラウザでlocalhost:5000/add_dataにアクセス。
2. ブラウザでlocalhost:5000/show_dataにアクセス。

# app.py
from flask import Flask, jsonify
from flask_sqlalchemy import SQLAlchemy
from flask_marshmallow import Marshmallow


from uuid import uuid4

app = Flask(__name__)

db = SQLAlchemy(app)
ma = Marshmallow(app)

app.config[
    'SQLALCHEMY_DATABASE_URI'] = \
    'mysql+mysqlconnector://{user}:{password}@{host}:{portnumber}/{database}?charset=utf8&' \
    'auth_plugin=mysql_native_password'.format(
        user='user',
        password='password',
        host='localhost',
        portnumber=3306,
        database='test_db'
    )


class User(db.Model):
    __tablename__ = 'user'
    id = db.Column('id', db.String(36), nullable=False, primary_key=True)
    name = db.Column('name', db.String(10), nullable=False)
    password = db.Column('password', db.String(24), nullable=False)


class UserSchema(ma.SQLAlchemySchema):
    class Meta:
        model = User
    id = ma.auto_field()
    name = ma.auto_field()
    password = ma.auto_field()


@app.route('/add_data')
def add_data():
    user = User(id=str(uuid4()), name='test name', password='Test_password123!#%')
    db.session.add(user)
    db.session.commit()
    return 'added'


@app.route('/show_data')
def show_data():
    user = db.session.query(User).filter().all()
    user_schema = UserSchema(many=True)
    return jsonify(user_schema.dump(user))


if __name__ == '__main__':
    app.run()

pip freezeの結果を以下に記載します。

# pip freeze
click==7.1.2
Flask==1.1.2
flask-marshmallow==0.14.0
Flask-SQLAlchemy==2.4.4
itsdangerous==1.1.0
Jinja2==2.11.2
MarkupSafe==1.1.1
marshmallow==3.9.1
marshmallow-sqlalchemy==0.24.1
mysql-connector==2.2.9
six==1.15.0
SQLAlchemy==1.3.20
Werkzeug==1.0.1

Comments

[kei11]

ご回答ありがとうございます。

推測されたパッケージを使用しており、環境はほぼ同じかと思います。
記述不足で申し訳ありません。

回答を参考にさせていただいたところ、原因は、db~.first()で取得した1件のデータに対し複数件を処理するコードを記述していたことにありました。

具体的には、UserSchema(many=True)のmany=Trueをなくすことで解決をする事ができました。

詳細なご回答ありがとうございました。