Docker環境でinit_appを実行できない

Question

実現したいこと

ここに実現したいことを箇条書きで書いてください。

• 最初のレンダリング時にデータベースを構築（初期化）したい

前提

フロントエンドにVue(Vue3)を採用し、APIサーバであるFlaskを経由してデータを取得するというシステムを設計している。DBMSはSQLiteで、それをSQLAlchemyで操作している（ORM）。フロントで入力したデータをFlask経由でデータベースに登録する操作を実行したときにエラーが発生した。

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

RuntimeError: The current Flask app is not registered with this 'SQLAlchemy' instance. Did you forget to call 'init_app', or did you create multiple 'SQLAlchemy' instances?

該当のソースコード

from datetime import datetime
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class Users(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(255))
    results = db.relationship('Results', backref='user', lazy=True)

class Results(db.Model):
    __tablename__ = 'results'
    id = db.Column(db.Integer, primary_key=True)
    user_id = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=False)
    level = db.Column(db.Text, nullable=False)
    clearTime = db.Column(db.Integer, nullable=False)
    collectedCoins = db.Column(db.Integer, nullable=False)
    timestamp = db.Column(db.DateTime, index=True, default=datetime.now)

def init_db(app):
    db.init_app(app)
    db.create_all()

def add_user(name):
    model = Users(name=name)
    db.session.add(model)
    db.session.commit()

from flask import Flask, send_from_directory
from api import api_bp
from flask_sqlalchemy import SQLAlchemy
from models import init_db

app = Flask(__name__, static_folder='/usr/src/app/frontend/dist', static_url_path="")
app.register_blueprint(api_bp)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///maze.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

@app.route("/", defaults={'path': ''})
@app.route('/<path:path>')
def index(path):
    return send_from_directory(app.static_folder, "index.html")

if __name__ == '__main__':
    with app.app_context():
        init_db(app)
    app.run()

services:
  frontend:
    build: 
      context: ./frontend
      dockerfile: Dockerfile
    command: npm run dev
    ports:
      - '5173:5173'
    volumes:
      - ./frontend:/usr/src/app
  backend:
    build: 
      context: ./backend
      dockerfile: Dockerfile
    ports:
      - '5000:5000'
    volumes:
      - ./backend:/usr/src/app
      - ./frontend/dist:/usr/src/app/frontend/dist
    command: flask run --host=0.0.0.0

services:
  frontend:
    build: 
      context: ./frontend
      dockerfile: Dockerfile
    command: npm run dev
    ports:
      - '5173:5173'
    volumes:
      - ./frontend:/usr/src/app
  backend:
    build: 
      context: ./backend
      dockerfile: Dockerfile
    command: ["python3", "app.py", "--host=0.0.0.0"]
    ports:
      - '5000:5000'
    volumes:
      - ./backend:/usr/src/app
      - ./frontend/dist:/usr/src/app/frontend/dist

FROM python:3.12.2

WORKDIR /usr/src/app

COPY ./ /usr/src/app/
COPY ./requirements.txt ./

RUN pip install --upgrade pip
RUN pip install --upgrade flask
RUN pip install -r requirements.txt
RUN pip install flask_sqlalchemy
RUN pip install flask-restful

試したこと

本アプリケーションとは異なるが、実環境でFlaskとVueを用いたWEBアプリケーションを作成したときは上記のコードでエラーは出なかった。CharGPT-4や各種Webサイトで調べたが、解決方法が見つからなかった。

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

特になし。

Comments

[bsdfan]

どのようにDockerで実行しているかの情報が必要と思います。
実行したコマンドとオプション、docker compose 使っているなら yml ファイル、あとはどんなイメージを使っているかなど。
特に、sqlite を使われていますが、データの永続化の設定(ボリューム等)がちゃんとできているのかが気になりました。

[Nakano_Akito]

ご指摘いただいたファイルを追加しました。
docker-compose.ymlにあるように、Docker環境を/usr/src/app/としています。

[bsdfan]

flask run で実行されているので、db.init_app(app) の部分は実行されておらず、そのエラーになっているのではないでしょうか。(Docker以外の環境でエラーになっていないということなので、よくわからないところではありますが)

[Nakano_Akito]

sqliteはファイルでDBを管理するので、コマンド操作は必要ないという認識でプロジェクトを進めていました（MySQLなどを利用する場合はdocker-compose.ymlにＤＢ用のコンテナについての記述が必要？）。sqliteを使用する際のコマンド操作についての記事がありましたら、ご教示ください。自身で検索しましたが、見つけられませんでした...。

