SQLAlchemy高级关联代理示例：实现类似defaultdict的多级集合结构-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00612/article/details/148415580

SQLAlchemy高级关联代理示例：实现类似defaultdict的多级集合结构

sqlalchemy The Database Toolkit for Python 项目地址: https://gitcode.com/gh_mirrors/sq/sqlalchemy

概述

在SQLAlchemy中，关联代理(association proxy)是一个非常强大的特性，它允许开发者创建虚拟属性，这些属性可以透明地访问关联对象中的属性。本文将通过一个高级示例，展示如何使用SQLAlchemy的关联代理功能构建一个类似Python标准库中collections.defaultdict的嵌套数据结构——具体来说，是一个字典结构，其中每个键对应一个整数集合。

核心概念解析

关联代理(Association Proxy)

关联代理是SQLAlchemy提供的一个扩展功能，它允许我们在模型之间创建"虚拟"属性，这些属性实际上是对关联对象属性的透明访问。在本例中，我们使用了两层关联代理：

第一层：从A类到B类的values属性
第二层：从B类到C类的value属性

自定义集合类

为了实现类似defaultdict的行为，我们继承了KeyFuncDict类并实现了__missing__方法。当访问不存在的键时，这个方法会被自动调用，我们可以在这里创建新的B对象并返回。

模型结构分析

这个示例使用了三个模型类，构成了一个三级关联结构：

A类：顶层模型，包含一个字典结构的关联
B类：中间模型，存储字典的键和关联的集合
C类：底层模型，存储实际的整数值

A类详解

class A(Base):
    __tablename__ = "a"
    associations = relationship(
        "B",
        collection_class=lambda: GenDefaultCollection(
            operator.attrgetter("key")
        ),
    )

    collections = association_proxy("associations", "values")

associations：这是一个常规的SQLAlchemy关系，但使用了自定义的集合类GenDefaultCollection
collections：这是一个关联代理，它桥接了A类的associations属性和B类的values属性

B类详解

class B(Base):
    __tablename__ = "b"
    a_id = Column(Integer, ForeignKey("a.id"), nullable=False)
    elements = relationship("C", collection_class=set)
    key = Column(String)

    values = association_proxy("elements", "value")

elements：这是一个指向C类的关系，使用Python的set作为集合类
values：关联代理，桥接B类的elements和C类的value属性

C类详解

class C(Base):
    __tablename__ = "c"
    b_id = Column(Integer, ForeignKey("b.id"), nullable=False)
    value = Column(Integer)

这是最简单的模型，只存储一个整数值。

实现原理

这个示例的核心在于GenDefaultCollection类，它继承了KeyFuncDict并实现了__missing__方法：

class GenDefaultCollection(KeyFuncDict):
    def __missing__(self, key):
        self[key] = b = B(key)
        return b

当访问字典中不存在的键时，__missing__方法会被调用，它会：

创建一个新的B对象
将这个对象添加到字典中
返回这个新对象

这模拟了Python标准库中collections.defaultdict的行为。

使用示例

# 创建并提交初始数据
session.add_all([A(collections={"1": {1, 2, 3}})])
session.commit()

# 查询并操作数据
a1 = session.query(A).first()
print(a1.collections["1"])  # 输出: {1, 2, 3}
a1.collections["1"].add(4)  # 添加元素到现有集合
session.commit()

a1.collections["2"].update([7, 8, 9])  # 自动创建新键"2"并添加元素
session.commit()

print(a1.collections["2"])  # 输出: {7, 8, 9}