feat(api(session)): Start process of making session arguments removed from API

CHANGELOG.md

@@ -17,6 +17,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * `@render.data_frame`'s input value `input.<ID>_column_filter()` has been deprecated. Please use `<ID>.filter()` to retrieve the same information. (#1374)
 
+* Many `shiny.ui` methods (and `reactive.invalidate_later`) have deprecated their `session` argument. This rarely used argument would pass the `Session` into the method, but it is now considered an anti-pattern. If a custom `session` value is needed, please execute your code within a session context like `with shiny.session.session_context(MY_SESSION):`.  (#793)
+
+* `require_active_session()` will display a warning if a non-`MISSING` value is provided. Please migrate from using `require_active_session(None)` to `require_active_session()`. If a session is still needed, please use the context `with shiny.session.session_context(MY_SESSION):`. (#793)
+
 ### New features
 
 * `@render.data_frame` has added a few new methods:

examples/airmass/app.py

@@ -12,7 +12,7 @@
 from astropy.coordinates import AltAz, EarthLocation, SkyCoord
 from location import location_server, location_ui
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, req, ui
+from shiny import App, Inputs, reactive, render, req, ui
 
 app_ui = ui.page_fixed(
     ui.tags.h3("Air mass calculator"),
@@ -57,7 +57,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     loc = location_server("location")
     time_padding = datetime.timedelta(hours=1.5)
 

examples/annotation-export/app.py

@@ -5,7 +5,7 @@
 import pandas as pd
 import seaborn as sns
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 from shiny.plotutils import brushed_points
 
 path = Path(__file__).parent / "boulder_temp.csv"
@@ -38,7 +38,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     annotated_data = reactive.value(weather_df)
 
     @reactive.calc

examples/brownian/app.py

@@ -41,7 +41,7 @@
 )
 
 
-def server(input, output, session):
+def server(input):
     # BROWNIAN MOTION ====
 
     @reactive.calc

examples/cpuinfo/app.py

@@ -13,7 +13,7 @@
 import numpy as np
 import pandas as pd
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 # The agg matplotlib backend seems to be a little more efficient than the default when
 # running on macOS, and also gives more consistent results across operating systems
@@ -110,7 +110,7 @@ def cpu_current():
     return cpu_percent(percpu=True)
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     cpu_history = reactive.value(None)
 
     @reactive.calc

examples/dataframe/app.py

@@ -2,7 +2,7 @@
 import seaborn as sns
 from shinyswatch.theme import darkly
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, req, ui
+from shiny import App, Inputs, reactive, render, req, ui
 
 
 def app_ui(req):
@@ -59,7 +59,7 @@ def light_dark_switcher(dark):
     )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     df: reactive.value[pd.DataFrame] = reactive.value()
 
     @reactive.effect

examples/duckdb/app.py

@@ -66,7 +66,7 @@ def load_csv(con, csv_name, table_name):
 )
 
 
-def server(input, output, session):
+def server(input):
     mod_counter = reactive.value(0)
 
     query_output_server("initial_query", con=con, remove_id="initial_query")

examples/event/app.py

