Enforce strict type checks in the example apps

Author: mwouts

apps/dash/1_display_only.py

@@ -15,4 +15,4 @@
 )
 
 if __name__ == "__main__":
-    app.run(debug=True)
+    app.run(debug=True)  # pyright: ignore[reportUnknownMemberType]

apps/dash/2_selected_rows.py

@@ -1,4 +1,7 @@
-from dash import Dash, Input, Output, callback, html
+from typing import Optional
+
+from dash import callback  # pyright: ignore[reportUnknownVariableType]
+from dash import Dash, Input, Output, html
 
 from itables.dash import ITable
 from itables.sample_dfs import get_countries
@@ -25,9 +28,9 @@
     Output("output", "children"),
     Input("my_dataframe", "selected_rows"),
 )
-def show_selection(selected_rows):
+def show_selection(selected_rows: Optional[list[int]]) -> str:
     return f"Selected rows: {selected_rows}"
 
 
 if __name__ == "__main__":
-    app.run(debug=True)
+    app.run(debug=True)  # pyright: ignore[reportUnknownMemberType]

apps/dash/3_update_table.py

@@ -5,10 +5,17 @@
 """
 
 import logging
+from typing import Any, Optional
 
-from dash import Dash, Input, Output, State, callback, callback_context, dcc, html
+from dash import callback  # pyright: ignore[reportUnknownVariableType]
+from dash import Dash, Input, Output, State, callback_context, dcc, html
 
-from itables.dash import ITable, ITableOutputs, updated_itable_outputs
+from itables import DTForITablesOptions, ITableOptions
+from itables.dash import (
+    ITable,
+    ITableOutputs,
+    updated_itable_outputs,
+)
 from itables.sample_dfs import get_countries
 
 logging.basicConfig(level=logging.INFO)
@@ -69,32 +76,44 @@
         State("my_dataframe", "dt_args"),
     ],
 )
-def update_table(checklist, caption, selected_rows, dt_args):
+def update_table(
+    checklist: Optional[list[str]],
+    caption: Optional[str],
+    selected_rows: Optional[list[int]],
+    dt_args: Optional[DTForITablesOptions],
+) -> list[Any]:
     if checklist is None:
         checklist = []
 
-    kwargs = {}
+    kwargs: ITableOptions = {}
 
     # When df=None and when the dt_args don't change, the table is not updated
-    if callback_context.triggered_id in {None, "checklist"}:
-        kwargs["df"] = get_countries(html="HTML" in checklist)
+    df = None
+    if callback_context.triggered_id in {  # pyright: ignore[reportUnknownMemberType]
+        None,
+        "checklist",
+    }:
+        df = get_countries(html="HTML" in checklist)
 
     kwargs["select"] = "Select" in checklist
     if "Buttons" in checklist:
         kwargs["buttons"] = ["copyHtml5", "csvHtml5", "excelHtml5"]
 
+    if selected_rows is not None:
+        kwargs["selected_rows"] = selected_rows
+
     return updated_itable_outputs(
-        caption=caption, selected_rows=selected_rows, current_dt_args=dt_args, **kwargs
+        df, caption=caption, current_dt_args=dt_args, **kwargs
     )
 
 
 @callback(
     Output("output", "children"),
     Input("my_dataframe", "selected_rows"),
 )
-def show_selection(selected_rows):
+def show_selection(selected_rows: list[int]):
     return f"Selected rows: {selected_rows}"
 
 
 if __name__ == "__main__":
-    app.run(debug=True)
+    app.run(debug=True)  # pyright: ignore[reportUnknownMemberType]

apps/shiny/itable_widget/app-core.py

@@ -23,7 +23,7 @@
 )
 
 
-def server(input, output, session):
+def server(input, output, session):  # type: ignore
     @render_widget
     def my_table():
         """
