Merge branch 'main' into shiny-theme

* main:
  Rename shiny/examples to shiny/api-examples (and X/examples to X/api-examples) (#627)
  Make --app-path work with app file argument (#598)
  Don't eval example code block
  Fix example code blocks (#626)
  Annotation export example (#584)

Author: schloerke

MANIFEST.in

@@ -8,5 +8,5 @@ recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 
 recursive-include shiny/www *
 recursive-include shiny/experimental/www *
-recursive-include shiny/examples *
+recursive-include shiny/api-examples *
 recursive-include shiny/ui/dataframe/js/dist *

e2e/README.md

@@ -10,7 +10,7 @@ tests against their apps.)
 The actual tests are in subdirectories. Each subdirectory contains one or more Pytest
 files (`test_*.py`) containing [Playwright](https://playwright.dev/python/) assertions,
 and optionally, a single app (`app.py`) that the assertions test against. (The app is
-optional, because the tests may also be for apps in the `../examples` or `../shiny/examples` directory.)
+optional, because the tests may also be for apps in the `../examples` or `../shiny/api-examples` directory.)
 
 ## Running tests
 

e2e/conftest.py

@@ -194,9 +194,9 @@ def create_example_fixture(example_name: str, scope: str = "module"):
 
 
 def create_doc_example_fixture(example_name: str, scope: str = "module"):
-    """Used to create app fixtures from apps in py-shiny/shiny/examples"""
+    """Used to create app fixtures from apps in py-shiny/shiny/api-examples"""
     return create_app_fixture(
-        here / "../shiny/examples" / example_name / "app.py", scope
+        here / "../shiny/api-examples" / example_name / "app.py", scope
     )
 
 

e2e/cpuinfo/test_app.py

@@ -1,6 +1,6 @@
 # pyright: reportUnknownMemberType=false
 
-# TODO-barret; Convert test into loop that tests all examples to make sure they load
+# TODO-karan; Convert test into loop that tests all examples to make sure they load
 
 import re
 

e2e/examples/test_examples.py

@@ -24,7 +24,7 @@ def get_apps(path: str) -> typing.List[str]:
 
 example_apps: typing.List[str] = [
     *get_apps("../../examples"),
-    *get_apps("../../shiny/examples"),
+    *get_apps("../../shiny/api-examples"),
 ]
 
 app_idle_wait = {"duration": 300, "timeout": 5 * 1000}
@@ -36,6 +36,8 @@ def get_apps(path: str) -> typing.List[str]:
     "SafeException": True,
     "global_pyplot": True,
     "static_plots": ["PlotnineWarning", "RuntimeWarning"],
+    # https://github.com/rstudio/py-shiny/issues/611#issuecomment-1632866419
+    "penguins": ["UserWarning", "plt.tight_layout"],
 }
 app_allow_js_errors: typing.Dict[str, typing.List[str]] = {
     "brownian": ["Failed to acquire camera feed:"],

examples/annotation-export/app.py

@@ -0,0 +1,120 @@
+from pathlib import Path
+
+import matplotlib.dates as mdates
+import matplotlib.pyplot as plt
+import pandas as pd
+import seaborn as sns
+
+from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny.plotutils import brushed_points
+
+path = Path(__file__).parent / "boulder_temp.csv"
+weather_df = pd.read_csv(path)
+weather_df["date"] = pd.to_datetime(weather_df["date"])
+weather_df["annotation"] = ""
+
+app_ui = ui.page_fluid(
+    ui.panel_title("Plot annotation example"),
+    ui.p(
+        """
+        Select points to annotate them.
+        The plot is rendered with seaborn and all interaction is handled by Shiny.
+        """,
+        {"style": "font-size: larger"},
+    ),
+    ui.row(
+        ui.column(
+            6,
+            ui.output_plot("time_series", brush=ui.brush_opts(direction="x")),
+            ui.output_ui("annotator"),
+        ),
+        ui.column(
+            4,
+            ui.h3("Annotated points"),
+            ui.output_data_frame("annotations"),
+        ),
+        ui.column(2, ui.download_button("download", "Download CSV")),
+    ),
+)
+
+
+def server(input: Inputs, output: Outputs, session: Session):
+    annotated_data = reactive.Value(weather_df)
+
+    @reactive.Calc
+    def selected_data():
+        out = brushed_points(annotated_data(), input.time_series_brush(), xvar="date")
+        return out
+
+    @reactive.Effect
+    @reactive.event(input.annotate_button)
+    def _():
+        selected = selected_data()
+        selected["annotation_new"] = input.annotation()
+        selected = selected.loc[:, ["date", "annotation_new"]]
+
+        df = annotated_data().copy()
+
+        df = df.merge(selected, on="date", how="left")
+        df["annotation_new"] = df["annotation_new"].fillna("")
+        updated_rows = df["annotation_new"] != ""
+        df.loc[updated_rows, "annotation"] = df.loc[updated_rows, "annotation_new"]
+        df = df.loc[:, ["date", "temp_c", "annotation"]]
+        annotated_data.set(df)
+
+    @output
+    @render.plot
+    def time_series():
+        fig, ax = plt.subplots()
+        ax.xaxis.set_major_locator(mdates.MonthLocator())
+        ax.xaxis.set_major_formatter(mdates.DateFormatter("%Y-%m"))
+        ax.set_title("Temperature readings, Boulder Colorado")
+        out = sns.scatterplot(
+            data=annotated_data(), x="date", y="temp_c", hue="annotation", ax=ax
+        )
+
+        out.tick_params(axis="x", rotation=30)
+        return out.get_figure()
+
+    @output
+    @render.ui
+    def annotator():
+        if input.time_series_brush() is not None:
+            selected = selected_data()
+
+            min = str(selected["date"].min())
+            max = str(selected["date"].max())
+
+            min = min.replace(" 00:00:00+00:00", "")
+            max = max.replace(" 00:00:00+00:00", "")
+
+            out = ui.TagList(
+                ui.row(
+                    {"style": "padding-top: 20px;"},
+                    ui.column(
+                        4,
+                        ui.p(f"{min} to", ui.br(), f"{max}"),
+                    ),
+                    ui.column(
+                        4,
+                        ui.input_text("annotation", "", placeholder="Enter annotation"),
+                    ),
+                    ui.column(4, ui.input_action_button("annotate_button", "Submit")),
+                )
+            )
+            return out
+
+    @output
+    @render.data_frame
+    def annotations():
+        df = annotated_data().copy()
+        df["date"] = df["date"].dt.strftime("%Y-%m-%d")
+        df = df.loc[df["annotation"] != ""]
+        return df
+
+    @session.download(filename="data.csv")
+    def download():
+        yield annotated_data().to_csv()
+
+
+app = App(app_ui, server)