@@ -1,6 +1,6 @@
 import asyncio
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 app_ui = ui.page_fluid(
     ui.tags.p(
@@ -26,7 +26,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.effect
     @reactive.event(input.btn)
     def _():

examples/global_pyplot/app.py

@@ -1,6 +1,6 @@
 import matplotlib.pyplot as plt
 
-from shiny import App, Inputs, Outputs, Session, render, ui
+from shiny import App, Inputs, render, ui
 
 app_ui = ui.page_fluid(
     ui.input_checkbox("render", "Render", value=True),
@@ -18,7 +18,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @render.plot
     def mpl():
         if input.render():

examples/inputs-update/app.py

@@ -1,6 +1,6 @@
 from datetime import date
 
-from shiny import App, Inputs, Outputs, Session, reactive, ui
+from shiny import App, Inputs, reactive, ui
 
 app_ui = ui.page_fluid(
     ui.panel_title("Changing the values of inputs from the server"),
@@ -87,7 +87,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.effect
     def _():
         # We'll use these multiple times, so use short var names for

examples/model-score/app.py

@@ -9,7 +9,7 @@
 from plotly_streaming import render_plotly_streaming
 from shinywidgets import output_widget
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 THRESHOLD_MID = 0.85
 THRESHOLD_MID_COLOR = "rgb(0, 137, 26)"
@@ -137,7 +137,7 @@ def app_ui(req):
     )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.calc
     def recent_df():
         """

examples/moduleapp/app.py

@@ -59,7 +59,7 @@ def dynamic_counter():
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     counter_server("counter1")
     counter_wrapper_server("counter2_wrapper", "Counter 2")
 

examples/penguins/app.py

@@ -8,7 +8,7 @@
 import seaborn as sns
 from colors import bg_palette, palette
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, req, ui
+from shiny import App, Inputs, reactive, render, req, ui
 
 sns.set_theme()
 
@@ -52,7 +52,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.calc
     def filtered_df() -> pd.DataFrame:
         """Returns a Pandas data frame that includes only the desired rows"""

examples/req/app.py

@@ -1,4 +1,4 @@
-from shiny import App, Inputs, Outputs, Session, reactive, render, req, ui
+from shiny import App, Inputs, reactive, render, req, ui
 from shiny.types import SafeException
 
 app_ui = ui.page_fluid(
@@ -15,7 +15,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.calc
     def safe_click():
         req(input.safe())

examples/static_plots/app.py

@@ -4,7 +4,7 @@
 import seaborn as sns
 from plotnine.data import mtcars
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 nav = ui.navset_pill_list(
     ui.nav_control(ui.p("Choose a package", class_="lead text-center")),
@@ -53,7 +53,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @reactive.calc
     def fake_data():
         n = 5000

examples/typed_inputs/app.py

@@ -2,7 +2,7 @@
 
 import typing
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 app_ui = ui.page_fluid(
     ui.input_numeric("n", "N", 20),
@@ -24,7 +24,7 @@ class ShinyInputs(Inputs):
     check: reactive.value[bool]
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     # Cast `input` to our ShinyInputs class. This just tells the static type checker
     # that we want it treated as a ShinyInputs object for type checking; it has no
     # run-time effect.

examples/ui-func/app.py

@@ -2,7 +2,7 @@
 
 from starlette.requests import Request
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 
 def app_ui(request: Request):
@@ -12,7 +12,7 @@ def app_ui(request: Request):
     )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @render.text
     def now():
         reactive.invalidate_later(0.1)

shiny/_app.py

@@ -57,8 +57,10 @@ class App:
         returns a UI definition, if you need the UI definition to be created dynamically
         for each pageview.
     server
-        A function which is called once for each session, ensuring that each session is
-        independent.
+        A function which is called once for each session, ensuring that each app is
+        independent. This function can either take one positional argument (``input:
+        Inputs``) or three positional  arguments (``input: Inputs``, ``output:Outputs``,
+        ``session: Session``).
     static_assets
         Static files to be served by the app. If this is a string or Path object, it
         must be a directory, and it will be mounted at `/`. If this is a dictionary,

shiny/_deprecated.py

@@ -1,8 +1,6 @@
 import warnings
 from typing import Any
 
-from . import reactive, render
-
 __all__ = (
     "render_text",
     "render_plot",
@@ -29,29 +27,53 @@ def warn_deprecated(message: str):
 
 def render_text():
     """Deprecated. Please use render.text() instead of render_text()."""
+    import shiny.render as render
+
     warn_deprecated("render_text() is deprecated. Use render.text() instead.")
     return render.text()
 
 
 def render_ui():
     """Deprecated. Please use render.ui() instead of render_ui()."""
+    import shiny.render as render
+
     warn_deprecated("render_ui() is deprecated. Use render.ui() instead.")
     return render.ui()
 
 
 def render_plot(*args: Any, **kwargs: Any):  # type: ignore
     """Deprecated. Please use render.plot() instead of render_plot()."""
+    import shiny.render as render
+
     warn_deprecated("render_plot() is deprecated. Use render.plot() instead.")
     return render.plot(*args, **kwargs)  # type: ignore
 
 
 def render_image(*args: Any, **kwargs: Any):  # type: ignore
     """Deprecated. Please use render.image() instead of render_image()."""
+    import shiny.render as render
+
     warn_deprecated("render_image() is deprecated. Use render.image() instead.")
     return render.image(*args, **kwargs)  # type: ignore
 
 
 def event(*args: Any, **kwargs: Any):
     """Deprecated. Please use @reactive.event() instead of @event()."""
+    import shiny.reactive as reactive
+
     warn_deprecated("@event() is deprecated. Use @reactive.event() instead.")
     return reactive.event(*args, **kwargs)
+
+
+def session_type_warning() -> None:
+    warn_deprecated(
+        "`session=` is deprecated. Please call with no `session=` argument as this parameter will be removed in the near future. If you need to pass a session, use your code inside a `with session_context(session):`."
+    )
+
+
+_session_param_docs = """
+    session
+        Deprecated. If a custom :class:`~shiny.Session` is needed, please execute your
+        code inside `with shiny.session.session_context(session):`. See
+        :func:`~shiny.session.session_context` for more details.
+    """

shiny/api-examples/Module/app-core.py

@@ -38,7 +38,7 @@ def out() -> str:
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     counter_server("counter1")
     counter_server("counter2")
 

shiny/api-examples/Progress/app-core.py

@@ -1,14 +1,14 @@
 import asyncio
 
-from shiny import App, Inputs, Outputs, Session, reactive, render, ui
+from shiny import App, Inputs, reactive, render, ui
 
 app_ui = ui.page_fluid(
     ui.input_action_button("button", "Compute"),
     ui.output_text("compute"),
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @render.text
     @reactive.event(input.button)
     async def compute():

shiny/api-examples/Renderer/app-core.py

@@ -3,7 +3,7 @@
 # Import the custom renderer implementations
 from renderers import render_capitalize, render_upper
 
-from shiny import App, Inputs, Outputs, Session, ui
+from shiny import App, Inputs, ui
 
 app_ui = ui.page_fluid(
     ui.h1("Capitalization renderer"),
@@ -19,7 +19,7 @@
 )
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     # Hovering over `@render_upper` will display the class documentation
     @render_upper
     def upper():

shiny/api-examples/SafeException/app-core.py

@@ -1,10 +1,10 @@
-from shiny import App, Inputs, Outputs, Session, render, ui
+from shiny import App, Inputs, render, ui
 from shiny.types import SafeException
 
 app_ui = ui.page_fluid(ui.output_ui("safe"), ui.output_ui("unsafe"))
 
 
-def server(input: Inputs, output: Outputs, session: Session):
+def server(input: Inputs):
     @render.ui
     def safe():
         raise SafeException("This is a safe exception")