fix(typing): export SQLModelConfig and allow ConfigDict for model_config (#2091)

Signed-off-by: DYNOSuprovo <DYNOSuprovo@users.noreply.github.com>

Author: DYNOSuprovo

sqlmodel/__init__.py

@@ -1,6 +1,7 @@
 __version__ = "0.0.46"
 
 # Re-export from Pydantic
+from pydantic import ConfigDict as ConfigDict
 from pydantic import Discriminator as Discriminator
 from pydantic import Tag as Tag
 
@@ -121,6 +122,7 @@
 from .main import Field as Field
 from .main import Relationship as Relationship
 from .main import SQLModel as SQLModel
+from .main import SQLModelConfig as SQLModelConfig
 from .orm.session import Session as Session
 from .sql.expression import all_ as all_
 from .sql.expression import and_ as and_

sqlmodel/main.py

@@ -57,9 +57,9 @@
 from ._compat import (
     PYDANTIC_MINOR_VERSION,
     BaseConfig,
+    ConfigDict,
     ModelMetaclass,
     Representation,
-    SQLModelConfig,
     Undefined,
     UndefinedType,
     finish_init,
@@ -74,6 +74,9 @@
     sqlmodel_init,
     sqlmodel_validate,
 )
+from ._compat import (
+    SQLModelConfig as SQLModelConfig,
+)
 from .sql.sqltypes import AutoString, UTCDateTime
 
 if TYPE_CHECKING:
@@ -557,7 +560,7 @@ def Relationship(
 @dataclass_transform(kw_only_default=True, field_specifiers=(Field, FieldInfo))
 class SQLModelMetaclass(ModelMetaclass, DeclarativeMeta):
     __sqlmodel_relationships__: dict[str, RelationshipInfo]
-    model_config: SQLModelConfig
+    model_config: SQLModelConfig | ConfigDict | dict[str, Any]
     model_fields: ClassVar[dict[str, FieldInfo]]
 
     # Replicate SQLAlchemy

tests/test_pydantic/test_model_config.py

@@ -0,0 +1,59 @@
+from pydantic import ConfigDict as PydanticConfigDict
+from sqlmodel import ConfigDict, Field, SQLModel, SQLModelConfig
+
+
+def test_sqlmodel_config_export():
+    import sqlmodel
+    import sqlmodel.main
+
+    assert hasattr(sqlmodel, "SQLModelConfig")
+    assert hasattr(sqlmodel.main, "SQLModelConfig")
+    assert hasattr(sqlmodel, "ConfigDict")
+    assert sqlmodel.SQLModelConfig is SQLModelConfig
+    assert sqlmodel.ConfigDict is ConfigDict
+
+
+def test_model_with_sqlmodel_config():
+    class Item(SQLModel):
+        id: int
+        name: str
+        model_config = SQLModelConfig(from_attributes=True)
+
+    assert Item.model_config.get("from_attributes") is True
+
+
+def test_model_with_sqlmodel_reexported_config_dict():
+    class Item(SQLModel):
+        id: int
+        name: str
+        model_config = ConfigDict(from_attributes=True)
+
+    assert Item.model_config.get("from_attributes") is True
+
+
+def test_model_with_pydantic_config_dict():
+    class Item(SQLModel):
+        id: int
+        name: str
+        model_config = PydanticConfigDict(from_attributes=True)
+
+    assert Item.model_config.get("from_attributes") is True
+
+
+def test_model_with_plain_dict_config():
+    class Item(SQLModel):
+        id: int
+        name: str
+        model_config = {"from_attributes": True}
+
+    assert Item.model_config.get("from_attributes") is True
+
+
+def test_table_model_with_sqlmodel_config():
+    class Hero(SQLModel, table=True):
+        id: int | None = Field(default=None, primary_key=True)
+        name: str
+        model_config = SQLModelConfig(extra="ignore")
+
+    assert Hero.model_config.get("extra") == "ignore"
+    assert Hero.model_config.get("table") is True