From 3eab2b6e7d8dab972b9e5714a845777d664e7ecb Mon Sep 17 00:00:00 2001
From: Khaleel Al-Adhami <khaleel.aladhami@gmail.com>
Date: Tue, 22 Oct 2024 14:27:04 -0700
Subject: [PATCH] implement rx dynamic (#4195)

* implement rx dynamic

* dang it darglint

* add custom type
---
 reflex/__init__.py         |  1 +
 reflex/__init__.pyi        |  1 +
 reflex/state.py            | 47 ++++++++++++++++++++++++++++++++++++++
 reflex/utils/exceptions.py |  4 ++++
 4 files changed, 53 insertions(+)

diff --git a/reflex/__init__.py b/reflex/__init__.py
index 979e5499a..ffc4426f9 100644
--- a/reflex/__init__.py
+++ b/reflex/__init__.py
@@ -331,6 +331,7 @@ _MAPPING: dict = {
         "var",
         "ComponentState",
         "State",
+        "dynamic",
     ],
     "style": ["Style", "toggle_color_mode"],
     "utils.imports": ["ImportVar"],
diff --git a/reflex/__init__.pyi b/reflex/__init__.pyi
index aeebaadf8..aa1c92b72 100644
--- a/reflex/__init__.pyi
+++ b/reflex/__init__.pyi
@@ -184,6 +184,7 @@ from .model import session as session
 from .page import page as page
 from .state import ComponentState as ComponentState
 from .state import State as State
+from .state import dynamic as dynamic
 from .state import var as var
 from .style import Style as Style
 from .style import toggle_color_mode as toggle_color_mode
diff --git a/reflex/state.py b/reflex/state.py
index dcd576b3a..208c23a0f 100644
--- a/reflex/state.py
+++ b/reflex/state.py
@@ -30,6 +30,7 @@ from typing import (
     Set,
     Tuple,
     Type,
+    TypeVar,
     Union,
     cast,
     get_args,
@@ -79,6 +80,7 @@ from reflex.utils import console, format, path_ops, prerequisites, types
 from reflex.utils.exceptions import (
     ComputedVarShadowsBaseVars,
     ComputedVarShadowsStateVar,
+    DynamicComponentInvalidSignature,
     DynamicRouteArgShadowsStateVar,
     EventHandlerShadowsBuiltInStateMethod,
     ImmutableStateError,
@@ -2095,6 +2097,51 @@ class State(BaseState):
     is_hydrated: bool = False
 
 
+T = TypeVar("T", bound=BaseState)
+
+
+def dynamic(func: Callable[[T], Component]):
+    """Create a dynamically generated components from a state class.
+
+    Args:
+        func: The function to generate the component.
+
+    Returns:
+        The dynamically generated component.
+
+    Raises:
+        DynamicComponentInvalidSignature: If the function does not have exactly one parameter.
+        DynamicComponentInvalidSignature: If the function does not have a type hint for the state class.
+    """
+    number_of_parameters = len(inspect.signature(func).parameters)
+
+    func_signature = get_type_hints(func)
+
+    if "return" in func_signature:
+        func_signature.pop("return")
+
+    values = list(func_signature.values())
+
+    if number_of_parameters != 1:
+        raise DynamicComponentInvalidSignature(
+            "The function must have exactly one parameter, which is the state class."
+        )
+
+    if len(values) != 1:
+        raise DynamicComponentInvalidSignature(
+            "You must provide a type hint for the state class in the function."
+        )
+
+    state_class: Type[T] = values[0]
+
+    def wrapper() -> Component:
+        from reflex.components.base.fragment import fragment
+
+        return fragment(state_class._evaluate(lambda state: func(state)))
+
+    return wrapper
+
+
 class FrontendEventExceptionState(State):
     """Substate for handling frontend exceptions."""
 
diff --git a/reflex/utils/exceptions.py b/reflex/utils/exceptions.py
index cd3d108b4..f16338513 100644
--- a/reflex/utils/exceptions.py
+++ b/reflex/utils/exceptions.py
@@ -139,3 +139,7 @@ class StateSchemaMismatchError(ReflexError, TypeError):
 
 class EnvironmentVarValueError(ReflexError, ValueError):
     """Raised when an environment variable is set to an invalid value."""
+
+
+class DynamicComponentInvalidSignature(ReflexError, TypeError):
+    """Raised when a dynamic component has an invalid signature."""