Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

✨ Add support for Literal types #1439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nsaccente wants to merge 24 commits into fastapi:main
base: main
Choose a base branch
Loading
from nsaccente:bugfix-57/literal-satype
Open
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
35c5b40
Add check for Literal type annotation in get_sqlalchemy_type to retur...
nsaccente Jul 24, 2025
e562654
Add unit test for Literal parsing
nsaccente Aug 7, 2025
fcabf3f
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Aug 7, 2025
3d4be3a
Merge branch 'main' into bugfix-57/literal-satype
nsaccente Aug 7, 2025
859a4af
Testing git test runner with commented out code
nsaccente Aug 7, 2025
e193bcd
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Aug 7, 2025
cdc863d
Test literal patch in _compat
nsaccente Aug 7, 2025
3c024e2
Merge branch 'bugfix-57/literal-satype' of github.com:nsaccente/sqlmo...
nsaccente Aug 7, 2025
73c5e46
Merge branch 'main' into bugfix-57/literal-satype
svlandeg Aug 22, 2025
4e8b303
import Literal from typing or typing_extensions
svlandeg Aug 22, 2025
c659666
fix import of AutoString
svlandeg Aug 22, 2025
ce968ea
avoid circular import
svlandeg Aug 22, 2025
e522d9d
fix case where AutoString is being converted
svlandeg Aug 26, 2025
510e421
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Aug 26, 2025
9068bad
fix enum cast
svlandeg Aug 26, 2025
545a55a
set typing-modules to avoid ruff error
svlandeg Aug 26, 2025
1fc1717
simply import Literal from typing_extensions always
svlandeg Aug 27, 2025
e4a5f6e
Merge branch 'main' into bugfix-57/literal-satype
svlandeg Aug 27, 2025
ab774b5
commit suggestion by Yurii
svlandeg Aug 27, 2025
7e55022
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Aug 27, 2025
1f0e0ea
cleanup
svlandeg Aug 27, 2025
303f10f
Merge branch 'main' into bugfix-57/literal-satype
nsaccente Aug 27, 2025
11cc55e
Handle special cases with `Literal` (all `int` and all `bool`)
YuriiMotov Sep 30, 2025
ae3d3ef
Merge branch 'main' into bugfix-57/literal-satype
YuriiMotov Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ disallow_untyped_defs = false
disallow_untyped_calls = false

[tool.ruff.lint]
typing-modules = ["sqlmodel._compat"]
select = [
"E", # pycodestyle errors
"W", # pycodestyle warnings
Expand Down
13 changes: 12 additions & 1 deletion sqlmodel/_compat.py
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import sys
import types
from contextlib import contextmanager
from contextvars import ContextVar
Expand All @@ -23,6 +24,8 @@
from pydantic.fields import FieldInfo
from typing_extensions import Annotated, get_args, get_origin

from .sql.sqltypes import AutoString

# Reassign variable to make it reexported for mypy
PYDANTIC_VERSION = P_VERSION
PYDANTIC_MINOR_VERSION = tuple(int(i) for i in P_VERSION.split(".")[:2])
Expand Down Expand Up @@ -62,6 +65,12 @@ def _is_union_type(t: Any) -> bool:
return t is UnionType or t is Union


if sys.version_info >= (3, 9):
from typing import Literal
else:
from typing_extensions import Literal


finish_init: ContextVar[bool] = ContextVar("finish_init", default=True)


Expand Down Expand Up @@ -459,7 +468,9 @@ def is_field_noneable(field: "FieldInfo") -> bool:
return field.allow_none # type: ignore[no-any-return, attr-defined]

def get_sa_type_from_field(field: Any) -> Any:
if isinstance(field.type_, type) and field.shape == SHAPE_SINGLETON:
if get_origin(field.type_) is Literal:
return AutoString
elif isinstance(field.type_, type) and field.shape == SHAPE_SINGLETON:
return field.type_
raise ValueError(f"The field {field.name} has no matching SQLAlchemy type")

Expand Down
13 changes: 11 additions & 2 deletions sqlmodel/main.py
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
inspect,
)
from sqlalchemy import Enum as sa_Enum
from sqlalchemy import types as sa_types
from sqlalchemy.orm import (
Mapped,
RelationshipProperty,
Expand All @@ -52,12 +53,13 @@
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 Literal, TypeAlias, deprecated, get_origin
from typing_extensions import TypeAlias, deprecated, get_origin

from ._compat import ( # type: ignore[attr-defined]
IS_PYDANTIC_V2,
PYDANTIC_MINOR_VERSION,
BaseConfig,
Literal,
ModelField,
ModelMetaclass,
Representation,
Expand Down Expand Up @@ -655,9 +657,16 @@ def get_sqlalchemy_type(field: Any) -> Any:
type_ = get_sa_type_from_field(field)
metadata = get_field_metadata(field)

# If it's already an SQLAlchemy type (eg. AutoString), use it directly
if isinstance(type_, type) and issubclass(type_, sa_types.TypeEngine):
return type_

# Checks for `Literal` type annotation
if type_ is Literal:
return AutoString
# Check enums first as an enum can also be a str, needed by Pydantic/FastAPI
if issubclass(type_, Enum):
return sa_Enum(type_)
return sa_Enum(cast(Type[Enum], type_))
if issubclass(
type_,
(
Expand Down
23 changes: 23 additions & 0 deletions tests/test_main.py
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from sqlalchemy.exc import IntegrityError
from sqlalchemy.orm import RelationshipProperty
from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select
from sqlmodel._compat import Literal


def test_should_allow_duplicate_row_if_unique_constraint_is_not_passed(clear_sqlmodel):
Expand Down Expand Up @@ -125,3 +126,25 @@ class Hero(SQLModel, table=True):
# The next statement should not raise an AttributeError
assert hero_rusty_man.team
assert hero_rusty_man.team.name == "Preventers"


def test_literal_typehints_are_treated_as_strings(clear_sqlmodel):
"""Test https://github.com/fastapi/sqlmodel/issues/57"""

class Hero(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)
name: str = Field(unique=True)
weakness: Literal["Kryptonite", "Dehydration", "Munchies"]

superguy = Hero(name="Superguy", weakness="Kryptonite")

engine = create_engine("sqlite://", echo=True)

SQLModel.metadata.create_all(engine)

with Session(engine) as session:
session.add(superguy)
session.commit()
session.refresh(superguy)
assert superguy.weakness == "Kryptonite"
assert isinstance(superguy.weakness, str)

AltStyle によって変換されたページ (->オリジナル) /