Using configure_mappers (for sqlalchemy-history)

[Matthieu-LAURENT39]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

# SQLAlchemy version
from sqlalchemy_history import make_versioned
from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
from sqlalchemy.orm import declarative_base
from sqlalchemy.orm import create_session, configure_mappers

make_versioned(user_cls=None)
Base = declarative_base()


class Article(Base):
    __versioned__ = {}
    __tablename__ = "article"
    id = Column(Integer, primary_key=True, autoincrement=True)
    name = Column(Unicode(255))
    content = Column(UnicodeText)


configure_mappers()
engine = create_engine("sqlite://")
Base.metadata.create_all(engine)
session = create_session(bind=engine, autocommit=False)
article = Article(name="Some article", content="Some content")
session.add(article)
session.commit()
print(article.versions[0].name)  # 'Some article'
article.name = "Updated name"
session.commit()
print(article.versions[1].name)  # 'Updated name'
article.versions[0].revert()
print(article.name)  # 'Some article'

# ==================================================================
# SQLModel version

from sqlalchemy_history import make_versioned
from sqlmodel import SQLModel, Field, create_engine, Session

# This doesn't exist in SQLModel, so we need to import it from SQLAlchemy
from sqlalchemy.orm import configure_mappers

make_versioned(user_cls=None)


class Article(SQLModel, table=True):
    __versioned__ = {}
    __tablename__ = "article"
    id: int = Field(primary_key=True)
    name: str
    content: str


# Raises: "AttributeError: registry"
configure_mappers()

engine = create_engine("sqlite://")
SQLModel.metadata.create_all(engine)
with Session(engine) as session:
    article = Article(name="Some article", content="Some content")
    session.add(article)
    session.commit()

    print(article.versions[0].name)  # 'Some article'
    article.name = "Updated name"
    session.commit()
    print(article.versions[1].name)  # 'Updated name'
    article.versions[0].revert()
    print(article.name)  # 'Some article'

Description

Hello,

I'm currently trying to use sqlalchemy-history with SQLModel.
I ported their example code to SQLModel, but there is a need to call configure_mappers().
I couldn't find it anywhere in SQLModel, and using the one from SQLAlchemy gives AttributeError: registry.
Fully removing the configure_mappers() call causes the same AttributeError when creating the first Article.

Am i missing something? What's the proper way to use sqlalchemy-history with SQLModel, if any?

Operating System

Linux

Operating System Details

No response

SQLModel Version

0.0.14

Python Version

Python 3.11.6

Additional Context

No response