Set up bookmark exclude and bookmark store

Author: schloerke

shiny/express/_stub_session.py

@@ -44,12 +44,21 @@ def __init__(self, ns: ResolvedId = Root):
         # Application-level (not session-level) options that may be set via app_opts().
         self.app_opts: AppOpts = {}
 
+        self.bookmark_exclude = []
+        self.bookmark_store = "disable"  # TODO: Is this correct?
+
     def is_stub_session(self) -> Literal[True]:
         return True
 
     async def close(self, code: int = 1001) -> None:
         return
 
+    def _get_bookmark_exclude(self) -> list[str]:
+        raise NotImplementedError("Please call this only from a real session object")
+
+    def do_bookmark(self) -> None:
+        raise NotImplementedError("Please call this only from a real session object")
+
     # This is needed so that Outputs don't throw an error.
     def _is_hidden(self, name: str) -> bool:
         return False

shiny/session/_session.py

@@ -59,9 +59,14 @@
 from ._utils import RenderedDeps, read_thunk_opt, session_context
 
 if TYPE_CHECKING:
+    from shiny.bookmark._serializers import Unserializable
+
     from .._app import App
 
 
+BookmarkStore = Literal["url", "server", "disable"]
+
+
 class ConnectionState(enum.Enum):
     Start = 0
     Running = 1
@@ -171,6 +176,9 @@ class Session(ABC):
     input: Inputs
     output: Outputs
     clientdata: ClientData
+    bookmark_exclude: list[str]
+    bookmark_store: BookmarkStore
+    _bookmark_exclude_fns: list[Callable[[], list[str]]]
     user: str | None
     groups: list[str] | None
 
@@ -477,6 +485,38 @@ def _increment_busy_count(self) -> None: ...
     @abstractmethod
     def _decrement_busy_count(self) -> None: ...
 
+    @abstractmethod
+    def _get_bookmark_exclude(self) -> list[str]:
+        """
+        Retrieve the list of inputs excluded from being bookmarked.
+        """
+        ...
+
+    @abstractmethod
+    def do_bookmark(self) -> None:
+        """
+        Perform bookmarking.
+
+        This method will also call the `on_bookmark` and `on_bookmarked` callbacks to alter the bookmark state. Then, the bookmark state will be either saved to the server or encoded in the URL, depending on the `bookmark_store` option.
+
+        No actions will be performed if the `bookmark_store` option is set to `"disable"`.
+        """
+        ...
+
+    # @abstractmethod
+    # def set_bookmark_exclude(self, *names: str) -> None:
+    #     """
+    #     Exclude inputs from being bookmarked.
+    #     """
+    #     ...
+
+    # @abstractmethod
+    # def get_bookmark_exclude(self) -> list[str]:
+    #     """
+    #     Get the list of inputs excluded from being bookmarked.
+    #     """
+    #     ...
+
 
 # ======================================================================================
 # AppSession
@@ -522,6 +562,10 @@ def __init__(
         self.output: Outputs = Outputs(self, self.ns, outputs=dict())
         self.clientdata: ClientData = ClientData(self)
 
+        self.bookmark_exclude: list[str] = []
+        self.bookmark_store = "disable"
+        self._bookmark_exclude_fns: list[Callable[[], list[str]]] = []
+
         self.user: str | None = None
         self.groups: list[str] | None = None
         credentials_json: str = ""
@@ -711,6 +755,21 @@ def _is_hidden(self, name: str) -> bool:
 
             return hidden_value_obj()
 
+    # ==========================================================================
+    # Bookmarking
+    # ==========================================================================
+
+    def _get_bookmark_exclude(self) -> list[str]:
+        """
+        Get the list of inputs excluded from being bookmarked.
+        """
+        scoped_excludes: list[str] = []
+        for exclude_fn in self._bookmark_exclude_fns:
+            # Call the function and append the result to the list
+            scoped_excludes.extend(exclude_fn())
+        # Remove duplicates
+        return list(set([*self.bookmark_exclude, *scoped_excludes]))
+
     # ==========================================================================
     # Message handlers
     # ==========================================================================
@@ -1173,9 +1232,32 @@ def __init__(self, parent: Session, ns: ResolvedId) -> None:
         self._outbound_message_queues = parent._outbound_message_queues
         self._downloads = parent._downloads
 
+        self.bookmark_exclude: list[str] = []
+
+        def ns_bookmark_exclude() -> list[str]:
+            return [self.ns(name) for name in self.bookmark_exclude]
+
+        self._parent._bookmark_exclude_fns.append(ns_bookmark_exclude)
+
     def _is_hidden(self, name: str) -> bool:
         return self._parent._is_hidden(name)
 
+    def _get_bookmark_exclude(self) -> list[str]:
+        raise NotImplementedError(
+            "Please call `._get_bookmark_exclude()` from the root session only."
+        )
+
+    @property
+    def bookmark_store(self) -> BookmarkStore:
+        return self._parent.bookmark_store
+
+    @bookmark_store.setter
+    def bookmark_store(  # pyright: ignore[reportIncompatibleVariableOverride]
+        self,
+        value: BookmarkStore,
+    ) -> None:
+        self._parent.bookmark_store = value
+
     def on_ended(
         self,
         fn: Callable[[], None] | Callable[[], Awaitable[None]],