SQLAlchemy高级关联代理示例：实现多层嵌套的字典集合结构-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01012/article/details/148577506

SQLAlchemy高级关联代理示例：实现多层嵌套的字典集合结构

sqlalchemy THIS IS NOT THE OFFICIAL REPO - PLEASE SUBMIT PRs ETC AT: http://github.com/sqlalchemy/sqlalchemy 项目地址: https://gitcode.com/gh_mirrors/sql/sqlalchemy

概述

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

技术背景

在关系型数据库中，我们经常需要处理复杂的数据结构。传统做法是直接操作数据库表和它们之间的关系，但这往往会导致代码变得冗长且难以维护。SQLAlchemy的关联代理提供了一种优雅的解决方案，它允许我们在Python层面操作这些关系，就像操作普通的Python数据结构一样。

模型设计

这个示例包含三个主要模型：

A类：顶层模型，包含一个字典结构
B类：中间模型，作为字典的键值对存储
C类：底层模型，存储实际的整数值

核心实现细节

自定义字典集合类

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

这个自定义字典类实现了__missing__方法，使得当访问不存在的键时，会自动创建一个新的B实例并添加到字典中。这模仿了Python标准库中collections.defaultdict的行为。

关联代理配置

在A类中，我们设置了两个关键属性：

associations = relationship(
    "B",
    collection_class=lambda: GenDefaultCollection(
        operator.attrgetter("key")
    ),
)

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

collections代理属性允许我们直接操作A实例的字典结构，而无需关心底层的B和C模型。

级联代理

B类中也定义了一个关联代理：

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

这使得我们可以通过a1.collections["1"]这样的表达式直接访问和修改整数集合，SQLAlchemy会自动处理所有中间层的对象关系。

使用示例

# 创建并添加初始数据
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])
session.commit()

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