python - 在 flask 和其他应用程序之间共享 sqlalchemy 模型

Question

我有一个正在运行的 Flask 应用程序，它是根据我们在网上和 Miguel Grinberg 的“Flask Web 开发”一书中找到的最佳实践组合设置的。

我们现在需要第二个 Python 应用程序，它不是 Web 应用程序，它需要访问与 Flask 应用程序相同的模型。我们当然想重用相同的模型，这样两个应用程序都可以从共享代码中受益。

我们已经删除了对 flask-sqlalchemy 扩展的依赖(我们之前使用过，当我们只有 Flask 应用程序时)。并将其替换为 SQLalchemy Declarative extension described here , 稍微简单一点(Flask-SQLalchemy adds a few specific things to standard SQLAlchemy)

根据示例，我们在根目录中创建了一个 database.py 文件。在我们的例子中，与声明式扩展示例有两点不同:我将引擎和 session 放在一个类中，因为我们所有的模型都使用 db.session，而不是 db_session，并且我将带有配置值的字典传递给 init()，这样我就可以使用不同的配置从 Flask 和另一个应用程序中重用这个 database.py。它看起来像这样:

from sqlalchemy import create_engine
from sqlalchemy.orm import scoped_session, sessionmaker
from sqlalchemy.ext.declarative import declarative_base


class Database(object):

    def __init__(self, cfg):
        self.engine = create_engine(cfg['SQLALCHEMY_DATABASE_URI'], convert_unicode=True)
        self.session = scoped_session(sessionmaker(autocommit=False, autoflush=False, bind=self.engine))

    class Model(object):
        pass

Base = declarative_base()

所以现在我们来解决实际问题。 Flask 创建一个包含配置选项的类字典对象，并将它们作为属性添加到应用程序实例中。它从 instance folder 加载它们, 一个 config.py在站点的根目录和环境变量中。我需要从 Flask 传递配置字典，所以我需要 Flask 来首先加载和组装配置，然后初始化数据库，并在应用程序文件的根目录中有一个(配置的)db 对象。但是，我们遵循 Application factory pattern ，因此我们可以针对不同的情况(测试、生产、开发)使用不同的配置。

这意味着我们的 app/__init__.py 看起来像这样(简化):

from flask import Flask
from database import Database
from flask.ext.mail import Mail
from flask_bcrypt import Bcrypt
from config import config

mail = Mail()
bcrypt = Bcrypt()


def create_app(config_name):

    app = Flask(__name__, instance_relative_config=True)

    if not config_name:
        config_name = 'default'
    app.config.from_object(config[config_name])
    app.config.from_pyfile('config.py')
    config[config_name].init_app(app)

    db = Database(app.config)

    mail.init_app(app)
    bcrypt.init_app(app)

    @app.teardown_appcontext
    def shutdown_session(exception=None):
        db.session.remove()

    from main import main as main_blueprint
    app.register_blueprint(main_blueprint)

    return app

但是 db(模型从 .. 导入)现在需要在 create_app() 函数中，因为这是 Flask 加载配置的地方。如果我要在 create_app() 函数之外实例化 db 对象，它将可以从模型中导入，但未配置!

示例模型如下所示，如您所见，它需要应用根目录中的“db”:

from . base_models import areas
from sqlalchemy.orm import relationship, backref
from ..utils.helper_functions import newid
from .. import db


class Areas(db.Model, areas):
    """Area model class.
    """
    country = relationship("Countries", backref=backref('areas'))

    def __init__(self, *args, **kwargs):
        self.area_id = newid()
        super(Areas, self).__init__(*args, **kwargs)

    def __str__(self):
        return u"{}".format(self.area_name).encode('utf8')

    def __repr__(self):
        return u"<Area: '{}'>".format(self.area_name).encode('utf8')

所以我的问题是，我怎样才能拥有一个可以在外部配置的数据库实例(通过 Flask 或其他应用程序)，并且仍然使用应用程序工厂模式？

编辑:代码示例不正确，它有一个 Flask-SQLalchemy 的导入，它被替换为 from database import Database。如有任何混淆，请见谅。

Answer 1

Flask-SQLAlchemy 扩展，像大多数 Flask 扩展一样，应该在工厂之外创建，然后在工厂中使用 init_app 进行初始化。这样您就可以在创建应用程序之前使用 db 对象。

db = SQLAlchemy()

def create_app():
    app = Flask(__name__)
    db.init_app(app)
    return app

您的 Flask 应用程序与任何设计合理的 Python 项目一样，应该是一个可安装的包。这很简单:确保您的项目布局合理，然后添加一个基本的 setup.py 文件。

project/
    my_flask_package/
        __init__.py  # at the most basic, this contains create_app and db
    setup.py

from setuptools import setup, find_packages

setup(
    name='my_flask_package',
    version='1.0',
    packages=find_packages(),
    install_requires=['flask', 'flask-sqlalchemy'],
)

$ python setup.py sdist

现在您可以安装 Flask 应用程序及其数据库，以便在其他项目中使用。在您的第二个项目的 virtualenv 中安装并导入它，然后创建并推送一个应用程序以对其进行初始化。

$ pip install my_flask_package-1.0.tar.gz

from my_flask_package import db, create_app
create_app().app_context().push()
db.session.query(...)

如果您担心创建应用程序所涉及的开销，您可以向 create_app 函数添加参数来控制初始化的内容。不过，在大多数情况下，这应该不是问题。