sqlmodel 0.0.42__tar.gz → 0.0.44__tar.gz

{sqlmodel-0.0.42 → sqlmodel-0.0.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlmodel
-Version: 0.0.42
+Version: 0.0.44
 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.42 → sqlmodel-0.0.44}/pyproject.toml

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

{sqlmodel-0.0.42 → sqlmodel-0.0.44}/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_dataclass_transform.py 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.42 → sqlmodel-0.0.44}/sqlmodel/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.42"
+__version__ = "0.0.44"
 
 # Re-export from Pydantic
 from pydantic import Discriminator as Discriminator

{sqlmodel-0.0.42 → sqlmodel-0.0.44}/sqlmodel/main.py

@@ -51,7 +51,8 @@ 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 typing_extensions import deprecated
+from sqlalchemy.types import TypeEngine
+from typing_extensions import dataclass_transform, deprecated
 
 from ._compat import (
     PYDANTIC_MINOR_VERSION,
@@ -81,7 +82,6 @@ if TYPE_CHECKING:
     from pydantic_core import PydanticUndefined as Undefined
     from pydantic_core import PydanticUndefinedType as UndefinedType
 
-_T = TypeVar("_T")
 NoArgAnyCallable = Callable[[], Any]
 IncEx: TypeAlias = (
     set[int]
@@ -89,6 +89,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 = (
@@ -99,16 +100,6 @@ MAX_ITEMS_DEPRECATION_MSG = (
 )
 
 
-def __dataclass_transform__(
-    *,
-    eq_default: bool = True,
-    order_default: bool = False,
-    kw_only_default: bool = False,
-    field_descriptors: tuple[type | Callable[..., Any], ...] = (()),
-) -> Callable[[_T], _T]:
-    return lambda a: a
-
-
 class FieldInfo(PydanticFieldInfo):  # ty: ignore[subclass-of-final-class]
     # mypy - ignore that PydanticFieldInfo is @final
     def __init__(self, default: Any = Undefined, **kwargs: Any) -> None:
@@ -161,6 +152,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 +213,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
@@ -282,7 +278,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,
@@ -332,7 +328,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,
@@ -429,7 +425,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,
@@ -558,7 +554,7 @@ def Relationship(
     return relationship_info
 
 
-@__dataclass_transform__(kw_only_default=True, field_descriptors=(Field, FieldInfo))
+@dataclass_transform(kw_only_default=True, field_specifiers=(Field, FieldInfo))
 class SQLModelMetaclass(ModelMetaclass, DeclarativeMeta):
     __sqlmodel_relationships__: dict[str, RelationshipInfo]
     model_config: SQLModelConfig
@@ -834,7 +830,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.44/tests/test_dataclass_transform.py

@@ -0,0 +1,25 @@
+from typing import TYPE_CHECKING
+
+from sqlmodel import Field, SQLModel
+
+
+def test_field_parameters() -> None:
+    class Hero(SQLModel):
+        name: str = Field()
+        secret_name: str = Field(alias="secretName")
+        age: int = Field(default=42)
+        tags: list[str] = Field(default_factory=list)
+
+    hero = Hero(name="Deadpond", secretName="Dive Wilson")
+    other = Hero(name="Spider-Boy", secretName="Pedro Parqueador")
+
+    assert hero.name == "Deadpond"
+    assert hero.secret_name == "Dive Wilson"
+    assert hero.age == 42
+    assert hero.tags == []
+    assert hero.tags is not other.tags
+
+    if TYPE_CHECKING:
+        Hero(secretName="Dive Wilson")  # ty: ignore[missing-argument]
+        Hero("Deadpond", "Dive Wilson")  # ty: ignore[too-many-positional-arguments, missing-argument]
+        Hero(name=123, secretName="Dive Wilson")  # ty: ignore[invalid-argument-type]

{sqlmodel-0.0.42 → sqlmodel-0.0.44}/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.44/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