Smarter, lazier, and more complete page default/api for express (#893)

Co-authored-by: Winston Chang <[email protected]>

Author: cpsievert

docs/_quartodoc.yml

@@ -19,6 +19,8 @@ quartodoc:
         - ui.page_fluid
         - ui.page_fixed
         - ui.page_bootstrap
+        - ui.page_auto
+        - ui.page_output
     - title: UI Layouts
       desc: Control the layout of multiple UI components.
       contents:
@@ -290,7 +292,6 @@ quartodoc:
             desc: ""
           flatten: true
           contents:
-            - express.ui.set_page
             - express.ui.sidebar
             - express.ui.layout_sidebar
             - express.ui.layout_column_wrap
@@ -315,11 +316,15 @@ quartodoc:
             - express.ui.panel_conditional
             - express.ui.panel_fixed
             - express.ui.panel_absolute
-            - express.ui.page_fluid
-            - express.ui.page_fixed
-            - express.ui.page_fillable
-            - express.ui.page_sidebar
-            - express.ui.page_navbar
+      contents:
+        - kind: page
+          path: PageFunctions
+          summary:
+            name: "Page functions"
+            desc: ""
+          flatten: true
+          contents:
+            - express.ui.page_opts
     - title: Deprecated
       desc: ""
       contents:

examples/express/plot_app.py

@@ -1,8 +1,8 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-from shiny import render, ui
-from shiny.express import input
+from shiny import render
+from shiny.express import input, ui
 
 ui.input_slider("n", "N", 1, 100, 50)
 

shiny/express/_recall_context.py

@@ -19,12 +19,10 @@ def __init__(
         self,
         fn: Callable[..., R],
         *,
-        default_page: RecallContextManager[Tag] | None = None,
         args: tuple[object, ...] | None = None,
         kwargs: Mapping[str, object] | None = None,
     ):
         self.fn = fn
-        self.default_page = default_page
         if args is None:
             args = tuple()
         if kwargs is None:
@@ -33,11 +31,6 @@ def __init__(
         self.kwargs: dict[str, object] = dict(kwargs)
 
     def __enter__(self) -> None:
-        if self.default_page is not None:
-            from . import _run
-
-            _run.replace_top_level_recall_context_manager(self.default_page)
-
         self._prev_displayhook = sys.displayhook
         # Collect each of the "printed" values in the args list.
         sys.displayhook = wrap_displayhook_handler(self.args.append)

shiny/express/_run.py

@@ -8,7 +8,6 @@
 
 from htmltools import Tag, TagList
 
-from .. import ui
 from .._app import App
 from ..session import Inputs, Outputs, Session
 from ._recall_context import RecallContextManager
@@ -20,8 +19,6 @@
 
 __all__ = ("wrap_express_app",)
 
-_DEFAULT_PAGE_FUNCTION = ui.page_fixed
-
 
 def wrap_express_app(file: Path) -> App:
     """Wrap a Shiny Express mode app into a Shiny `App` object.
@@ -133,64 +130,14 @@ def set_result(x: object):
 
 
 _top_level_recall_context_manager: RecallContextManager[Tag]
-_top_level_recall_context_manager_has_been_replaced = False
 
 
 def reset_top_level_recall_context_manager() -> None:
+    from .ui._page import page_auto_cm
+
     global _top_level_recall_context_manager
-    global _top_level_recall_context_manager_has_been_replaced
-    _top_level_recall_context_manager = RecallContextManager(_DEFAULT_PAGE_FUNCTION)
-    _top_level_recall_context_manager_has_been_replaced = False
+    _top_level_recall_context_manager = page_auto_cm()
 
 
 def get_top_level_recall_context_manager() -> RecallContextManager[Tag]:
     return _top_level_recall_context_manager
-
-
-def replace_top_level_recall_context_manager(
-    cm: RecallContextManager[Tag],
-    force: bool = False,
-) -> RecallContextManager[Tag]:
-    """
-    Replace the current top level RecallContextManager with another one.
-
-    This transfers the `args` and `kwargs` from the previous RecallContextManager to the
-    new one. Normally it will only have an effect the first time it's run; it only
-    replace the previous one if has not already been replaced. To override this
-    behavior, this use `force=True`.
-
-    Parameters
-    ----------
-    cm
-        The RecallContextManager to replace the previous one.
-    force
-        If `False` (the default) and the top level RecallContextManager has already been
-        replaced, return with no chnages. If `True`, this will aways replace.
-
-    Returns
-    -------
-    :
-        The previous top level RecallContextManager.
-    """
-    global _top_level_recall_context_manager
-    global _top_level_recall_context_manager_has_been_replaced
-
-    old_cm = _top_level_recall_context_manager
-
-    if force is False and _top_level_recall_context_manager_has_been_replaced:
-        return old_cm
-
-    args = old_cm.args.copy()
-    args.extend(cm.args)
-    cm.args = args
-
-    kwargs = old_cm.kwargs.copy()
-    kwargs.update(cm.kwargs)
-    cm.kwargs = kwargs
-
-    old_cm.__exit__(BaseException, None, None)
-    cm.__enter__()
-    _top_level_recall_context_manager = cm
-    _top_level_recall_context_manager_has_been_replaced = True
-
-    return old_cm

shiny/express/ui/__init__.py

@@ -107,7 +107,6 @@
 )
 
 from ._cm_components import (
-    set_page,
     sidebar,
     layout_sidebar,
     layout_column_wrap,
@@ -134,11 +133,10 @@
     panel_conditional,
     panel_fixed,
     panel_absolute,
-    page_fluid,
-    page_fixed,
-    page_fillable,
-    page_sidebar,
-    page_navbar,
+)
+
+from ._page import (
+    page_opts,
 )
 
 __all__ = (
@@ -245,7 +243,6 @@
     "output_data_frame",
     "value_box_theme",
     # Imports from ._cm_components
-    "set_page",
     "sidebar",
     "layout_sidebar",
     "layout_column_wrap",
@@ -272,11 +269,8 @@
     "panel_conditional",
     "panel_fixed",
     "panel_absolute",
-    "page_fluid",
-    "page_fixed",
-    "page_fillable",
-    "page_sidebar",
-    "page_navbar",
+    # Imports from ._page
+    "page_opts",
 )
 
 
@@ -290,6 +284,12 @@
         "navset_pill_card",  # Deprecated
         "navset_tab_card",  # Deprecated
         "page_bootstrap",
+        "page_fixed",
+        "page_sidebar",
+        "page_fillable",
+        "page_navbar",
+        "page_fluid",
+        "page_auto",
         "page_output",
         "panel_main",  # Deprecated
         "panel_sidebar",  # Deprecated
@@ -301,5 +301,5 @@
         "tooltip",
     ),
     # Items from shiny.express.ui that don't have a counterpart in shiny.ui
-    "shiny.express.ui": ("set_page",),
+    "shiny.express.ui": ("page_opts",),
 }