Do not return html by default in itables.sample_dfs.get_countries

mwouts · mwouts · commit 718c6e5a4899 · 2025-08-28T20:57:32.000+02:00
diff --git a/apps/dash/1_display_only.py b/apps/dash/1_display_only.py
@@ -5,7 +5,7 @@
 
 app = Dash(__name__)
 
-df = get_countries(html=False)
+df = get_countries()
 
 app.layout = html.Div(
     [
diff --git a/apps/dash/2_selected_rows.py b/apps/dash/2_selected_rows.py
@@ -8,7 +8,7 @@
 
 app = Dash(__name__)
 
-df = get_countries(html=False)
+df = get_countries()
 
 app.layout = html.Div(
     [
diff --git a/apps/dash/3_update_table.py b/apps/dash/3_update_table.py
@@ -24,7 +24,7 @@
 
 app = Dash(__name__)
 
-df = get_countries(html=False)
+df = get_countries()
 
 # Create the layout with sidebar
 app.layout = html.Div(
diff --git a/apps/marimo/search_panes.py b/apps/marimo/search_panes.py
@@ -13,7 +13,7 @@ def _():
 
     mo.output.append(
         ITable(
-            get_countries(html=False, climate_zone=True).reset_index(),
+            get_countries(climate_zone=True).reset_index(),
             layout={"top1": "searchPanes"},
             searchPanes={
                 "layout": "columns-3",
diff --git a/apps/shiny/issue_360/app.py b/apps/shiny/issue_360/app.py
@@ -23,7 +23,7 @@ def server(
 ):
     @render_widget
     def my_table():  # pyright: ignore[reportUnusedFunction]
-        return ITable(df=get_countries(html=False))
+        return ITable(df=get_countries())
 
 
 # Create the Shiny app
diff --git a/docs/apps/html.md b/docs/apps/html.md
@@ -27,7 +27,7 @@ from IPython.display import HTML, display
 
 import itables
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 html = itables.to_html_datatable(df.head(3), display_logo_when_loading=False)
 ```
 
diff --git a/docs/apps/notebook.md b/docs/apps/notebook.md
@@ -33,7 +33,7 @@ You can go back to the standard HTML representation of Pandas DataFrames with `i
 ```{code-cell} ipython3
 :tags: [full-width]
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 df
 ```
 
diff --git a/docs/apps/shiny.md b/docs/apps/shiny.md
@@ -111,7 +111,7 @@ from itables.shiny import DT, init_itables
 ui.HTML(init_itables())
 
 # Render the table with DT
-ui.HTML(DT(get_countries(html=False)))
+ui.HTML(DT(get_countries()))
 ```
 
 An example for an application that uses `DT` is available at [`app.py`](https://github.com/mwouts/itables/tree/main/apps/shiny/itables_DT/app.py)
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -10,6 +10,8 @@ ITables ChangeLog
 **Added**
 - We have added the `columnControl` extension that was recently added to DataTables ([blog post](https://datatables.net/blog/2025/columncontrol)) ([#403](https://github.com/mwouts/itables/issues/403))
 
+**Changed**
+- We have changed the default value of the `html` argument in `itables.sample_dfs.get_countries`. It now defaults to `False`, in which case the example dataframes contains no HTML code.
 
 2.4.5 (2025-08-23)
 ------------------
diff --git a/docs/css.md b/docs/css.md
@@ -70,7 +70,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, classes="display nowrap table_with_monospace_font")
 ```
diff --git a/docs/custom_extensions.md b/docs/custom_extensions.md
@@ -19,7 +19,7 @@ kernelspec:
 ```{code-cell} ipython3
 import itables
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 ```
 
 DataTables controls can use a different language than English. To
diff --git a/docs/developing.md b/docs/developing.md
@@ -76,7 +76,7 @@ import itables
 # try both connected=False (the default) and connected=True
 itables.init_notebook_mode(connected=False)
 
-itables.sample_dfs.get_countries()
+itables.sample_dfs.get_countries(html=True)
 ```
 
 You can do this using for instance the notebook at `tests/test_notebook.ipynb`.
diff --git a/docs/downsampling.md b/docs/downsampling.md
@@ -39,7 +39,7 @@ itables.init_notebook_mode()
 
 itables.options.maxBytes = "8KB"
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.downsample.as_nbytes(itables.options.maxBytes), itables.downsample.nbytes(df)
 ```
 
diff --git a/docs/options/allow_html.md b/docs/options/allow_html.md
@@ -62,7 +62,7 @@ itables.show(
 ```{code-cell} ipython3
 :tags: [full-width]
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 df["flag"] = [
     '<a href="https://flagpedia.net/{code}">'
diff --git a/docs/options/buttons.md b/docs/options/buttons.md
@@ -25,7 +25,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, buttons=["pageLength", "copyHtml5", "csvHtml5", "excelHtml5"])
 ```
diff --git a/docs/options/caption.md b/docs/options/caption.md
@@ -21,7 +21,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.show(df, "Countries from the World Bank Database")
 ```
 
diff --git a/docs/options/classes.md b/docs/options/classes.md
@@ -25,7 +25,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, classes="display nowrap compact")
 ```
diff --git a/docs/options/column_control.md b/docs/options/column_control.md
@@ -25,7 +25,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 ```
 
 ## Getting started
diff --git a/docs/options/column_defs.md b/docs/options/column_defs.md
@@ -34,7 +34,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(
     df,
diff --git a/docs/options/colvis.md b/docs/options/colvis.md
@@ -23,7 +23,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(
     # column visibility works best with a flat header
diff --git a/docs/options/footer.md b/docs/options/footer.md
@@ -23,6 +23,6 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.show(df, footer=True)
 ```
diff --git a/docs/options/keys.md b/docs/options/keys.md
@@ -24,7 +24,7 @@ import itables
 itables.init_notebook_mode()
 
 itables.show(
-    itables.sample_dfs.get_countries(html=False),
+    itables.sample_dfs.get_countries(),
     keys=True,
 )
 ```
diff --git a/docs/options/layout.md b/docs/options/layout.md
@@ -22,7 +22,7 @@ DataTables' [`layout` option](https://datatables.net/reference/option/layout) wi
 import itables
 
 itables.init_notebook_mode()
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 ```
 
 ```{code-cell} ipython3
diff --git a/docs/options/length_menu.md b/docs/options/length_menu.md
@@ -20,7 +20,7 @@ Select [how many entries](https://datatables.net/examples/advanced_init/length_m
 import itables
 
 itables.init_notebook_mode()
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 ```
 
 ```{code-cell} ipython3
diff --git a/docs/options/paging.md b/docs/options/paging.md
@@ -20,7 +20,7 @@ Use [`paging=False`](https://datatables.net/reference/option/paging) to show the
 import itables
 
 itables.init_notebook_mode()
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 ```
 
 ```{code-cell} ipython3
diff --git a/docs/options/row_group.md b/docs/options/row_group.md
@@ -30,7 +30,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(
     df.sort_values("region"),
diff --git a/docs/options/scroll_y.md b/docs/options/scroll_y.md
@@ -23,6 +23,6 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.show(df, scrollY="350px", scrollCollapse=True, paging=False)
 ```
diff --git a/docs/options/search.md b/docs/options/search.md
@@ -25,6 +25,6 @@ itables.init_notebook_mode()
 ```{code-cell} ipython3
 :tags: [full-width]
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.show(df, search={"regex": True, "caseInsensitive": True, "search": "s.ain"})
 ```
diff --git a/docs/options/search_builder.md b/docs/options/search_builder.md
@@ -26,7 +26,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False, climate_zone=True)
+df = itables.sample_dfs.get_countries(climate_zone=True)
 
 itables.show(
     df,
diff --git a/docs/options/search_panes.md b/docs/options/search_panes.md
@@ -25,7 +25,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False, climate_zone=True)
+df = itables.sample_dfs.get_countries(climate_zone=True)
 
 itables.show(
     df.reset_index(),
diff --git a/docs/options/select.md b/docs/options/select.md
@@ -36,7 +36,7 @@ import itables
 itables.init_notebook_mode()
 
 itables.show(
-    itables.sample_dfs.get_countries(html=False),
+    itables.sample_dfs.get_countries(),
     select=True,
     selected_rows=[2, 4, 5],
     buttons=["copyHtml5", "csvHtml5", "excelHtml5"],
diff --git a/docs/options/state_save.md b/docs/options/state_save.md
@@ -29,7 +29,7 @@ import itables
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, stateSave=True)
 ```
diff --git a/docs/options/text_in_header_can_be_selected.md b/docs/options/text_in_header_can_be_selected.md
@@ -23,7 +23,7 @@ you need to copy back the column name to your code.
 import itables
 
 itables.init_notebook_mode()
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, "A table in which column headers can be selected")
 ```
diff --git a/docs/py/apps/html.py b/docs/py/apps/html.py
@@ -27,7 +27,7 @@
 
 import itables
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 html = itables.to_html_datatable(df.head(3), display_logo_when_loading=False)
 
 # %% [markdown]
diff --git a/docs/py/apps/notebook.py b/docs/py/apps/notebook.py
@@ -31,7 +31,7 @@
 # You can go back to the standard HTML representation of Pandas DataFrames with `init_notebook_mode(all_interactive=False)`.
 
 # %% tags=["full-width"]
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 df
 
 # %% [markdown]
diff --git a/docs/py/css.py b/docs/py/css.py
@@ -67,6 +67,6 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, classes="display nowrap table_with_monospace_font")
diff --git a/docs/py/custom_extensions.py b/docs/py/custom_extensions.py
@@ -22,7 +22,7 @@
 # %%
 import itables
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 # %% [markdown]
 # DataTables controls can use a different language than English. To
diff --git a/docs/py/downsampling.py b/docs/py/downsampling.py
@@ -36,7 +36,7 @@
 # %% tags=["full-width"]
 itables.options.maxBytes = "8KB"
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.downsample.as_nbytes(itables.options.maxBytes), itables.downsample.nbytes(df)
 
 # %% tags=["full-width"]
diff --git a/docs/py/options/allow_html.py b/docs/py/options/allow_html.py
@@ -60,7 +60,7 @@
 # ## Images in a table
 
 # %% tags=["full-width"]
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 df["flag"] = [
     '<a href="https://flagpedia.net/{code}">'
diff --git a/docs/py/options/buttons.py b/docs/py/options/buttons.py
@@ -26,7 +26,7 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, buttons=["pageLength", "copyHtml5", "csvHtml5", "excelHtml5"])
 
diff --git a/docs/py/options/caption.py b/docs/py/options/caption.py
@@ -22,7 +22,7 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 itables.show(df, "Countries from the World Bank Database")
 
 # %% [markdown]
diff --git a/docs/py/options/classes.py b/docs/py/options/classes.py
@@ -26,7 +26,7 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(df, classes="display nowrap compact")
 
diff --git a/docs/py/options/column_control.py b/docs/py/options/column_control.py
@@ -26,7 +26,7 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 # %% [markdown]
 # ## Getting started
diff --git a/docs/py/options/column_defs.py b/docs/py/options/column_defs.py
@@ -32,7 +32,7 @@
 
 itables.init_notebook_mode()
 
-df = itables.sample_dfs.get_countries(html=False)
+df = itables.sample_dfs.get_countries()
 
 itables.show(
     df,
diff --git a/docs/py/options/colvis.py b/docs/py/options/colvis.py
diff --git a/docs/py/options/footer.py b/docs/py/options/footer.py
diff --git a/docs/py/options/keys.py b/docs/py/options/keys.py
diff --git a/docs/py/options/layout.py b/docs/py/options/layout.py
diff --git a/docs/py/options/length_menu.py b/docs/py/options/length_menu.py
diff --git a/docs/py/options/paging.py b/docs/py/options/paging.py
diff --git a/docs/py/options/row_group.py b/docs/py/options/row_group.py
diff --git a/docs/py/options/scroll_y.py b/docs/py/options/scroll_y.py
diff --git a/docs/py/options/search.py b/docs/py/options/search.py
diff --git a/docs/py/options/search_builder.py b/docs/py/options/search_builder.py
diff --git a/docs/py/options/search_panes.py b/docs/py/options/search_panes.py
diff --git a/docs/py/options/select.py b/docs/py/options/select.py
diff --git a/docs/py/options/state_save.py b/docs/py/options/state_save.py
diff --git a/docs/py/options/text_in_header_can_be_selected.py b/docs/py/options/text_in_header_can_be_selected.py
diff --git a/docs/py/quick_start.py b/docs/py/quick_start.py
diff --git a/docs/quarto/quarto_html.qmd b/docs/quarto/quarto_html.qmd
diff --git a/docs/quarto/quarto_revealjs.qmd b/docs/quarto/quarto_revealjs.qmd
diff --git a/docs/quick_start.md b/docs/quick_start.md
diff --git a/src/itables/sample_dfs.py b/src/itables/sample_dfs.py
diff --git a/tests/test_sample_dfs.py b/tests/test_sample_dfs.py

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`app = Dash(__name__)`
`7`	`7`
`8`		`-df = get_countries(html=False)`
	`8`	`+df = get_countries()`
`9`	`9`
`10`	`10`	`app.layout = html.Div(`
`11`	`11`	`[`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`app = Dash(__name__)`
`10`	`10`
`11`		`-df = get_countries(html=False)`
	`11`	`+df = get_countries()`
`12`	`12`
`13`	`13`	`app.layout = html.Div(`
`14`	`14`	`[`