perf: sqlmodelx is not used by default

Author: amisadmin

fastapi_amis_admin/models/__init__.py

@@ -1,4 +1,13 @@
-from sqlmodelx import SQLModel
-from sqlmodelx.enums import Choices, IntegerChoices, TextChoices
-
 from .fields import Field
+
+try:
+    from sqlmodelx import SQLModel
+except ImportError:
+    from sqlmodel import SQLModel
+
+try:
+    from sqlmodelx.enums import Choices, IntegerChoices, TextChoices
+    from sqlmodelx.sqltypes import ChoiceType
+except ImportError:
+    from ._enums import Choices, IntegerChoices, TextChoices
+    from ._sqltypes import ChoiceType

fastapi_amis_admin/models/_enums.py

@@ -0,0 +1,77 @@
+import enum
+
+__all__ = ["Choices", "IntegerChoices", "TextChoices"]
+
+
+class ChoicesMeta(enum.EnumMeta):
+    """A metaclass for creating a enum choices."""
+
+    def __new__(metacls, classname, bases, classdict, **kwds):
+        labels = []
+        for key in classdict._member_names:
+            value = classdict[key]
+            if isinstance(value, (list, tuple)) and len(value) > 1 and isinstance(value[-1], str):
+                *value, label = value
+                value = tuple(value)
+            else:
+                label = key.replace("_", " ").title()
+            labels.append(label)
+            # Use dict.__setitem__() to suppress defenses against double
+            # assignment in enum's classdict.
+            dict.__setitem__(classdict, key, value)
+        cls = super().__new__(metacls, classname, bases, classdict, **kwds)
+        cls._value2label_map_ = dict(zip(cls._value2member_map_, labels))
+        # Add a label property to instances of enum which uses the enum member
+        # that is passed in as "self" as the value to use when looking up the
+        # label in the choices.
+        cls.label = property(lambda self: cls._value2label_map_.get(self.value))
+        cls.do_not_call_in_templates = True
+        return enum.unique(cls)
+
+    def __contains__(cls, member):
+        if not isinstance(member, enum.Enum):
+            # Allow non-enums to match against member values.
+            return any(x.value == member for x in cls)
+        return super().__contains__(member)
+
+    @property
+    def names(cls):
+        empty = ["__empty__"] if hasattr(cls, "__empty__") else []
+        return empty + [member.name for member in cls]
+
+    @property
+    def choices(cls):
+        empty = [(None, cls.__empty__)] if hasattr(cls, "__empty__") else []
+        return empty + [(member.value, member.label) for member in cls]
+
+    @property
+    def labels(cls):
+        return [label for _, label in cls.choices]
+
+    @property
+    def values(cls):
+        return [value for value, _ in cls.choices]
+
+
+class Choices(enum.Enum, metaclass=ChoicesMeta):
+    """Class for creating enumerated choices."""
+
+    def __str__(self):
+        """
+        Use value when cast to str, so that Choices set as model instance
+        attributes are rendered as expected in templates and similar contexts.
+        """
+        return str(self.value)
+
+
+class IntegerChoices(enum.IntEnum, Choices):
+    """Class for creating enumerated integer choices."""
+
+    pass
+
+
+class TextChoices(str, Choices):
+    """Class for creating enumerated string choices."""
+
+    def _generate_next_value_(name, start, count, last_values):
+        return name

fastapi_amis_admin/models/_sqltypes.py

@@ -0,0 +1,34 @@
+from typing import Type
+
+from sqlalchemy import types
+from sqlalchemy.engine import Dialect
+
+from ._enums import Choices
+
+
+class ChoiceType(types.TypeDecorator):
+    impl = types.CHAR
+    cache_ok = True
+
+    def __init__(self, choices: Type[Choices], impl=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.choices = choices
+
+    @property
+    def python_type(self):
+        return self.impl.python_type
+
+    def load_dialect_impl(self, dialect: Dialect):
+        return dialect.type_descriptor(types.CHAR(20))
+
+    def process_bind_param(self, value, dialect):
+        if value and isinstance(value, Choices):
+            return value.value
+        return value
+
+    def process_result_value(self, value, dialect):
+        if value is not None:
+            if issubclass(self.choices, int):
+                value = int(value)
+            return self.choices(value)
+        return value

pyproject.toml

@@ -37,7 +37,7 @@ classifiers = [
 ]
 dependencies = [
     "fastapi>=0.103.2",
-    "sqlmodelx>=0.0.7,<0.1.0",
+    "sqlmodel>=0.0.14,<0.1.0",
     "python-multipart>=0.0.5",
     "sqlalchemy-database>=0.1.1,<0.2.0",
     "aiofiles>=0.17.0",

tests/models/sqlm.py

@@ -2,9 +2,9 @@
 from typing import List, Optional
 
 from sqlalchemy import JSON, Column, String, Text
-from sqlmodel import Field, Relationship
+from sqlmodel import Field, Relationship, SQLModel
 
-from fastapi_amis_admin.models import SQLModel
+from fastapi_amis_admin.models import ChoiceType
 from tests.models.schemas import ArticleStatusChoices
 
 Base = SQLModel
@@ -63,7 +63,7 @@ class ArticleContent(PkModelMixin, table=True):
 class Article(PkModelMixin, CreateTimeModelMixin, table=True):
     title: str = Field(title="ArticleTitle", max_length=200)
     description: str = Field(default="", title="ArticleDescription", sa_column=Column(Text))
-    status: ArticleStatusChoices = Field(ArticleStatusChoices.PENDING, title="status")
+    status: ArticleStatusChoices = Field(ArticleStatusChoices.PENDING, title="status", sa_type=ChoiceType(ArticleStatusChoices))
 
     category_id: Optional[int] = Field(default=None, foreign_key="category.id", title="CategoryId")
     category: Optional[Category] = Relationship(back_populates="articles")