match.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. """rx.match."""
  2. import textwrap
  3. from typing import Any
  4. from reflex.components.base import Fragment
  5. from reflex.components.component import BaseComponent, Component, MemoizationLeaf
  6. from reflex.components.tags import MatchTag, Tag
  7. from reflex.style import Style
  8. from reflex.utils import format
  9. from reflex.utils.exceptions import MatchTypeError
  10. from reflex.utils.imports import ImportDict
  11. from reflex.vars import VarData
  12. from reflex.vars.base import LiteralVar, Var
  13. class Match(MemoizationLeaf):
  14. """Match cases based on a condition."""
  15. # The condition to determine which case to match.
  16. cond: Var[Any]
  17. # The list of match cases to be matched.
  18. match_cases: list[Any] = []
  19. # The catchall case to match.
  20. default: Any
  21. @classmethod
  22. def create(cls, cond: Any, *cases) -> Component | Var:
  23. """Create a Match Component.
  24. Args:
  25. cond: The condition to determine which case to match.
  26. cases: This list of cases to match.
  27. Returns:
  28. The match component.
  29. Raises:
  30. ValueError: When a default case is not provided for cases with Var return types.
  31. """
  32. match_cond_var = cls._create_condition_var(cond)
  33. cases, default = cls._process_cases(list(cases))
  34. match_cases = cls._process_match_cases(cases)
  35. cls._validate_return_types(match_cases)
  36. if default is None and isinstance(match_cases[0][-1], Var):
  37. raise ValueError(
  38. "For cases with return types as Vars, a default case must be provided"
  39. )
  40. return cls._create_match_cond_var_or_component(
  41. match_cond_var, match_cases, default
  42. )
  43. @classmethod
  44. def _create_condition_var(cls, cond: Any) -> Var:
  45. """Convert the condition to a Var.
  46. Args:
  47. cond: The condition.
  48. Returns:
  49. The condition as a base var
  50. Raises:
  51. ValueError: If the condition is not provided.
  52. """
  53. match_cond_var = LiteralVar.create(cond)
  54. if match_cond_var is None:
  55. raise ValueError("The condition must be set")
  56. return match_cond_var
  57. @classmethod
  58. def _process_cases(cls, cases: list) -> tuple[list, Var | BaseComponent | None]:
  59. """Process the list of match cases and the catchall default case.
  60. Args:
  61. cases: The list of match cases.
  62. Returns:
  63. The default case and the list of match case tuples.
  64. Raises:
  65. ValueError: If there are multiple default cases.
  66. """
  67. default = None
  68. if len([case for case in cases if not isinstance(case, tuple)]) > 1:
  69. raise ValueError("rx.match can only have one default case.")
  70. if not cases:
  71. raise ValueError("rx.match should have at least one case.")
  72. # Get the default case which should be the last non-tuple arg
  73. if not isinstance(cases[-1], tuple):
  74. default = cases.pop()
  75. default = (
  76. cls._create_case_var_with_var_data(default)
  77. if not isinstance(default, BaseComponent)
  78. else default
  79. )
  80. return cases, default
  81. @classmethod
  82. def _create_case_var_with_var_data(cls, case_element: Any) -> Var:
  83. """Convert a case element into a Var.If the case
  84. is a Style type, we extract the var data and merge it with the
  85. newly created Var.
  86. Args:
  87. case_element: The case element.
  88. Returns:
  89. The case element Var.
  90. """
  91. _var_data = case_element._var_data if isinstance(case_element, Style) else None
  92. case_element = LiteralVar.create(case_element, _var_data=_var_data)
  93. return case_element
  94. @classmethod
  95. def _process_match_cases(cls, cases: list) -> list[list[Var]]:
  96. """Process the individual match cases.
  97. Args:
  98. cases: The match cases.
  99. Returns:
  100. The processed match cases.
  101. Raises:
  102. ValueError: If the default case is not the last case or the tuple elements are less than 2.
  103. """
  104. match_cases = []
  105. for case in cases:
  106. if not isinstance(case, tuple):
  107. raise ValueError(
  108. "rx.match should have tuples of cases and a default case as the last argument."
  109. )
  110. # There should be at least two elements in a case tuple(a condition and return value)
  111. if len(case) < 2:
  112. raise ValueError(
  113. "A case tuple should have at least a match case element and a return value."
  114. )
  115. case_list = []
  116. for element in case:
  117. # convert all non component element to vars.
  118. el = (
  119. cls._create_case_var_with_var_data(element)
  120. if not isinstance(element, BaseComponent)
  121. else element
  122. )
  123. if not isinstance(el, (Var, BaseComponent)):
  124. raise ValueError("Case element must be a var or component")
  125. case_list.append(el)
  126. match_cases.append(case_list)
  127. return match_cases
  128. @classmethod
  129. def _validate_return_types(cls, match_cases: list[list[Var]]) -> None:
  130. """Validate that match cases have the same return types.
  131. Args:
  132. match_cases: The match cases.
  133. Raises:
  134. MatchTypeError: If the return types of cases are different.
  135. """
  136. first_case_return = match_cases[0][-1]
  137. return_type = type(first_case_return)
  138. if isinstance(first_case_return, BaseComponent):
  139. return_type = BaseComponent
  140. elif isinstance(first_case_return, Var):
  141. return_type = Var
  142. for index, case in enumerate(match_cases):
  143. if not isinstance(case[-1], return_type):
  144. raise MatchTypeError(
  145. f"Match cases should have the same return types. Case {index} with return "
  146. f"value `{case[-1]._js_expr if isinstance(case[-1], Var) else textwrap.shorten(str(case[-1]), width=250)}`"
  147. f" of type {type(case[-1])!r} is not {return_type}"
  148. )
  149. @classmethod
  150. def _create_match_cond_var_or_component(
  151. cls,
  152. match_cond_var: Var,
  153. match_cases: list[list[Var]],
  154. default: Var | BaseComponent | None,
  155. ) -> Component | Var:
  156. """Create and return the match condition var or component.
  157. Args:
  158. match_cond_var: The match condition.
  159. match_cases: The list of match cases.
  160. default: The default case.
  161. Returns:
  162. The match component wrapped in a fragment or the match var.
  163. Raises:
  164. ValueError: If the return types are not vars when creating a match var for Var types.
  165. """
  166. if default is None and isinstance(match_cases[0][-1], BaseComponent):
  167. default = Fragment.create()
  168. if isinstance(match_cases[0][-1], BaseComponent):
  169. return Fragment.create(
  170. cls._create(
  171. cond=match_cond_var,
  172. match_cases=match_cases,
  173. default=default,
  174. children=[case[-1] for case in match_cases] + [default], # pyright: ignore [reportArgumentType]
  175. )
  176. )
  177. # Validate the match cases (as well as the default case) to have Var return types.
  178. if any(
  179. case for case in match_cases if not isinstance(case[-1], Var)
  180. ) or not isinstance(default, Var):
  181. raise ValueError("Return types of match cases should be Vars.")
  182. return Var(
  183. _js_expr=format.format_match(
  184. cond=str(match_cond_var),
  185. match_cases=match_cases,
  186. default=default,
  187. ),
  188. _var_type=default._var_type,
  189. _var_data=VarData.merge(
  190. match_cond_var._get_all_var_data(),
  191. *[el._get_all_var_data() for case in match_cases for el in case],
  192. default._get_all_var_data(),
  193. ),
  194. )
  195. def _render(self) -> Tag:
  196. return MatchTag(
  197. cond=self.cond, match_cases=self.match_cases, default=self.default
  198. )
  199. def render(self) -> dict:
  200. """Render the component.
  201. Returns:
  202. The dictionary for template of component.
  203. """
  204. tag = self._render()
  205. tag.name = "match"
  206. return dict(tag)
  207. def add_imports(self) -> ImportDict:
  208. """Add imports for the Match component.
  209. Returns:
  210. The import dict.
  211. """
  212. var_data = VarData.merge(self.cond._get_all_var_data())
  213. return var_data.old_school_imports() if var_data else {}
  214. match = Match.create