Skip to content

Add option to pass kwargs to SQLAlchemy types #366

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 1 commit into from
Closed

Add option to pass kwargs to SQLAlchemy types #366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 16 additions & 8 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
Column,
Date,
DateTime,
Enum as SAEnum,
Float,
ForeignKey,
Integer,
Expand Down Expand Up @@ -73,6 +74,7 @@ def __init__(self, default: Any = Undefined, **kwargs: Any) -> None:
sa_column = kwargs.pop("sa_column", Undefined)
sa_column_args = kwargs.pop("sa_column_args", Undefined)
sa_column_kwargs = kwargs.pop("sa_column_kwargs", Undefined)
sa_type_kwargs = kwargs.pop("sa_type_kwargs", Undefined)
if sa_column is not Undefined:
if sa_column_args is not Undefined:
raise RuntimeError(
Expand All @@ -92,6 +94,7 @@ def __init__(self, default: Any = Undefined, **kwargs: Any) -> None:
self.sa_column = sa_column
self.sa_column_args = sa_column_args
self.sa_column_kwargs = sa_column_kwargs
self.sa_type_kwargs = sa_type_kwargs


class RelationshipInfo(Representation):
Expand Down Expand Up @@ -154,6 +157,7 @@ def Field(
sa_column: Union[Column, UndefinedType] = Undefined, # type: ignore
sa_column_args: Union[Sequence[Any], UndefinedType] = Undefined,
sa_column_kwargs: Union[Mapping[str, Any], UndefinedType] = Undefined,
sa_type_kwargs: Union[Mapping[str, Any], UndefinedType] = Undefined,
schema_extra: Optional[Dict[str, Any]] = None,
) -> Any:
current_schema_extra = schema_extra or {}
Expand Down Expand Up @@ -184,6 +188,7 @@ def Field(
sa_column=sa_column,
sa_column_args=sa_column_args,
sa_column_kwargs=sa_column_kwargs,
sa_type_kwargs=sa_type_kwargs,
**current_schema_extra,
)
field_info._validate()
Expand Down Expand Up @@ -375,28 +380,31 @@ def __init__(


def get_sqlachemy_type(field: ModelField) -> Any:
sa_type_kwargs = getattr(field.field_info, "sa_type_kwargs", Undefined)
if sa_type_kwargs is Undefined:
sa_type_kwargs = {}
if issubclass(field.type_, Enum):
return SAEnum(field.type_, **sa_type_kwargs)
if issubclass(field.type_, str):
if field.field_info.max_length:
return AutoString(length=field.field_info.max_length)
return AutoString
if issubclass(field.type_, float):
return Float
return Float(**sa_type_kwargs)
if issubclass(field.type_, bool):
return Boolean
return Boolean(**sa_type_kwargs)
if issubclass(field.type_, int):
return Integer
if issubclass(field.type_, datetime):
return DateTime
return DateTime(**sa_type_kwargs)
if issubclass(field.type_, date):
return Date
if issubclass(field.type_, timedelta):
return Interval
return Interval(**sa_type_kwargs)
if issubclass(field.type_, time):
return Time
if issubclass(field.type_, Enum):
return Enum
return Time(**sa_type_kwargs)
if issubclass(field.type_, bytes):
return LargeBinary
return LargeBinary(**sa_type_kwargs)
if issubclass(field.type_, Decimal):
return Numeric(
precision=getattr(field.type_, "max_digits", None),
Expand Down