sqlmodel 0.0.41__tar.gz → 0.0.43__tar.gz

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlmodel
-Version: 0.0.41
+Version: 0.0.43
 Summary: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License-Expression: MIT

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "pydantic>=2.11.0",
     "typing-extensions>=4.5.0",
 ]
-version = "0.0.41"
+version = "0.0.43"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/sqlmodel"

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/scripts/lint.sh

@@ -3,7 +3,6 @@
 set -e
 set -x
 
-ty check sqlmodel
-ty check tests/test_select_typing.py
+ty check sqlmodel tests/test_field_sa_type.py tests/test_select_typing.py
 ruff check sqlmodel tests docs_src scripts
 ruff format sqlmodel tests docs_src scripts --check

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/sqlmodel/__init__.py

@@ -1,4 +1,8 @@
-__version__ = "0.0.41"
+__version__ = "0.0.43"
+
+# Re-export from Pydantic
+from pydantic import Discriminator as Discriminator
+from pydantic import Tag as Tag
 
 # Re-export from SQLAlchemy
 from sqlalchemy.engine import create_engine as create_engine

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/sqlmodel/main.py

@@ -24,7 +24,7 @@ from typing import (
     overload,
 )
 
-from pydantic import BaseModel, EmailStr
+from pydantic import BaseModel, Discriminator, EmailStr
 from pydantic.fields import FieldInfo as PydanticFieldInfo
 from sqlalchemy import (
     Boolean,
@@ -51,6 +51,7 @@ from sqlalchemy.orm.decl_api import DeclarativeMeta
 from sqlalchemy.orm.instrumentation import is_instrumented
 from sqlalchemy.sql.schema import MetaData
 from sqlalchemy.sql.sqltypes import LargeBinary, Time, Uuid
+from sqlalchemy.types import TypeEngine
 from typing_extensions import deprecated
 
 from ._compat import (
@@ -89,6 +90,7 @@ IncEx: TypeAlias = (
     | Mapping[int, Union["IncEx", bool]]
     | Mapping[str, Union["IncEx", bool]]
 )
+SaTypeOrInstance: TypeAlias = TypeEngine[Any] | type[TypeEngine[Any]]
 OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]
 
 MIN_ITEMS_DEPRECATION_MSG = (
@@ -161,6 +163,11 @@ class FieldInfo(PydanticFieldInfo):  # ty: ignore[subclass-of-final-class]
                 raise RuntimeError(
                     "Passing sa_type is not supported when also passing a sa_column"
                 )
+        if sa_column_kwargs is not Undefined and "type_" in sa_column_kwargs:
+            raise RuntimeError(
+                "Passing type_ is not supported in sa_column_kwargs, "
+                "use sa_type instead"
+            )
         if ondelete is not Undefined:
             if foreign_key is Undefined:
                 raise RuntimeError("ondelete can only be used with foreign_key")
@@ -217,7 +224,7 @@ class FieldInfoMetadata:
     ondelete: OnDeleteType | UndefinedType = Undefined
     unique: bool | UndefinedType = Undefined
     index: bool | UndefinedType = Undefined
-    sa_type: type[Any] | UndefinedType = Undefined
+    sa_type: SaTypeOrInstance | UndefinedType = Undefined
     sa_column: Column[Any] | UndefinedType = Undefined
     sa_column_args: Sequence[Any] | UndefinedType = Undefined
     sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined
@@ -275,14 +282,14 @@ def Field(
     max_length: int | None = None,
     allow_mutation: bool = True,
     regex: str | None = None,
-    discriminator: str | None = None,
+    discriminator: str | Discriminator | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
     foreign_key: Any = Undefined,
     unique: bool | UndefinedType = Undefined,
     nullable: bool | UndefinedType = Undefined,
     index: bool | UndefinedType = Undefined,
-    sa_type: type[Any] | UndefinedType = Undefined,
+    sa_type: SaTypeOrInstance | UndefinedType = Undefined,
     sa_column_args: Sequence[Any] | UndefinedType = Undefined,
     sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined,
     schema_extra: dict[str, Any] | None = None,
@@ -324,7 +331,7 @@ def Field(
     max_length: int | None = None,
     allow_mutation: bool = True,
     regex: str | None = None,
-    discriminator: str | None = None,
+    discriminator: str | Discriminator | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
     foreign_key: str,
@@ -332,7 +339,7 @@ def Field(
     unique: bool | UndefinedType = Undefined,
     nullable: bool | UndefinedType = Undefined,
     index: bool | UndefinedType = Undefined,
-    sa_type: type[Any] | UndefinedType = Undefined,
+    sa_type: SaTypeOrInstance | UndefinedType = Undefined,
     sa_column_args: Sequence[Any] | UndefinedType = Undefined,
     sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined,
     schema_extra: dict[str, Any] | None = None,
@@ -382,7 +389,7 @@ def Field(
     max_length: int | None = None,
     allow_mutation: bool = True,
     regex: str | None = None,
-    discriminator: str | None = None,
+    discriminator: str | Discriminator | None = None,
     repr: bool = True,
     sa_column: Column[Any] | UndefinedType = Undefined,
     schema_extra: dict[str, Any] | None = None,
@@ -421,7 +428,7 @@ def Field(
     max_length: int | None = None,
     allow_mutation: bool = True,
     regex: str | None = None,
-    discriminator: str | None = None,
+    discriminator: str | Discriminator | None = None,
     repr: bool = True,
     primary_key: bool | UndefinedType = Undefined,
     foreign_key: Any = Undefined,
@@ -429,7 +436,7 @@ def Field(
     unique: bool | UndefinedType = Undefined,
     nullable: bool | UndefinedType = Undefined,
     index: bool | UndefinedType = Undefined,
-    sa_type: type[Any] | UndefinedType = Undefined,
+    sa_type: SaTypeOrInstance | UndefinedType = Undefined,
     sa_column: Column | UndefinedType = Undefined,
     sa_column_args: Sequence[Any] | UndefinedType = Undefined,
     sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined,
@@ -834,7 +841,7 @@ def get_column_from_field(field: Any) -> Column:
     )
     if sa_column_kwargs is not Undefined:
         kwargs.update(cast(dict[Any, Any], sa_column_kwargs))
-    return Column(sa_type, *args, **kwargs)
+    return Column(*args, type_=sa_type, **kwargs)
 
 
 default_registry = registry()

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/tests/test_field_sa_args_kwargs.py

@@ -1,4 +1,7 @@
-from sqlalchemy import ForeignKey
+from typing import Any
+
+import pytest
+from sqlalchemy import ForeignKey, Integer, String
 from sqlmodel import Field, SQLModel, create_engine
 
 
@@ -35,3 +38,18 @@ def test_sa_column_kargs(clear_sqlmodel, caplog) -> None:
         message for message in caplog.messages if "CREATE TABLE item" in message
     ][0]
     assert "PRIMARY KEY (id)" in create_table_log
+
+
+@pytest.mark.parametrize(
+    "field_kwargs",
+    [
+        {"sa_column_kwargs": {"type_": Integer}},
+        {"sa_type": String, "sa_column_kwargs": {"type_": Integer}},
+    ],
+)
+def test_sa_column_kwargs_type_raises(field_kwargs: dict[str, Any]) -> None:
+    with pytest.raises(
+        RuntimeError,
+        match="Passing type_ is not supported in sa_column_kwargs, use sa_type instead",
+    ):
+        Field(**field_kwargs)

sqlmodel-0.0.43/tests/test_field_sa_type.py

@@ -0,0 +1,22 @@
+from typing import Any, cast
+
+from sqlalchemy import Integer, String
+from sqlmodel import Field, SQLModel
+
+
+def test_sa_type_class() -> None:
+    class Item(SQLModel, table=True):
+        id: int = Field(primary_key=True, sa_type=Integer)
+
+    id_column = cast(Any, Item).id
+    assert isinstance(id_column.type, Integer)
+
+
+def test_sa_type_instance() -> None:
+    class Item(SQLModel, table=True):
+        id: int = Field(primary_key=True)
+        name: str = Field(sa_type=String(50))
+
+    name_column = cast(Any, Item).name
+    assert isinstance(name_column.type, String)
+    assert name_column.type.length == 50

{sqlmodel-0.0.41 → sqlmodel-0.0.43}/tests/test_pydantic/test_field.py

@@ -1,9 +1,9 @@
 from decimal import Decimal
-from typing import Literal
+from typing import Annotated, Any, Literal
 
 import pytest
 from pydantic import ValidationError
-from sqlmodel import Field, SQLModel
+from sqlmodel import Discriminator, Field, SQLModel, Tag
 
 
 def test_decimal():
@@ -47,6 +47,38 @@ def test_discriminator():
         Model(pet={"pet_type": "dog"}, n=1)  # type: ignore[arg-type]
 
 
+def test_discriminator_callable():
+    # Example adapted from
+    # [Pydantic docs](https://docs.pydantic.dev/latest/concepts/unions/#discriminated-unions-with-callable-discriminator):
+
+    class Pie(SQLModel):
+        pass
+
+    class ApplePie(Pie):
+        fruit: Literal["apple"] = "apple"
+
+    class PumpkinPie(Pie):
+        filling: Literal["pumpkin"] = "pumpkin"
+
+    def get_discriminator_value(v: Any) -> str:
+        if isinstance(v, dict):
+            return v.get("fruit", v.get("filling"))
+        return getattr(v, "fruit", getattr(v, "filling", None))
+
+    class ThanksgivingDinner(SQLModel):
+        dessert: (
+            Annotated[ApplePie, Tag("apple")] | Annotated[PumpkinPie, Tag("pumpkin")]
+        ) = Field(
+            discriminator=Discriminator(get_discriminator_value),
+        )
+
+    apple_pie = ThanksgivingDinner.model_validate({"dessert": {"fruit": "apple"}})
+    assert isinstance(apple_pie.dessert, ApplePie)
+
+    pumpkin_pie = ThanksgivingDinner.model_validate({"dessert": {"filling": "pumpkin"}})
+    assert isinstance(pumpkin_pie.dessert, PumpkinPie)
+
+
 def test_repr():
     class Model(SQLModel):
         id: int | None = Field(primary_key=True)