Rename model_declarative_base to avoid conflicts with pydantic v2 models model_ attribute namespace

Author: febus982

README.md

@@ -72,7 +72,7 @@ Example:
 bind = sa_manager.get_bind()
 
 
-class MyModel(bind.model_declarative_base):
+class MyModel(bind.declarative_base):
     pass
 
 
@@ -144,7 +144,7 @@ The `SQLAlchemyRepository` and `SQLAlchemyAsyncRepository` class can be used dir
 from sqlalchemy_bind_manager.repository import SQLAlchemyRepository
 
 
-class MyModel(model_declarative_base):
+class MyModel(declarative_base):
     pass
 
 # Direct usage

docs/index.md

@@ -61,7 +61,7 @@ config = SQLAlchemyConfig(
 sa_manager = SQLAlchemyBindManager(config)
 
 # Declare a model
-class MyModel(sa_manager.get_bind().model_declarative_base):
+class MyModel(sa_manager.get_bind().declarative_base):
     id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str] = mapped_column(String(30))
 

docs/manager/alembic/env.py

@@ -27,7 +27,7 @@
 
 sa_manager = SQLAlchemyBindManager(config=bind_config)
 
-class BookModel(sa_manager.get_bind().model_declarative_base):
+class BookModel(sa_manager.get_bind().declarative_base):
     id = Column(Integer)
     title = Column(String)
 ################################################################

docs/manager/config.md

@@ -23,7 +23,7 @@ Once the bind manager is initialised we can retrieve and use the SQLAlchemyBind
 The `SQLAlchemyBind` class has the following attributes:
 
 * `engine`: The initialised SQLALchemy `Engine`
-* `model_declarative_base`: A base class that can be used to create [declarative models](https://docs.sqlalchemy.org/en/14/orm/mapping_styles.html#declarative-mapping)
+* `declarative_base`: A base class that can be used to create [declarative models](https://docs.sqlalchemy.org/en/14/orm/mapping_styles.html#declarative-mapping)
 * `registry_mapper`: The `registry` associated with the `engine`. It can be used with Alembic or to setup [imperative mapping](https://docs.sqlalchemy.org/en/14/orm/mapping_styles.html#imperative-mapping)
 * `session_class`: The class built by [sessionmaker()](https://docs.sqlalchemy.org/en/14/orm/session_api.html#sqlalchemy.orm.sessionmaker), either `Session` or `AsyncSession`
 

docs/manager/models.md

@@ -10,7 +10,7 @@ from sqlalchemy import String
 
 bind = sa_manager.get_bind()
 
-class MyModel(bind.model_declarative_base):
+class MyModel(bind.declarative_base):
     id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str] = mapped_column(String(30))
 ```

docs/repository/usage.md

@@ -6,7 +6,7 @@ The `SQLAlchemyRepository` and `SQLAlchemyAsyncRepository` class can be used dir
 from sqlalchemy_bind_manager.repository import SQLAlchemyRepository
 
 
-class MyModel(model_declarative_base):
+class MyModel(declarative_base):
     pass
 
 # Direct usage

sqlalchemy_bind_manager/_bind_manager.py

@@ -10,7 +10,7 @@
     create_async_engine,
 )
 from sqlalchemy.orm import Session, sessionmaker
-from sqlalchemy.orm.decl_api import registry
+from sqlalchemy.orm.decl_api import DeclarativeMeta, registry
 
 from sqlalchemy_bind_manager.exceptions import (
     InvalidConfig,
@@ -32,7 +32,7 @@ class SQLAlchemyAsyncConfig(BaseModel):
 
 class SQLAlchemyBind(BaseModel):
     engine: Engine
-    model_declarative_base: type
+    declarative_base: DeclarativeMeta
     registry_mapper: registry
     session_class: sessionmaker[Session]
 
@@ -42,7 +42,7 @@ class Config:
 
 class SQLAlchemyAsyncBind(BaseModel):
     engine: AsyncEngine
-    model_declarative_base: type
+    declarative_base: DeclarativeMeta
     registry_mapper: registry
     session_class: async_sessionmaker[AsyncSession]
 
@@ -123,7 +123,7 @@ def __build_sync_bind(
                 class_=Session,
                 **session_options,
             ),
-            model_declarative_base=registry_mapper.generate_base(),
+            declarative_base=registry_mapper.generate_base(),
         )
 
     def __build_async_bind(
@@ -141,7 +141,7 @@ def __build_async_bind(
                 bind=engine,
                 **session_options,
             ),
-            model_declarative_base=registry_mapper.generate_base(),
+            declarative_base=registry_mapper.generate_base(),
         )
 
     def get_binds(self) -> Mapping[str, Union[SQLAlchemyBind, SQLAlchemyAsyncBind]]:

tests/conftest.py

@@ -102,7 +102,7 @@ def sa_bind(request, sa_manager):
 
 @pytest.fixture
 async def model_classes(sa_bind) -> Tuple[Type, Type]:
-    class ParentModel(sa_bind.model_declarative_base):
+    class ParentModel(sa_bind.declarative_base):
         __tablename__ = "parent_model"
         # required in order to access columns with server defaults
         # or SQL expression defaults, subsequent to a flush, without
@@ -119,7 +119,7 @@ class ParentModel(sa_bind.model_declarative_base):
             lazy="selectin",
         )
 
-    class ChildModel(sa_bind.model_declarative_base):
+    class ChildModel(sa_bind.declarative_base):
         __tablename__ = "child_model"
         # required in order to access columns with server defaults
         # or SQL expression defaults, subsequent to a flush, without

tests/repository/test_composite_pk.py

@@ -26,7 +26,7 @@ def sa_manager() -> SQLAlchemyBindManager:
 def model_class_composite_pk(sa_manager) -> Type:
     default_bind = sa_manager.get_bind()
 
-    class MyModel(default_bind.model_declarative_base):
+    class MyModel(default_bind.declarative_base):
         __tablename__ = "mymodel"
         # required in order to access columns with server defaults
         # or SQL expression defaults, subsequent to a flush, without

tests/repository/test_cursor_paginated_find.py

@@ -7,7 +7,7 @@
 
 @pytest.fixture
 async def model_class_string_pk(sa_bind):
-    class MyModel(sa_bind.model_declarative_base):
+    class MyModel(sa_bind.declarative_base):
         __tablename__ = "mymodel_string_pk"
 
         model_id = Column(String, primary_key=True)