Flaskのデータベースのテーブルを自由自在に操作したいが、出来ずに困っている。

Question

実現したいこと

初めて３か月程度の学習中の者です。
flaskによってサイトを作成するためにデータベースを整理しています。
多くのサイトで見るように、テーブルをmodelというディレクトリの配下でmodel.pyとして定義したいですが、現状のコードではうまくいきません。よって実現したいことは、

・model.pyに正しくデータベースを定義したい。
・そのmodel.pyをapp.pyにインポートしたい。
・方法はいろいろあると思いますが、テーブルの操作を自由自在に行う方法を知りたい。

前提

質問したい内容は、上記の３つを達成しようとした際に生じた問題の解決策を質問したいです。
具体的な問題として、以下の二つがあります。

・テーブル変更を行いマイグレーションを実行しても、データベース内のテーブルは変化していない。
具体的には

backend/app.py

の階層で

python
>>>import app from app,db
>>>with app.app_context():
>>>    db.create_all()

・テーブルに対してＣＲＵＤ操作を行いたいが、現状はコマンドからReadしかできない。
具体的には、

backend/instance/admin.db

の階層でターミナルから

sqlite3 admin.db
(sqlite3).table
(sqlite3).schema

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

先ほどの２つのコードに対してエラーは出ていません。

試したこと

・app.pyにmodel.pyのテーブルを全て書いてマイグレーションしたがやはり変更されなかった。
・backend/instanceからadmin.dbに対してSQLコマンドでCRUD操作を行うことは出来た。
http://blog.e-riverstyle.com/2010/05/sqlite.html参考に

だが、基本的にはCRUD操作をコマンドではなくpyhtonコードで行いたいので、やはり問題は解決していない。

・phpmyadminにadmin.dbをインポートしてCRUD操作は成功した。

だが、中心的に操作したいのはflaskのmodel.pyの部分なので、データベースの管理ツールやコマンドベースのデータベース操作の成功では、今後のデータベース操作で苦労しそう。

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

githubに全体のソースコードを公開しているので、そのURLを載せます。
https://github.com/zero-penguin/original_site

関連のバージョン
python 3.11.3
Flask 2.2.3

Comments

[退会済みユーザー]

「具体的には～」以降に書いてあることを"実際に"試した結果、エラーは何も出ていないのですか？
もしエラーが出ているならばその内容を書いてください。

Answer 1

☆Usersテーブルを操作するコードの例を示します。
（frontendと組み合わせることを想定して、JSONでやり取りする形）
下記は、
・http://localhost:8000/users でユーザー情報一覧をJSONで返す
・http://localhost:8000/users に対して ペイロードをjsonにしてPOSTすると、ユーザーを追加。
・http://localhost:8000/users/<id番号> で該当するidのユーザー情報をJSONで返す
・http://localhost:8000/admin で、管理画面に入る
というコードになります。

POSTでデータ追記するのが面倒なら、サンプルデータは、http://localhost:8000/admin で、管理画面に入って、「Create」タブを開けば、手動で追加できます。

追加したあと、
http://localhost:8000/users/1
にアクセスすると、ユーザーの情報がJSON形式で表示されます。

---

　
admin画面を連携するにはAdmin()ではだめで、Admin(app)とする必要があります。

model.py は app.py ではなく、main.py でインポートしており、ルーティングも main.py で行っています。
したがって、起動するときは

python main.py

とする必要があります。

※「passward」 の正しい綴りは「password」ですが、下記は元のコードを尊重してそのままにしています。

---

コード

app.py

from flask import Flask

app = Flask(__name__,
            static_folder="../frontend/dist/static",
            template_folder="../frontend/dist"
            )

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///admin.db'
app.config['SECRET_KEY'] = 'secret_key'

main.py

# -*- coding: utf-8 -*-
import os
from app import app
from model.model import db
from model.model import Users
from flask import request


@app.route('/',defaults={'path':''})
def index(path):
    db.create_all()
    return 'ようこそ'


@app.route('/users', methods=['POST'])
def create_user():
    data = request.get_json()  # POSTされたJSONデータを取得します
    name = data.get('name')
    passward = data.get('passward')
    status = data.get('status')

    if name is None or status is None:
        return '受け取ったデータが不正です。', 400

    user = Users(name=name, passward=passward, status=status)
    db.session.add(user)
    db.session.commit()
    return 'ユーザーの追加に成功しました。', 200


@app.route('/users/<userid>', methods=['GET'])
def get_user(userid):
    user = Users.query.filter_by(id=userid).first()

    if user is None:
        return 'ユーザーが見つかりませんでした。', 404

    data = {
        'name': user.name,
        'passward': user.passward,
        'status': user.status
    }
    return data, 200


@app.route('/users', methods=['GET'])
def get_all_users():
    users = Users.query.all()

    data = []
    for user in users:
        user_data = {
            'id': user.id,
            'name': user.name,
            'passward': user.passward,
            'status': user.status
        }
        data.append(user_data)

    return {'users': data}, 200


if __name__ == '__main__':
    app.run(host=os.getenv('APP_ADDRESS', 'localhost'), port=8000)

