首页 文章

在烧瓶和其他应用程序之间共享sqlalchemy模型

提问于
浏览 次
18

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

我们现在需要第二个Python应用程序，它不是Web应用程序，需要访问与Flask应用程序相同的模型 . 我们希望重复使用相同的模型，因此两个应用程序都可以从共享代码中受益 .

我们已经删除了对flask-sqlalchemy扩展（我们之前使用过Flask应用程序时）的依赖关系 . 并将其替换为SQLalchemy Declarative extension described here，这有点简单（Flask-SQLalchemy adds a few specific things to standard SQLAlchemy）

根据示例，我们在根目录中创建了一个database.py文件 . 在我们的例子中，有两个与Declarative扩展示例不同的东西：我将引擎和会话放在一个类中，因为我们所有的模型都使用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创建一个包含配置选项的类字典对象，并将它们作为属性添加到app-instance . 它从站点根目录中的instance folder，config.py和环境变量加载它们 . 我需要从Flask传递配置字典，所以我需要Flask来FIRST加载和组装配置，然后初始化数据库，并在app文件的根目录中有一个（配置的）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或其他应用程序），并仍然使用应用程序工厂模式？

edit: 代码示例不正确，它有一个Flask-SQLalchemy的导入，被 from database import Database 取代 . 对不起任何困惑 .

python flask sqlalchemy flask-sqlalchemy

4 回答

  • 0

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

    db = SQLAlchemy()

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

    与任何设计合理的Python项目一样，您的Flask应用程序应该是可安装的程序包 . 这很简单：确保您的项目布局有意义，然后添加一个基本的 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 函数添加参数以控制初始化的内容 . 对于大多数情况，这应该不是问题 .

    回复于
  • 18

    你可以轻松分享 . 我将展示如何 . 考虑到这个Flask应用程序：

    .
├── config.py
├── db
│   └── test.db
├── do_somenthing2.py ============> Here is run some script 2
├── do_something.py   ============> Here is run some script
├── machinelearning
│   ├── models
│   │   ├── restore.py
│   │   ├── train.py
│   │   └── utils.py
│   └── save
│       └── test.ckpt
├── runserver.py ============> Here is run your app
├── test.py
└── web
    ├── __init__.py
    ├── api
    │   ├── __init__.py
    │   ├── app.py  ============> Here is app = Flask(__name__)
    │   ├── client.py
    │   ├── models.py ==========> Here is db = SQLAlchemy(app)
    │   ├── sample.json
    │   └── utils.py
    └── frontend
        ├── __init__.py
        └── routes.py

    runserver.py

    import os

from config import DEBUG

from web.api.app import app
from web.api.client import *

if __name__ == "__main__":
    app.run(debug=DEBUG)

    好 . 现在你想要使用相同的模型来做另一件事 . 例如：使用相同的模型训练机器，服务并保存在数据库（ORM）中 .

    您可以导入应用程序并使用app.test_request_context（） . 像那样：

    do_something.py

    来自web.api.app的web.api.m导入应用程序导入数据库，用户

    def do_something():
    q = db.session.query(User)\
        .filter(User.Name.ilike('Andre'))
    for i in q.all():
        print (i.Name)    

with app.test_request_context():
    do_something()

    do_something2.py (real example)

    from web.api.app import app
from web.api.models import *

def save(df):

    passengers = []

    records = df.to_dict('records')

    for row in records:
        p = Passenger(row)
        passengers.append(p)

    for p in passengers:
        db.session.add(p)

    db.session.commit()

from ml.models import train, restore

with app.test_request_context():
    print ('Trainning model. It will take a while... (~ 5 minutos)')
    train.run()
    print ('Saving model...')
    save(restore.run())
    print ('Saved!')

    许多答案建议使用（从不同文件夹导入文件）：

    import sys
sys.path.append('../')

    But I disagree when you have a Flask app and other scripts, because you will get crazy solving the relative references.

    另一种选择是安装Flask应用程序及其数据库以便在其他项目中使用的方法 .

    在这里您可以找到有关packages and modules的文档 .

    包是一种使用“点模块名称”构建Python模块命名空间的方法 . 例如，模块名称AB在名为A的包中指定名为B的子模块 . 就像模块的使用使得不同模块的作者不必担心彼此的全局变量名称一样，使用虚线模块名称可以保存作者NumPy或Pillow等多模块软件包不必担心彼此的模块名称 .

    回复于
  • 2

    对于其他人在这个方向冒险 . There is quite a good blog post和link to a library提供Flask-SQLAlchemy之类的优点，而不直接将SQLAlchemy链接到Flask .

    但是要警告一句;我曾试图使用Alchy，但仍然无法弄清楚如何将它集成到Flask和非web应用程序中，所以我接受了davidism对这个问题的接受答案 . 你的里程可能会有所不同 .

    回复于
  • 2

    我遇到了同样的问题 .

    如果打开“SQLALCHEMY_ECHO”，您可能会看到新事务已启动但缺少相应的COMMIT / ROLLBACK .

    对于我发现的内容，它与您创建的两个SQLAlchemy实例有关，一次在模型文件中，一次在web.py中 . 很可能是因为你与web.py的会话进行交互，如果你查询你的模型，有一些上下文切换将接收COMMIT .

    我通过从模型导入“db”来修复问题，然后通过调用db.init_app（app）来初始化它 . 根据日志，现在提交工作正常 .

    @app.teardown_appcontext 不应该't be necessary as it is set up in Flask-SQLAlchemy'的SQLAlchemy类（https://github.com/mitsuhiko/flask-sqlalchemy/blob/master/flask_sqlalchemy/init.py）

    回复于

相关问题