📝 Enhance type alias handling in compatibility module and tests for Python 3.12

Author: stickm4n

sqlmodel/_compat.py

@@ -1,5 +1,6 @@
 import sys
 import types
+import typing
 from contextlib import contextmanager
 from contextvars import ContextVar
 from dataclasses import dataclass
@@ -19,6 +20,7 @@
     Union,
 )
 
+import typing_extensions
 from pydantic import VERSION as P_VERSION
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
@@ -74,9 +76,6 @@ def partial_init() -> Generator[None, None, None]:
 
 
 if IS_PYDANTIC_V2:
-    if sys.version_info >= (3, 12):
-        from typing import TypeAliasType
-
     from annotated_types import MaxLen
     from pydantic import ConfigDict as BaseConfig
     from pydantic._internal._fields import PydanticMetadata
@@ -202,11 +201,24 @@ def is_field_noneable(field: "FieldInfo") -> bool:
             return False
         return False
 
+    def _is_type_alias_type_instance(annotation: Any) -> bool:
+        type_to_check = "TypeAliasType"
+        in_typing = hasattr(typing, type_to_check)
+        in_typing_extensions = hasattr(typing_extensions, type_to_check)
+
+        check_type = []
+        if in_typing:
+            check_type.append(typing.TypeAliasType)
+        if in_typing_extensions:
+            check_type.append(typing_extensions.TypeAliasType)
+
+        return check_type and isinstance(annotation, tuple(check_type))
+
     def get_sa_type_from_type_annotation(annotation: Any) -> Any:
         # Resolve Optional fields
         if annotation is None:
             raise ValueError("Missing field type")
-        if sys.version_info >= (3, 12) and isinstance(annotation, TypeAliasType):
+        if _is_type_alias_type_instance(annotation):
             annotation = annotation.__value__
         origin = get_origin(annotation)
         if origin is None:

tests/test_field_sa_type.py

@@ -1,63 +1,118 @@
-import sys
-from typing import Annotated, TypeAlias
+import typing as t
 
+import typing_extensions as te
 from sqlmodel import Field, SQLModel
 
 from tests.conftest import needs_py312
 
 
 @needs_py312
-def test_sa_type_1() -> None:
-    Type1 = str
+def test_sa_type_typing_1() -> None:
+    Type1_t = str
 
     class Hero1(SQLModel, table=True):
         pk: int = Field(primary_key=True)
-        weapon: Type1 = "sword"
+        weapon: Type1_t = "sword"
 
 
 @needs_py312
-def test_sa_type_2() -> None:
-    Type2 = Annotated[str, "Just a comment"]
+def test_sa_type_typing_2() -> None:
+    Type2_t = t.Annotated[str, "Just a comment"]
 
     class Hero(SQLModel, table=True):
         pk: int = Field(primary_key=True)
-        weapon: Type2 = "sword"
+        weapon: Type2_t = "sword"
 
 
-Type3: TypeAlias = str
+Type3_t: t.TypeAlias = str
 
 
 @needs_py312
-def test_sa_type_3() -> None:
+def test_sa_type_typing_3() -> None:
     class Hero(SQLModel, table=True):
         pk: int = Field(primary_key=True)
-        weapon: Type3 = "sword"
+        weapon: Type3_t = "sword"
 
 
-Type4: TypeAlias = Annotated[str, "Just a comment"]
+Type4_t: t.TypeAlias = t.Annotated[str, "Just a comment"]
 
 
 @needs_py312
-def test_sa_type_4() -> None:
+def test_sa_type_typing_4() -> None:
     class Hero(SQLModel, table=True):
         pk: int = Field(primary_key=True)
-        weapon: Type4 = "sword"
+        weapon: Type4_t = "sword"
 
 
-if sys.version_info >= (3, 12):
+@needs_py312
+def test_sa_type_typing_5() -> None:
+    type Type5_t = str
+
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type5_t = "sword"
+
+
+@needs_py312
+def test_sa_type_typing_6() -> None:
+    type Type6_t = t.Annotated[str, "Just a comment"]
+
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type6_t = "sword"
+
+
+@needs_py312
+def test_sa_type_typing_extensions_1() -> None:
+    Type1_te = str
+
+    class Hero1(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type1_te = "sword"
+
+
+@needs_py312
+def test_sa_type_typing_extensions_2() -> None:
+    Type2_te = te.Annotated[str, "Just a comment"]
+
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type2_te = "sword"
 
-    @needs_py312
-    def test_sa_type_5() -> None:
-        type Type5 = str
 
-        class Hero(SQLModel, table=True):
-            pk: int = Field(primary_key=True)
-            weapon: Type5 = "sword"
+Type3_te: te.TypeAlias = str
 
-    @needs_py312
-    def test_sa_type_6() -> None:
-        type Type6 = Annotated[str, "Just a comment"]
 
-        class Hero(SQLModel, table=True):
-            pk: int = Field(primary_key=True)
-            weapon: Type6 = "sword"
+@needs_py312
+def test_sa_type_typing_extensions_3() -> None:
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type3_te = "sword"
+
+
+Type4_te: te.TypeAlias = te.Annotated[str, "Just a comment"]
+
+
+@needs_py312
+def test_sa_type_typing_extensions_4() -> None:
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type4_te = "sword"
+
+
+@needs_py312
+def test_sa_type_typing_extensions_5() -> None:
+    type Type5_te = str
+
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type5_te = "sword"
+
+
+@needs_py312
+def test_sa_type_typing_extensions_6() -> None:
+    type Type6_te = te.Annotated[str, "Just a comment"]
+
+    class Hero(SQLModel, table=True):
+        pk: int = Field(primary_key=True)
+        weapon: Type6_te = "sword"