Add tests to .update_cell_value() and .update_data()

Author: schloerke

tests/playwright/shiny/components/data_frame/update_cell_value/app.py

@@ -3,27 +3,51 @@
 from __future__ import annotations
 
 import palmerpenguins  # pyright: ignore[reportMissingTypeStubs]
+import polars as pl
 
 from shiny import reactive
 from shiny.express import input, render, ui
 
-pd_df = palmerpenguins.load_penguins_raw().iloc[0:2, 0:2]
+pd_data = palmerpenguins.load_penguins_raw().iloc[0:2, 0:2]
+pl_data = pl.DataFrame(pd_data)
 
-with ui.card():
+with ui.layout_column_wrap(width=1 / 2):
 
-    ui.input_action_button("update_btn", "Update cell")
+    with ui.card():
 
-    @render.data_frame
-    def dt():
-        return pd_df
+        ui.h3("Pandas")
 
+        ui.input_action_button("update_pd_btn", "Update cell")
 
-@reactive.effect
-@reactive.event(input.update_btn)
-async def update_cell():
+        @render.data_frame
+        def pd_df():
+            return pd_data
 
-    await dt.update_cell_value(
-        "new_value - " + str(input.update_btn()),
-        row=0,
-        col=0,
-    )
+    @reactive.effect
+    @reactive.event(input.update_pd_btn)
+    async def _():
+
+        await pd_df.update_cell_value(
+            "pandas - " + str(input.update_pd_btn()),
+            row=0,
+            col=0,
+        )
+
+    with ui.card():
+
+        ui.h3("Polars")
+        ui.input_action_button("update_pl_btn", "Update cell")
+
+        @render.data_frame
+        def pl_df():
+            return pl_data
+
+    @reactive.effect
+    @reactive.event(input.update_pl_btn)
+    async def _():
+
+        await pl_df.update_cell_value(
+            "polars - " + str(input.update_pl_btn()),
+            row=0,
+            col=0,
+        )

tests/playwright/shiny/components/data_frame/update_cell_value/test_cell_value.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+
+def test_update_cell_value(page: Page, local_app: ShinyAppProc) -> None:
+    page.goto(local_app.url)
+
+    pd_df = controller.OutputDataFrame(page, "pd_df")
+    pd_df.expect_cell("PAL0708", row=0, col=0)
+
+    pl_df = controller.OutputDataFrame(page, "pl_df")
+    pl_df.expect_cell("PAL0708", row=0, col=0)
+
+    pd_btn = controller.InputActionButton(page, "update_pd_btn")
+    pl_btn = controller.InputActionButton(page, "update_pl_btn")
+
+    # Update pandas
+    pd_btn.click()
+    pd_df.expect_cell("pandas - 1", row=0, col=0)
+    pl_df.expect_cell("PAL0708", row=0, col=0)
+
+    # Update polars
+    pl_btn.click()
+    pl_btn.click()
+    pl_btn.click()
+
+    pd_df.expect_cell("pandas - 1", row=0, col=0)
+    pl_df.expect_cell("polars - 3", row=0, col=0)
+
+    # Verify other cells do not change
+    pd_df.expect_cell("PAL0708", row=1, col=0)
+    pd_df.expect_cell("1", row=0, col=1)
+    pd_df.expect_cell("2", row=1, col=1)
+
+    pl_df.expect_cell("PAL0708", row=1, col=0)
+    pl_df.expect_cell("1", row=0, col=1)
+    pl_df.expect_cell("2", row=1, col=1)

tests/playwright/shiny/components/data_frame/update_data/app.py

@@ -8,7 +8,7 @@
 from shiny import reactive
 from shiny.express import input, render, ui
 
-pd_df = palmerpenguins.load_penguins_raw()
+pd_data = palmerpenguins.load_penguins_raw()
 
 
 with ui.card():
@@ -19,9 +19,9 @@
     ui.h4("Data")
 
     @render.data_frame