model.py

from datetime import datetime
import pytz
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView
from flask_sqlalchemy import SQLAlchemy
from app import app

db = SQLAlchemy(app)


class Users(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(15), nullable=False)
    passward = db.Column(db.String(10), nullable=False)
    status = db.Column(db.String(50), nullable=False)
    created_data = db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Users_names(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(15), nullable=False)
    created_data = db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Users_password(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(15), nullable=False)
    passward = db.Column(db.String(15), nullable=False)
    created_data = db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Users_status(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(10), nullable=False)
    gender = db.Column(db.String(10), nullable=False)
    old = db.Column(db.Integer, nullable=False)
    created_data= db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Creates(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(10), nullable=False)
    img = db.Column(db.String(10), nullable=False)
    comment = db.Column(db.String(20), nullable=False)
    goodcount = db.Column(db.String(50), nullable=False)
    created_data= db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Creates_title(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(10), nullable=False)
    content = db.Column(db.String(300), nullable=False)
    created_date = db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Creates_img(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    imgpath = db.VARCHAR(db.String(100))
    created_data= db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Creates_goodcount(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    supporter_id = db.Column(db.Integer, primary_key=True)
    count = db.Column(db.Integer, primary_key=True)
    created_data= db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

class Creates_comment(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    supporter_id = db.Column(db.Integer, primary_key=True)
    supporter_name = db.Column(db.String(10), nullable=False)
    supporter_content = db.Column(db.String(100), nullable=False)
    created_data= db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

admin = Admin(app)
admin.add_view(ModelView(Users,db.session))
admin.add_view(ModelView(Users_names,db.session))
admin.add_view(ModelView(Users_password,db.session))
admin.add_view(ModelView(Users_status,db.session))
admin.add_view(ModelView(Creates,db.session))
admin.add_view(ModelView(Creates_title,db.session))
admin.add_view(ModelView(Creates_img,db.session))
admin.add_view(ModelView(Creates_goodcount,db.session))
admin.add_view(ModelView(Creates_comment,db.session))

ディレクトリ構造（githubの通り）

├model
│　└model.py
├app.py
└main.py

※../frontend/dist ディレクトリの下に、空のファイルでよいので、index.htmlを置いておいてください。

Comments

[zero-penguin]

Json形式に変換することまで想定しての丁寧なご回答ありがとうございます！少し実行に時間がかかる可能性があるので、解決や問題が発生した場合は随時返信いたします！

Answer 2

・テーブル変更を行いマイグレーションを実行しても、データベース内のテーブルは変化していない。

以下を参照ください。

Create the Tables

create_all does not update tables if they are already in the database.

(DeepL翻訳: create_allはすでにデータベースにあるテーブルを更新しません。)
と、いうことなので、データベース内のテーブルに変化が無いのは正しい動作です。

変更したい場合は、続きに以下の様な記載があります。

If you change a model’s columns, use a migration library like Alembic with Flask-Alembic or Flask-Migrate to generate migrations that update the database schema.

(DeepL翻訳: モデルのカラムを変更する場合は、Flask-Alembic や Flask-Migrate を使って Alembic のようなマイグレーションライブラリを使い、データベースのスキーマを更新するマイグレーションを生成します。)

なので、Flask-AlembicやFlask-Migrateを使えばできそうです。

・テーブルに対してＣＲＵＤ操作を行いたいが、現状はコマンドからReadしかできない。

Selectはできているようなので、Insert/Update/Delete部分は以下を参照ください。

Insert, Update, Delete

試して見ると分かりますが、Insert/Update/Delete操作は、commit()を最後に実行する必要があります。

また、ドキュメントにある例がわかりにくいですが・・・

user = User()
db.session.add(user)
db.session.commit()

User()オブジェクトを作成し、(オブジェクトの中身を記載し)、add()してから、commit()すると、それがInsertされます。
例えばUserが

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(15), nullable=False)
    passward = db.Column(db.String(10), nullable=False)
    status = db.Column(db.String(50), nullable=False)
    created_data = db.Column(db.DateTime, nullable=False, default=datetime.now(pytz.timezone('Asia/Tokyo')))

のような感じの場合は、

user.id = 1
user.name = "name"

みたいな事をした後に(もしくはModelを初期化する時にuser =User(id=1, name="name",...)の様にして)登録したい情報を登録します。

Updateは新しく作らず、すでにあるものを取得してから、それを変更しcommit()します。

user = db.session.execute(db.select(User).filter_by(username=username)).scalar_one()
user.id = 2
db.session.commit()

Deleteも、Updateと同じで、すでにあるものを取得してから、それを削除します。

user = db.session.execute(db.select(User).filter_by(username=username)).scalar_one()
db.session.delete(user)
db.session.commit()

※ sclar_one()は、SQLAlchemyのドキュメントによると、Result.scalars()やResult.one().と同じです、ということなので、1個だけ取得していることに注意してください。

Comments

[zero-penguin]

丁寧なご回答ありがとうございます！少し実行に時間がかかる可能性があるので、解決や問題が発生した場合は随時返信いたします！