python - SQLAlchemy 的问题 - 推断外键的棉花糖嵌套对象
问题描述
我试图让 Marshmallow-SQLAlchemy 反序列化具有嵌套对象的对象,而不指定嵌套对象的外键(它应该是父对象的主键)。这是一个独立的示例:
# Python version == 3.8.2
from datetime import datetime
import re
# SQLAlchemy == 1.3.23
from sqlalchemy import func, create_engine, Column, ForeignKey, Text, DateTime
from sqlalchemy.ext.declarative import as_declarative, declared_attr
from sqlalchemy.orm import relationship, sessionmaker
# marshmallow==3.10.0
# marshmallow-sqlalchemy==0.24.2
from marshmallow import fields
from marshmallow.fields import Nested
from marshmallow_sqlalchemy import SQLAlchemyAutoSchema
################################################################################
# Set up
################################################################################
engine = create_engine("sqlite:///test.db")
Session = sessionmaker()
Session.configure(bind=engine)
session = Session()
################################################################################
# Models
################################################################################
@as_declarative()
class Base(object):
@declared_attr
def __tablename__(cls):
# From https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case
name = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', cls.__name__)
return re.sub('([a-z0-9])([A-Z])', r'\1_\2', name).lower()
@declared_attr
def updated(cls):
return Column(DateTime, default=func.now(), onupdate=func.now(), nullable=False)
class Account(Base):
id = Column(Text, primary_key=True)
name = Column(Text, nullable=False)
tags = relationship("AccountTag", backref="account")
class AccountTag(Base):
account_id = Column(Text, ForeignKey('account.id'), primary_key=True)
Key = Column(Text, primary_key=True)
Value = Column(Text, nullable=False)
################################################################################
# Schemas
################################################################################
class AutoSchemaWithUpdate(SQLAlchemyAutoSchema):
class Meta:
load_instance = True
sqla_session = session
updated = fields.DateTime(default=lambda: datetime.now())
class AccountSchema(AutoSchemaWithUpdate):
class Meta:
model = Account
include_relationships = True
tags = Nested("AccountTagSchema", many=True)
class AccountTagSchema(AutoSchemaWithUpdate):
class Meta:
model = AccountTag
include_fk = True
################################################################################
# Test
################################################################################
Base.metadata.create_all(engine)
account_object = AccountSchema().load({
"id": "ABC1234567",
"name": "Account Name",
"tags": [
{
"Value": "Color",
"Key": "Blue"
}
]
})
session.merge(account_object)
session.commit()
这是我得到的错误:
Traceback (most recent call last):
File "example.py", line 88, in <module>
account_object = AccountSchema().load({
File "C:\python\site-packages\marshmallow_sqlalchemy\schema\load_instance_mixin.py", line 92, in load
return super().load(data, **kwargs)
File "C:\python\site-packages\marshmallow\schema.py", line 727, in load
return self._do_load(
File "C:\python\site-packages\marshmallow\schema.py", line 909, in _do_load
raise exc
marshmallow.exceptions.ValidationError: {'tags': {0: {'account_id': ['Missing data for required field.']}}}
我觉得我正在尝试做一些直观的事情,但我不确定了。我敢肯定我在这里很近,但没有运气让它发挥作用。非常感谢您的帮助。
解决方案
您收到错误是因为您include_fk
在Meta
类中指定了AccountTagSchema
.
您可以检查已为架构生成的字段:
print(AccountTagSchema._declared_fields["account_id"])
# <fields.String(default=<marshmallow.missing>, attribute=None, validate=[], required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>
请注意,它使用 生成account_id
,required=True
这是由于它表示的 sqlalchemy 列NOT NULL
是主键的一部分。
所以最简单的事情是include_fk
从模式元中删除:
class AccountTagSchema(AutoSchemaWithUpdate):
class Meta(AutoSchemaWithUpdate.Meta):
model = AccountTag
# include_fk = True <--- remove
...但是,运行脚本,你会遇到另一个问题:
sqlalchemy.orm.exc.UnmappedInstanceError:类'builtins.dict'未映射
这意味着我们最终将一个dict
需要映射子类的 SQLAlchemy 会话传递给该会话Base
。
这样做的原因是,当子类从基本模式继承时,例如,AutoSchemaWithUpdate
在这种情况下,子类不会自动继承父类的元配置。文档为此提供了一些策略,最简单的是子Meta
类也应该从父Meta
类继承:
class AccountSchema(AutoSchemaWithUpdate):
class Meta(AutoSchemaWithUpdate.Meta): # <--- this here
model = Account
include_relationships = True
tags = Nested("AccountTagSchema", many=True)
一旦我们为两者都这样做了AccountSchema
,AccountTagSchema
我们就可以再次运行脚本并且它可以工作......第一次。立即再次运行脚本,又出现一个错误:
AssertionError:依赖规则试图在实例“<AccountTag at 0x7f14b0f9b670>”上清除主键列“account_tag.account_id”
这是设计决定使加载的AccountTag
实例无法识别(即,从有效负载中排除主键)以及决定将外键字段作为主键的一部分包括在内的结果AccountTag
。
SQLAlchemy 无法识别新创建的AccountTag
实例与已经存在的实例相同,因此它首先尝试通过将外键字段的值设置为 来解除原始帐户标签与帐户的关联None
。但是,这是不允许的,因为外键也是主键,不能设置为 NULL。
此处描述了解决方案,并涉及在 上设置显cascade
式relationship
:
class Account(Base):
id = Column(Text, primary_key=True)
name = Column(Text, nullable=False)
tags = relationship("AccountTag", backref="account", cascade="all,delete-orphan")
现在再次运行脚本,它每次都会工作。
推荐阅读
- excel - 如何将单元格从 template.xml(2003 文件)复制到 mydoc.xltm
- javascript - 不明白为什么 onclick 事件没有触发
- javascript - 如果 href 包含端口号,请执行某些操作
- spring-mvc - spring mvc控制器协程挂起函数抛出IllegalStateException
- algorithm - Minimize the distance to the farthest point
- javascript - 在 JavaScript 中为日期和名称编写排序?
- php - Remove "." (dot) after each word enclosed in pattern
- tronbox - Tronbox unbox and tronbox init commands are giving following error:-bash post-unpack.sh && rm post-unpack.sh && npm install
- php - How can I make my PHP code readable and not repeating?
- android - 如何使用从 RecyclerView 到 Fragment 的共享转换