-    def dt():
+    def df():
         return render.DataGrid(
-            pd_df.iloc[:, 0:2],
+            pd_data.iloc[:, 0:2],
             selection_mode="rows",
             filters=True,
             editable=True,
@@ -30,18 +30,18 @@ def dt():
     ui.h4("Selected data")
 
     @render.data_frame
-    def dt_selected():
-        return dt.data_view(selected=True)
+    def df_selected():
+        return df.data_view(selected=True)
 
     @reactive.effect
-    @reactive.event(dt.cell_selection)
+    @reactive.event(df.cell_selection)
     def _on_cell_selection():
-        print("Cell selected", dt.cell_selection())
+        print("Cell selected", df.cell_selection())
         return
 
 
 # Reactive value to store the un-subsetted data
-full_data = reactive.value(pd_df)
+full_data = reactive.value(pd_data)
 
 
 @reactive.effect
@@ -54,7 +54,7 @@ async def shift_data():
     k = 2
     shift = (k * input.shift_btn()) % full_data().shape[0]
     subsetted_data = full_data().iloc[(0 + shift) : (k + shift), 0:2]
-    await dt.update_data(subsetted_data)
+    await df.update_data(subsetted_data)
     return
 
 
@@ -69,14 +69,13 @@ async def different_data():
         "input.different_btn()", input.different_btn(), input.different_btn() % 2 == 0
     )
     if input.different_btn() % 2 == 0:
-        # await dt.update_data(pd_df.iloc[:, 0:2])
-        await dt.update_data(pd_df)
-        full_data.set(pd_df)
+        await df.update_data(pd_data)
+        full_data.set(pd_data)
         return
 
     new_df = pd.DataFrame(
         {
-            "studyName": [
+            "Letter": [
                 "a",
                 "b",
                 "c",
@@ -104,9 +103,9 @@ async def different_data():
                 "y",
                 "z",
             ],
-            "Sample Number": [-1 * i for i in range(1, 27)],
+            "Negative index": [-1 * i for i in range(1, 27)],
         },
     )
-    await dt.update_data(new_df)
+    await df.update_data(new_df)
     full_data.set(new_df)
     return

tests/playwright/shiny/components/data_frame/update_data/test_update_data.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from playwright.sync_api import Page
+
+from shiny.playwright import controller
+from shiny.run import ShinyAppProc
+
+
+def test_update_data(page: Page, local_app: ShinyAppProc) -> None:
+    page.goto(local_app.url)
+
+    df = controller.OutputDataFrame(page, "df")
+    df_selected = controller.OutputDataFrame(page, "df_selected")
+    shift_btn = controller.InputActionButton(page, "shift_btn")
+    different_btn = controller.InputActionButton(page, "different_btn")
+
+    # df.expect_nrow(344) # TODO-barret; broken
+    df.expect_ncol(2)
+    df_selected.expect_column_labels(["studyName", "Sample Number"])
+
+    df_selected.expect_nrow(0)
+    df_selected.expect_ncol(2)
+    df_selected.expect_column_labels(["studyName", "Sample Number"])
+
+    df.select_rows([1])
+    df_selected.expect_nrow(1)
+    df_selected.expect_cell("2", row=0, col=1)
+
+    # Shift data
+    shift_btn.click()
+    df.expect_nrow(2)
+    df.expect_ncol(2)
+    df.expect_column_labels(["studyName", "Sample Number"])
+    df.expect_selected_rows([1])
+    df.expect_cell("3", row=0, col=1)
+    df.expect_cell("4", row=1, col=1)
+    df_selected.expect_nrow(1)
+    df_selected.expect_ncol(2)
+    df_selected.expect_cell("4", row=0, col=1)
+
+    # Change data set
+    different_btn.click()
+    df.expect_nrow(26)
+    df.expect_ncol(2)
+    df.expect_column_labels(["Letter", "Negative index"])
+    df.expect_selected_rows([1])
+
+    df_selected.expect_nrow(1)
+    df_selected.expect_ncol(2)
+    df_selected.expect_cell("b", row=0, col=0)
+    df_selected.expect_cell("-2", row=0, col=1)
+
+    # Change data set again
+    different_btn.click()
+    # df.expect_nrow(344) # TODO-barret; broken
+    df.expect_ncol(17)
+    df.expect_column_labels(
+        [
+            "studyName",
+            "Sample Number",
+            "Species",
+            "Region",
+            "Island",
+            "Stage",
+            "Individual ID",
+            "Clutch Completion",
+            "Date Egg",
+            "Culmen Length (mm)",
+            "Culmen Depth (mm)",
+            "Flipper Length (mm)",
+            "Body Mass (g)",
+            "Sex",
+            "Delta 15 N (o/oo)",
+            "Delta 13 C (o/oo)",
+            "Comments",
+        ]
+    )
+    df.expect_selected_rows([1])