Flask创建数据库时出现循环导入报错无法启动应用的问题求助

问题根因 #

1. 导入顺序错误触发未完成初始化导入：website/__init__.py中在Flask实例app、SQLAlchemy实例db创建完成之前，就提前导入了routes模块。而routes.py中必然会引用website包下的app或db对象，此时导入routes时website包还未完成app对象的初始化，就会触发“从部分初始化的模块导入”的报错，属于隐式循环导入场景。
2. 存在两处语法/配置错误：
   • app.py中if __name__ == '__main__'后缺失冒号
   • 数据库URI配置格式错误，正确SQLite URI格式为sqlite:///数据库文件路径，原有写法多了多余的冒号、斜杠顺序错误

修复方案 #

1. 修改website/__init__.py代码，调整导入顺序

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

# 先初始化app和db实例
app = Flask(__name__)
app.config['SECRET_KEY'] = '自定义任意加密字符串，不要泄露'
# 修正数据库URI格式
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///database.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

# 等app和db全部初始化完成后，再导入依赖这两个实例的routes模块
from website import routes

2. 修正app.py的语法错误

from website import app

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

修改完成后直接执行python app.py即可正常启动应用。

避坑经验 #

• 基于包结构开发Flask项目时，所有依赖app/db实例的模块（路由、模型类等）的导入语句，必须放到实例初始化代码的后面，不能放在__init__.py文件顶部。
• 排查循环导入问题时，优先检查报错涉及的两个模块的导入顺序，把依赖已初始化对象的导入操作后移即可解决绝大多数场景的问题。
• 不要在模块顶层编写依赖其他模块未初始化对象的代码，尽量把相关逻辑放到函数、方法内部延迟加载。

内容的提问来源于stack exchange，提问作者Paul Clauss