Flask自動載入Blueprint

摘要： 寫多了from controllers.xxx import xxx ,app.register_blueprint(xxx) 就想偷懶。 於是就仿照unittest 的實現思路來做了一個自動載入Blueprint 的工具。使用方法如下： from l...

寫多了from controllers.xxx import xxx ,app.register_blueprint(xxx) 就想偷懶。 於是就仿照unittest 的實現思路來做了一個自動載入Blueprint 的工具。使用方法如下：

from loadbp import load_bp

app = Flask(__name__, template_folder="templates")
load_bp(app)

是不是非常簡單？如果有一些Blueprint 暫時還不想載入，那麼設定一個屬性_DO_NOT_LOAD_BP 即可。例如：

$ grep _DO_NOT_LOAD_BP controllers/*
controllers/issue.py:_DO_NOT_LOAD_BP = True
controllers/user.py:_DO_NOT_LOAD_BP = True

下面是實現：

import logging
import glob
import importlib

from flask import Blueprint, Flask

app = Flask(__name__)


def load_bp(app, path="controllers/**/*.py"):
for file_path in glob.glob(path, recursive=True):
module_name = file_path.split(".")[0].replace("/", ".")
try:
module = importlib.import_module(module_name)

if "__init__" in file_path:
continue

if hasattr(module, "_DO_NOT_LOAD_BP"):
logging.warn("ignore module %s because of attribute _DO_NOT_LOAD_BP settled", module_name)
continue

for attr_name in dir(module):
attr = getattr(module, attr_name)
if isinstance(attr, Blueprint):
logging.info("register %s to flask", attr_name)
app.register_blueprint(attr)
except AttributeError:
logging.error("failed to load module %s", module_name)