sqlalchemy.exc.ProgrammingError: (psycopg2.ProgrammingError) can't adapt type 'Color'

[masreplay]

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from typing import Optional
from uuid import UUID

from pydantic import AnyHttpUrl, EmailStr
from pydantic.color import Color
from sqlalchemy import Column, Enum
from sqlmodel import SQLModel, Field, AutoString

from app.schemas.base_model import BaseSchema
from app.schemas.enums import UserType, UserGender, UserScrapeFrom


class UserBase(SQLModel):
    type: UserType

    en_name: Optional[str] = Field(index=True)
    ar_name: Optional[str] = Field(index=True)
    email: Optional[EmailStr] = Field(default=None)
    uot_url: Optional[AnyHttpUrl] = Field(default=None)
    image: Optional[AnyHttpUrl] = Field(default=None)

    color: Color = Field(sa_column=Column(AutoString()))
    asc_job_title: str = Field()
    asc_name: str = Field()
    scrape_from: Optional[UserScrapeFrom] = Field(default=None)
    gender: UserGender = Field(sa_column=Column(Enum(UserGender)))

    # relations
    role_id: Optional[UUID] = Field(foreign_key="role.id")

Description

Create a type that does not belong to sqlalchemy
color: Color = Field(sa_column=Column(AutoString())) throw error in migration

alembic migration line
sa.Column('color', sqlmodel.sql.sqltypes.AutoString(), nullable=True),

Operating System

Windows

Operating System Details

No response

SQLModel Version

0.0.6

Python Version

Python 3.9.7

Additional Context

No response

[byrman]

I cannot reproduce your issue. What's the exact error and what database are you using?

[masreplay]

I'm using PostgreSQL and I can't save types like pedantic color in DB

[byrman]

Weird, I had no difficulties using PostgreSQL.

[byrman]

Ah, I thought you had an error while migrating, but saving is your problem?

[byrman]

You could use a validator

class Foo(SQLModel, table=True):
    class Config:
        validate_assignment = True

    id: Optional[int] = Field(default=None, primary_key=True)
    color: Color = Field(sa_column=Column(AutoString()))

    @validator("color")
    def color_as_hex(cls, v):
        return v.as_hex()

if you don't mind that your color attribute will become a string after validation. Or you could write a custom ColorType:

class ColorType(types.TypeDecorator):
    impl = types.TEXT

    def process_bind_param(self, value, dialect):
        return value.as_hex()

    def process_result_value(self, value, dialect):
        return Color(value)


class Bar(SQLModel, table=True):
    class Config:
        validate_assignment = True

    id: Optional[int] = Field(default=None, primary_key=True)
    color: Color = Field(sa_column=Column(ColorType()))

[YuriiMotov]

Runnable code example:

from typing import Optional

from pydantic_extra_types.color import Color
from sqlalchemy import Column
from sqlalchemy.types import TEXT, TypeDecorator
from sqlmodel import Field, Session, SQLModel, create_engine


class ColorType(TypeDecorator):
    impl = TEXT

    def process_bind_param(self, value, dialect):
        return value.as_hex()

    def process_result_value(self, value, dialect):
        return Color(value)


class Bar(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    color: Color = Field(sa_column=Column(ColorType()))


def main() -> None:
    engine = create_engine("sqlite:///", echo=True)
    SQLModel.metadata.create_all(engine)

    with Session(engine) as session:
        session.add(Bar(id=1, color=Color((0, 254, 0))))
        session.commit()

    with Session(engine) as session:
        b = session.get(Bar, 1)
        assert isinstance(b.color, Color)
        assert b.color.as_rgb_tuple() == (0, 254, 0), b.color.as_rgb_tuple()


if __name__ == "__main__":
    main()

[jd-solanki]

Hi @masreplay

I guess you are looking for values_callable

Here's my code:

# Pay attention in importing enum
from enum import Enum
from sqlalchemy import Enum as sqlAlchemyEnum

class EnumAccessStatus(Enum):
    PENDING = "pending"
    APPROVED = "approved"
    REJECTED = "rejected"
    REVOKED = "revoked"

access_status_values: Callable[[Type[EnumAccessStatus]], list[str]] = lambda status: [
    s.value for s in status
]

class GithubAccessBase(SQLModel):
    access_status: EnumAccessStatus = Field(
        sa_column=Column(
            sqlAlchemyEnum(EnumAccessStatus, values_callable=access_status_values)
        )
    )

[masreplay]

Enum already supported I'm talking about other types like pydantic Color @jd-0001
Thanks for help