Pythonフラスコプロジェクトの構成と動的登録の青写真

私は長い間フラスコの開発をしていませんでしたが、今度は主に以前のフラスコのプロジェクト開発についてのいくつかの経験の要約をあなたと共有したいと思います、それが皆に役立つことを願っています！
フラスコスタートアッププロジェクトの初期化ファイルには、通常、アプリの初期化、構成構成の初期化、ブループリントの登録などの手順が含まれています。
最も満足のいく方法は、新しいモジュールが追加されるたびに、ブループリント登録用の初期化ファイルに2行のコードを手動で追加することです。

プロジェクト構成ファイルconfig.py：

その中で、csrfを防ぐために、SECRET_KEYを設定する必要があります。そうでない場合は、csrfエラー警告を使用するためにsecret_keyを提供する必要があります。

# -*- coding: utf-8 -*-
import os

class Config(object):
    SECRET_KEY = 'wwzgYXYPI/ytEfA4wP1W5KucP21vaDaiusGaO5OlaOBw5O1Bg1f3nmg+G0VkauQPQEodiI4AKXF05rLPNmvquFYC'

    @staticmethod
    def init_app(app):
        # staticmethod可以在类不需要实例化时调用方法
        pass

class DevConfig(Config):
    DEBUG = True
    SQLALCHEMY_ECHO = True
    CELERY_BROKER_URL = 'redis://localhost:6379/0'
    CELERY_BACKEND_URL = 'redis://localhost:6379/0'
    SQLALCHEMY_DATABASE_URI = "mysql+pymysql://root:123456@ip:port/dev_db"


config = {
    
    'development': DevConfig}

SECRET_KEYのランダムな文字列を生成します。

import os, base64

def create_key(length):
	random_str = os.urandom(length)
	byte_ret = base64.b64encode(random_str) # 生成byte类型字符串: b'Easpoammc+/'
	result = byte_ret.decode('unicode_escape')
	return result

if __name__ == '__main__':
	create_key(66)

# 测试结果：wwzgYXYPI/ytEfA4wP1W5KucP21vaDaiusGaO5OlaOBw5O1Bg1f3nmg+G0VkauQPQEodiI4AKXF05rLPNmvquFYC

初期化__init__。pyファイルは次のとおりです。

from flask import Flask, redirect, url_for
from config import config
from flask_sqlalchemy import SQLAlchemy
from .extensions import celery
from flask_login import LoginManager, login_required, current_user


# 实例化数据库对象
db = SQLAlchemy()
login_manager = LoginManager()
login_manager.session_protection = 'strong'
login_manager.login_view = 'auth.login'


def create_app(config_name='development'):
    '''
    1: 创建一个app应用程序
    2: 把配置对象传递给所创建的app
    '''
    app = Flask(__name__)
    app.config.from_object(config[config_name])

    # 将app中的配置文件应用到db中
    db.init_app(app)
    celery.init_app(app)
    login_manager.init_app(app)
    login_manager.login_message = '请先登录'

    from app.auth import auth as auth_bp
    app.register_blueprint(auth_bp, url_prefix='/auth')

    from app.main import main as main_bp
    app.register_blueprint(main_bp, url_prefix='/main')

   	# 登录后默认跳转页
    @app.route('/')
    @login_required
    def index():
        return redirect(url_for('main.index'))

    return app

もちろん、開発する機能が少なければ、上記のような設計図の1つずつの登録は大きな問題ではありません。プロジェクトビジネスがますます複雑になると、上記の方法で大きな登録コードが表示されます。美しくも簡潔でもないので、バッチ登録を使用してコードを最適化し、動的登録ブループリント機能をカプセル化できます。

• 方法1

import importlib
import os

def auto_register_blueprint(app):
    path = os.path.dirname(os.path.abspath(__file__))
    base_file = path.split('\\')[-1]
    for filename in os.listdir(path):
        file_path = os.path.join(path, filename)
        if not os.path.isdir(file_path):
            continue
        if not os.path.exists(os.path.join(file_path, '__init__.py')):
            continue
        auto_blueprint = importlib.import_module(f'{base_file}.' + filename).__dict__[filename]
        app.register_blueprint(auto_blueprint, url_prefix=f'/{filename}')

• 方法2

from werkzeug.utils import import_string
import os

def auto_register_blueprint(app):
    path = os.path.dirname(os.path.abspath(__file__))
    base_file = path.split('\\')[-1]
    for filename in os.listdir(path):
        file_path = os.path.join(path, filename)
        if not os.path.isdir(file_path):
            continue
        if not os.path.exists(os.path.join(file_path, '__init__.py')):
            continue
        auto_blueprint = import_string(f'{base_file}.' + filename + ".__init__:" + filename)
        app.register_blueprint(auto_blueprint, url_prefix=f'/{filename}')

最適化された初期化__init__。pyファイルは次のとおりです。

def create_app(config_name='development'):
    '''
    1: 创建一个app应用程序
    2: 把配置对象传递给所创建的app
    '''
    app = Flask(__name__)
    app.config.from_object(config[config_name])

    # 将app中的配置文件应用到db中
    db.init_app(app)
    celery.init_app(app)
    login_manager.init_app(app)
    login_manager.login_message = '请先登录'

    auto_register_blueprint(app)

    # 登录后默认跳转页
    @app.route('/')
    @login_required
    def index():
        return redirect(url_for('main.index'))

    return app

プロジェクト起動管理ファイルmanage.py

# -*- coding: utf-8 -*-
from flask_script import Manager, Shell, Server
from app import create_app, db


app = create_app('development')
manager = Manager(app)

def make_shell_context():
    return dict(app=app, db=db)


manager.add_command('shell', Shell(make_context=make_shell_context))

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

上記のプロジェクトの基本ファイルが構成され、プロジェクトを開始できます。シェルコマンドを入力します。

python manage.py shell

プロジェクト起動コマンド。ホストとポートはオプションのパラメーターです。

python manage.py runserver --host 0.0.0.0 --port 8888

たとえば、アカウントモジュールのブループリント登録用の単一のサブモジュールのブループリント構成では、次のように、アカウントファイルの下に新しい__init__.pyファイルを作成します。

from flask import Blueprint

account = Blueprint('account', __name__)

from .forms import *
from .views import *
from .models import *