Export session.ClientData; add to quartodoc

Author: cpsievert

docs/_quartodoc-core.yml

@@ -233,19 +233,21 @@ quartodoc:
           path: Session
           summary:
             name: "Session"
-            desc: ""
+            desc: "Tools for managing user sessions and accessing session-related information."
           flatten: true
           contents:
             - session.get_current_session
             - session.require_active_session
             - session.session_context
             - reactive.get_current_context
+            - session.ClientData
             - session.Session.send_custom_message
             - session.Session.send_input_message
             - session.Session.on_flush
             - session.Session.on_flushed
             - session.Session.on_ended
             - session.Session.dynamic_route
+            - session.Session.close
             - input_handler.input_handlers
         - kind: page
           path: Renderer

docs/_quartodoc-express.yml

@@ -168,6 +168,14 @@ quartodoc:
         - express.ui.panel_conditional
         - express.ui.insert_ui
         - express.ui.remove_ui
+    - title: User Session
+      desc: Tools for managing user sessions and accessing session-related information.
+      contents:
+        - session.Session
+    - title: Client Data
+      desc: Access (client-side) information about the user session (e.g., URL, output info, etc).
+      contents:
+        - session.ClientData
     - title: UI as HTML
       desc: Tools for creating HTML/CSS/JS
       contents:

shiny/session/__init__.py

@@ -2,7 +2,7 @@
 Tools for working within a (user) session context.
 """
 
-from ._session import Session, Inputs, Outputs
+from ._session import ClientData, Inputs, Outputs, Session
 from ._utils import (  # noqa: F401
     get_current_session,
     session_context as session_context,
@@ -13,6 +13,7 @@
     "Session",
     "Inputs",
     "Outputs",
+    "ClientData",
     "get_current_session",
     "require_active_session",
 )

shiny/session/_session.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("Session", "Inputs", "Outputs")
+__all__ = ("Session", "Inputs", "Outputs", "ClientData")
 
 import asyncio
 import contextlib
@@ -1361,11 +1361,14 @@ def __dir__(self):
 @add_example()
 class ClientData:
     """
-    Reactively read client data from the browser.
+    Access (client-side) information from the browser.
 
-    This class provides access to client data values, such as the URL components, the
+    Provides access to client-side information, such as the URL components, the
     pixel ratio of the device, and the properties of outputs.
 
+    Each method in this class reads a reactive input value, which means that the
+    method will error if called outside of a reactive context.
+
     Raises
     ------
     RuntimeError