运行Flask+SQLAlchemy代码无报错但未生成.db数据库文件如何解决

核心原因及对应解决方法 #

• 未主动调用数据库创建函数
  仅定义了create_database()函数，没有在代码逻辑中主动触发执行，自然不会生成数据库文件。
  解决方法：在应用初始化逻辑末尾添加函数调用，注意新版Flask-SQLAlchemy需要搭配应用上下文使用：

  def create_app():
      app = Flask(__name__)
      app.config['SECRET_KEY'] = 'key123'
      app.config['SQLALCHEMY_DATABASE_URI'] = f'sqlite:///{DB_NAME}'
      db.init_app(app)
      # 新增调用逻辑
      with app.app_context():
          create_database(app)
      return app
  

• 路径配置不匹配
  配置的SQLALCHEMY_DATABASE_URI默认会将数据库文件生成在脚本运行的当前工作目录下，但create_database()判断的是website/子目录下是否存在文件，两者路径不一致会导致逻辑错位：要么判断路径不存在但实际根目录已经生成了文件，要么生成路径和预期不一致。
  解决方法：统一使用绝对路径避免相对路径随运行目录变动的问题，修改配置如下：

  # 基于当前脚本所在目录生成绝对路径
  basedir = path.abspath(path.dirname(__file__))
  app.config['SQLALCHEMY_DATABASE_URI'] = f'sqlite:///{path.join(basedir, DB_NAME)}'
  # 同步修改判断逻辑的路径
  def create_database(app):
      if not path.exists(path.join(basedir, DB_NAME)):
          db.create_all()
  

• 未定义任何数据模型
  db.create_all()只会为已定义的、继承自db.Model的模型类创建对应表，如果你没有写任何模型类，该方法会静默执行不生成任何文件，也不会抛出错误。
  解决方法：先定义至少一个数据模型再执行创建逻辑，示例：

  # 定义模型，注意要放在db初始化之后、create_all执行之前
  class User(db.Model):
      id = db.Column(db.Integer, primary_key=True)
      username = db.Column(db.String(100), unique=True, nullable=False)
  

• Flask-SQLAlchemy版本兼容问题
  2.0及以上版本的Flask-SQLAlchemy不再支持db.create_all(app=app)的传参写法，旧写法执行会静默失败不生成文件。
  解决方法：统一使用应用上下文包裹创建逻辑，不要给create_all传app参数，写法参考前文的with app.app_context()示例。

完整可运行参考代码 #

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from os import path

db = SQLAlchemy()
DB_NAME = "database.db"
basedir = path.abspath(path.dirname(__file__))

# 示例模型
class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(100), unique=True, nullable=False)

def create_app():
    app = Flask(__name__)
    app.config['SECRET_KEY'] = 'key123'
    app.config['SQLALCHEMY_DATABASE_URI'] = f'sqlite:///{path.join(basedir, DB_NAME)}'
    db.init_app(app)

    with app.app_context():
        create_database(app)
    
    return app

def create_database(app):
    if not path.exists(path.join(basedir, DB_NAME)):
        db.create_all()
        print("数据库创建成功")

# 入口执行
if __name__ == "__main__":
    app = create_app()
    app.run()

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