Improve type hints and add py.typed files (#389)

* Mirror the md documentation with py scripts
* New option warn_on_unexpected_option_type
* More type hints, use Sequence rather than list
* Add py.typed files
* Version 2.4.1-dev

Author: mwouts

.pre-commit-config.yaml

@@ -33,10 +33,5 @@ repos:
     rev: v1.17.1
     hooks:
     - id: jupytext
-      exclude: packages/
-      types: ["markdown"]
-      args: ["--pipe", "isort {} --treat-comment-as-code '# %%' --profile black", "--pipe", "black", "--check", "ruff check {} --ignore E402"]
-      additional_dependencies:
-        - black==24.4.2 # Matches hook
-        - ruff==0.4.3
-        - isort==5.13.2
+      types: ["python"]
+      args: ["--sync", "--quiet"]

docs/apps/dash.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md

docs/apps/html.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md

docs/apps/marimo.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md

docs/apps/notebook.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md

docs/apps/widget.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md
@@ -12,6 +12,13 @@ kernelspec:
   name: itables
 ---
 
+```{code-cell} ipython3
+:tags: [remove-cell]
+
+# ruff: noqa: E402
+# pyright: reportUnusedExpression=false
+```
+
 # Widget
 
 The `ITable` widget depends on [AnyWidget](https://anywidget.dev) -

docs/changelog.md

@@ -1,6 +1,20 @@
 ITables ChangeLog
 =================
 
+2.4.1-dev (2025-06-??)
+----------------------
+
+**Added**
+- We now enforce `pyright` on the ITables documentation
+
+**Changed**
+- The `warn_on_undocumented_option` option now defaults to `True` and only check the option names
+- We have added a new option `warn_on_unexpected_option_type` that defaults to `warn_on_undocumented_option` when `typeguard>=4.4.1` is installed (`False` otherwise)
+
+**Fixed**
+- We have added type hints to `itable.options` even for the options that don't have a default value ([#224](https://github.com/mwouts/itables/issues/224))
+
+
 2.4.0 (2025-05-17)
 ------------------
 

docs/contributing.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md

docs/css.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md
@@ -12,6 +12,12 @@ kernelspec:
   name: itables
 ---
 
+```{code-cell} ipython3
+:tags: [remove-cell]
+
+# ruff: noqa: E402
+```
+
 # CSS
 
 You can use CSS to alter how tables are rendered.

docs/custom_extensions.md

@@ -1,6 +1,6 @@
 ---
 jupytext:
-  formats: md:myst
+  formats: docs///md:myst,docs/py///py:percent
   notebook_metadata_filter: -jupytext.text_representation.jupytext_version
   text_representation:
     extension: .md