Answer 1

質問文にあるコードを実行してみましたが、質問文にあるエラーメッセージは表示されませんでした。

質問文にある実行方法で実行されていないのかもしれません。(例えば、既に作成されているコンテナを実行していて、昔書いた部分が実行され、現在の手順が反映されていないなど)

また、bsdfanさんの指摘にもある通り、flask runでは、if __name__ == '__main__':部分が実行されないので、DBが作成される訳がありません。
Dockerfileの中で(例えばRUNで)、対象のコードを実行するようにするなど、手順を変えてみてはいかがでしょうか？
(if __name__ == '__main__':を動かすなら、python3 app.pyなどで実行する必要があります。)

それから、上記回答とは関係ありませんが、importされているflask-restfulは最終更新が2014年で、メンテナンスされていません。
これを使い続ける場合、セキュリティの問題や、新しいFlaskにバージョンアップされた時に動作しないなどの問題が発生する可能性があります。
FlaskにはClass-based Viewsという機能があります。
このページの下の方、Method Dispatching and APIsというあたりを参考にすると、flask-restfulを使わずにRESTful APIを実装可能です。

さらに余談ですが、現状はdevなので問題無いと思いますが、この構成のまま本番環境にデプロイしないよう注意ください。
本番環境ではflask runなどで実行される開発サーバの使用は推奨されていません。
FlaskをLinux環境で利用する場合はgunicornやmod-wsgi等を利用ください。

手前にWebサーバ(ApacheやNginx)を入れると良いです。

Comments

[Nakano_Akito]

質問内容以外にもご指摘いただきありがとうございます。（flask runを実行）＝（Flaskサーバ起動）という認識をしており、app.pyの実行についての知識が不十分であったため、今回のご指摘で大変勉強になりました。まずはDockerfileの修正、その後CRUD操作についての修正を行いたいと思います。
今後、分からないことが出てくると思います。その際は再びご指導ください。

[Nakano_Akito]

DockerfileでRUNコマンドを記述するとDockerコンテナのビルド時にpython3 app.pyが実行され、ビルドが永遠に続いてしまいます。そこで、docker-compose.yml内のcommandプロパティでpython3 app.pyを記述しました。Dockerコンテナのビルド後、docker-composeを立ち上げましたが、localhostのアクセス制限に引っかかってしまいました。（この時、同様にinit_appが実行されていないというエラーが出力された。）
改変後のdocker-compose.ymlを本質問の編集として行いますので、記述方法が間違っていたらご指摘ください。

[FiroProchainezo]

> DockerfileでRUNコマンドを記述するとDockerコンテナのビルド時にpython3 app.pyが実行され、ビルドが永遠に続いてしまいます。

buildが終わるように記載する必要があると思います。
たぶん、バックグラウンドで実行すれば終わってくれると思います。

回答では動くだろう方法を書きましたが、`docker run`(`docker-compose up`)する度にDBを作成(Sqliteなのでファイル作成)するのはおかしいかもしれません。

実行は `flask run` として、`docker exec -it {container name} bash`で中に入って、
`python3`からDBを作成するコマンドを実行するとか、

SqliteのDBファイルを作成するコマンドをローカルで実行し、
そのファイルをvolumeでマウントするような方法とかが良いかもしれません。

> docker-compose.yml内のcommandプロパティでpython3 app.pyを記述しました。Dockerコンテナのビルド後、docker-composeを立ち上げましたが、localhostのアクセス制限に引っかかってしまいました。

質問文にdocker-composeのような記述が2個ありますが、` command: ["python3", "app.py", "--host=0.0.0.0"]`がある方が最新ですか？

`python3 app.py` は良いとして、`--host=0.0.0.0`は何でしょうか？
`flask run --host=0.0.0.0`と同じで使っていますか？
だとすると、`app.py`のどこかに`--host`オプションに対応する処理を追加する必要があります。
`argparse`とかを使うと楽だと思います。
(言い換えると、Nakano_Akitoさんの作成した`app.py`に`--host=0.0.0.0`を処理するコードは存在しません。
つまり、指定してもしなくても、指定しない場合と同じように動作し、`0.0.0.0`は指定されていないのと同じです。)
オプション実装するのが面倒だったら、` app.run()`部分で指定してしまった方が楽です。

Answer 2

以下の修正を行ったところ、DBの初期化に成功した。
・backendプロジェクトにおけるDockerfileで、「flask run」→「python3 app.py」に修正。
（そもそもPythonプロジェクト）