move pydantic, sqlmodel, alembic to optional dependencies (#5438)

* move pydantic, sqlmodel, alembic to optional dependencies

* fix greptile comments

* and sqlmodel

* sqlalchemy

* add those guys to dev

* fix some of the tests

* fix that a bit more strongly

* bruh

* dang it darglint

* fix prerequisites having unused fields

* move model registry and sqla_session

* rx.Base

* remove fastapi dep

* add fastapi for tests

* some cleanup

* guard sqlalchemy inside of import

* make tests possible to run without sqlmodel, sqlalchemy, starlette admin, fastapi

* make it possible to run without pydantic

* delay httpx

* do things in a different way

* event . event = event

* maybe?

* add __file__

* remove extra for now

* why not both

* update pyi hashes

* fix uv lock

* post merge issues

* starlette 47

* move some compat code inside of if statement

* update uv.lock

* rx.Model no longer inherits from rx.Base (and friends)

* Move sqlalchemy-only helpers out of the sqlmodel section
* Remove sqlmodel pydantic v2 hacks -- just use pydantic v2 now
* Import guard other parts of the code that were importing sqlalchemy

* move sqlmodel to pydantic v2 and remove compat code

* rx.model: from __future__ import annotations

* upgrade

---------

Co-authored-by: Masen Furer <[email protected]>

Author: adhami3310

pyi_hashes.json

@@ -1,5 +1,5 @@
 {
-  "reflex/__init__.pyi": "cc4f461d8244f0f372b7607eb1edd146",
+  "reflex/__init__.pyi": "2fa0051c43f2d3d10114283480c666fb",
   "reflex/components/__init__.pyi": "ac05995852baa81062ba3d18fbc489fb",
   "reflex/components/base/__init__.pyi": "16e47bf19e0d62835a605baa3d039c5a",
   "reflex/components/base/app_wrap.pyi": "22e94feaa9fe675bcae51c412f5b67f1",
@@ -23,7 +23,7 @@
   "reflex/components/core/window_events.pyi": "76bf03a273a1fbbb3b333e10d5d08c30",
   "reflex/components/datadisplay/__init__.pyi": "52755871369acbfd3a96b46b9a11d32e",
   "reflex/components/datadisplay/code.pyi": "b86769987ef4d1cbdddb461be88539fd",
-  "reflex/components/datadisplay/dataeditor.pyi": "82c652f0679148d8431a0cf645686a50",
+  "reflex/components/datadisplay/dataeditor.pyi": "35391d4ba147cf20ce4ac7a782066d61",
   "reflex/components/datadisplay/shiki_code_block.pyi": "1d53e75b6be0d3385a342e7b3011babd",
   "reflex/components/el/__init__.pyi": "0adfd001a926a2a40aee94f6fa725ecc",
   "reflex/components/el/element.pyi": "c5974a92fbc310e42d0f6cfdd13472f4",
@@ -118,5 +118,5 @@
   "reflex/components/recharts/general.pyi": "d87ff9b85b2a204be01753690df4fb11",
   "reflex/components/recharts/polar.pyi": "ad24bd37c6acc0bc9bd4ac01af3ffe49",
   "reflex/components/recharts/recharts.pyi": "c41d19ab67972246c574098929bea7ea",
-  "reflex/components/sonner/toast.pyi": "1be74a25e344129b80f14165ae1a01f2"
+  "reflex/components/sonner/toast.pyi": "3c27bad1aaeb5183eaa6a41e77e8d7f0"
 }

pyproject.toml

@@ -50,6 +50,11 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
+db = [
+  "alembic >=1.15.2,<2.0",
+  "pydantic >=1.10.21,<3.0",
+  "sqlmodel >=0.0.24,<0.1",
+]
 monitoring = ["pyleak >=0.1.14,<1.0"]
 
 [project.urls]

reflex/__init__.py

@@ -323,7 +323,7 @@
         "SessionStorage",
     ],
     "middleware": ["middleware", "Middleware"],
-    "model": ["asession", "session", "Model"],
+    "model": ["asession", "session", "Model", "ModelRegistry"],
     "page": ["page"],
     "state": [
         "var",

reflex/app.py

@@ -83,7 +83,6 @@
     get_hydrate_event,
     noop,
 )
