python-3.x - flask-sqlalchemy db.Model._decl_class_registry.values() 和 db.metadata.tables 不一致
问题描述
我想基于这样的单位字段动态生成一个类:
def gm_a(unit):
tname = '%s_a' % unit
for c in db.Model._decl_class_registry.values():
if hasattr(c, '__table__') and c.__table__.fullname == tname:
return c
class A(DynamicBase):
__tablename__ = '%s_a' % unit
id = db.Column(db.Integer, primary_key=True)
......# other fields
return A
你可以看看我是否想在 ORM 操作中使用 table_a 或desk_a 表,我可以这样做:
@app.route('/<unit>/a')
def a(unit):
obj_table = gm_a('table').query.filter_by(xxx).all()
obj_desk = gm_a('desk').query.filter_by(xxx).all()
这样,我们就可以对相同结构的不同表名的表进行操作。有一个问题,如果我们有 3 个 gm_* 函数(gm_a,gm_b,gm_c)和 3 个路由(/<unit>/a
, /<unit>/b
, /<unit>/c
),每个模板像这样:
<ul>
<li><a href="a">A</a></li>
<li><a href="b">B</a></li>
<li><a href="c">C</a></li>
</ul>
如果我们随机点击这些链接,我们期望在 db.Model._decl_class_registry.values() 中生成 3 个类,在 db.metadata.tables 中生成 3 个表。
---
[<class '__main__.gm_a.<locals>.A'>, <class '__main__.gm_b.<locals>.B'>, <class '__main__.gm_c.<locals>.C'>]
immutabledict({'table_a': Table('table_a', MetaData(bind=None), Column('id', Integer(), table=<table_a>, primary_key=True, nullable=False), schema=None), 'table_b': Table('table_b', MetaData(bind=None), Column('id', Integer(), table=<table_b>, primary_key=True, nullable=False), schema=None), 'table_c': Table('table_c', MetaData(bind=None), Column('id', Integer(), table=<table_c>, primary_key=True, nullable=False), schema=None)})
127.0.0.1 - - [12/Jul/2018 09:58:03] "GET /table/b HTTP/1.1" 200 -
---
[<class '__main__.gm_a.<locals>.A'>, <class '__main__.gm_b.<locals>.B'>, <class '__main__.gm_c.<locals>.C'>]
immutabledict({'table_a': Table('table_a', MetaData(bind=None), Column('id', Integer(), table=<table_a>, primary_key=True, nullable=False), schema=None), 'table_b': Table('table_b', MetaData(bind=None), Column('id', Integer(), table=<table_b>, primary_key=True, nullable=False), schema=None), 'table_c': Table('table_c', MetaData(bind=None), Column('id', Integer(), table=<table_c>, primary_key=True, nullable=False), schema=None)})
127.0.0.1 - - [12/Jul/2018 09:58:04] "GET /table/c HTTP/1.1" 200 -
---
[<class '__main__.gm_a.<locals>.A'>, <class '__main__.gm_b.<locals>.B'>]
immutabledict({'table_a': Table('table_a', MetaData(bind=None), Column('id', Integer(), table=<table_a>, primary_key=True, nullable=False), schema=None), 'table_b': Table('table_b', MetaData(bind=None), Column('id', Integer(), table=<table_b>, primary_key=True, nullable=False), schema=None), 'table_c': Table('table_c', MetaData(bind=None), Column('id', Integer(), table=<table_c>, primary_key=True, nullable=False), schema=None)})
127.0.0.1 - - [12/Jul/2018 09:58:04] "GET /table/b HTTP/1.1" 200 -
---
[<class '__main__.gm_a.<locals>.A'>, <class '__main__.gm_b.<locals>.B'>]
immutabledict({'table_a': Table('table_a', MetaData(bind=None), Column('id', Integer(), table=<table_a>, primary_key=True, nullable=False), schema=None), 'table_b': Table('table_b', MetaData(bind=None), Column('id', Integer(), table=<table_b>, primary_key=True, nullable=False), schema=None), 'table_c': Table('table_c', MetaData(bind=None), Column('id', Integer(), table=<table_c>, primary_key=True, nullable=False), schema=None)})
127.0.0.1 - - [12/Jul/2018 09:58:04] "GET /table/a HTTP/1.1" 200 -
如您在图片或代码中看到的,我们之前已经单击了a、b、c,因此class 和table 中有三个。但是一旦我们点击 b,.vales() 中就只有 a, b。由于没有table_c类,所以在我们的程序逻辑中会重新生成,但是Tables中确实存在table_c。所以它会抛出一个异常:
sqlalchemy.exc.InvalidRequestError: Table 'table_c' is already defined for this MetaData instance. Specify 'extend_existing=True' to redefine options and columns on an existing Table object.
我很困惑为什么 db.Model._decl_class_registry.values() 中的数字会随机变化,而 _decl_class_registry.values() 和 db.metadata.tables() 的数字会不同。我也在sqlalchemy-utils中使用了get_class_by_table函数,但是原理和我们的方法一致,不起作用。
有谁知道为什么?谢谢。
解决方案
我昨天一直在与这个例外作斗争,并想出了一个“解决方案”。有点hacky但有效。
我的问题是,在烧瓶服务器重新启动后,预先存在的动态创建的表没有加载,db.Model._decl_class_registry
但它们列在db.metadata.tables
. 问题中不包括如何初始化数据库,但我认为问题的根本原因与我的相同,我尝试metadata.reflect
在启动时使用具有动态表名的持久数据库。重新创建一个名称存在db.metadata.tables
但不存在的表db.Model._decl_class_registry
将导致上述异常。无效状态表示已加载持久数据库,并且 flask-sqalchemy 在初始化期间未找到表的模型。
这只是一个假设,我有点迟到了,这个问题已经快 2 年了,可能你甚至没有那段代码了。无论如何,如果有人想使用动态表名和持久数据库:我希望这个答案将有助于不花费数小时的谷歌搜索和调试。
因此,有问题的代码会遇到
sqlalchemy.exc.InvalidRequestError: Table '{something}' is already defined for this MetaData instance. Specify 'extend_existing=True' to redefine options and columns on an existing Table object.
服务器重启后:
app.py - 原始方法 <<错误
from flask import Flask, request, render_template
from config.config_test import ConfigCache, db
import logging
import os
app = Flask(__name__, static_url_path='/static')
basedir = os.path.abspath(os.path.dirname(__file__))
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'data.sqlite')
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SECRET_KEY'] = 'absolutely secret'
# !!!!!
# https://stackoverflow.com/questions/28789063/associate-external-class-model-with-flask-sqlalchemy
db.init_app(app)
with app.app_context():
# !!!!
# https://stackoverflow.com/a/40984584/8375783
db.metadata.reflect(bind=db.engine)
configs.py - 原始方法 <<错误
from flask_sqlalchemy import SQLAlchemy, declarative_base
Base = declarative_base()
db = SQLAlchemy(model_class=Base)
class ServerConfig(db.Model):
__tablename__ = 'server_config'
__abstract__ = True
name = db.Column(db.String, unique=True, primary_key=True)
location = db.Column(db.String)
config_type = db.Column(db.String)
descriptor = ['name', 'location', 'config_type']
class ConfigCache:
def _is_server_config_cached(self, config_name):
return db.metadata.tables.get(config_name, False)
def _create_server_config_table(self, name):
new_table = type(name, (ServerConfig,), {'__tablename__': name})
db.create_all()
return new_table
def add_server_config(self, data):
table = self._is_server_config_cached(data['config_name'])
if table is False:
table = self._create_server_config_table(data['config_name'])
for d in data["data_batch"]:
entry = table(name=d['name'], location=d['location'], config_type=d['config_type'])
db.session.add(entry)
db.session.commit()
在这个问题上花了几个小时后,我注意到所有非抽象、非动态的命名表都可以正常工作。db.metadata.reflect(bind=db.engine)
在进入 db.Model._decl_class_registry
和之后,所有模型都被正确加载db.metadata.tables
。在我看来,关键是调用local
时的范围(关于可用模型) 。db = SQLAlchemy(model_class=Base)
所以我想出了这个:
让我们调整启动顺序以提供所有模型:
- 加载数据库(物理 sqlite 数据库)
- 从连接中,加载所有表名
- 为当地人添加适当的模型
- 使用包含所有模型的局部变量重新初始化 SqlAlchemy
- 调用反映
- 所有先前生成的动态命名表都已正确加载
app.py - 具有更新的初始化序列 << WORKING
from flask import Flask, request, render_template
from config.config_test import db, dirty_factory
import logging
import os
app = Flask(__name__, static_url_path='/static')
basedir = os.path.abspath(os.path.dirname(__file__))
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'data.sqlite')
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SECRET_KEY'] = 'absolutely secret'
# !!!!!
# https://stackoverflow.com/questions/28789063/associate-external-class-model-with-flask-sqlalchemy
db.init_app(app)
with app.app_context():
# !!!!
# https://stackoverflow.com/a/40984584/8375783
dirty_factory(config_db.engine.engine.table_names())
db.metadata.reflect(bind=config_db.engine)
db.create_all(app=app)
configs.py - 使用 locals() hack << WORKING
from flask_sqlalchemy import SQLAlchemy, declarative_base
Base = declarative_base()
db = SQLAlchemy(model_class=Base)
class ServerConfig(db.Model):
__tablename__ = 'server_config'
__abstract__ = True
name = db.Column(db.String, unique=True, primary_key=True)
location = db.Column(db.String)
config_type = db.Column(db.String)
descriptor = ['name', 'location', 'config_type']
def dirty_factory(config_names):
for config_name in config_names:
if 'server-config' in config_name: #pattern in data['config_name']
locals().update({config_name: type(config_name, (ServerConfig,), {'__tablename__': config_name, })})
db = SQLAlchemy(model_class=Base)
class ConfigCache:
def _is_server_config_cached(self, config_name):
return db.metadata.tables.get(config_name, False)
def _create_server_config_table(self, name):
new_table = type(name, (ServerConfig,), {'__tablename__': name})
db.create_all()
return new_table
def add_server_config(self, data):
table = self._is_server_config_cached(data['config_name'])
if table is False:
table = self._create_server_config_table(data['config_name'])
for d in data["data_batch"]:
entry = table(name=d['name'], location=d['location'], config_type=d['config_type'])
db.session.add(entry)
db.session.commit()
TLDR;
如果您使用动态表名和持久数据库,请确保在初始化 SQLAlchemy 之前注意加载模型。如果您的模型在db = SQLAlchemy(model_class=Base)
被调用时无法加载,则表格将被加载到db.metadata.tables
,但相关模型不会被加载到db.Model._decl_class_registry
. 重新声明表/模型将导致上述异常。如果您将重新声明放入 try/except 块中(是的,我已经尝试过),您将无法查询,因为表和模型将无法正确连接。
推荐阅读
- python - 如何使用 NLP 从 PDF 文件中提取关键字及其页码?
- c - 如何使用缓冲区溢出攻击找到要利用的程序的漏洞
- grails - 更新行时变音符号出错
- c++ - 对话框在打开后立即关闭
- php - 是通过 google-api-php-client SSL 连接的吗?
- cluster-computing - CAP:我们可以牺牲可用性来获得分区容限吗?
- html - div元素悬停时如何删除多余的空间?
- c# - 在 Web API 控制器中获取绝对 URL?
- javascript - javaScript:window.open 不显示背景图像
- python - 如何使用 BeautifulSoup 获取上一个元素