Merge branch 'main' into fix-issue-2013

schloerke · web-flow · commit 5f9c1035fdef · 2025-07-21T15:00:50.000-04:00
diff --git a/.github/workflows/pytest.yaml b/.github/workflows/pytest.yaml
@@ -193,6 +193,17 @@ jobs:
         working-directory: examples/brownian/shinymediapipe
         run: |
           npm ci
+      - name: Checkout py-shiny-templates repository
+        uses: actions/checkout@v4
+        with:
+          repository: posit-dev/py-shiny-templates
+          path: py-shiny-templates
+
+      - name: Install py-shiny-templates dependencies
+        if: matrix.python-version != '3.9'
+        # Scikit-learn 1.7.0+ requires Python 3.10+
+        run: |
+          make ci-install-py-shiny-templates-deps
 
       - name: Run example app tests
         timeout-minutes: 60
diff --git a/Makefile b/Makefile
@@ -56,9 +56,6 @@ clean-test: FORCE
 	rm -fr .pytest_cache
 	rm -rf typings/
 
-typings/appdirs:
-	@echo "Creating appdirs stubs"
-	pyright --createstub appdirs
 typings/folium:
 	@echo "Creating folium stubs"
 	pyright --createstub folium
@@ -75,7 +72,7 @@ typings/matplotlib/__init__.pyi:
 	mv typings/python-type-stubs/stubs/matplotlib typings/
 	rm -rf typings/python-type-stubs
 
-pyright-typings: typings/appdirs typings/folium typings/uvicorn typings/seaborn typings/matplotlib/__init__.pyi
+pyright-typings: typings/folium typings/uvicorn typings/seaborn typings/matplotlib/__init__.pyi
 
 check: check-format check-lint check-types check-tests  ## check code, style, types, and test (basic CI)
 check-fix: format check-lint check-types check-tests ## check and format code, style, types, and test
@@ -223,6 +220,8 @@ install-deps: FORCE ## install dependencies
 	pip install -e ".[dev,test]" --upgrade
 ci-install-deps: FORCE
 	uv pip install -e ".[dev,test]"
+ci-install-py-shiny-templates-deps: FORCE
+	uv pip install -r py-shiny-templates/requirements.txt
 
 install-docs: FORCE
 	pip install -e ".[dev,test,doc]"
diff --git a/docs/_quartodoc-testing.yml b/docs/_quartodoc-testing.yml
@@ -26,6 +26,7 @@ quartodoc:
       contents:
         - playwright.controller.InputActionButton
         - playwright.controller.InputActionLink
+        - playwright.controller.InputBookmarkButton
         - playwright.controller.InputCheckbox
         - playwright.controller.InputCheckboxGroup
         - playwright.controller.InputDarkMode
@@ -59,6 +60,7 @@ quartodoc:
         - playwright.controller.NavsetTab
         - playwright.controller.NavsetUnderline
         - playwright.controller.NavPanel
+        - playwright.controller.PageNavbar
     - title: Upload and download
       desc: Methods for interacting with Shiny app uploading and downloading controller.
       contents:
