Make all props after id keyword only

Author: tcbegley

justfile

@@ -137,4 +137,10 @@ _move-generated-files:
         if file_.name in ("__init__.py", "_table.py", "_version.py", "icons.py", "themes.py"):
             continue
         filename = "__init__.py" if file_.name == "_imports_.py" else file_.name
-        file_.rename(file_.parent / "_components" / filename)
+        new_file = file_.parent / "_components" / filename
+        file_.rename(new_file)
+        # enforce keyword arguments only after the id argument
+        id_pattern = "        id: typing.Optional[str] = None,\n"
+        new_file.write_text(
+            new_file.read_text().replace(id_pattern, f"{id_pattern}{8 * ' '}*,\n")
+        )

tests/test_positional_args.py

@@ -1,12 +1,15 @@
+import inspect
+
+import dash_bootstrap_components as dbc
+import pytest
 from dash import Dash, html
-from dash_bootstrap_components import Checklist, RadioItems, Select
+from dash_bootstrap_components._components import __all__ as COMPONENT_NAMES
 from selenium.webdriver.common.by import By
 
 
 def test_dbpa001_checklist(dash_duo):
     """
-    Check that the options and value positional arguments are working for
-    Checklist.
+    Check that the options and value positional arguments are working for dbc.Checklist.
     """
     app = Dash()
 
@@ -18,12 +21,12 @@ def test_dbpa001_checklist(dash_duo):
 
     value = "OptionB"
 
-    with_keywords = Checklist(
+    with_keywords = dbc.Checklist(
         options=options,
         value=value,
         id="with-keywords",
     )
-    without_keywords = Checklist(options, value, id="without-keywords")
+    without_keywords = dbc.Checklist(options, value, id="without-keywords")
 
     app.layout = html.Div([with_keywords, without_keywords])
 
@@ -59,7 +62,7 @@ def test_dbpa001_checklist(dash_duo):
 def test_dbpa002_radio_items(dash_duo):
     """
     Check that the options and value positional arguments are working for
-    RadioItems.
+    dbc.RadioItems.
     """
     app = Dash()
 
@@ -71,12 +74,12 @@ def test_dbpa002_radio_items(dash_duo):
 
     value = "OptionB"
 
-    with_keywords = RadioItems(
+    with_keywords = dbc.RadioItems(
         options=options,
         value=value,
         id="with-keywords",
     )
-    without_keywords = RadioItems(options, value, id="without-keywords")
+    without_keywords = dbc.RadioItems(options, value, id="without-keywords")
 
     app.layout = html.Div([with_keywords, without_keywords])
 
@@ -111,8 +114,7 @@ def test_dbpa002_radio_items(dash_duo):
 
 def test_dbpa003_select(dash_duo):
     """
-    Check that the options and value positional arguments are working for
-    Select.
+    Check that the options and value positional arguments are working for dbc.Select.
     """
     app = Dash()
 
@@ -124,12 +126,12 @@ def test_dbpa003_select(dash_duo):
 
     value = "OptionB"
 
-    with_keywords = Select(
+    with_keywords = dbc.Select(
         options=options,
         value=value,
         id="with-keywords",
     )
-    without_keywords = Select(options, value, id="without-keywords")
+    without_keywords = dbc.Select(options, value, id="without-keywords")
 
     app.layout = html.Div([with_keywords, without_keywords])
 
@@ -160,3 +162,21 @@ def test_dbpa003_select(dash_duo):
             by=By.TAG_NAME, value="option"
         )
     ]
+
+
+@pytest.mark.parametrize("component_name", COMPONENT_NAMES)
+def test_dbpa004_keyword_only_args(component_name):
+    component = getattr(dbc, component_name)
+    signature = inspect.signature(component)
+    id_seen = False
+    for name, param in signature.parameters.items():
+        if name == "id":
+            id_seen = True
+        elif id_seen:
+            # all parameters after the id should be keyword only or **kwargs
+            assert param.kind in (
+                inspect.Parameter.KEYWORD_ONLY,
+                inspect.Parameter.VAR_KEYWORD,
+            )
+
+    assert id_seen