SQLAlchemy中C类自关联引发CircularDependencyError的解决办法

问题背景 #

现有三层继承的SQLAlchemy模型：A为基类，B继承A，C继承B。同时B与C建立一对多关联：一个C实例可关联多个B实例，每个B实例仅关联一个C实例，且C需要支持自关联。当前代码在普通关联场景下正常，但C自关联提交时触发循环依赖错误。

原模型代码 #

class A(Base):
    __tablename__ = "a"
    
    __mapper_args__ = {
        "polymorphic_identity": "a",
        "polymorphic_on": "type"
    }
    
    id = mapped_column(Integer, primary_key=True)
    type = mapped_column(String(50), nullable=False)
    
class B(A):
    __tablename__ = "b"
    
    id = mapped_column(Integer, ForeignKey("a.id"), primary_key=True)
    
    __mapper_args__ = {
        "polymorphic_identity": "b",
        "inherit_condition": (A.id == id)
    }
    # 关联字段
    c_id = mapped_column(Integer, ForeignKey("c.id", ondelete="CASCADE", use_alter=True), nullable=True)
    c = relationship("C", back_populates="bs", foreign_keys=[c_id])
    
class C(B):
    __tablename__ = "c"
    id = mapped_column(Integer, ForeignKey("b.id"), primary_key=True)
    __mapper_args__ = {
        "polymorphic_identity": "c",
        "inherit_condition": (id == B.id),
    }
    
    # 关联字段
    bs = relationship(
        "B",
        back_populates="c",
        uselist=True,
        cascade="all, delete-orphan",
        single_parent=True,
        foreign_keys=[B.c_id])

正常执行场景 #

以下代码可正常提交：

b = B()
c = C()
b.c = c
c.bs = [b]

session.add_all([b,c])
session.commit()

自关联报错场景 #

执行C自关联代码时触发CircularDependencyError：

c = C()
c.c = c
c.bs = [c]
session.add(c)
session.commit()

错误信息：

sqlalchemy.exc.CircularDependencyError: Circular dependency detected. (SaveUpdateState(<C at 0x11163b850>), ProcessState(ManyToOneDP(B.c), <C at 0x11163b850>, delete=False), ProcessState(OneToManyDP(C.bs), <C at 0x11163b850>, delete=False))

解决方案（不改变架构） #

问题根源是SQLAlchemy在保存自关联实例时，无法同时处理c_id外键赋值和bs集合关联的双向依赖。通过以下两处修改即可解决：

1. 在B类的c关系中添加post_update=True：
   该参数告诉SQLAlchemy先插入C实例，再更新其c_id外键，避免循环依赖。

2. 移除C类bs关系中的single_parent=True：
   single_parent=True要求集合中的子对象只能属于一个父对象，但自关联场景下同一个实例既是父又是子，违反该约束，因此需要移除。

修改后的关键代码片段：

B类修改：

c = relationship("C", back_populates="bs", foreign_keys=[c_id], post_update=True)

C类修改：

bs = relationship(
    "B",
    back_populates="c",
    uselist=True,
    cascade="all, delete-orphan",
    foreign_keys=[B.c_id])

修改后重新执行自关联代码即可正常提交，同时保留原有架构和普通关联的功能。

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