SQLAlchemy Mixins继承方法及可变关联关系实现咨询

问题根源 #

@declared_attr装饰的方法仅接收cls作为唯一入参，由SQLAlchemy声明式系统在映射类构建阶段自动调用，不支持自定义额外参数，也不需要手动在子类__init__中调用，因此你之前给target_id增加targetTable参数的写法不符合规范，会触发参数缺失报错。

实现思路 #

通过约定子类配置类属性的方式传递关联参数，Mixin内部通过cls读取子类的配置属性，动态生成外键和关联关系即可。

通用Mixin代码 #

from sqlalchemy import Column, ForeignKey, Integer, String
from sqlalchemy.orm import declared_attr, relationship
from sqlalchemy.ext.declarative import declarative_mixin, declarative_base

Base = declarative_base()

@declarative_mixin
class GenericRelMixin:
    # 子类必填配置：关联模型类/类名字符串
    __rel_model__ = None
    # 子类必填配置：关联表名
    __rel_table__ = None
    # 子类可选配置：外键字段名，默认xxx_id，xxx为关联表名
    __rel_fk_column__ = None
    # 子类可选配置：关联表的关联字段，默认id
    __rel_target_column__ = "id"
    # 子类可选配置：relationship懒加载策略
    __rel_lazy__ = "select"
    # 子类可选配置：反向引用名
    __rel_backref__ = None

    @declared_attr
    def rel_id(cls):
        if not cls.__rel_model__ or not cls.__rel_table__:
            raise ValueError("继承GenericRelMixin必须配置__rel_model__和__rel_table__属性")
        # 生成外键字段名
        fk_col = cls.__rel_fk_column__ or f"{cls.__rel_table__.rstrip('s')}_id"
        # 生成外键关联字符串
        fk_str = f"{cls.__rel_table__}.{cls.__rel_target_column__}"
        return Column(fk_col, ForeignKey(fk_str), nullable=False)

    @declared_attr
    def rel(cls):
        return relationship(
            cls.__rel_model__,
            lazy=cls.__rel_lazy__,
            backref=cls.__rel_backref__
        )

使用示例 #

# 先定义待关联的目标模型
class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String(32))

# 子类继承Mixin，传入关联配置即可
class Article(Base, GenericRelMixin):
    __tablename__ = "articles"
    id = Column(Integer, primary_key=True)
    title = Column(String(128))
    # 配置关联参数
    __rel_model__ = User
    __rel_table__ = "users"
    # 可选自定义外键字段名为user_id
    __rel_fk_column__ = "user_id"
    # 可选自定义反向引用，User实例可以直接.articles获取对应文章
    __rel_backref__ = "articles"

如果需要在同一个子类中关联多个不同的模型，可以针对不同关联场景写多个专用Mixin，或者进一步扩展Mixin的配置规则适配多关联需求。

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