221 lines
7.3 KiB
Python
221 lines
7.3 KiB
Python
"""A bare component."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any, Iterator
|
|
|
|
from reflex.components.component import Component, ComponentStyle
|
|
from reflex.components.tags import Tag
|
|
from reflex.components.tags.tagless import Tagless
|
|
from reflex.config import PerformanceMode, environment
|
|
from reflex.utils import console
|
|
from reflex.utils.decorator import once
|
|
from reflex.utils.imports import ParsedImportDict
|
|
from reflex.vars import BooleanVar, ObjectVar, Var
|
|
from reflex.vars.base import GLOBAL_CACHE, VarData
|
|
from reflex.vars.sequence import LiteralStringVar
|
|
|
|
|
|
@once
|
|
def get_performance_mode():
|
|
"""Get the performance mode.
|
|
|
|
Returns:
|
|
The performance mode.
|
|
"""
|
|
return environment.REFLEX_PERF_MODE.get()
|
|
|
|
|
|
def validate_str(value: str):
|
|
"""Validate a string value.
|
|
|
|
Args:
|
|
value: The value to validate.
|
|
|
|
Raises:
|
|
ValueError: If the value is a Var and the performance mode is set to raise.
|
|
"""
|
|
perf_mode = get_performance_mode()
|
|
if perf_mode != PerformanceMode.OFF and value.startswith("reflex___state"):
|
|
if perf_mode == PerformanceMode.WARN:
|
|
console.warn(
|
|
f"Output includes {value!s} which will be displayed as a string. If you are calling `str` on a Var, consider using .to_string() instead."
|
|
)
|
|
elif perf_mode == PerformanceMode.RAISE:
|
|
raise ValueError(
|
|
f"Output includes {value!s} which will be displayed as a string. If you are calling `str` on a Var, consider using .to_string() instead."
|
|
)
|
|
|
|
|
|
class Bare(Component):
|
|
"""A component with no tag."""
|
|
|
|
contents: Var[Any]
|
|
|
|
@classmethod
|
|
def create(cls, contents: Any) -> Component:
|
|
"""Create a Bare component, with no tag.
|
|
|
|
Args:
|
|
contents: The contents of the component.
|
|
|
|
Returns:
|
|
The component.
|
|
"""
|
|
if isinstance(contents, Var):
|
|
if isinstance(contents, LiteralStringVar):
|
|
validate_str(contents._var_value)
|
|
return cls(contents=contents)
|
|
else:
|
|
if isinstance(contents, str):
|
|
validate_str(contents)
|
|
contents = str(contents) if contents is not None else ""
|
|
|
|
return cls(contents=contents)
|
|
|
|
def _get_all_hooks_internal(self) -> dict[str, VarData | None]:
|
|
"""Include the hooks for the component.
|
|
|
|
Returns:
|
|
The hooks for the component.
|
|
"""
|
|
hooks = super()._get_all_hooks_internal()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
hooks |= component._get_all_hooks_internal()
|
|
return hooks
|
|
|
|
def _get_all_hooks(self) -> dict[str, VarData | None]:
|
|
"""Include the hooks for the component.
|
|
|
|
Returns:
|
|
The hooks for the component.
|
|
"""
|
|
hooks = super()._get_all_hooks()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
hooks |= component._get_all_hooks()
|
|
return hooks
|
|
|
|
def _get_all_imports(self, collapse: bool = False) -> ParsedImportDict:
|
|
"""Include the imports for the component.
|
|
|
|
Args:
|
|
collapse: Whether to collapse the imports.
|
|
|
|
Returns:
|
|
The imports for the component.
|
|
"""
|
|
imports = super()._get_all_imports(collapse=collapse)
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
imports |= {k: list(v) for k, v in var_data.imports}
|
|
return imports
|
|
|
|
def _get_all_dynamic_imports(self) -> set[str]:
|
|
"""Get dynamic imports for the component.
|
|
|
|
Returns:
|
|
The dynamic imports.
|
|
"""
|
|
dynamic_imports = super()._get_all_dynamic_imports()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
dynamic_imports |= component._get_all_dynamic_imports()
|
|
return dynamic_imports
|
|
|
|
def _get_all_custom_code(self) -> set[str]:
|
|
"""Get custom code for the component.
|
|
|
|
Returns:
|
|
The custom code.
|
|
"""
|
|
custom_code = super()._get_all_custom_code()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
custom_code |= component._get_all_custom_code()
|
|
return custom_code
|
|
|
|
def _get_all_app_wrap_components(self) -> dict[tuple[int, str], Component]:
|
|
"""Get the components that should be wrapped in the app.
|
|
|
|
Returns:
|
|
The components that should be wrapped in the app.
|
|
"""
|
|
app_wrap_components = super()._get_all_app_wrap_components()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
if isinstance(component, Component):
|
|
app_wrap_components |= component._get_all_app_wrap_components()
|
|
return app_wrap_components
|
|
|
|
def _get_all_refs(self) -> set[str]:
|
|
"""Get the refs for the children of the component.
|
|
|
|
Returns:
|
|
The refs for the children.
|
|
"""
|
|
refs = super()._get_all_refs()
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
refs |= component._get_all_refs()
|
|
return refs
|
|
|
|
def _render(self) -> Tag:
|
|
if isinstance(self.contents, Var):
|
|
if isinstance(self.contents, (BooleanVar, ObjectVar)):
|
|
return Tagless(contents=f"{{{self.contents.to_string()!s}}}")
|
|
return Tagless(contents=f"{{{self.contents!s}}}")
|
|
return Tagless(contents=str(self.contents))
|
|
|
|
def _add_style_recursive(
|
|
self, style: ComponentStyle, theme: Component | None = None
|
|
) -> Component:
|
|
"""Add style to the component and its children.
|
|
|
|
Args:
|
|
style: The style to add.
|
|
theme: The theme to add.
|
|
|
|
Returns:
|
|
The component with the style added.
|
|
"""
|
|
new_self = super()._add_style_recursive(style, theme)
|
|
if isinstance(self.contents, Var):
|
|
var_data = self.contents._get_all_var_data()
|
|
if var_data:
|
|
for component in var_data.components:
|
|
if isinstance(component, Component):
|
|
component._add_style_recursive(style, theme)
|
|
|
|
GLOBAL_CACHE.clear()
|
|
|
|
return new_self
|
|
|
|
def _get_vars(
|
|
self, include_children: bool = False, ignore_ids: set[int] | None = None
|
|
) -> Iterator[Var]:
|
|
"""Walk all Vars used in this component.
|
|
|
|
Args:
|
|
include_children: Whether to include Vars from children.
|
|
ignore_ids: The ids to ignore.
|
|
|
|
Yields:
|
|
The contents if it is a Var, otherwise nothing.
|
|
"""
|
|
yield self.contents
|