1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015 |
- """Define the reflex state specification."""
- from __future__ import annotations
- import asyncio
- import copy
- import functools
- import inspect
- import json
- import traceback
- import urllib.parse
- from abc import ABC
- from collections import defaultdict
- from types import FunctionType
- from typing import (
- Any,
- AsyncIterator,
- Callable,
- ClassVar,
- Dict,
- List,
- Optional,
- Sequence,
- Set,
- Tuple,
- Type,
- Union,
- )
- import cloudpickle
- import pydantic
- from redis import Redis
- from reflex import constants
- from reflex.base import Base
- from reflex.event import Event, EventHandler, EventSpec, fix_events, window_alert
- from reflex.utils import format, prerequisites, types
- from reflex.vars import BaseVar, ComputedVar, ReflexDict, ReflexList, Var
- Delta = Dict[str, Any]
- class State(Base, ABC, extra=pydantic.Extra.allow):
- """The state of the app."""
- # A map from the var name to the var.
- vars: ClassVar[Dict[str, Var]] = {}
- # The base vars of the class.
- base_vars: ClassVar[Dict[str, BaseVar]] = {}
- # The computed vars of the class.
- computed_vars: ClassVar[Dict[str, ComputedVar]] = {}
- # Vars inherited by the parent state.
- inherited_vars: ClassVar[Dict[str, Var]] = {}
- # Backend vars that are never sent to the client.
- backend_vars: ClassVar[Dict[str, Any]] = {}
- # Backend vars inherited
- inherited_backend_vars: ClassVar[Dict[str, Any]] = {}
- # The event handlers.
- event_handlers: ClassVar[Dict[str, EventHandler]] = {}
- # The parent state.
- parent_state: Optional[State] = None
- # The substates of the state.
- substates: Dict[str, State] = {}
- # The set of dirty vars.
- dirty_vars: Set[str] = set()
- # The set of dirty substates.
- dirty_substates: Set[str] = set()
- # The routing path that triggered the state
- router_data: Dict[str, Any] = {}
- # Mapping of var name to set of computed variables that depend on it
- computed_var_dependencies: Dict[str, Set[str]] = {}
- # Mapping of var name to set of substates that depend on it
- substate_var_dependencies: Dict[str, Set[str]] = {}
- # Per-instance copy of backend variable values
- _backend_vars: Dict[str, Any] = {}
- def __init__(self, *args, parent_state: Optional[State] = None, **kwargs):
- """Initialize the state.
- Args:
- *args: The args to pass to the Pydantic init method.
- parent_state: The parent state.
- **kwargs: The kwargs to pass to the Pydantic init method.
- """
- kwargs["parent_state"] = parent_state
- super().__init__(*args, **kwargs)
- # initialize per-instance var dependency tracking
- self.computed_var_dependencies = defaultdict(set)
- self.substate_var_dependencies = defaultdict(set)
- # Setup the substates.
- for substate in self.get_substates():
- self.substates[substate.get_name()] = substate(parent_state=self)
- # Convert the event handlers to functions.
- for name, event_handler in self.event_handlers.items():
- fn = functools.partial(event_handler.fn, self)
- fn.__module__ = event_handler.fn.__module__ # type: ignore
- fn.__qualname__ = event_handler.fn.__qualname__ # type: ignore
- setattr(self, name, fn)
- # Initialize computed vars dependencies.
- inherited_vars = set(self.inherited_vars).union(
- set(self.inherited_backend_vars),
- )
- for cvar_name, cvar in self.computed_vars.items():
- # Add the dependencies.
- for var in cvar.deps(objclass=type(self)):
- self.computed_var_dependencies[var].add(cvar_name)
- if var in inherited_vars:
- # track that this substate depends on its parent for this var
- state_name = self.get_name()
- parent_state = self.parent_state
- while parent_state is not None and var in parent_state.vars:
- parent_state.substate_var_dependencies[var].add(state_name)
- state_name, parent_state = (
- parent_state.get_name(),
- parent_state.parent_state,
- )
- # Initialize the mutable fields.
- self._init_mutable_fields()
- # Create a fresh copy of the backend variables for this instance
- self._backend_vars = copy.deepcopy(self.backend_vars)
- def _init_mutable_fields(self):
- """Initialize mutable fields.
- So that mutation to them can be detected by the app:
- * list
- """
- for field in self.base_vars.values():
- value = getattr(self, field.name)
- value_in_rx_data = _convert_mutable_datatypes(
- value, self._reassign_field, field.name
- )
- if types._issubclass(field.type_, Union[List, Dict]):
- setattr(self, field.name, value_in_rx_data)
- self.clean()
- def _reassign_field(self, field_name: str):
- """Reassign the given field.
- Primarily for mutation in fields of mutable data types.
- Args:
- field_name: The name of the field we want to reassign
- """
- setattr(
- self,
- field_name,
- getattr(self, field_name),
- )
- def __repr__(self) -> str:
- """Get the string representation of the state.
- Returns:
- The string representation of the state.
- """
- return f"{self.__class__.__name__}({self.dict()})"
- @classmethod
- def __init_subclass__(cls, **kwargs):
- """Do some magic for the subclass initialization.
- Args:
- **kwargs: The kwargs to pass to the pydantic init_subclass method.
- """
- super().__init_subclass__(**kwargs)
- # Get the parent vars.
- parent_state = cls.get_parent_state()
- if parent_state is not None:
- cls.inherited_vars = parent_state.vars
- cls.inherited_backend_vars = parent_state.backend_vars
- cls.new_backend_vars = {
- name: value
- for name, value in cls.__dict__.items()
- if types.is_backend_variable(name)
- and name not in cls.inherited_backend_vars
- and not isinstance(value, FunctionType)
- }
- cls.backend_vars = {**cls.inherited_backend_vars, **cls.new_backend_vars}
- # Set the base and computed vars.
- cls.base_vars = {
- f.name: BaseVar(name=f.name, type_=f.outer_type_).set_state(cls)
- for f in cls.get_fields().values()
- if f.name not in cls.get_skip_vars()
- }
- cls.computed_vars = {
- v.name: v.set_state(cls)
- for v in cls.__dict__.values()
- if isinstance(v, ComputedVar)
- }
- cls.vars = {
- **cls.inherited_vars,
- **cls.base_vars,
- **cls.computed_vars,
- }
- cls.event_handlers = {}
- # Setup the base vars at the class level.
- for prop in cls.base_vars.values():
- cls._init_var(prop)
- # Set up the event handlers.
- events = {
- name: fn
- for name, fn in cls.__dict__.items()
- if not name.startswith("_")
- and isinstance(fn, Callable)
- and not isinstance(fn, EventHandler)
- }
- for name, fn in events.items():
- handler = EventHandler(fn=fn)
- cls.event_handlers[name] = handler
- setattr(cls, name, handler)
- @classmethod
- def get_skip_vars(cls) -> Set[str]:
- """Get the vars to skip when serializing.
- Returns:
- The vars to skip when serializing.
- """
- return set(cls.inherited_vars) | {
- "parent_state",
- "substates",
- "dirty_vars",
- "dirty_substates",
- "router_data",
- "computed_var_dependencies",
- "substate_var_dependencies",
- "_backend_vars",
- }
- @classmethod
- @functools.lru_cache()
- def get_parent_state(cls) -> Optional[Type[State]]:
- """Get the parent state.
- Returns:
- The parent state.
- """
- parent_states = [
- base
- for base in cls.__bases__
- if types._issubclass(base, State) and base is not State
- ]
- assert len(parent_states) < 2, "Only one parent state is allowed."
- return parent_states[0] if len(parent_states) == 1 else None # type: ignore
- @classmethod
- @functools.lru_cache()
- def get_substates(cls) -> Set[Type[State]]:
- """Get the substates of the state.
- Returns:
- The substates of the state.
- """
- return set(cls.__subclasses__())
- @classmethod
- @functools.lru_cache()
- def get_name(cls) -> str:
- """Get the name of the state.
- Returns:
- The name of the state.
- """
- return format.to_snake_case(cls.__name__)
- @classmethod
- @functools.lru_cache()
- def get_full_name(cls) -> str:
- """Get the full name of the state.
- Returns:
- The full name of the state.
- """
- name = cls.get_name()
- parent_state = cls.get_parent_state()
- if parent_state is not None:
- name = ".".join((parent_state.get_full_name(), name))
- return name
- @classmethod
- @functools.lru_cache()
- def get_class_substate(cls, path: Sequence[str]) -> Type[State]:
- """Get the class substate.
- Args:
- path: The path to the substate.
- Returns:
- The class substate.
- Raises:
- ValueError: If the substate is not found.
- """
- if len(path) == 0:
- return cls
- if path[0] == cls.get_name():
- if len(path) == 1:
- return cls
- path = path[1:]
- for substate in cls.get_substates():
- if path[0] == substate.get_name():
- return substate.get_class_substate(path[1:])
- raise ValueError(f"Invalid path: {path}")
- @classmethod
- def get_class_var(cls, path: Sequence[str]) -> Any:
- """Get the class var.
- Args:
- path: The path to the var.
- Returns:
- The class var.
- Raises:
- ValueError: If the path is invalid.
- """
- path, name = path[:-1], path[-1]
- substate = cls.get_class_substate(tuple(path))
- if not hasattr(substate, name):
- raise ValueError(f"Invalid path: {path}")
- return getattr(substate, name)
- @classmethod
- def _init_var(cls, prop: BaseVar):
- """Initialize a variable.
- Args:
- prop: The variable to initialize
- Raises:
- TypeError: if the variable has an incorrect type
- """
- if not types.is_valid_var_type(prop.type_):
- raise TypeError(
- "State vars must be primitive Python types, "
- "Plotly figures, Pandas dataframes, "
- "or subclasses of rx.Base. "
- f'Found var "{prop.name}" with type {prop.type_}.'
- )
- cls._set_var(prop)
- cls._create_setter(prop)
- cls._set_default_value(prop)
- @classmethod
- def add_var(cls, name: str, type_: Any, default_value: Any = None):
- """Add dynamically a variable to the State.
- The variable added this way can be used in the same way as a variable
- defined statically in the model.
- Args:
- name: The name of the variable
- type_: The type of the variable
- default_value: The default value of the variable
- Raises:
- NameError: if a variable of this name already exists
- """
- if name in cls.__fields__:
- raise NameError(
- f"The variable '{name}' already exist. Use a different name"
- )
- # create the variable based on name and type
- var = BaseVar(name=name, type_=type_)
- var.set_state(cls)
- # add the pydantic field dynamically (must be done before _init_var)
- cls.add_field(var, default_value)
- cls._init_var(var)
- # update the internal dicts so the new variable is correctly handled
- cls.base_vars.update({name: var})
- cls.vars.update({name: var})
- # let substates know about the new variable
- for substate_class in cls.__subclasses__():
- substate_class.vars.setdefault(name, var)
- @classmethod
- def _set_var(cls, prop: BaseVar):
- """Set the var as a class member.
- Args:
- prop: The var instance to set.
- """
- setattr(cls, prop.name, prop)
- @classmethod
- def _create_setter(cls, prop: BaseVar):
- """Create a setter for the var.
- Args:
- prop: The var to create a setter for.
- """
- setter_name = prop.get_setter_name(include_state=False)
- if setter_name not in cls.__dict__:
- event_handler = EventHandler(fn=prop.get_setter())
- cls.event_handlers[setter_name] = event_handler
- setattr(cls, setter_name, event_handler)
- @classmethod
- def _set_default_value(cls, prop: BaseVar):
- """Set the default value for the var.
- Args:
- prop: The var to set the default value for.
- """
- # Get the pydantic field for the var.
- field = cls.get_fields()[prop.name]
- default_value = prop.get_default_value()
- if field.required and default_value is not None:
- field.required = False
- field.default = default_value
- def get_token(self) -> str:
- """Return the token of the client associated with this state.
- Returns:
- The token of the client.
- """
- return self.router_data.get(constants.RouteVar.CLIENT_TOKEN, "")
- def get_sid(self) -> str:
- """Return the session ID of the client associated with this state.
- Returns:
- The session ID of the client.
- """
- return self.router_data.get(constants.RouteVar.SESSION_ID, "")
- def get_headers(self) -> Dict:
- """Return the headers of the client associated with this state.
- Returns:
- The headers of the client.
- """
- return self.router_data.get(constants.RouteVar.HEADERS, {})
- def get_client_ip(self) -> str:
- """Return the IP of the client associated with this state.
- Returns:
- The IP of the client.
- """
- return self.router_data.get(constants.RouteVar.CLIENT_IP, "")
- def get_current_page(self) -> str:
- """Obtain the path of current page from the router data.
- Returns:
- The current page.
- """
- return self.router_data.get(constants.RouteVar.PATH, "")
- def get_query_params(self) -> Dict[str, str]:
- """Obtain the query parameters for the queried page.
- The query object contains both the URI parameters and the GET parameters.
- Returns:
- The dict of query parameters.
- """
- return self.router_data.get(constants.RouteVar.QUERY, {})
- def get_cookies(self) -> Dict[str, str]:
- """Obtain the cookies of the client stored in the browser.
- Returns:
- The dict of cookies.
- """
- cookie_dict = {}
- cookies = self.get_headers().get(constants.RouteVar.COOKIE, "").split(";")
- cookie_pairs = [cookie.split("=") for cookie in cookies if cookie]
- for pair in cookie_pairs:
- key, value = pair[0].strip(), urllib.parse.unquote(pair[1].strip())
- try:
- # cast non-string values to the actual types.
- value = json.loads(value)
- except json.JSONDecodeError:
- pass
- finally:
- cookie_dict[key] = value
- return cookie_dict
- @classmethod
- def setup_dynamic_args(cls, args: dict[str, str]):
- """Set up args for easy access in renderer.
- Args:
- args: a dict of args
- """
- def argsingle_factory(param):
- @ComputedVar
- def inner_func(self) -> str:
- return self.get_query_params().get(param, "")
- return inner_func
- def arglist_factory(param):
- @ComputedVar
- def inner_func(self) -> List:
- return self.get_query_params().get(param, [])
- return inner_func
- for param, value in args.items():
- if value == constants.RouteArgType.SINGLE:
- func = argsingle_factory(param)
- elif value == constants.RouteArgType.LIST:
- func = arglist_factory(param)
- else:
- continue
- func.fget.__name__ = param # to allow passing as a prop
- cls.vars[param] = cls.computed_vars[param] = func.set_state(cls) # type: ignore
- setattr(cls, param, func)
- def __getattribute__(self, name: str) -> Any:
- """Get the state var.
- If the var is inherited, get the var from the parent state.
- Args:
- name: The name of the var.
- Returns:
- The value of the var.
- """
- # If the state hasn't been initialized yet, return the default value.
- if not super().__getattribute__("__dict__"):
- return super().__getattribute__(name)
- inherited_vars = {
- **super().__getattribute__("inherited_vars"),
- **super().__getattribute__("inherited_backend_vars"),
- }
- if name in inherited_vars:
- return getattr(super().__getattribute__("parent_state"), name)
- elif name in super().__getattribute__("_backend_vars"):
- return super().__getattribute__("_backend_vars").__getitem__(name)
- return super().__getattribute__(name)
- def __setattr__(self, name: str, value: Any):
- """Set the attribute.
- If the attribute is inherited, set the attribute on the parent state.
- Args:
- name: The name of the attribute.
- value: The value of the attribute.
- """
- # Set the var on the parent state.
- inherited_vars = {**self.inherited_vars, **self.inherited_backend_vars}
- if name in inherited_vars:
- setattr(self.parent_state, name, value)
- return
- if types.is_backend_variable(name) and name != "_backend_vars":
- self._backend_vars.__setitem__(name, value)
- self.dirty_vars.add(name)
- self.mark_dirty()
- return
- # Make sure lists and dicts are converted to ReflexList and ReflexDict.
- if name in self.vars and types._isinstance(value, Union[List, Dict]):
- value = _convert_mutable_datatypes(value, self._reassign_field, name)
- # Set the attribute.
- super().__setattr__(name, value)
- # Add the var to the dirty list.
- if name in self.vars or name in self.computed_var_dependencies:
- self.dirty_vars.add(name)
- self.mark_dirty()
- # For now, handle router_data updates as a special case
- if name == constants.ROUTER_DATA:
- self.dirty_vars.add(name)
- self.mark_dirty()
- # propagate router_data updates down the state tree
- for substate in self.substates.values():
- setattr(substate, name, value)
- def reset(self):
- """Reset all the base vars to their default values."""
- # Reset the base vars.
- fields = self.get_fields()
- for prop_name in self.base_vars:
- setattr(self, prop_name, fields[prop_name].default)
- # Recursively reset the substates.
- for substate in self.substates.values():
- substate.reset()
- # Clean the state.
- self.clean()
- def get_substate(self, path: Sequence[str]) -> Optional[State]:
- """Get the substate.
- Args:
- path: The path to the substate.
- Returns:
- The substate.
- Raises:
- ValueError: If the substate is not found.
- """
- if len(path) == 0:
- return self
- if path[0] == self.get_name():
- if len(path) == 1:
- return self
- path = path[1:]
- if path[0] not in self.substates:
- raise ValueError(f"Invalid path: {path}")
- return self.substates[path[0]].get_substate(path[1:])
- async def _process(self, event: Event) -> AsyncIterator[StateUpdate]:
- """Obtain event info and process event.
- Args:
- event: The event to process.
- Yields:
- The state update after processing the event.
- Raises:
- ValueError: If the state value is None.
- """
- # Get the event handler.
- path = event.name.split(".")
- path, name = path[:-1], path[-1]
- substate = self.get_substate(path)
- handler = substate.event_handlers[name] # type: ignore
- if not substate:
- raise ValueError(
- "The value of state cannot be None when processing an event."
- )
- # Get the event generator.
- event_iter = self._process_event(
- handler=handler,
- state=substate,
- payload=event.payload,
- )
- # Clean the state before processing the event.
- self.clean()
- # Run the event generator and return state updates.
- async for events, final in event_iter:
- # Fix the returned events.
- events = fix_events(events, event.token) # type: ignore
- # Get the delta after processing the event.
- delta = self.get_delta()
- # Yield the state update.
- yield StateUpdate(delta=delta, events=events, final=final)
- # Clean the state to prepare for the next event.
- self.clean()
- async def _process_event(
- self, handler: EventHandler, state: State, payload: Dict
- ) -> AsyncIterator[Tuple[Optional[List[EventSpec]], bool]]:
- """Process event.
- Args:
- handler: Eventhandler to process.
- state: State to process the handler.
- payload: The event payload.
- Yields:
- Tuple containing:
- 0: The state update after processing the event.
- 1: Whether the event is the final event.
- """
- # Get the function to process the event.
- fn = functools.partial(handler.fn, state)
- # Wrap the function in a try/except block.
- try:
- # Handle async functions.
- if asyncio.iscoroutinefunction(fn.func):
- events = await fn(**payload)
- # Handle regular functions.
- else:
- events = fn(**payload)
- # Handle async generators.
- if inspect.isasyncgen(events):
- async for event in events:
- yield event, False
- yield None, True
- # Handle regular generators.
- elif inspect.isgenerator(events):
- try:
- while True:
- yield next(events), False
- except StopIteration as si:
- # the "return" value of the generator is not available
- # in the loop, we must catch StopIteration to access it
- if si.value is not None:
- yield si.value, False
- yield None, True
- # Handle regular event chains.
- else:
- yield events, True
- # If an error occurs, throw a window alert.
- except Exception:
- error = traceback.format_exc()
- print(error)
- yield [window_alert("An error occurred. See logs for details.")], True
- def _always_dirty_computed_vars(self) -> Set[str]:
- """The set of ComputedVars that always need to be recalculated.
- Returns:
- Set of all ComputedVar in this state where cache=False
- """
- return set(
- cvar_name
- for cvar_name, cvar in self.computed_vars.items()
- if not cvar.cache
- )
- def _mark_dirty_computed_vars(self) -> None:
- """Mark ComputedVars that need to be recalculated based on dirty_vars."""
- dirty_vars = self.dirty_vars
- while dirty_vars:
- calc_vars, dirty_vars = dirty_vars, set()
- for cvar in self._dirty_computed_vars(from_vars=calc_vars):
- self.dirty_vars.add(cvar)
- dirty_vars.add(cvar)
- actual_var = self.computed_vars.get(cvar)
- if actual_var:
- actual_var.mark_dirty(instance=self)
- def _dirty_computed_vars(self, from_vars: Optional[Set[str]] = None) -> Set[str]:
- """Determine ComputedVars that need to be recalculated based on the given vars.
- Args:
- from_vars: find ComputedVar that depend on this set of vars. If unspecified, will use the dirty_vars.
- Returns:
- Set of computed vars to include in the delta.
- """
- return set(
- cvar
- for dirty_var in from_vars or self.dirty_vars
- for cvar in self.computed_var_dependencies[dirty_var]
- )
- def get_delta(self) -> Delta:
- """Get the delta for the state.
- Returns:
- The delta for the state.
- """
- delta = {}
- # Apply dirty variables down into substates
- self.dirty_vars.update(self._always_dirty_computed_vars())
- self.mark_dirty()
- # Return the dirty vars for this instance, any cached/dependent computed vars,
- # and always dirty computed vars (cache=False)
- delta_vars = (
- self.dirty_vars.intersection(self.base_vars)
- .union(self._dirty_computed_vars())
- .union(self._always_dirty_computed_vars())
- )
- subdelta = {
- prop: getattr(self, prop)
- for prop in delta_vars
- if not types.is_backend_variable(prop)
- }
- if len(subdelta) > 0:
- delta[self.get_full_name()] = subdelta
- # Recursively find the substate deltas.
- substates = self.substates
- for substate in self.dirty_substates:
- delta.update(substates[substate].get_delta())
- # Format the delta.
- delta = format.format_state(delta)
- # Return the delta.
- return delta
- def mark_dirty(self):
- """Mark the substate and all parent states as dirty."""
- state_name = self.get_name()
- if (
- self.parent_state is not None
- and state_name not in self.parent_state.dirty_substates
- ):
- self.parent_state.dirty_substates.add(self.get_name())
- self.parent_state.mark_dirty()
- # have to mark computed vars dirty to allow access to newly computed
- # values within the same ComputedVar function
- self._mark_dirty_computed_vars()
- # Propagate dirty var / computed var status into substates
- substates = self.substates
- for var in self.dirty_vars:
- for substate_name in self.substate_var_dependencies[var]:
- self.dirty_substates.add(substate_name)
- substate = substates[substate_name]
- substate.dirty_vars.add(var)
- substate.mark_dirty()
- def clean(self):
- """Reset the dirty vars."""
- # Recursively clean the substates.
- for substate in self.dirty_substates:
- self.substates[substate].clean()
- # Clean this state.
- self.dirty_vars = set()
- self.dirty_substates = set()
- def dict(self, include_computed: bool = True, **kwargs) -> Dict[str, Any]:
- """Convert the object to a dictionary.
- Args:
- include_computed: Whether to include computed vars.
- **kwargs: Kwargs to pass to the pydantic dict method.
- Returns:
- The object as a dictionary.
- """
- if include_computed:
- # Apply dirty variables down into substates to allow never-cached ComputedVar to
- # trigger recalculation of dependent vars
- self.dirty_vars.update(self._always_dirty_computed_vars())
- self.mark_dirty()
- base_vars = {
- prop_name: self.get_value(getattr(self, prop_name))
- for prop_name in self.base_vars
- }
- computed_vars = (
- {
- # Include the computed vars.
- prop_name: self.get_value(getattr(self, prop_name))
- for prop_name in self.computed_vars
- }
- if include_computed
- else {}
- )
- substate_vars = {
- k: v.dict(include_computed=include_computed, **kwargs)
- for k, v in self.substates.items()
- }
- variables = {**base_vars, **computed_vars, **substate_vars}
- return {k: variables[k] for k in sorted(variables)}
- class DefaultState(State):
- """The default empty state."""
- pass
- class StateUpdate(Base):
- """A state update sent to the frontend."""
- # The state delta.
- delta: Delta = {}
- # Events to be added to the event queue.
- events: List[Event] = []
- # Whether this is the final state update for the event.
- final: bool = True
- class StateManager(Base):
- """A class to manage many client states."""
- # The state class to use.
- state: Type[State] = DefaultState
- # The mapping of client ids to states.
- states: Dict[str, State] = {}
- # The token expiration time (s).
- token_expiration: int = constants.TOKEN_EXPIRATION
- # The redis client to use.
- redis: Optional[Redis] = None
- def setup(self, state: Type[State]):
- """Set up the state manager.
- Args:
- state: The state class to use.
- """
- self.state = state
- self.redis = prerequisites.get_redis()
- def get_state(self, token: str) -> State:
- """Get the state for a token.
- Args:
- token: The token to get the state for.
- Returns:
- The state for the token.
- """
- if self.redis is not None:
- redis_state = self.redis.get(token)
- if redis_state is None:
- self.set_state(token, self.state())
- return self.get_state(token)
- return cloudpickle.loads(redis_state)
- if token not in self.states:
- self.states[token] = self.state()
- return self.states[token]
- def set_state(self, token: str, state: State):
- """Set the state for a token.
- Args:
- token: The token to set the state for.
- state: The state to set.
- """
- if self.redis is None:
- return
- self.redis.set(token, cloudpickle.dumps(state), ex=self.token_expiration)
- def _convert_mutable_datatypes(
- field_value: Any, reassign_field: Callable, field_name: str
- ) -> Any:
- """Recursively convert mutable data to the Rx data types.
- Note: right now only list & dict would be handled recursively.
- Args:
- field_value: The target field_value.
- reassign_field:
- The function to reassign the field in the parent state.
- field_name: the name of the field in the parent state
- Returns:
- The converted field_value
- """
- if isinstance(field_value, list):
- field_value = [
- _convert_mutable_datatypes(value, reassign_field, field_name)
- for value in field_value
- ]
- field_value = ReflexList(
- field_value, reassign_field=reassign_field, field_name=field_name
- )
- if isinstance(field_value, dict):
- field_value = {
- key: _convert_mutable_datatypes(value, reassign_field, field_name)
- for key, value in field_value.items()
- }
- field_value = ReflexDict(
- field_value, reassign_field=reassign_field, field_name=field_name
- )
- return field_value
|