FlaskにおいてModelとViewとDB設定をうまくファイル分離できない

Question

前提

Python+Flaskで簡易なWebページを作成しています。

状況

• Flaskにおいて、ModelとViewとDB設定をファイル単位で分割したい。
• ViewとDBを共通化したファイル（「うまくいくコード」のsub.py）ではflaskのcurrent_appをモジュールを利用して、applicationの設定情報を読み込める。
• しかし、sub.pyのうち、DBクラスを分割した場合、DBクラス内でapplication.configの読み込み方がわかりません。
• 実際のコードで、DBクラスではAWSのDynamoDBへの接続情報をapplication.configから読み込もうとしています。事例を検索するとSQLAlchemyでのDB分割方法はありましたが、このスクリプトでSQLAlchemyは使用していません。そのため、db.init_app(app)といった利用ができない状況です。

うまくいくコード

main.py

from flask import Flask
from sub import application_sub

def create_app():
    application = Flask(__name__)
    application.config['table_name'] = 'fuga_table'
    return application


if __name__ == '__main__':
    application = create_app()
    application.register_blueprint(application_sub)
    application.run()

sub.py

from flask import Blueprint, current_app

application_sub = Blueprint('sub', __name__)

class DB():
    table_name = current_app.config['table_name']

@application_sub.route('/')
def top_page():
    return 'hello world'

試したこと（うまくいかないコード）

以下のコードでmain.pyを実行すると、RuntimeError: Working outside of application context.
とエラーが出ます。sub2でapplication設定を読めないのはわかるのですが、対応の仕方がわかりませんでした。

main.py（変更なし）

from flask import Flask
from sub import application_sub

def create_app():
    application = Flask(__name__)
    application.config['table_name'] = 'fuga_table'
    return application


if __name__ == '__main__':
    application = create_app()
    application.register_blueprint(application_sub)
    application.run()

sub.py(DB設定を除外)

from flask import Blueprint, current_app
from sub2 import DB 

application_sub = Blueprint('sub', __name__)

@application_sub.route('/')
def top_page():
    return 'hello world'

sub2.py(DB設定)

from flask import current_app

class DB():
    table_name = current_app.config['table_name']

実際のDBファイルのイメージ

実際のDBは以下のようになっています。

DB

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute

class DB(Model):
    class Meta:
        table_name = application.config.get('TABLE_NAME')
        region = application.config.get('AWS_REGION')
        aws_access_key_id = application.config.get('AWS_ACCESS_KEY_ID')
        aws_secret_access_key = application.config.get('AWS_SECRET_ACCESS_KEY')

    partition_key = UnicodeAttribute(hash_key=True, null=False)

View

from sub import DB

@application.route('/', methods=['GET'])
def top_page():
    entries = DB_Training.scan()
    entries = sorted(entries, key=lambda x: x.partition_key, reverse=True)
    return render_template('entries/top_page.html', registration_data=entries)

Answer 1

質問文記載のコードでは、起動時に
main 内で sub がインポートされ、
その sub 内で sub2 がインポートされ、
その sub2 内で DB クラスが読み込まれます。
そしてDB クラスが読み込まれる段階で自動的に

    table_name = current_app.config['table_name']

が評価(「実行」)されますが、このタイミングでは current_app が空っぽのため、上記のエラーが発生しているのだと思われます。

アプリ全体における、sub2 にて定義している DB の使われ方が質問文に全く示されていないので何とも言えませんが
あくまで現状のコードの限りでは、下記のように必要なときに table_name を設定すればよいのではないのでしょうか。

sub2.py

from flask import current_app

class DB():
    table_name = ''

    def initdb():
        DB.table_name = current_app.config['table_name']

sub.py

from flask import Blueprint, current_app
from sub2 import DB 

application_sub = Blueprint('sub', __name__)

@application_sub.route('/')
def top_page():
    DB.initdb()  # 追加（たとえばここ以降でDBを使いたいというとき）
    # 以下DBを使った処理。詳細は質問文に記載がないため不明。
    # 略
    return 'hello world'

追記内容について

下記のように、実行時に、必要な部分で内容を読みだし、設定するようにしてみてはいかがでしょうか。

DB

from pynamodb.models import Model
from pynamodb.attributes import UnicodeAttribute

class DB(Model):
    class Meta:
        pass
        
    def init_db():
        DB.Meta.table_name = application.config.get('TABLE_NAME')
        DB.Meta.region = application.config.get('AWS_REGION')
        DB.Meta.aws_access_key_id = application.config.get('AWS_ACCESS_KEY_ID')
        DB.Meta.aws_secret_access_key = application.config.get('AWS_SECRET_ACCESS_KEY')

    partition_key = UnicodeAttribute(hash_key=True, null=False)

View

from sub import DB

@application.route('/', methods=['GET'])
def top_page():
    DB.init_db()
    entries = DB_Training.scan()
    entries = sorted(entries, key=lambda x: x.partition_key, reverse=True)
    return render_template('entries/top_page.html', registration_data=entries)

（試せていないので、上記で正常に動くかどうかはわかりません）

Comments

[MagMag]

qnoir様
回答ありがとうございます！実際のDB構造を入れる質問が複雑になるかな、と思って省略しましたが、アドバイスを受けてinit_dbメソッドを実装しようとしまいたが、PynamoDBの使い方としてclassをネストしているせいもあって、どのように実装したらいいかわかりませんでした。

実際のDBを追加して編集したので、可能だったらこのDBに対してどうinit_dbを実装したらいいか、ヒントをいただけないでしょうか？

[MagMag]

ありがとうございます。

sub2.pyでapplicationをimportするわけにはいかないと思い、applicationをcurrent_appに変えて実行すると"RuntimeError: Working outside of application context."が出ました。

また、init_db()をinit_db(self)にすると"TypeError: init_db() missing 1 required positional argument: 'self'
"とエラーが出ます(selfを入れるとなぜselfがないって怒られるのか謎です)。classを重ねてこうなっているとは思いつつ、対応方法がわからないので、分割するのは諦めようかなと思います。

お付き合いいただき、ありがとうございます。