@@ -40,7 +40,7 @@ def _():
         to update the widget with the new inputs.
         """
         # Get the new inputs
-        df = dfs[input.table_selector()]
+        df = dfs[input.table_selector()]  # pyright: ignore[reportUnknownMemberType]
         selected_rows = list(range(0, len(df), 3))
 
         # Update the widget
@@ -52,7 +52,7 @@ def _():
     ui.markdown("Selected rows")
 
     @render.code
-    def selected_rows():
+    def selected_rows():  # pyright: ignore[reportUnusedFunction]
         """
         Here we read the "selected_rows" attribute of the ITable widget
         """
@@ -62,4 +62,4 @@ def selected_rows():
         return str(reactive_read(my_table.widget, "selected_rows"))
 
 
-app = App(app_ui, server)
+app = App(app_ui, server)  # type: ignore

apps/shiny/itables_DT/app-core.py

@@ -23,15 +23,15 @@
 )
 
 
-def server(input, output, session):
+def server(input, output, session):  # type: ignore
     @render.ui
-    def my_table():
+    def my_table():  # pyright: ignore[reportUnusedFunction]
         """
         This function renders the table using "DT".
         """
-        df = dfs[input.table_selector()]
+        df = dfs[input.table_selector()]  # pyright: ignore[reportUnknownMemberType]
 
         return ui.HTML(DT(df))
 
 
-app = App(app_ui, server)
+app = App(app_ui, server)  # pyright: ignore[reportUnknownArgumentType]

apps/streamlit/itables_app.py

@@ -1,25 +1,24 @@
 """Run this app with: streamlit run apps/streamlit/itables_app.py"""
 
-from typing import Sequence, cast
+from typing import Optional, Sequence, cast
 
-import pyarrow
+import pyarrow  # type: ignore
 import streamlit as st
+from typing_extensions import Unpack
 
 try:
     from st_aggrid import AgGrid  # type: ignore
 except ImportError as e:
     import_error = e
 
     class AgGrid:
-        def __init__(self, *args, **kwargs):
+        def __init__(self, *args, **kwargs):  # type: ignore
             raise import_error
 
 
 from streamlit.components.v1.components import MarshallComponentException
 
-import itables.options as it_opt
-from itables.javascript import get_compact_style, get_expanded_classes
-from itables.sample_dfs import get_countries, get_dict_of_test_dfs
+import itables
 from itables.streamlit import interactive_table
 
 st.set_page_config(
@@ -45,51 +44,49 @@ def __init__(self, *args, **kwargs):
 classes = st.sidebar.multiselect(
     "Classes",
     options=["display", "nowrap", "compact", "cell-border", "stripe"],
-    default=get_expanded_classes(it_opt.classes),
+    default=itables.javascript.get_expanded_classes(itables.options.classes),
 )
 buttons = st.sidebar.multiselect(
     "Buttons",
     options=["pageLength", "copyHtml5", "csvHtml5", "excelHtml5", "colvis"],
     default=["copyHtml5", "csvHtml5", "excelHtml5", "colvis"],
 )
 
-style = st.sidebar.text_input("Style", value=get_compact_style(it_opt.style))
+style = st.sidebar.text_input(
+    "Style", value=itables.javascript.get_compact_style(itables.options.style)
+)
 
 render_with = st.sidebar.selectbox(
     "Render with", ["st.dataframe", "streamlit-aggrid", "itables"], index=2
 )
 
 include_html = st.sidebar.checkbox("Include HTML")
-df = get_countries(html=include_html)
+df = itables.sample_dfs.get_countries(html=include_html)
 
-it_args = {}
+it_args: itables.ITableOptions = {}
 if select:
     it_args["select"] = True
     it_args["selected_rows"] = [0, 1, 2, 100, 207]
-if classes != get_expanded_classes(it_opt.classes):
+if classes != itables.javascript.get_expanded_classes(itables.options.classes):
     it_args["classes"] = classes
-if style != it_opt.style:
+if style != itables.options.style:
     it_args["style"] = style
 
 if buttons:
     it_args["buttons"] = buttons
 
-
-if caption:
-    it_args = {"caption": caption, **it_args}
-
 if render_with == "st.dataframe":
 
-    def render_table(df, key: str, **not_used):  # type: ignore
-        return st.dataframe(df, key=key)
+    def render_table(df, key: str, caption: Optional[str], **not_used):  # type: ignore
+        return st.dataframe(df, key=key)  # type: ignore
 
     snippet = """st.dataframe(df)
 """
 
 elif render_with == "streamlit-aggrid":
 
-    def render_table(df, key: str, **not_used):  # type: ignore
-        return AgGrid(df, key=key)
+    def render_table(df, key: str, caption: Optional[str], **not_used):  # type: ignore
+        return AgGrid(df, key=key)  # type: ignore
 
     snippet = """from st_aggrid import AgGrid
 