diff --git a/pyproject.toml b/pyproject.toml
@@ -37,7 +37,7 @@ dependencies = [
     "markdown-it-py>=1.1.0",
     "mdit-py-plugins>=0.3.0",
     "linkify-it-py>=1.0",
-    "appdirs>=1.4.4",
+    "platformdirs>=2.1.0",
     "asgiref>=3.5.2",
     "packaging>=20.9",
     "watchfiles>=0.18.0;platform_system!='Emscripten'",
@@ -113,11 +113,7 @@ dev = [
     "anthropic",
     "google-generativeai;python_version>='3.9'",
     "langchain_core",
-    # langsmith (needed for langchain_core) versions >= 0.3
-    # (up to at least 0.3.2 as of 2025-01-29)
-    # cause an `argparse.ArgumentError` when running `pytest`.
-    # https://github.com/posit-dev/py-shiny/issues/1829
-    "langsmith<0.3",
+    "langsmith>=0.3.4",
     "openai",
     "ollama",
     "chatlas>=0.6.1",
diff --git a/shiny/_main_add_test.py b/shiny/_main_add_test.py
@@ -73,28 +73,10 @@ def path_does_not_exist(x: Path) -> bool | str:
     if not test_file.name.startswith("test_"):
         return "Test file must start with 'test_'"
 
-    # if app path directory is the same as the test file directory, use `local_app`
-    # otherwise, use `create_app_fixture`
-    is_same_dir = app_file.parent == test_file.parent
-
     test_name = test_file.name.replace(".py", "")
     rel_path = os.path.relpath(app_file, test_file.parent)
 
-    template = (
-        f"""\
-from playwright.sync_api import Page
-
-from shiny.playwright import controller
-from shiny.run import ShinyAppProc
-
-
-def {test_name}(page: Page, local_app: ShinyAppProc):
-
-    page.goto(local_app.url)
-    # Add test code here
-"""
-        if is_same_dir
-        else f"""\
+    template = f"""\
 from playwright.sync_api import Page
 
 from shiny.playwright import controller
@@ -109,7 +91,6 @@ def {test_name}(page: Page, app: ShinyAppProc):
     page.goto(app.url)
     # Add test code here
 """
-    )
     # Make sure test file directory exists
     test_file.parent.mkdir(parents=True, exist_ok=True)
 
diff --git a/shiny/_static.py b/shiny/_static.py
@@ -36,16 +36,10 @@ def remove_shinylive_local(
 
 
 def get_default_shinylive_dir() -> Path:
-    import appdirs
-
-    return (
-        Path(
-            appdirs.user_cache_dir(  # pyright: ignore[reportUnknownMemberType, reportUnknownArgumentType]
-                "shiny"
-            )
-        )
-        / "shinylive"
-    )
+    import platformdirs
+
+    user_cache_dir = platformdirs.user_cache_dir("shinylive")
+    return Path(user_cache_dir) / "shinylive"
 
 
 def _installed_shinylive_versions(shinylive_dir: Optional[Path] = None) -> list[str]:
diff --git a/shiny/playwright/controller/_output.py b/shiny/playwright/controller/_output.py
@@ -1058,13 +1058,33 @@ def expect_class_state(
                 "cell-edit-editing", timeout=timeout
             )
         elif value == "editing":
-            self.expect_cell_class("cell-edit-editing", row=row, col=col)
+            self.expect_cell_class(
+                "cell-edit-editing",
+                row=row,
+                col=col,
+                timeout=timeout,
+            )
         elif value == "saving":
-            self.expect_cell_class("cell-edit-saving", row=row, col=col)
+            self.expect_cell_class(
+                "cell-edit-saving",
+                row=row,
+                col=col,
+                timeout=timeout,
+            )
         elif value == "failure":
-            self.expect_cell_class("cell-edit-failure", row=row, col=col)
+            self.expect_cell_class(
+                "cell-edit-failure",
+                row=row,
+                col=col,
+                timeout=timeout,
+            )
         elif value == "success":
-            self.expect_cell_class("cell-edit-success", row=row, col=col)
+            self.expect_cell_class(
+                "cell-edit-success",
+                row=row,
+                col=col,
+                timeout=timeout,
+            )
         else:
             raise ValueError(
                 "Invalid state. Select one of 'success', 'failure', 'saving', 'editing', 'ready'"
diff --git a/tests/playwright/examples/example_apps.py b/tests/playwright/examples/example_apps.py
@@ -4,7 +4,7 @@
 from pathlib import PurePath
 from typing import Literal
 
-from playwright.sync_api import ConsoleMessage, Page
+from playwright.sync_api import ConsoleMessage, Page, expect
 
 from shiny.run import ShinyAppProc, run_shiny_app
 
@@ -91,11 +91,20 @@ def get_apps(path: str) -> typing.List[str]:
     "FutureWarning: use_inf_as_na option is deprecated",
     "pd.option_context('mode.use_inf_as_na",  # continutation of line above,
     "RuntimeWarning: invalid value encountered in dot",  # some groups didn't have enough data points to create a meaningful line
+    "DatetimeIndex.format is deprecated and will be removed in a future version. Convert using index.astype(str) or index.map(formatter) instead.",  # cufflinks package is using this method
+    "Series.__getitem__ treating keys as positions is deprecated. In a future version, integer keys will always be treated as labels (consistent with DataFrame behavior). To access a value by position, use `ser.iloc[pos]`",  # cufflinks package is using this method
 ]
 app_allow_js_errors: typing.Dict[str, typing.List[str]] = {
     "examples/brownian": ["Failed to acquire camera feed:"],
 }
 
+# Check for Shiny output errors, except for known exception cases
+app_allow_output_error = [
+    "shiny/api-examples/SafeException/app-express.py",
+    "shiny/api-examples/SafeException/app-core.py",
+    "examples/global_pyplot/app.py",
+]
+
 
 # Altered from `shinytest2:::app_wait_for_idle()`
 # https://github.com/rstudio/shinytest2/blob/b8fdce681597e9610fc078aa6e376134c404f3bd/R/app-driver-wait.R
@@ -251,3 +260,8 @@ def on_console_msg(msg: ConsoleMessage) -> None:
             + " had JavaScript console errors!\n"
             + "* ".join(console_errors)
         )
+
+        if ex_app_path not in app_allow_output_error:
+            # Ensure there are no output errors present
+            error_locator = page.locator(".shiny-output-error")
+            expect(error_locator).to_have_count(0)
diff --git a/tests/playwright/examples/test_external_templates.py b/tests/playwright/examples/test_external_templates.py
@@ -0,0 +1,24 @@
+import sys
+from pathlib import Path
+
+import pytest
+from conftest import here_root
+from example_apps import get_apps, reruns, reruns_delay, validate_example
+from playwright.sync_api import Page
+
+if not Path(here_root / "py-shiny-templates").exists():
+    pytest.skip(
+        "./py-shiny-templates dir is not available. Skipping test.",
+        allow_module_level=True,
+    )
+
+
+@pytest.mark.skipif(
+    sys.version_info[:2] == (3, 9),
+    reason="Skipping test for Python 3.9 since scikit-learn pinned version is only supported on Python 3.10+",
+)
+@pytest.mark.only_browser("chromium")
+@pytest.mark.flaky(reruns=reruns, reruns_delay=reruns_delay)
+@pytest.mark.parametrize("ex_app_path", get_apps("py-shiny-templates"))
+def test_external_templates(page: Page, ex_app_path: str) -> None:
+    validate_example(page, ex_app_path)
diff --git a/tests/playwright/shiny/components/data_frame/validate_row_selection_edit_mode/test_validate_row_selection_edit_mode.py b/tests/playwright/shiny/components/data_frame/validate_row_selection_edit_mode/test_validate_row_selection_edit_mode.py
@@ -60,6 +60,10 @@ def test_validate_row_selection_in_edit_mode(
     page.keyboard.press("Escape")
     data_frame._edit_cell_no_save("Temp value", row=1, col=16)
     page.keyboard.press("Escape")
+    # Wait for the row to be focused again after escaping edit mode
+    data_frame._expect_row_focus_state(True, row=1)
+    # Also ensure the cell is no longer in editing state
+    data_frame.expect_class_state("ready", row=1, col=16)
     page.keyboard.press("Enter")
     data_frame.expect_class_state(
         "editing",
diff --git a/tests/pytest/test_controller_documentation.py b/tests/pytest/test_controller_documentation.py
@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+import ast
+from pathlib import Path
+from typing import Set
+
+import pytest
+import yaml
+
+root = Path(__file__).parent.parent.parent
+
+CONTROLLER_DIR = root / "shiny/playwright/controller"
+DOCS_CONFIG = root / "docs/_quartodoc-testing.yml"
+SKIP_PATTERNS = {"Base", "Container", "Label", "StyleM"}
+CONTROLLER_BASE_PATTERNS = {
+    "Base",
+    "Container",
+    "Label",
+    "StyleM",
+    "WidthLocM",
+    "InputActionButton",
+    "UiBase",
+    "UiWithLabel",
+    "UiWithContainer",
+}
+
+
+def _is_valid_controller_class(node: ast.ClassDef) -> bool:
+    class_name = node.name
+    base_names = {ast.unparse(base) for base in node.bases}
+
+    return (
+        not class_name.startswith("_")
+        and not any(pattern in class_name for pattern in SKIP_PATTERNS)
+        and not any(base.endswith("P") for base in base_names if isinstance(base, str))
+        and any(
+            base.startswith("_") or any(p in base for p in CONTROLLER_BASE_PATTERNS)
+            for base in base_names
+        )
+    )
+
+
+def get_controller_classes() -> Set[str]:
+    classes: Set[str] = set()
+    for py_file in CONTROLLER_DIR.glob("*.py"):
+        if py_file.name == "__init__.py":
+            continue
+        try:
+            tree = ast.parse(py_file.read_text(encoding="utf-8"))
+            classes.update(
+                node.name
+                for node in ast.walk(tree)
+                if isinstance(node, ast.ClassDef) and _is_valid_controller_class(node)
+            )
+        except Exception as e:
+            pytest.fail(f"Failed to parse {py_file}: {e}")
+    return classes
+
+
+def get_documented_controllers() -> Set[str]:
+    try:
+        config = yaml.safe_load(DOCS_CONFIG.read_text(encoding="utf-8"))
+    except Exception as e:
+        pytest.fail(f"Failed to load or parse {DOCS_CONFIG}: {e}")
+
+    return {
+        content.split(".")[-1]
+        for section in config.get("quartodoc", {}).get("sections", [])
+        for content in section.get("contents", [])
+        if isinstance(content, str) and content.startswith("playwright.controller.")
+    }
+
+
+def test_all_controllers_are_documented():
+    controller_classes = get_controller_classes()
+    documented_controllers = get_documented_controllers()
+
+    missing_from_docs = controller_classes - documented_controllers
+    extra_in_docs = documented_controllers - controller_classes
+
+    error_messages: list[str] = []
+    if missing_from_docs:
+        missing_list = "\n".join(
+            sorted(f"  - playwright.controller.{c}" for c in missing_from_docs)
+        )
+        error_messages.append(
+            f"Controllers missing from {DOCS_CONFIG}:\n{missing_list}"
+        )
+
+    if extra_in_docs:
+        extra_list = "\n".join(
+            sorted(f"  - playwright.controller.{c}" for c in extra_in_docs)
+        )
+        error_messages.append(f"Extraneous classes in {DOCS_CONFIG}:\n{extra_list}")
+
+    if error_messages:
+        pytest.fail("\n\n".join(error_messages), pytrace=False)
+
+    assert controller_classes, "No controller classes were found."
+    assert documented_controllers, "No documented controllers were found."