-from reflex.model import Model, get_db_status
 from reflex.page import DECORATED_PAGES
 from reflex.route import (
     get_route_args,
@@ -648,7 +647,7 @@ def __call__(self) -> ASGIApp:
 
             for api_transformer in api_transformers:
                 if isinstance(api_transformer, Starlette):
-                    # Mount the api to the fastapi app.
+                    # Mount the api to the starlette app.
                     App._add_cors(api_transformer)
                     api_transformer.mount("", asgi_app)
                     asgi_app = api_transformer
@@ -957,6 +956,8 @@ def _setup_admin_dash(self):
         try:
             from starlette_admin.contrib.sqla.admin import Admin
             from starlette_admin.contrib.sqla.view import ModelView
+
+            from reflex.model import Model
         except ImportError:
             return
 
@@ -1849,6 +1850,8 @@ async def health(_request: Request) -> JSONResponse:
     tasks = []
 
     if prerequisites.check_db_used():
+        from reflex.model import get_db_status
+
         tasks.append(get_db_status())
     if prerequisites.check_redis_used():
         tasks.append(prerequisites.get_redis_status())

reflex/base.py

@@ -1,47 +1,75 @@
 """Define the base Reflex class."""
 
-from pydantic.v1 import BaseModel
+from importlib.util import find_spec
 
+if find_spec("pydantic") and find_spec("pydantic.v1"):
+    from pydantic.v1 import BaseModel
 
-class Base(BaseModel):
-    """The base class subclassed by all Reflex classes.
+    class Base(BaseModel):
+        """The base class subclassed by all Reflex classes.
 
-    This class wraps Pydantic and provides common methods such as
-    serialization and setting fields.
+        This class wraps Pydantic and provides common methods such as
+        serialization and setting fields.
 
-    Any data structure that needs to be transferred between the
-    frontend and backend should subclass this class.
-    """
+        Any data structure that needs to be transferred between the
+        frontend and backend should subclass this class.
+        """
 
-    class Config:
-        """Pydantic config."""
+        class Config:
+            """Pydantic config."""
 
-        arbitrary_types_allowed = True
-        use_enum_values = True
-        extra = "allow"
+            arbitrary_types_allowed = True
+            use_enum_values = True
+            extra = "allow"
 
-    def json(self) -> str:
-        """Convert the object to a json string.
+        def __init__(self, *args, **kwargs):
+            """Initialize the base class.
 
-        Returns:
-            The object as a json string.
-        """
-        from reflex.utils.serializers import serialize
+            Args:
+                *args: Positional arguments.
+                **kwargs: Keyword arguments.
+            """
+            from reflex.utils import console
 
-        return self.__config__.json_dumps(
-            self.dict(),
-            default=serialize,
-        )
+            console.deprecate(
+                feature_name="rx.Base",
+                reason="You can subclass from `pydantic.BaseModel` directly instead or use dataclasses if possible.",
+                deprecation_version="0.8.2",
+                removal_version="0.9.0",
+            )
+            super().__init__(*args, **kwargs)
 
-    def set(self, **kwargs: object):
-        """Set multiple fields and return the object.
+        def json(self) -> str:
+            """Convert the object to a json string.
 
-        Args:
-            **kwargs: The fields and values to set.
+            Returns:
+                The object as a json string.
+            """
+            from reflex.utils.serializers import serialize
 
-        Returns:
-            The object with the fields set.
-        """
-        for key, value in kwargs.items():
-            setattr(self, key, value)
-        return self
+            return self.__config__.json_dumps(
+                self.dict(),
+                default=serialize,
+            )
+else:
+
+    class PydanticNotFoundFallback:
+        """Fallback base class for environments without Pydantic."""
+
+        def __init__(self, *args, **kwargs):
+            """Initialize the base class.
+
+            Args:
+                *args: Positional arguments.
+                **kwargs: Keyword arguments.
+
+            Raises:
+                ImportError: As Pydantic is not installed.
+            """
+            msg = (
+                "Pydantic is not installed. Please install it to use rx.Base."
+                "You can install it with `pip install pydantic`."
+            )
+            raise ImportError(msg)
+
+    Base = PydanticNotFoundFallback  # pyright: ignore[reportAssignmentType]

reflex/components/datadisplay/dataeditor.py

@@ -2,11 +2,11 @@
 
 from __future__ import annotations
 
+import dataclasses
 from collections.abc import Mapping, Sequence
 from enum import Enum
 from typing import Any, Literal, TypedDict
 
-from reflex.base import Base
 from reflex.components.component import Component, NoSSRComponent
 from reflex.components.literals import LiteralRowMarker
 from reflex.event import EventHandler, no_args_event_spec, passthrough_event_spec
@@ -50,7 +50,8 @@ class GridColumnIcons(Enum):
     VideoUri = "video_uri"
 
 
-class DataEditorTheme(Base):
+@dataclasses.dataclass
+class DataEditorThemeBase:
     """The theme for the DataEditor component."""
 
     accent_color: str | None = None
@@ -87,6 +88,20 @@ class DataEditorTheme(Base):
     text_medium: str | None = None
 
 
+@dataclasses.dataclass(init=False)
+class DataEditorTheme(DataEditorThemeBase):
+    """The theme for the DataEditor component."""
+
+    def __init__(self, **kwargs: Any):
+        """Initialize the DataEditorTheme.
+
+        Args:
+            **kwargs: The keyword arguments to initialize the theme.
+        """
+        kwargs = {format.to_snake_case(k): v for k, v in kwargs.items()}
+        super().__init__(**kwargs)
+
+
 class Bounds(TypedDict):
     """The bounds of the group header."""
 

reflex/components/sonner/toast.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
+import dataclasses
 from typing import Any, Literal
 
-from reflex.base import Base
 from reflex.components.component import Component, ComponentNamespace
 from reflex.components.lucide.icon import Icon
 from reflex.components.props import NoExtrasAllowedProps
@@ -35,7 +35,8 @@
 )
 
 
