Skip to content

Added typecheck to sqlalchemy JSON #931

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

Added typecheck to sqlalchemy JSON #931

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
19859fa
Added typecheck to sqlalchemy JSON
LucaGelmini May 8, 2024
87401ca
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] May 8, 2024
44d0d79
Merge branch 'main' into patch-1
LucaGelmini May 13, 2024
e0df9d8
Merge branch 'main' into patch-1
LucaGelmini Jul 29, 2024
367b317
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Jul 29, 2024
65b3c1d
Update main.py
LucaGelmini Jul 29, 2024
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
4 changes: 3 additions & 1 deletion sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +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
from sqlalchemy.sql.sqltypes import JSON, LargeBinary, Time
from typing_extensions import Literal, deprecated, get_origin

from ._compat import ( # type: ignore[attr-defined]
Expand Down Expand Up @@ -612,6 +612,8 @@ def get_sqlalchemy_type(field: Any) -> Any:
return AutoString
if issubclass(type_, uuid.UUID):
return GUID
Copy link
Author

@LucaGelmini LucaGelmini Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This type was not imported, is better to return sqlalchemy UUID type. That's why test are failing

if issubclass(type_, JSON):
return JSON
Copy link

@MRigal MRigal Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you want issubclass(type_, Mapping) rather here?

Also it is probably not clear if JSON or JSONB is the desired type.

Maybe better to document the workaround in the docs

Copy link
Member

@YuriiMotov YuriiMotov Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't it be if issubclass(type_, pydantic.Json): instead?
Or better

    if issubclass(type_, (Sequence, Mapping, Json)):
        return JSON

raise ValueError(f"{type_} has no matching SQLAlchemy type")


Expand Down