Class BaseStateToken

reflex/istate/manager/token.py:124–244

A token for the accessing reflex BaseState instances. This token type implies subtree hierarchy population and other semantic checks.

class BaseStateToken(StateToken["BaseState"]):
    """A token for the accessing reflex BaseState instances.

    This token type implies subtree hierarchy population and other semantic checks.
    """

    @property
    def cache_key(self) -> str:
        """The key used for caching state instances in the StateManager.

        BaseState tokens use just the ident because the entire state hierarchy
        lives under a single root state instance per session.

        Returns:
            The token ident.
        """
        return self.ident

    def with_cls(self, cls: type[BaseState]) -> Self:
        """Return a new token with the cls field updated to the provided class.

        Args:
            cls: The class to update the cls field to.

        Returns:
            A new StateToken instance with the updated cls field.
        """
        return super().with_cls(cls)

    def __str__(self) -> str:
        """The key used in the underlying StateManager store.

        Returns:
            A string representation of the token, which is a combination of the ident and cls name.
        """
        # urlencode the redis token to escape the slash delimiter.
        return f"{self.ident}_{self.cls.get_full_name()}"

    @classmethod
    def serialize(cls, state: BaseState) -> bytes:
        """Serialize the BaseState for redis/disk storage.

        Args:
            state: The BaseState to serialize.

        Returns:
            The serialized state.
        """
        return state._serialize()

    @classmethod
    def deserialize(
        cls, data: bytes | None = None, fp: BinaryIO | None = None
    ) -> BaseState:
        """Deserialize the BaseState from redis/disk.

        data and fp are mutually exclusive, but one must be provided.