-class ToastAction(Base):
+@dataclasses.dataclass
+class ToastAction:
     """A toast action that render a button in the toast."""
 
     label: str

reflex/environment.py

@@ -24,6 +24,7 @@
 )
 
 from reflex import constants
+from reflex.constants.base import LogLevel
 from reflex.plugins import Plugin
 from reflex.utils.exceptions import EnvironmentVarValueError
 from reflex.utils.types import GenericType, is_union, value_inside_optional
@@ -204,7 +205,8 @@ def interpret_env_var_value(
         The interpreted value.
 
     Raises:
-        ValueError: If the environment variable type is invalid.
+        ValueError: If the value is invalid.
+        EnvironmentVarValueError: If the value is invalid for the specific type.
     """
     field_type = value_inside_optional(field_type)
 
@@ -218,6 +220,12 @@ def interpret_env_var_value(
         return interpret_boolean_env(value, field_name)
     if field_type is str:
         return value
+    if field_type is LogLevel:
+        loglevel = LogLevel.from_string(value)
+        if loglevel is None:
+            msg = f"Invalid log level value: {value} for {field_name}"
+            raise EnvironmentVarValueError(msg)
+        return loglevel
     if field_type is int:
         return interpret_int_env(value, field_name)
     if field_type is Path:

reflex/istate/proxy.py

@@ -9,19 +9,16 @@
 import inspect
 import json
 from collections.abc import Callable, Sequence
+from importlib.util import find_spec
 from types import MethodType
 from typing import TYPE_CHECKING, Any, SupportsIndex, TypeVar
 
-import pydantic
 import wrapt
-from pydantic import BaseModel as BaseModelV2
-from pydantic.v1 import BaseModel as BaseModelV1
-from sqlalchemy.orm import DeclarativeBase
 
 from reflex.base import Base
 from reflex.utils import prerequisites
 from reflex.utils.exceptions import ImmutableStateError
-from reflex.utils.serializers import serializer
+from reflex.utils.serializers import can_serialize, serialize, serializer
 from reflex.vars.base import Var
 
 if TYPE_CHECKING:
@@ -339,6 +336,34 @@ def mark_dirty(self):
         raise NotImplementedError(msg)
 
 
+if find_spec("pydantic"):
+    import pydantic
+
+    NEVER_WRAP_BASE_ATTRS = set(Base.__dict__) - {"set"} | set(
+        pydantic.BaseModel.__dict__
+    )
+else:
+    NEVER_WRAP_BASE_ATTRS = {}
+
+MUTABLE_TYPES = (
+    list,
+    dict,
+    set,
+    Base,
+)
+
+if find_spec("sqlalchemy"):
+    from sqlalchemy.orm import DeclarativeBase
+
+    MUTABLE_TYPES += (DeclarativeBase,)
+
+if find_spec("pydantic"):
+    from pydantic import BaseModel as BaseModelV2
+    from pydantic.v1 import BaseModel as BaseModelV1
+
+    MUTABLE_TYPES += (BaseModelV1, BaseModelV2)
+
+
 class MutableProxy(wrapt.ObjectProxy):
     """A proxy for a mutable object that tracks changes."""
 
@@ -371,11 +396,6 @@ class MutableProxy(wrapt.ObjectProxy):
         "setdefault",
     }
 
-    # These internal attributes on rx.Base should NOT be wrapped in a MutableProxy.
-    __never_wrap_base_attrs__ = set(Base.__dict__) - {"set"} | set(
-        pydantic.BaseModel.__dict__
-    )
-
     # Dynamically generated classes for tracking dataclass mutations.
     __dataclass_proxies__: dict[type, type] = {}
 
@@ -539,7 +559,7 @@ def __getattr__(self, __name: str) -> Any:
 
             if (
                 isinstance(self.__wrapped__, Base)
-                and __name not in self.__never_wrap_base_attrs__
+                and __name not in NEVER_WRAP_BASE_ATTRS
                 and hasattr(value, "__func__")
             ):
                 # Wrap methods called on Base subclasses, which might do _anything_
@@ -669,7 +689,10 @@ def serialize_mutable_proxy(mp: MutableProxy):
     Returns:
         The wrapped object.
     """
-    return mp.__wrapped__
+    obj = mp.__wrapped__
+    if can_serialize(type(obj)):
+        return serialize(obj)
+    return obj
 
 
 _orig_json_encoder_default = json.JSONEncoder.default
@@ -739,18 +762,6 @@ def _mark_dirty(
         )
 
 
-# These types will be wrapped in MutableProxy
-MUTABLE_TYPES = (
-    list,
-    dict,
-    set,
-    Base,
-    DeclarativeBase,
-    BaseModelV2,
-    BaseModelV1,
-)
-
-
 @functools.lru_cache(maxsize=1024)
 def is_mutable_type(type_: type) -> bool:
     """Check if a type is mutable and should be wrapped.