@@ -102,12 +99,17 @@ def render_table(df, key: str, **not_used):  # type: ignore
     ]
     formatted_args = ",\n                  ".join(formatted_args)
 
-    def render_table(df, key, **it_args):
-        return interactive_table(df, key=key, **it_args)
+    def render_table(
+        df: itables.DataFrameOrSeries,
+        key: str,
+        caption: Optional[str],
+        **it_args: Unpack[itables.ITableOptions],
+    ):
+        return interactive_table(df, key=key, caption=caption, **it_args)
 
     snippet = f"""from itables.streamlit import interactive_table
 
-interactive_table({formatted_args})
+interactive_table(df, caption='{caption}', {formatted_args})
 """
 
 st.markdown(
@@ -117,17 +119,17 @@ def render_table(df, key, **it_args):
 """
 )
 
-t = render_table(df, "my_table", **it_args)
+t = render_table(df, caption=caption, key="my_table", **it_args)
 
 st.header("Table state")
 st.markdown(
     """The value returned by `interactive_table` is
 a dict that contains the index of the selected rows:"""
 )
-st.write(t)
+st.write(t)  # type: ignore
 
 st.header("More sample dataframes")
-test_dfs = get_dict_of_test_dfs()
+test_dfs = itables.sample_dfs.get_dict_of_test_dfs()
 tabs = st.tabs(cast(Sequence[str], test_dfs.keys()))
 
 for (name, df), tab in zip(test_dfs.items(), tabs):
@@ -140,7 +142,7 @@ def render_table(df, key, **it_args):
             # st.dataframe
             ValueError,
             # streamlit-aggrid
-            pyarrow.lib.ArrowInvalid,  # type: ignore
+            pyarrow.lib.ArrowInvalid,  # pyright: ignore[reportUnknownMemberType,reportAttributeAccessIssue]
             MarshallComponentException,
-        ) as e:
-            st.warning(e)
+        ) as e:  # pyright: ignore[reportUnknownVariableType]
+            st.warning(e)  # pyright: ignore[reportUnknownArgumentType]

docs/changelog.md

@@ -5,7 +5,7 @@ ITables ChangeLog
 ----------------------
 
 **Added**
-- We now enforce `pyright` on the ITables documentation ([#395](https://github.com/mwouts/itables/issues/395))
+- We enforce strict `pyright` on the ITables documentation ([#395](https://github.com/mwouts/itables/issues/395)) and on the example apps ([#401](https://github.com/mwouts/itables/pull/401))
 
 **Changed**
 - The `warn_on_undocumented_option` option now defaults to `True` and only check the option names

pyproject.toml

@@ -126,4 +126,5 @@ artifacts = [
 
 [tool.pyright]
 typeCheckingMode = "standard"
-strict = ["docs"]
+ignore = ["apps/marimo"]
+strict = ["docs", "apps"]

src/itables/__init__.py

@@ -1,7 +1,13 @@
 from itables import downsample, options, sample_dfs
 
 from .javascript import init_notebook_mode, show, to_html_datatable
-from .typing import DataFrameOrSeries, ITableOptions, JavascriptCode, JavascriptFunction
+from .typing import (
+    DataFrameOrSeries,
+    DTForITablesOptions,
+    ITableOptions,
+    JavascriptCode,
+    JavascriptFunction,
+)
 from .version import __version__
 
 __all__ = [
@@ -13,6 +19,7 @@
     "JavascriptFunction",
     "DataFrameOrSeries",
     "ITableOptions",
+    "DTForITablesOptions",
     "options",
     "downsample",
     "sample_dfs",

src/itables/javascript.py

@@ -527,7 +527,7 @@ def get_itables_extension_arguments(
     df: Optional[DataFrameOrSeries],
     caption: Optional[str] = None,
     **kwargs: Unpack[ITableOptions],
-):
+) -> tuple[DTForITablesOptions, dict[str, Any]]:
     """
     This function returns two dictionaries that are JSON
     serializable and can be passed to the ITable extensions.