Use a Bookmark class

Author: schloerke

shiny/bookmark/_bookmark.py

@@ -21,7 +21,9 @@
 # * √ `session.bookmark_store`: `url`, `server`, `disable`
 # Session hooks -> `onBookmark()`, `onBookmarked()`, `onRestore(), `onRestored()`
 # * √ `session.on_bookmark()` # Takes the save state
+#     * Cancel callback
 # * √ `session.on_bookmarked()` # Takes a url
+#     * Cancel callback
 # * `session.onRestore()`
 # * `session.onRestored()`
 # Session hooks -> Require list of callback functions for each

shiny/express/_stub_session.py

@@ -4,9 +4,11 @@
 
 from htmltools import TagChild
 
+from shiny.bookmark._bookmark import ShinySaveState
+
 from .._namespaces import Id, ResolvedId, Root
 from ..session import Inputs, Outputs, Session
-from ..session._session import SessionProxy
+from ..session._session import Bookmark, SessionProxy
 
 if TYPE_CHECKING:
     from ..session._session import DownloadHandler, DynamicRouteHandler, RenderedDeps
@@ -44,21 +46,17 @@ 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?
+        self.bookmark = BookmarkExpressStub(self)
+
+        self.exclude = []
+        self.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
@@ -147,3 +145,32 @@ def download(
         encoding: str = "utf-8",
     ) -> Callable[[DownloadHandler], None]:
         return lambda x: None
+
+
+class BookmarkExpressStub(Bookmark):
+
+    def _get_bookmark_exclude(self) -> list[str]:
+        raise NotImplementedError("Please call this only from a real session object")
+
+    def on_bookmark(
+        self,
+        callback: (
+            Callable[[ShinySaveState], None]
+            | Callable[[ShinySaveState], Awaitable[None]]
+        ),
+    ) -> None:
+        raise NotImplementedError("Please call this only from a real session object")
+
+    def on_bookmarked(
+        self,
+        callback: Callable[[str], None] | Callable[[str], Awaitable[None]],
+    ) -> None:
+        raise NotImplementedError("Please call this only from a real session object")
+
+    async def update_query_string(
+        self, query_string: str, mode: Literal["replace", "push"] = "replace"
+    ) -> None:
+        raise NotImplementedError("Please call this only from a real session object")
+
+    async def do_bookmark(self) -> None:
+        raise NotImplementedError("Please call this only from a real session object")