Skip to content
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

fix: add pydantic types to sqlalchemy registry only if pydantic is installed #2252

Merged
Merged
Changes from all commits
Commits
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
28 changes: 15 additions & 13 deletions litestar/contrib/sqlalchemy/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
from typing import TYPE_CHECKING, Any, ClassVar, Protocol, TypeVar, runtime_checkable
from uuid import UUID, uuid4

from pydantic import AnyHttpUrl, AnyUrl, EmailStr
from sqlalchemy import Date, MetaData, Sequence, String
from sqlalchemy.event import listens_for
from sqlalchemy.orm import (
Expand All @@ -24,6 +23,7 @@
if TYPE_CHECKING:
from sqlalchemy.sql import FromClause
from sqlalchemy.sql.schema import _NamingSchemaParameter as NamingSchemaParameter
from sqlalchemy.types import TypeEngine

__all__ = (
"AuditColumns",
Expand Down Expand Up @@ -153,18 +153,20 @@ def to_dict(self, exclude: set[str] | None = None) -> dict[str, Any]:
def create_registry() -> registry:
"""Create a new SQLAlchemy registry."""
meta = MetaData(naming_convention=convention)
return registry(
metadata=meta,
type_annotation_map={
UUID: GUID,
EmailStr: String,
AnyUrl: String,
AnyHttpUrl: String,
dict: JsonB,
datetime: DateTimeUTC,
date: Date,
},
)
type_annotation_map: dict[type, type[TypeEngine[Any]] | TypeEngine[Any]] = {
UUID: GUID,
datetime: DateTimeUTC,
date: Date,
dict: JsonB,
}
try:
from pydantic import AnyHttpUrl, AnyUrl, EmailStr

type_annotation_map.update({EmailStr: String, AnyUrl: String, AnyHttpUrl: String})
except ImportError:
pass

return registry(metadata=meta, type_annotation_map=type_annotation_map)


orm_registry = create_registry()
Expand Down