laipeng/reflex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'main' into add-validation-to-function-vars

Browse Source
This commit is contained in:
Khaleel Al-Adhami 2025-01-17 14:24:48 -08:00
commit 270fcb996d
10 changed files with 67 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
reflex/state.py
View File

@ -1200,7 +1200,6 @@ class BaseState(Base, ABC, extra=pydantic.Extra.allow):
fget=func, fget=func,
auto_deps=False, auto_deps=False,
deps=["router"], deps=["router"],
cache=True,
_js_expr=param, _js_expr=param,
_var_data=VarData.from_state(cls), _var_data=VarData.from_state(cls),
) )

17
reflex/vars/base.py
View File

@ -2078,7 +2078,7 @@ class ComputedVar(Var[RETURN_TYPE]):
self, self,
fget: Callable[[BASE_STATE], RETURN_TYPE], fget: Callable[[BASE_STATE], RETURN_TYPE],
initial_value: RETURN_TYPE | types.Unset = types.Unset(), initial_value: RETURN_TYPE | types.Unset = types.Unset(),
cache: bool = False, cache: bool = True,
deps: Optional[List[Union[str, Var]]] = None, deps: Optional[List[Union[str, Var]]] = None,
auto_deps: bool = True, auto_deps: bool = True,
interval: Optional[Union[int, datetime.timedelta]] = None, interval: Optional[Union[int, datetime.timedelta]] = None,
@ -2486,7 +2486,7 @@ if TYPE_CHECKING:
def computed_var( def computed_var(
fget: None = None, fget: None = None,
initial_value: Any | types.Unset = types.Unset(), initial_value: Any | types.Unset = types.Unset(),
cache: bool = False, cache: bool = True,
deps: Optional[List[Union[str, Var]]] = None, deps: Optional[List[Union[str, Var]]] = None,
auto_deps: bool = True, auto_deps: bool = True,
interval: Optional[Union[datetime.timedelta, int]] = None, interval: Optional[Union[datetime.timedelta, int]] = None,
@ -2499,7 +2499,7 @@ def computed_var(
def computed_var( def computed_var(
fget: Callable[[BASE_STATE], RETURN_TYPE], fget: Callable[[BASE_STATE], RETURN_TYPE],
initial_value: RETURN_TYPE | types.Unset = types.Unset(), initial_value: RETURN_TYPE | types.Unset = types.Unset(),
cache: bool = False, cache: bool = True,
deps: Optional[List[Union[str, Var]]] = None, deps: Optional[List[Union[str, Var]]] = None,
auto_deps: bool = True, auto_deps: bool = True,
interval: Optional[Union[datetime.timedelta, int]] = None, interval: Optional[Union[datetime.timedelta, int]] = None,
@ -2511,7 +2511,7 @@ def computed_var(
def computed_var( def computed_var(
fget: Callable[[BASE_STATE], Any] | None = None, fget: Callable[[BASE_STATE], Any] | None = None,
initial_value: Any | types.Unset = types.Unset(), initial_value: Any | types.Unset = types.Unset(),
cache: Optional[bool] = None, cache: bool = True,
deps: Optional[List[Union[str, Var]]] = None, deps: Optional[List[Union[str, Var]]] = None,
auto_deps: bool = True, auto_deps: bool = True,
interval: Optional[Union[datetime.timedelta, int]] = None, interval: Optional[Union[datetime.timedelta, int]] = None,
@ -2537,15 +2537,6 @@ def computed_var(
ValueError: If caching is disabled and an update interval is set. ValueError: If caching is disabled and an update interval is set.
VarDependencyError: If user supplies dependencies without caching. VarDependencyError: If user supplies dependencies without caching.
""" """
if cache is None:
cache = False
console.deprecate(
"Default non-cached rx.var",
"the default value will be `@rx.var(cache=True)` in a future release. "
"To retain uncached var, explicitly pass `@rx.var(cache=False)`",
deprecation_version="0.6.8",
removal_version="0.7.0",
)
if cache is False and interval is not None: if cache is False and interval is not None:
raise ValueError("Cannot set update interval without caching.") raise ValueError("Cannot set update interval without caching.")

17
tests/integration/test_computed_vars.py
View File

@ -22,22 +22,22 @@ def ComputedVars():
count: int = 0 count: int = 0
# cached var with dep on count # cached var with dep on count
@rx.var(cache=True, interval=15) @rx.var(interval=15)
def count1(self) -> int: def count1(self) -> int:
return self.count return self.count
# cached backend var with dep on count # cached backend var with dep on count
@rx.var(cache=True, interval=15, backend=True) @rx.var(interval=15, backend=True)
def count1_backend(self) -> int: def count1_backend(self) -> int:
return self.count return self.count
# same as above but implicit backend with `_` prefix # same as above but implicit backend with `_` prefix
@rx.var(cache=True, interval=15) @rx.var(interval=15)
def _count1_backend(self) -> int: def _count1_backend(self) -> int:
return self.count return self.count
# explicit disabled auto_deps # explicit disabled auto_deps
@rx.var(interval=15, cache=True, auto_deps=False) @rx.var(interval=15, auto_deps=False)
def count3(self) -> int: def count3(self) -> int:
# this will not add deps, because auto_deps is False # this will not add deps, because auto_deps is False
print(self.count1) print(self.count1)
@ -45,16 +45,19 @@ def ComputedVars():
return self.count return self.count
# explicit dependency on count var # explicit dependency on count var
@rx.var(cache=True, deps=["count"], auto_deps=False) @rx.var(deps=["count"], auto_deps=False)
def depends_on_count(self) -> int: def depends_on_count(self) -> int:
return self.count return self.count
# explicit dependency on count1 var # explicit dependency on count1 var
@rx.var(cache=True, deps=[count1], auto_deps=False) @rx.var(deps=[count1], auto_deps=False)
def depends_on_count1(self) -> int: def depends_on_count1(self) -> int:
return self.count return self.count
@rx.var(deps=[count3], auto_deps=False, cache=True) @rx.var(
deps=[count3],
auto_deps=False,
)
def depends_on_count3(self) -> int: def depends_on_count3(self) -> int:
return self.count return self.count

6
tests/integration/test_dynamic_routes.py
View File

@ -74,16 +74,16 @@ def DynamicRoute():
class ArgState(rx.State): class ArgState(rx.State):
"""The app state.""" """The app state."""
@rx.var @rx.var(cache=False)
def arg(self) -> int: def arg(self) -> int:
return int(self.arg_str or 0) return int(self.arg_str or 0)
class ArgSubState(ArgState): class ArgSubState(ArgState):
@rx.var(cache=True) @rx.var
def cached_arg(self) -> int: def cached_arg(self) -> int:
return self.arg return self.arg
@rx.var(cache=True) @rx.var
def cached_arg_str(self) -> str: def cached_arg_str(self) -> str:
return self.arg_str return self.arg_str

4
tests/integration/test_lifespan.py
View File

@ -45,11 +45,11 @@ def LifespanApp():
class LifespanState(rx.State): class LifespanState(rx.State):
interval: int = 100 interval: int = 100
@rx.var @rx.var(cache=False)
def task_global(self) -> int: def task_global(self) -> int:
return lifespan_task_global return lifespan_task_global
@rx.var @rx.var(cache=False)
def context_global(self) -> int: def context_global(self) -> int:
return lifespan_context_global return lifespan_context_global

14
tests/integration/test_media.py
View File

@ -22,31 +22,31 @@ def MediaApp():
img.format = format # type: ignore img.format = format # type: ignore
return img return img
@rx.var(cache=True) @rx.var
def img_default(self) -> Image.Image: def img_default(self) -> Image.Image:
return self._blue() return self._blue()
@rx.var(cache=True) @rx.var
def img_bmp(self) -> Image.Image: def img_bmp(self) -> Image.Image:
return self._blue(format="BMP") return self._blue(format="BMP")
@rx.var(cache=True) @rx.var
def img_jpg(self) -> Image.Image: def img_jpg(self) -> Image.Image:
return self._blue(format="JPEG") return self._blue(format="JPEG")
@rx.var(cache=True) @rx.var
def img_png(self) -> Image.Image: def img_png(self) -> Image.Image:
return self._blue(format="PNG") return self._blue(format="PNG")
@rx.var(cache=True) @rx.var
def img_gif(self) -> Image.Image: def img_gif(self) -> Image.Image:
return self._blue(format="GIF") return self._blue(format="GIF")
@rx.var(cache=True) @rx.var
def img_webp(self) -> Image.Image: def img_webp(self) -> Image.Image:
return self._blue(format="WEBP") return self._blue(format="WEBP")
@rx.var(cache=True) @rx.var
def img_from_url(self) -> Image.Image: def img_from_url(self) -> Image.Image:
img_url = "https://picsum.photos/id/1/200/300" img_url = "https://picsum.photos/id/1/200/300"
img_resp = httpx.get(img_url, follow_redirects=True) img_resp = httpx.get(img_url, follow_redirects=True)

8
tests/units/test_app.py
View File

@ -908,7 +908,7 @@ class DynamicState(BaseState):
"""Increment the counter var.""" """Increment the counter var."""
self.counter = self.counter + 1 self.counter = self.counter + 1
@computed_var(cache=True) @computed_var
def comp_dynamic(self) -> str: def comp_dynamic(self) -> str:
"""A computed var that depends on the dynamic var. """A computed var that depends on the dynamic var.
@ -1549,11 +1549,11 @@ def test_app_with_valid_var_dependencies(compilable_app: tuple[App, Path]):
base: int = 0 base: int = 0
_backend: int = 0 _backend: int = 0
@computed_var(cache=True) @computed_var()
def foo(self) -> str: def foo(self) -> str:
return "foo" return "foo"
@computed_var(deps=["_backend", "base", foo], cache=True) @computed_var(deps=["_backend", "base", foo])
def bar(self) -> str: def bar(self) -> str:
return "bar" return "bar"
@ -1565,7 +1565,7 @@ def test_app_with_invalid_var_dependencies(compilable_app: tuple[App, Path]):
app, _ = compilable_app app, _ = compilable_app
class InvalidDepState(BaseState): class InvalidDepState(BaseState):
@computed_var(deps=["foolksjdf"], cache=True) @computed_var(deps=["foolksjdf"])
def bar(self) -> str: def bar(self) -> str:
return "bar" return "bar"

74
tests/units/test_state.py
View File

@ -203,7 +203,7 @@ class GrandchildState(ChildState):
class GrandchildState2(ChildState2): class GrandchildState2(ChildState2):
"""A grandchild state fixture.""" """A grandchild state fixture."""
@rx.var(cache=True) @rx.var
def cached(self) -> str: def cached(self) -> str:
"""A cached var. """A cached var.
@ -216,7 +216,7 @@ class GrandchildState2(ChildState2):
class GrandchildState3(ChildState3): class GrandchildState3(ChildState3):
"""A great grandchild state fixture.""" """A great grandchild state fixture."""
@rx.var @rx.var(cache=False)
def computed(self) -> str: def computed(self) -> str:
"""A computed var. """A computed var.
@ -800,7 +800,7 @@ async def test_process_event_simple(test_state):
# The delta should contain the changes, including computed vars. # The delta should contain the changes, including computed vars.
assert update.delta == { assert update.delta == {
TestState.get_full_name(): {"num1": 69, "sum": 72.14, "upper": ""}, TestState.get_full_name(): {"num1": 69, "sum": 72.14},
GrandchildState3.get_full_name(): {"computed": ""}, GrandchildState3.get_full_name(): {"computed": ""},
} }
assert update.events == [] assert update.events == []
@ -827,7 +827,7 @@ async def test_process_event_substate(test_state, child_state, grandchild_state)
assert child_state.value == "HI" assert child_state.value == "HI"
assert child_state.count == 24 assert child_state.count == 24
assert update.delta == { assert update.delta == {
TestState.get_full_name(): {"sum": 3.14, "upper": ""}, # TestState.get_full_name(): {"sum": 3.14, "upper": ""},
ChildState.get_full_name(): {"value": "HI", "count": 24}, ChildState.get_full_name(): {"value": "HI", "count": 24},
GrandchildState3.get_full_name(): {"computed": ""}, GrandchildState3.get_full_name(): {"computed": ""},
} }
@ -843,7 +843,7 @@ async def test_process_event_substate(test_state, child_state, grandchild_state)
update = await test_state._process(event).__anext__() update = await test_state._process(event).__anext__()
assert grandchild_state.value2 == "new" assert grandchild_state.value2 == "new"
assert update.delta == { assert update.delta == {
TestState.get_full_name(): {"sum": 3.14, "upper": ""}, # TestState.get_full_name(): {"sum": 3.14, "upper": ""},
GrandchildState.get_full_name(): {"value2": "new"}, GrandchildState.get_full_name(): {"value2": "new"},
GrandchildState3.get_full_name(): {"computed": ""}, GrandchildState3.get_full_name(): {"computed": ""},
} }
@ -993,7 +993,7 @@ class InterdependentState(BaseState):
v1: int = 0 v1: int = 0
_v2: int = 1 _v2: int = 1
@rx.var(cache=True) @rx.var
def v1x2(self) -> int: def v1x2(self) -> int:
"""Depends on var v1. """Depends on var v1.
@ -1002,7 +1002,7 @@ class InterdependentState(BaseState):
""" """
return self.v1 * 2 return self.v1 * 2
@rx.var(cache=True) @rx.var
def v2x2(self) -> int: def v2x2(self) -> int:
"""Depends on backend var _v2. """Depends on backend var _v2.
@ -1011,7 +1011,7 @@ class InterdependentState(BaseState):
""" """
return self._v2 * 2 return self._v2 * 2
@rx.var(cache=True, backend=True) @rx.var(backend=True)
def v2x2_backend(self) -> int: def v2x2_backend(self) -> int:
"""Depends on backend var _v2. """Depends on backend var _v2.
@ -1020,7 +1020,7 @@ class InterdependentState(BaseState):
""" """
return self._v2 * 2 return self._v2 * 2
@rx.var(cache=True) @rx.var
def v1x2x2(self) -> int: def v1x2x2(self) -> int:
"""Depends on ComputedVar v1x2. """Depends on ComputedVar v1x2.
@ -1029,7 +1029,7 @@ class InterdependentState(BaseState):
""" """
return self.v1x2 * 2 # type: ignore return self.v1x2 * 2 # type: ignore
@rx.var(cache=True) @rx.var
def _v3(self) -> int: def _v3(self) -> int:
"""Depends on backend var _v2. """Depends on backend var _v2.
@ -1038,7 +1038,7 @@ class InterdependentState(BaseState):
""" """
return self._v2 return self._v2
@rx.var(cache=True) @rx.var
def v3x2(self) -> int: def v3x2(self) -> int:
"""Depends on ComputedVar _v3. """Depends on ComputedVar _v3.
@ -1243,7 +1243,7 @@ def test_computed_var_cached():
class ComputedState(BaseState): class ComputedState(BaseState):
v: int = 0 v: int = 0
@rx.var(cache=True) @rx.var
def comp_v(self) -> int: def comp_v(self) -> int:
nonlocal comp_v_calls nonlocal comp_v_calls
comp_v_calls += 1 comp_v_calls += 1
@ -1268,15 +1268,15 @@ def test_computed_var_cached_depends_on_non_cached():
class ComputedState(BaseState): class ComputedState(BaseState):
v: int = 0 v: int = 0
@rx.var @rx.var(cache=False)
def no_cache_v(self) -> int: def no_cache_v(self) -> int:
return self.v return self.v
@rx.var(cache=True) @rx.var
def dep_v(self) -> int: def dep_v(self) -> int:
return self.no_cache_v # type: ignore return self.no_cache_v # type: ignore
@rx.var(cache=True) @rx.var
def comp_v(self) -> int: def comp_v(self) -> int:
return self.v return self.v
@ -1308,14 +1308,14 @@ def test_computed_var_depends_on_parent_non_cached():
counter = 0 counter = 0
class ParentState(BaseState): class ParentState(BaseState):
@rx.var @rx.var(cache=False)
def no_cache_v(self) -> int: def no_cache_v(self) -> int:
nonlocal counter nonlocal counter
counter += 1 counter += 1
return counter return counter
class ChildState(ParentState): class ChildState(ParentState):
@rx.var(cache=True) @rx.var
def dep_v(self) -> int: def dep_v(self) -> int:
return self.no_cache_v # type: ignore return self.no_cache_v # type: ignore
@ -1362,7 +1362,7 @@ def test_cached_var_depends_on_event_handler(use_partial: bool):
def handler(self): def handler(self):
self.x = self.x + 1 self.x = self.x + 1
@rx.var(cache=True) @rx.var
def cached_x_side_effect(self) -> int: def cached_x_side_effect(self) -> int:
self.handler() self.handler()
nonlocal counter nonlocal counter
@ -1398,7 +1398,7 @@ def test_computed_var_dependencies():
def testprop(self) -> int: def testprop(self) -> int:
return self.v return self.v
@rx.var(cache=True) @rx.var
def comp_v(self) -> int: def comp_v(self) -> int:
"""Direct access. """Direct access.
@ -1407,7 +1407,7 @@ def test_computed_var_dependencies():
""" """
return self.v return self.v
@rx.var(cache=True, backend=True) @rx.var(backend=True)
def comp_v_backend(self) -> int: def comp_v_backend(self) -> int:
"""Direct access backend var. """Direct access backend var.
@ -1416,7 +1416,7 @@ def test_computed_var_dependencies():
""" """
return self.v return self.v
@rx.var(cache=True) @rx.var
def comp_v_via_property(self) -> int: def comp_v_via_property(self) -> int:
"""Access v via property. """Access v via property.
@ -1425,7 +1425,7 @@ def test_computed_var_dependencies():
""" """
return self.testprop return self.testprop
@rx.var(cache=True) @rx.var
def comp_w(self): def comp_w(self):
"""Nested lambda. """Nested lambda.
@ -1434,7 +1434,7 @@ def test_computed_var_dependencies():
""" """
return lambda: self.w return lambda: self.w
@rx.var(cache=True) @rx.var
def comp_x(self): def comp_x(self):
"""Nested function. """Nested function.
@ -1447,7 +1447,7 @@ def test_computed_var_dependencies():
return _ return _
@rx.var(cache=True) @rx.var
def comp_y(self) -> List[int]: def comp_y(self) -> List[int]:
"""Comprehension iterating over attribute. """Comprehension iterating over attribute.
@ -1456,7 +1456,7 @@ def test_computed_var_dependencies():
""" """
return [round(y) for y in self.y] return [round(y) for y in self.y]
@rx.var(cache=True) @rx.var
def comp_z(self) -> List[bool]: def comp_z(self) -> List[bool]:
"""Comprehension accesses attribute. """Comprehension accesses attribute.
@ -2035,10 +2035,6 @@ async def test_state_proxy(grandchild_state: GrandchildState, mock_app: rx.App):
assert mcall.args[0] == str(SocketEvent.EVENT) assert mcall.args[0] == str(SocketEvent.EVENT)
assert mcall.args[1] == StateUpdate( assert mcall.args[1] == StateUpdate(
delta={ delta={
parent_state.get_full_name(): {
"upper": "",
"sum": 3.14,
},
grandchild_state.get_full_name(): { grandchild_state.get_full_name(): {
"value2": "42", "value2": "42",
}, },
@ -2061,7 +2057,7 @@ class BackgroundTaskState(BaseState):
super().__init__(**kwargs) super().__init__(**kwargs)
self.router_data = {"simulate": "hydrate"} self.router_data = {"simulate": "hydrate"}
@rx.var @rx.var(cache=False)
def computed_order(self) -> List[str]: def computed_order(self) -> List[str]:
"""Get the order as a computed var. """Get the order as a computed var.
@ -3052,10 +3048,6 @@ async def test_get_state(mock_app: rx.App, token: str):
grandchild_state.value2 = "set_value" grandchild_state.value2 = "set_value"
assert test_state.get_delta() == { assert test_state.get_delta() == {
TestState.get_full_name(): {
"sum": 3.14,
"upper": "",
},
GrandchildState.get_full_name(): { GrandchildState.get_full_name(): {
"value2": "set_value", "value2": "set_value",
}, },
@ -3093,10 +3085,6 @@ async def test_get_state(mock_app: rx.App, token: str):
child_state2.value = "set_c2_value" child_state2.value = "set_c2_value"
assert new_test_state.get_delta() == { assert new_test_state.get_delta() == {
TestState.get_full_name(): {
"sum": 3.14,
"upper": "",
},
ChildState2.get_full_name(): { ChildState2.get_full_name(): {
"value": "set_c2_value", "value": "set_c2_value",
}, },
@ -3151,7 +3139,7 @@ async def test_get_state_from_sibling_not_cached(mock_app: rx.App, token: str):
child3_var: int = 0 child3_var: int = 0
@rx.var @rx.var(cache=False)
def v(self): def v(self):
pass pass
@ -3222,8 +3210,8 @@ def test_potentially_dirty_substates():
def bar(self) -> str: def bar(self) -> str:
return "" return ""
assert RxState._potentially_dirty_substates() == {State} assert RxState._potentially_dirty_substates() == set()
assert State._potentially_dirty_substates() == {C1} assert State._potentially_dirty_substates() == set()
assert C1._potentially_dirty_substates() == set() assert C1._potentially_dirty_substates() == set()
@ -3238,7 +3226,7 @@ def test_router_var_dep() -> None:
class RouterVarDepState(RouterVarParentState): class RouterVarDepState(RouterVarParentState):
"""A state with a router var dependency.""" """A state with a router var dependency."""
@rx.var(cache=True) @rx.var
def foo(self) -> str: def foo(self) -> str:
return self.router.page.params.get("foo", "") return self.router.page.params.get("foo", "")
@ -3433,7 +3421,7 @@ class MixinState(State, mixin=True):
_backend: int = 0 _backend: int = 0
_backend_no_default: dict _backend_no_default: dict
@rx.var(cache=True) @rx.var
def computed(self) -> str: def computed(self) -> str:
"""A computed var on mixin state. """A computed var on mixin state.

8
tests/units/test_state_tree.py
View File

@ -42,7 +42,7 @@ class SubA_A_A_A(SubA_A_A):
class SubA_A_A_B(SubA_A_A): class SubA_A_A_B(SubA_A_A):
"""SubA_A_A_B is a child of SubA_A_A.""" """SubA_A_A_B is a child of SubA_A_A."""
@rx.var(cache=True) @rx.var
def sub_a_a_a_cached(self) -> int: def sub_a_a_a_cached(self) -> int:
"""A cached var. """A cached var.
@ -117,7 +117,7 @@ class TreeD(Root):
d: int d: int
@rx.var @rx.var(cache=False)
def d_var(self) -> int: def d_var(self) -> int:
"""A computed var. """A computed var.
@ -156,7 +156,7 @@ class SubE_A_A_A_A(SubE_A_A_A):
sub_e_a_a_a_a: int sub_e_a_a_a_a: int
@rx.var @rx.var(cache=False)
def sub_e_a_a_a_a_var(self) -> int: def sub_e_a_a_a_a_var(self) -> int:
"""A computed var. """A computed var.
@ -183,7 +183,7 @@ class SubE_A_A_A_D(SubE_A_A_A):
sub_e_a_a_a_d: int sub_e_a_a_a_d: int
@rx.var(cache=True) @rx.var
def sub_e_a_a_a_d_var(self) -> int: def sub_e_a_a_a_d_var(self) -> int:
"""A computed var. """A computed var.

10
tests/units/test_var.py
View File

@ -1995,10 +1995,7 @@ def cv_fget(state: BaseState) -> int:
], ],
) )
def test_computed_var_deps(deps: List[Union[str, Var]], expected: Set[str]): def test_computed_var_deps(deps: List[Union[str, Var]], expected: Set[str]):
@computed_var( @computed_var(deps=deps)
deps=deps,
cache=True,
)
def test_var(state) -> int: def test_var(state) -> int:
return 1 return 1
@ -2016,10 +2013,7 @@ def test_computed_var_deps(deps: List[Union[str, Var]], expected: Set[str]):
def test_invalid_computed_var_deps(deps: List): def test_invalid_computed_var_deps(deps: List):
with pytest.raises(TypeError): with pytest.raises(TypeError):
@computed_var( @computed_var(deps=deps)
deps=deps,
cache=True,
)
def test_var(state) -> int: def test_var(state) -> int:
return 1 return 1