match.py 8.7 KB

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