123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215 |
- from typing import Any, Dict, List, Type
- import pytest
- import reflex as rx
- from reflex.base import Base
- from reflex.components.base.bare import Bare
- from reflex.components.chakra.layout.box import Box
- from reflex.components.component import (
- Component,
- CustomComponent,
- StatefulComponent,
- custom_component,
- )
- from reflex.constants import EventTriggers
- from reflex.event import EventChain, EventHandler
- from reflex.state import BaseState
- from reflex.style import Style
- from reflex.utils import imports
- from reflex.utils.imports import ImportVar
- from reflex.vars import Var, VarData
- @pytest.fixture
- def test_state():
- class TestState(BaseState):
- num: int
- def do_something(self):
- pass
- def do_something_arg(self, arg):
- pass
- return TestState
- @pytest.fixture
- def component1() -> Type[Component]:
- """A test component.
- Returns:
- A test component.
- """
- class TestComponent1(Component):
- # A test string prop.
- text: Var[str]
- # A test number prop.
- number: Var[int]
- def _get_imports(self) -> imports.ImportDict:
- return {"react": [ImportVar(tag="Component")]}
- def _get_custom_code(self) -> str:
- return "console.log('component1')"
- return TestComponent1
- @pytest.fixture
- def component2() -> Type[Component]:
- """A test component.
- Returns:
- A test component.
- """
- class TestComponent2(Component):
- # A test list prop.
- arr: Var[List[str]]
- def get_event_triggers(self) -> Dict[str, Any]:
- """Test controlled triggers.
- Returns:
- Test controlled triggers.
- """
- return {
- **super().get_event_triggers(),
- "on_open": lambda e0: [e0],
- "on_close": lambda e0: [e0],
- }
- def _get_imports(self) -> imports.ImportDict:
- return {"react-redux": [ImportVar(tag="connect")]}
- def _get_custom_code(self) -> str:
- return "console.log('component2')"
- return TestComponent2
- @pytest.fixture
- def component3() -> Type[Component]:
- """A test component with hook defined.
- Returns:
- A test component.
- """
- class TestComponent3(Component):
- def _get_hooks(self) -> str:
- return "const a = () => true"
- return TestComponent3
- @pytest.fixture
- def component4() -> Type[Component]:
- """A test component with hook defined.
- Returns:
- A test component.
- """
- class TestComponent4(Component):
- def _get_hooks(self) -> str:
- return "const b = () => false"
- return TestComponent4
- @pytest.fixture
- def component5() -> Type[Component]:
- """A test component.
- Returns:
- A test component.
- """
- class TestComponent5(Component):
- tag = "RandomComponent"
- _invalid_children: List[str] = ["Text"]
- _valid_children: List[str] = ["Text"]
- _valid_parents: List[str] = ["Text"]
- return TestComponent5
- @pytest.fixture
- def component6() -> Type[Component]:
- """A test component.
- Returns:
- A test component.
- """
- class TestComponent6(Component):
- tag = "RandomComponent"
- _invalid_children: List[str] = ["Text"]
- return TestComponent6
- @pytest.fixture
- def component7() -> Type[Component]:
- """A test component.
- Returns:
- A test component.
- """
- class TestComponent7(Component):
- tag = "RandomComponent"
- _valid_children: List[str] = ["Text"]
- return TestComponent7
- @pytest.fixture
- def on_click1() -> EventHandler:
- """A sample on click function.
- Returns:
- A sample on click function.
- """
- def on_click1():
- pass
- return EventHandler(fn=on_click1)
- @pytest.fixture
- def on_click2() -> EventHandler:
- """A sample on click function.
- Returns:
- A sample on click function.
- """
- def on_click2():
- pass
- return EventHandler(fn=on_click2)
- @pytest.fixture
- def my_component():
- """A test component function.
- Returns:
- A test component function.
- """
- def my_component(prop1: Var[str], prop2: Var[int]):
- return Box.create(prop1, prop2)
- return my_component
- def test_set_style_attrs(component1):
- """Test that style attributes are set in the dict.
- Args:
- component1: A test component.
- """
- component = component1(color="white", text_align="center")
- assert component.style["color"] == "white"
- assert component.style["textAlign"] == "center"
- def test_custom_attrs(component1):
- """Test that custom attributes are set in the dict.
- Args:
- component1: A test component.
- """
- component = component1(custom_attrs={"attr1": "1", "attr2": "attr2"})
- assert component.custom_attrs == {"attr1": "1", "attr2": "attr2"}
- def test_create_component(component1):
- """Test that the component is created correctly.
- Args:
- component1: A test component.
- """
- children = [component1() for _ in range(3)]
- attrs = {"color": "white", "text_align": "center"}
- c = component1.create(*children, **attrs)
- assert isinstance(c, component1)
- assert c.children == children
- assert c.style == {"color": "white", "textAlign": "center"}
- def test_add_style(component1, component2):
- """Test adding a style to a component.
- Args:
- component1: A test component.
- component2: A test component.
- """
- style = {
- component1: Style({"color": "white"}),
- component2: Style({"color": "black"}),
- }
- c1 = component1().add_style(style) # type: ignore
- c2 = component2().add_style(style) # type: ignore
- assert c1.style["color"] == "white"
- assert c2.style["color"] == "black"
- def test_add_style_create(component1, component2):
- """Test that adding style works with the create method.
- Args:
- component1: A test component.
- component2: A test component.
- """
- style = {
- component1.create: Style({"color": "white"}),
- component2.create: Style({"color": "black"}),
- }
- c1 = component1().add_style(style) # type: ignore
- c2 = component2().add_style(style) # type: ignore
- assert c1.style["color"] == "white"
- assert c2.style["color"] == "black"
- def test_get_imports(component1, component2):
- """Test getting the imports of a component.
- Args:
- component1: A test component.
- component2: A test component.
- """
- c1 = component1.create()
- c2 = component2.create(c1)
- assert c1.get_imports() == {"react": [ImportVar(tag="Component")]}
- assert c2.get_imports() == {
- "react-redux": [ImportVar(tag="connect")],
- "react": [ImportVar(tag="Component")],
- }
- def test_get_custom_code(component1, component2):
- """Test getting the custom code of a component.
- Args:
- component1: A test component.
- component2: A test component.
- """
- # Check that the code gets compiled correctly.
- c1 = component1.create()
- c2 = component2.create()
- assert c1.get_custom_code() == {"console.log('component1')"}
- assert c2.get_custom_code() == {"console.log('component2')"}
- # Check that nesting components compiles both codes.
- c1 = component1.create(c2)
- assert c1.get_custom_code() == {
- "console.log('component1')",
- "console.log('component2')",
- }
- # Check that code is not duplicated.
- c1 = component1.create(c2, c2, c1, c1)
- assert c1.get_custom_code() == {
- "console.log('component1')",
- "console.log('component2')",
- }
- def test_get_props(component1, component2):
- """Test that the props are set correctly.
- Args:
- component1: A test component.
- component2: A test component.
- """
- assert component1.get_props() == {"text", "number"}
- assert component2.get_props() == {"arr"}
- @pytest.mark.parametrize(
- "text,number",
- [
- ("", 0),
- ("test", 1),
- ("hi", -13),
- ],
- )
- def test_valid_props(component1, text: str, number: int):
- """Test that we can construct a component with valid props.
- Args:
- component1: A test component.
- text: A test string.
- number: A test number.
- """
- c = component1.create(text=text, number=number)
- assert c.text._decode() == text
- assert c.number._decode() == number
- @pytest.mark.parametrize(
- "text,number", [("", "bad_string"), (13, 1), (None, 1), ("test", [1, 2, 3])]
- )
- def test_invalid_prop_type(component1, text: str, number: int):
- """Test that an invalid prop type raises an error.
- Args:
- component1: A test component.
- text: A test string.
- number: A test number.
- """
- # Check that
- with pytest.raises(TypeError):
- component1.create(text=text, number=number)
- def test_var_props(component1, test_state):
- """Test that we can set a Var prop.
- Args:
- component1: A test component.
- test_state: A test state.
- """
- c1 = component1.create(text="hello", number=test_state.num)
- assert c1.number.equals(test_state.num)
- def test_get_event_triggers(component1, component2):
- """Test that we can get the triggers of a component.
- Args:
- component1: A test component.
- component2: A test component.
- """
- default_triggers = {
- EventTriggers.ON_FOCUS,
- EventTriggers.ON_BLUR,
- EventTriggers.ON_CLICK,
- EventTriggers.ON_CONTEXT_MENU,
- EventTriggers.ON_DOUBLE_CLICK,
- EventTriggers.ON_MOUSE_DOWN,
- EventTriggers.ON_MOUSE_ENTER,
- EventTriggers.ON_MOUSE_LEAVE,
- EventTriggers.ON_MOUSE_MOVE,
- EventTriggers.ON_MOUSE_OUT,
- EventTriggers.ON_MOUSE_OVER,
- EventTriggers.ON_MOUSE_UP,
- EventTriggers.ON_SCROLL,
- EventTriggers.ON_MOUNT,
- EventTriggers.ON_UNMOUNT,
- }
- assert set(component1().get_event_triggers().keys()) == default_triggers
- assert (
- component2().get_event_triggers().keys()
- == {"on_open", "on_close"} | default_triggers
- )
- class C1State(BaseState):
- """State for testing C1 component."""
- def mock_handler(self, _e, _bravo, _charlie):
- """Mock handler."""
- pass
- def test_component_event_trigger_arbitrary_args():
- """Test that we can define arbitrary types for the args of an event trigger."""
- class Obj(Base):
- custom: int = 0
- def on_foo_spec(_e, alpha: str, bravo: Dict[str, Any], charlie: Obj):
- return [_e.target.value, bravo["nested"], charlie.custom + 42]
- class C1(Component):
- library = "/local"
- tag = "C1"
- def get_event_triggers(self) -> Dict[str, Any]:
- return {
- **super().get_event_triggers(),
- "on_foo": on_foo_spec,
- }
- comp = C1.create(on_foo=C1State.mock_handler)
- assert comp.render()["props"][0] == (
- "onFoo={(__e,_alpha,_bravo,_charlie) => addEvents("
- '[Event("c1_state.mock_handler", {_e:__e.target.value,_bravo:_bravo["nested"],_charlie:((_charlie.custom) + (42))})], '
- "(__e,_alpha,_bravo,_charlie), {})}"
- )
- def test_create_custom_component(my_component):
- """Test that we can create a custom component.
- Args:
- my_component: A test custom component.
- """
- component = CustomComponent(component_fn=my_component, prop1="test", prop2=1)
- assert component.tag == "MyComponent"
- assert component.get_props() == set()
- assert component.get_custom_components() == {component}
- def test_custom_component_hash(my_component):
- """Test that the hash of a custom component is correct.
- Args:
- my_component: A test custom component.
- """
- component1 = CustomComponent(component_fn=my_component, prop1="test", prop2=1)
- component2 = CustomComponent(component_fn=my_component, prop1="test", prop2=2)
- assert {component1, component2} == {component1}
- def test_custom_component_wrapper():
- """Test that the wrapper of a custom component is correct."""
- @custom_component
- def my_component(width: Var[int], color: Var[str]):
- return rx.box(
- width=width,
- color=color,
- )
- from reflex.components.radix.themes.typography.text import Text
- ccomponent = my_component(
- rx.text("child"), width=Var.create(1), color=Var.create("red")
- )
- assert isinstance(ccomponent, CustomComponent)
- assert len(ccomponent.children) == 1
- assert isinstance(ccomponent.children[0], Text)
- component = ccomponent.get_component(ccomponent)
- assert isinstance(component, Box)
- def test_invalid_event_handler_args(component2, test_state):
- """Test that an invalid event handler raises an error.
- Args:
- component2: A test component.
- test_state: A test state.
- """
- # Uncontrolled event handlers should not take args.
- # This is okay.
- component2.create(on_click=test_state.do_something)
- # This is not okay.
- with pytest.raises(ValueError):
- component2.create(on_click=test_state.do_something_arg)
- component2.create(on_open=test_state.do_something)
- component2.create(
- on_open=[test_state.do_something_arg, test_state.do_something]
- )
- # However lambdas are okay.
- component2.create(on_click=lambda: test_state.do_something_arg(1))
- component2.create(
- on_click=lambda: [test_state.do_something_arg(1), test_state.do_something]
- )
- component2.create(
- on_click=lambda: [test_state.do_something_arg(1), test_state.do_something()]
- )
- # Controlled event handlers should take args.
- # This is okay.
- component2.create(on_open=test_state.do_something_arg)
- def test_get_hooks_nested(component1, component2, component3):
- """Test that a component returns hooks from child components.
- Args:
- component1: test component.
- component2: another component.
- component3: component with hooks defined.
- """
- c = component1.create(
- component2.create(arr=[]),
- component3.create(),
- component3.create(),
- component3.create(),
- text="a",
- number=1,
- )
- assert c.get_hooks() == component3().get_hooks()
- def test_get_hooks_nested2(component3, component4):
- """Test that a component returns both when parent and child have hooks.
- Args:
- component3: component with hooks defined.
- component4: component with different hooks defined.
- """
- exp_hooks = component3().get_hooks().union(component4().get_hooks())
- assert component3.create(component4.create()).get_hooks() == exp_hooks
- assert component4.create(component3.create()).get_hooks() == exp_hooks
- assert (
- component4.create(
- component3.create(),
- component4.create(),
- component3.create(),
- ).get_hooks()
- == exp_hooks
- )
- @pytest.mark.parametrize("fixture", ["component5", "component6"])
- def test_unsupported_child_components(fixture, request):
- """Test that a value error is raised when an unsupported component (a child component found in the
- component's invalid children list) is provided as a child.
- Args:
- fixture: the test component as a fixture.
- request: Pytest request.
- """
- component = request.getfixturevalue(fixture)
- with pytest.raises(ValueError) as err:
- comp = component.create(rx.text("testing component"))
- comp.render()
- assert (
- err.value.args[0]
- == f"The component `{component.__name__}` cannot have `Text` as a child component"
- )
- def test_unsupported_parent_components(component5):
- """Test that a value error is raised when an component is not in _valid_parents of one of its children.
- Args:
- component5: component with valid parent of "Text" only
- """
- with pytest.raises(ValueError) as err:
- rx.box(component5.create())
- assert (
- err.value.args[0]
- == f"The component `{component5.__name__}` can only be a child of the components: `{component5._valid_parents[0]}`. Got `Box` instead."
- )
- @pytest.mark.parametrize("fixture", ["component5", "component7"])
- def test_component_with_only_valid_children(fixture, request):
- """Test that a value error is raised when an unsupported component (a child component not found in the
- component's valid children list) is provided as a child.
- Args:
- fixture: the test component as a fixture.
- request: Pytest request.
- """
- component = request.getfixturevalue(fixture)
- with pytest.raises(ValueError) as err:
- comp = component.create(rx.box("testing component"))
- comp.render()
- assert (
- err.value.args[0]
- == f"The component `{component.__name__}` only allows the components: `Text` as children. "
- f"Got `Box` instead."
- )
- @pytest.mark.parametrize(
- "component,rendered",
- [
- (rx.text("hi"), "<RadixThemesText as={`p`}>\n {`hi`}\n</RadixThemesText>"),
- (
- rx.box(rx.chakra.heading("test", size="md")),
- "<RadixThemesBox>\n <Heading size={`md`}>\n {`test`}\n</Heading>\n</RadixThemesBox>",
- ),
- ],
- )
- def test_format_component(component, rendered):
- """Test that a component is formatted correctly.
- Args:
- component: The component to format.
- rendered: The expected rendered component.
- """
- assert str(component) == rendered
- def test_stateful_component(test_state):
- """Test that a stateful component is created correctly.
- Args:
- test_state: A test state.
- """
- text_component = rx.text(test_state.num)
- stateful_component = StatefulComponent.compile_from(text_component)
- assert isinstance(stateful_component, StatefulComponent)
- assert stateful_component.tag is not None
- assert stateful_component.tag.startswith("Text_")
- assert stateful_component.references == 1
- sc2 = StatefulComponent.compile_from(rx.text(test_state.num))
- assert isinstance(sc2, StatefulComponent)
- assert stateful_component.references == 2
- assert sc2.references == 2
- def test_stateful_component_memoize_event_trigger(test_state):
- """Test that a stateful component is created correctly with events.
- Args:
- test_state: A test state.
- """
- button_component = rx.button("Click me", on_click=test_state.do_something)
- stateful_component = StatefulComponent.compile_from(button_component)
- assert isinstance(stateful_component, StatefulComponent)
- # No event trigger? No StatefulComponent
- assert not isinstance(
- StatefulComponent.compile_from(rx.button("Click me")), StatefulComponent
- )
- def test_stateful_banner():
- """Test that a stateful component is created correctly with events."""
- connection_modal_component = rx.connection_modal()
- stateful_component = StatefulComponent.compile_from(connection_modal_component)
- assert isinstance(stateful_component, StatefulComponent)
- TEST_VAR = Var.create_safe("test")._replace(
- merge_var_data=VarData(
- hooks={"useTest"},
- imports={"test": {ImportVar(tag="test")}},
- state="Test",
- interpolations=[],
- )
- )
- FORMATTED_TEST_VAR = Var.create(f"foo{TEST_VAR}bar")
- STYLE_VAR = TEST_VAR._replace(_var_name="style", _var_is_local=False)
- EVENT_CHAIN_VAR = TEST_VAR._replace(_var_type=EventChain)
- ARG_VAR = Var.create("arg")
- TEST_VAR_DICT_OF_DICT = Var.create_safe({"a": {"b": "test"}})._replace(
- merge_var_data=TEST_VAR._var_data
- )
- FORMATTED_TEST_VAR_DICT_OF_DICT = Var.create_safe({"a": {"b": f"footestbar"}})._replace(
- merge_var_data=TEST_VAR._var_data
- )
- TEST_VAR_LIST_OF_LIST = Var.create_safe([["test"]])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- FORMATTED_TEST_VAR_LIST_OF_LIST = Var.create_safe([["footestbar"]])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- TEST_VAR_LIST_OF_LIST_OF_LIST = Var.create_safe([[["test"]]])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- FORMATTED_TEST_VAR_LIST_OF_LIST_OF_LIST = Var.create_safe([[["footestbar"]]])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- TEST_VAR_LIST_OF_DICT = Var.create_safe([{"a": "test"}])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- FORMATTED_TEST_VAR_LIST_OF_DICT = Var.create_safe([{"a": "footestbar"}])._replace(
- merge_var_data=TEST_VAR._var_data
- )
- class ComponentNestedVar(Component):
- """A component with nested Var types."""
- dict_of_dict: Var[Dict[str, Dict[str, str]]]
- list_of_list: Var[List[List[str]]]
- list_of_list_of_list: Var[List[List[List[str]]]]
- list_of_dict: Var[List[Dict[str, str]]]
- class EventState(rx.State):
- """State for testing event handlers with _get_vars."""
- v: int = 42
- def handler(self):
- """A handler that does nothing."""
- def handler2(self, arg):
- """A handler that takes an arg.
- Args:
- arg: An arg.
- """
- @pytest.mark.parametrize(
- ("component", "exp_vars"),
- (
- pytest.param(
- Bare.create(TEST_VAR),
- [TEST_VAR],
- id="direct-bare",
- ),
- pytest.param(
- Bare.create(f"foo{TEST_VAR}bar"),
- [FORMATTED_TEST_VAR],
- id="fstring-bare",
- ),
- pytest.param(
- rx.text(as_=TEST_VAR),
- [TEST_VAR],
- id="direct-prop",
- ),
- pytest.param(
- rx.heading(as_=f"foo{TEST_VAR}bar"),
- [FORMATTED_TEST_VAR],
- id="fstring-prop",
- ),
- pytest.param(
- rx.fragment(id=TEST_VAR),
- [TEST_VAR],
- id="direct-id",
- ),
- pytest.param(
- rx.fragment(id=f"foo{TEST_VAR}bar"),
- [FORMATTED_TEST_VAR],
- id="fstring-id",
- ),
- pytest.param(
- rx.fragment(key=TEST_VAR),
- [TEST_VAR],
- id="direct-key",
- ),
- pytest.param(
- rx.fragment(key=f"foo{TEST_VAR}bar"),
- [FORMATTED_TEST_VAR],
- id="fstring-key",
- ),
- pytest.param(
- rx.fragment(class_name=TEST_VAR),
- [TEST_VAR],
- id="direct-class_name",
- ),
- pytest.param(
- rx.fragment(class_name=f"foo{TEST_VAR}bar"),
- [FORMATTED_TEST_VAR],
- id="fstring-class_name",
- ),
- pytest.param(
- rx.fragment(special_props={TEST_VAR}),
- [TEST_VAR],
- id="direct-special_props",
- ),
- pytest.param(
- rx.fragment(special_props={Var.create(f"foo{TEST_VAR}bar")}),
- [FORMATTED_TEST_VAR],
- id="fstring-special_props",
- ),
- pytest.param(
- # custom_attrs cannot accept a Var directly as a value
- rx.fragment(custom_attrs={"href": f"{TEST_VAR}"}),
- [TEST_VAR],
- id="fstring-custom_attrs-nofmt",
- ),
- pytest.param(
- rx.fragment(custom_attrs={"href": f"foo{TEST_VAR}bar"}),
- [FORMATTED_TEST_VAR],
- id="fstring-custom_attrs",
- ),
- pytest.param(
- rx.fragment(background_color=TEST_VAR),
- [STYLE_VAR],
- id="direct-background_color",
- ),
- pytest.param(
- rx.fragment(background_color=f"foo{TEST_VAR}bar"),
- [STYLE_VAR],
- id="fstring-background_color",
- ),
- pytest.param(
- rx.fragment(style={"background_color": TEST_VAR}), # type: ignore
- [STYLE_VAR],
- id="direct-style-background_color",
- ),
- pytest.param(
- rx.fragment(style={"background_color": f"foo{TEST_VAR}bar"}), # type: ignore
- [STYLE_VAR],
- id="fstring-style-background_color",
- ),
- pytest.param(
- rx.fragment(on_click=EVENT_CHAIN_VAR), # type: ignore
- [EVENT_CHAIN_VAR],
- id="direct-event-chain",
- ),
- pytest.param(
- rx.fragment(on_click=EventState.handler),
- [],
- id="direct-event-handler",
- ),
- pytest.param(
- rx.fragment(on_click=EventState.handler2(TEST_VAR)), # type: ignore
- [ARG_VAR, TEST_VAR],
- id="direct-event-handler-arg",
- ),
- pytest.param(
- rx.fragment(on_click=EventState.handler2(EventState.v)), # type: ignore
- [ARG_VAR, EventState.v],
- id="direct-event-handler-arg2",
- ),
- pytest.param(
- rx.fragment(on_click=lambda: EventState.handler2(TEST_VAR)), # type: ignore
- [ARG_VAR, TEST_VAR],
- id="direct-event-handler-lambda",
- ),
- pytest.param(
- ComponentNestedVar.create(dict_of_dict={"a": {"b": TEST_VAR}}),
- [TEST_VAR_DICT_OF_DICT],
- id="direct-dict_of_dict",
- ),
- pytest.param(
- ComponentNestedVar.create(dict_of_dict={"a": {"b": f"foo{TEST_VAR}bar"}}),
- [FORMATTED_TEST_VAR_DICT_OF_DICT],
- id="fstring-dict_of_dict",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_list=[[TEST_VAR]]),
- [TEST_VAR_LIST_OF_LIST],
- id="direct-list_of_list",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_list=[[f"foo{TEST_VAR}bar"]]),
- [FORMATTED_TEST_VAR_LIST_OF_LIST],
- id="fstring-list_of_list",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_list_of_list=[[[TEST_VAR]]]),
- [TEST_VAR_LIST_OF_LIST_OF_LIST],
- id="direct-list_of_list_of_list",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_list_of_list=[[[f"foo{TEST_VAR}bar"]]]),
- [FORMATTED_TEST_VAR_LIST_OF_LIST_OF_LIST],
- id="fstring-list_of_list_of_list",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_dict=[{"a": TEST_VAR}]),
- [TEST_VAR_LIST_OF_DICT],
- id="direct-list_of_dict",
- ),
- pytest.param(
- ComponentNestedVar.create(list_of_dict=[{"a": f"foo{TEST_VAR}bar"}]),
- [FORMATTED_TEST_VAR_LIST_OF_DICT],
- id="fstring-list_of_dict",
- ),
- ),
- )
- def test_get_vars(component, exp_vars):
- comp_vars = sorted(component._get_vars(), key=lambda v: v._var_name)
- assert len(comp_vars) == len(exp_vars)
- for comp_var, exp_var in zip(
- comp_vars,
- sorted(exp_vars, key=lambda v: v._var_name),
- ):
- assert comp_var.equals(exp_var)
- def test_instantiate_all_components():
- """Test that all components can be instantiated."""
- # These components all have required arguments and cannot be trivially instantiated.
- untested_components = {
- "Card",
- "Cond",
- "DebounceInput",
- "Foreach",
- "FormControl",
- "Html",
- "Icon",
- "Match",
- "Markdown",
- "MultiSelect",
- "Option",
- "Popover",
- "Radio",
- "Script",
- "Tag",
- "Tfoot",
- "Thead",
- }
- for component_name in rx._ALL_COMPONENTS: # type: ignore
- if component_name in untested_components:
- continue
- component = getattr(rx, component_name)
- if isinstance(component, type) and issubclass(component, Component):
- component.create()
- class InvalidParentComponent(Component):
- """Invalid Parent Component."""
- ...
- class ValidComponent1(Component):
- """Test valid component."""
- _valid_children = ["ValidComponent2"]
- class ValidComponent2(Component):
- """Test valid component."""
- ...
- class ValidComponent3(Component):
- """Test valid component."""
- _valid_parents = ["ValidComponent2"]
- class ValidComponent4(Component):
- """Test valid component."""
- _invalid_children = ["InvalidComponent"]
- class InvalidComponent(Component):
- """Test invalid component."""
- ...
- valid_component1 = ValidComponent1.create
- valid_component2 = ValidComponent2.create
- invalid_component = InvalidComponent.create
- valid_component3 = ValidComponent3.create
- invalid_parent = InvalidParentComponent.create
- valid_component4 = ValidComponent4.create
- def test_validate_valid_children():
- valid_component1(valid_component2())
- valid_component1(
- rx.fragment(valid_component2()),
- )
- valid_component1(
- rx.fragment(
- rx.fragment(
- rx.fragment(valid_component2()),
- ),
- ),
- )
- valid_component1(
- rx.cond( # type: ignore
- True,
- rx.fragment(valid_component2()),
- rx.fragment(
- rx.foreach(Var.create([1, 2, 3]), lambda x: valid_component2(x)) # type: ignore
- ),
- )
- )
- valid_component1(
- rx.cond(
- True,
- valid_component2(),
- rx.fragment(
- rx.match(
- "condition",
- ("first", valid_component2()),
- rx.fragment(valid_component2(rx.text("default"))),
- )
- ),
- )
- )
- valid_component1(
- rx.match(
- "condition",
- ("first", valid_component2()),
- ("second", "third", rx.fragment(valid_component2())),
- (
- "fourth",
- rx.cond(True, valid_component2(), rx.fragment(valid_component2())),
- ),
- (
- "fifth",
- rx.match(
- "nested_condition",
- ("nested_first", valid_component2()),
- rx.fragment(valid_component2()),
- ),
- valid_component2(),
- ),
- )
- )
- def test_validate_valid_parents():
- valid_component2(valid_component3())
- valid_component2(
- rx.fragment(valid_component3()),
- )
- valid_component1(
- rx.fragment(
- valid_component2(
- rx.fragment(valid_component3()),
- ),
- ),
- )
- valid_component2(
- rx.cond( # type: ignore
- True,
- rx.fragment(valid_component3()),
- rx.fragment(
- rx.foreach(
- Var.create([1, 2, 3]), # type: ignore
- lambda x: valid_component2(valid_component3(x)),
- )
- ),
- )
- )
- valid_component2(
- rx.cond(
- True,
- valid_component3(),
- rx.fragment(
- rx.match(
- "condition",
- ("first", valid_component3()),
- rx.fragment(valid_component3(rx.text("default"))),
- )
- ),
- )
- )
- valid_component2(
- rx.match(
- "condition",
- ("first", valid_component3()),
- ("second", "third", rx.fragment(valid_component3())),
- (
- "fourth",
- rx.cond(True, valid_component3(), rx.fragment(valid_component3())),
- ),
- (
- "fifth",
- rx.match(
- "nested_condition",
- ("nested_first", valid_component3()),
- rx.fragment(valid_component3()),
- ),
- valid_component3(),
- ),
- )
- )
- def test_validate_invalid_children():
- with pytest.raises(ValueError):
- valid_component4(invalid_component())
- with pytest.raises(ValueError):
- valid_component4(
- rx.fragment(invalid_component()),
- )
- with pytest.raises(ValueError):
- valid_component2(
- rx.fragment(
- valid_component4(
- rx.fragment(invalid_component()),
- ),
- ),
- )
- with pytest.raises(ValueError):
- valid_component4(
- rx.cond( # type: ignore
- True,
- rx.fragment(invalid_component()),
- rx.fragment(
- rx.foreach(Var.create([1, 2, 3]), lambda x: invalid_component(x)) # type: ignore
- ),
- )
- )
- with pytest.raises(ValueError):
- valid_component4(
- rx.cond(
- True,
- invalid_component(),
- rx.fragment(
- rx.match(
- "condition",
- ("first", invalid_component()),
- rx.fragment(invalid_component(rx.text("default"))),
- )
- ),
- )
- )
- with pytest.raises(ValueError):
- valid_component4(
- rx.match(
- "condition",
- ("first", invalid_component()),
- ("second", "third", rx.fragment(invalid_component())),
- (
- "fourth",
- rx.cond(True, invalid_component(), rx.fragment(valid_component2())),
- ),
- (
- "fifth",
- rx.match(
- "nested_condition",
- ("nested_first", invalid_component()),
- rx.fragment(invalid_component()),
- ),
- invalid_component(),
- ),
- )
- )
- def test_rename_props():
- """Test that _rename_props works and is inherited."""
- class C1(Component):
- tag = "C1"
- prop1: Var[str]
- prop2: Var[str]
- _rename_props = {"prop1": "renamed_prop1", "prop2": "renamed_prop2"}
- class C2(C1):
- tag = "C2"
- prop3: Var[str]
- _rename_props = {"prop2": "subclass_prop2", "prop3": "renamed_prop3"}
- c1 = C1.create(prop1="prop1_1", prop2="prop2_1")
- rendered_c1 = c1.render()
- assert "renamed_prop1={`prop1_1`}" in rendered_c1["props"]
- assert "renamed_prop2={`prop2_1`}" in rendered_c1["props"]
- c2 = C2.create(prop1="prop1_2", prop2="prop2_2", prop3="prop3_2")
- rendered_c2 = c2.render()
- assert "renamed_prop1={`prop1_2`}" in rendered_c2["props"]
- assert "subclass_prop2={`prop2_2`}" in rendered_c2["props"]
- assert "renamed_prop3={`prop3_2`}" in rendered_c2["props"]
|