085b761f6b
* delete most references to varr * [REF-3562][REF-3563] Replace chakra usage (#3872) * only one mention of var * delete vars.py why not * remove reflex.vars * rename immutable var to var * rename ivars to vars * add vars back smh * ruff * no more create_safe * reorder deprecated * remove raises * remove all Var.create * move to new api * fix unit tests * fix pyi hopefully * sort literals * fix event handler issues * update poetry * fix silly issues i'm very silly * add var_operation_return * rename immutable to not immutable * add str type * it's ruff out there --------- Co-authored-by: Elijah Ahianyo <elijahahianyo@gmail.com>
137 lines
4.3 KiB
Python
137 lines
4.3 KiB
Python
"""Create a list of components from an iterable."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import inspect
|
|
from typing import Any, Callable, Iterable
|
|
|
|
from reflex.components.base.fragment import Fragment
|
|
from reflex.components.component import Component
|
|
from reflex.components.tags import IterTag
|
|
from reflex.constants import MemoizationMode
|
|
from reflex.state import ComponentState
|
|
from reflex.vars.base import LiteralVar, Var
|
|
|
|
|
|
class ForeachVarError(TypeError):
|
|
"""Raised when the iterable type is Any."""
|
|
|
|
|
|
class ForeachRenderError(TypeError):
|
|
"""Raised when there is an error with the foreach render function."""
|
|
|
|
|
|
class Foreach(Component):
|
|
"""A component that takes in an iterable and a render function and renders a list of components."""
|
|
|
|
_memoization_mode = MemoizationMode(recursive=False)
|
|
|
|
# The iterable to create components from.
|
|
iterable: Var[Iterable]
|
|
|
|
# A function from the render args to the component.
|
|
render_fn: Callable = Fragment.create
|
|
|
|
@classmethod
|
|
def create(
|
|
cls,
|
|
iterable: Var[Iterable] | Iterable,
|
|
render_fn: Callable,
|
|
) -> Foreach:
|
|
"""Create a foreach component.
|
|
|
|
Args:
|
|
iterable: The iterable to create components from.
|
|
render_fn: A function from the render args to the component.
|
|
|
|
Returns:
|
|
The foreach component.
|
|
|
|
Raises:
|
|
ForeachVarError: If the iterable is of type Any.
|
|
TypeError: If the render function is a ComponentState.
|
|
"""
|
|
iterable = LiteralVar.create(iterable)
|
|
if iterable._var_type == Any:
|
|
raise ForeachVarError(
|
|
f"Could not foreach over var `{str(iterable)}` of type Any. "
|
|
"(If you are trying to foreach over a state var, add a type annotation to the var). "
|
|
"See https://reflex.dev/docs/library/dynamic-rendering/foreach/"
|
|
)
|
|
|
|
if (
|
|
hasattr(render_fn, "__qualname__")
|
|
and render_fn.__qualname__ == ComponentState.create.__qualname__
|
|
):
|
|
raise TypeError(
|
|
"Using a ComponentState as `render_fn` inside `rx.foreach` is not supported yet."
|
|
)
|
|
|
|
component = cls(
|
|
iterable=iterable,
|
|
render_fn=render_fn,
|
|
)
|
|
# Keep a ref to a rendered component to determine correct imports/hooks/styles.
|
|
component.children = [component._render().render_component()]
|
|
return component
|
|
|
|
def _render(self) -> IterTag:
|
|
props = {}
|
|
|
|
render_sig = inspect.signature(self.render_fn)
|
|
params = list(render_sig.parameters.values())
|
|
|
|
# Validate the render function signature.
|
|
if len(params) == 0 or len(params) > 2:
|
|
raise ForeachRenderError(
|
|
"Expected 1 or 2 parameters in foreach render function, got "
|
|
f"{[p.name for p in params]}. See "
|
|
"https://reflex.dev/docs/library/dynamic-rendering/foreach/"
|
|
)
|
|
|
|
if len(params) >= 1:
|
|
# Determine the arg var name based on the params accepted by render_fn.
|
|
props["arg_var_name"] = params[0].name
|
|
|
|
if len(params) == 2:
|
|
# Determine the index var name based on the params accepted by render_fn.
|
|
props["index_var_name"] = params[1].name
|
|
else:
|
|
# Otherwise, use a deterministic index, based on the render function bytecode.
|
|
code_hash = (
|
|
hash(self.render_fn.__code__)
|
|
.to_bytes(
|
|
length=8,
|
|
byteorder="big",
|
|
signed=True,
|
|
)
|
|
.hex()
|
|
)
|
|
props["index_var_name"] = f"index_{code_hash}"
|
|
|
|
return IterTag(
|
|
iterable=self.iterable,
|
|
render_fn=self.render_fn,
|
|
children=self.children,
|
|
**props,
|
|
)
|
|
|
|
def render(self):
|
|
"""Render the component.
|
|
|
|
Returns:
|
|
The dictionary for template of component.
|
|
"""
|
|
tag = self._render()
|
|
|
|
return dict(
|
|
tag,
|
|
iterable_state=str(tag.iterable),
|
|
arg_name=tag.arg_var_name,
|
|
arg_index=tag.get_index_var_arg(),
|
|
iterable_type=tag.iterable._var_type.mro()[0].__name__,
|
|
)
|
|
|
|
|
|
foreach = Foreach.create
|