大元で定義したシリアライザーをBlueprintで仕切られた各appへ使わせたい

Question

いつもお世話になっております。
server.pyでBlueprintを用いてフォルダＡとフォルダＢに機能を分け、フォルダAだけにシリアライザーなるものを使わせたいと考えました。
ディレクトリは以下の構造です。

main
┠server.py
┠Ａ
┃┗Ａ.py
┗B
┃┗Ｂ.py

コードは以下の通りです。

#!/usr/local/bin/python3
# -*- coding: utf-8 -*-

from flask import Flask, render_template, url_for, request, redirect, Blueprint
from itsdangerous import URLSafeTimedSerializer

from A.A import A_app
from B.B import B_app

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret'

app.register_blueprint(A_app, url_prefix='/A')
app.register_blueprint(B_app, url_prefix='/B')

###　メールアドレスをハッシュ化するシリアライザー　###
ts = URLSafeTimedSerializer(app.config["SECRET_KEY"])
####################################

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

#!/usr/local/bin/python3
# -*- coding: utf-8 -*-

from flask import Flask, render_template, request,Response, abort, redirect, session, Blueprint
from flask_login import LoginManager, login_user, logout_user, login_required, UserMixin, login_required
from server import ts

# Blueprintオブジェクトを生成
A_app = Blueprint('A', __name__,template_folder='templates', static_folder='static')

@A_app.route('A/send_confirm_mail', methods=["GET","POST"])
def send_confirm_mail():
    if(request.method == "POST"):

        #create.htmlから情報受け取り
        address = request.form["username"]

        #addressをハッシュ化してURLにしたものを載せたメールをaddressへ送る
        token = ts.dumps(self.email, salt='email-confirm-key')
        confirm_url = url_for('confirm_email',token=token,_external=True)
        html = render_template('sendmail.html',confirm_url=confirm_url)
        subject = "メールです"
        #メールを送る別関数
        send_email(address, subject, html)
        return redirect("send_confirm_mail")
    else:
        return render_template("A/create.html")

server.pyを実行させますと、以下のようなエラーが出ます。

Traceback (most recent call last):
File "server.py", line 7, in <module>
from A.A import A_app
File "C:\main\A.py", line 6, in <module>
from server import ts
File "C:\main\server.py", line 7, in <module>
from A.A import A_app
ImportError: cannot import name 'A_app' from 'A.A' (C:\main\A\A.py)

循環的な参照となっている為にエラーが出ているように思われますが、解決方法が分かりません。
別の所に関数を作り、そこからimportしても同じことになりました。
大元で定義したtsをBlueprint先のA.pyに適用するには、どのようにすれば良いのか何卒ご教授下さい。

Answer 1

大本で定義したtsをA.pyに適応する必要は無いと思います。

「その処理を何回も利用するから最初に定義して」のような発想だと思いますが、別関数に分けてそれを使えば解決しませんでしょうか？

以下、コードを記載しますが、長いので、回答に関係無い部分は端折っている部分があります。
また、itsdangerousは明示的に使った事がないので、その部分が本当に動作するかは確認お願いします。

ルートフォルダに設定ファイル`config.pyを新規作成し

SECRET_KEY = 'secret'

modules/common.pyを新規作成し

from itsdangerous import URLSafeTimedSerializer
from config import SECRET_KEY


def url_safe_timed_serializer(email_address):
    ts = URLSafeTimedSerializer(SECRET_KEY)
    return ts.dumps(email_address, salt='email-confirm-key')

server.pyを以下の様にし

from flask import Flask
from A.A import A_app

app = Flask(__name__)
app.config.from_pyfile('config.py')

app.register_blueprint(A_app, url_prefix='/A')

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

A/A.pyも以下の様に変更し

from flask import request, Blueprint
from modules.common import url_safe_timed_serializer

# Blueprintオブジェクトを生成
A_app = Blueprint('A', __name__, template_folder='templates', static_folder='static')


@A_app.route('A/send_confirm_mail', methods=["GET", "POST"])
def send_confirm_mail():
    if request.method == "POST":
        address = request.form["username"]
        token = url_safe_timed_serializer(address)
        # 以下略

こうすると、url_safe_timed_serializer()を呼び出せば動作するはずです。

本件には関係ありませんが、あとあと便利なので、Flask-WTFの使用を検討してはいかがでしょうか？
CSRF対応も入っていますし、Validatorも簡単に使える(定義もできる)から便利です。
CSRFのせいで思った動作をしないことがありその点は不便ですが、どのみち実装することになるので今のうちになれておくのもありと思います。

Comments

[jyansinkai]

ご指導、誠にありがとうございます。
仰る通りにしましたら、問題なく動きました。

今回のご指導で学びましたのは、
・定数SECRET_KEYは別ファイルとする
・定数SECRET_KEYを使いたいコード毎にインポートする
・app.config.from_pyfile('config.py')とすることで別ファイルからappに定数を与えられる
・シリアライザーも別のファイルで定義し、使いたいコードでインポートする

ファイルを増やすと混乱するので、できるだけ1つのファイルに全て記入したいと考えていたことに問題があったように思います。

この学びが、またどなたかへ伝わりますように。