Strip * in parameter names of *args & **kwargs

Author: lagru

src/docstub/_docstrings.py

@@ -534,7 +534,8 @@ def parameters(self) -> dict[str, Annotation]:
                 continue
 
             annotation = self._doctype_to_annotation(param.type, ds_line=ds_line)
-            annotated_params[param.name] = annotation
+            name = param.name.lstrip("*")  # normalize *args & **kwargs
+            annotated_params[name] = annotation
 
         return annotated_params
 

tests/test_docstrings.py

@@ -195,11 +195,11 @@ def test_empty_docstring(self):
     def test_parameters(self, doctype, expected):
         docstring = dedent(
             f"""
-        Parameters
-        ----------
-        a : {doctype}
-        b :
-        """
+            Parameters
+            ----------
+            a : {doctype}
+            b :
+            """
         )
         transformer = DoctypeTransformer()
         annotations = DocstringAnnotations(docstring, transformer=transformer)
@@ -216,11 +216,11 @@ def test_parameters(self, doctype, expected):
     def test_returns(self, doctypes, expected):
         docstring = dedent(
             """
-        Returns
-        -------
-        a : {}
-        b : {}
-        """
+            Returns
+            -------
+            a : {}
+            b : {}
+            """
         ).format(*doctypes)
         transformer = DoctypeTransformer()
         annotations = DocstringAnnotations(docstring, transformer=transformer)
@@ -229,11 +229,11 @@ def test_returns(self, doctypes, expected):
     def test_duplicate_parameters(self, caplog):
         docstring = dedent(
             """
-        Parameters
-        ----------
-        a : int
-        a : str
-        """
+            Parameters
+            ----------
+            a : int
+            a : str
+            """
         )
         transformer = DoctypeTransformer()
         annotations = DocstringAnnotations(docstring, transformer=transformer)
@@ -252,3 +252,19 @@ def test_duplicate_returns(self, caplog):
         transformer = DoctypeTransformer()
         annotations = DocstringAnnotations(docstring, transformer=transformer)
         assert annotations.returns.value == "int"
+
+    def test_args_kwargs(self):
+        docstring = dedent(
+            """
+            Parameters
+            ----------
+            *args : int
+            **kwargs : str
+            """
+        )
+        transformer = DoctypeTransformer()
+        annotations = DocstringAnnotations(docstring, transformer=transformer)
+        assert "args" in annotations.parameters
+        assert "*args" not in annotations.parameters
+        assert "kwargs" in annotations.parameters
+        assert "**kargs" not in annotations.parameters

tests/test_stubs.py

@@ -430,3 +430,25 @@ class Foo:
         transformer = Py2StubTransformer()
         result = transformer.python_to_stub(source)
         assert expected == result
+
+    def test_args_kwargs(self):
+        # Unpack and TypedDict (PEP 692) are not yet considered / supported
+        source = dedent(
+            """
+            def foo(*args, **kwargs):
+                '''
+                Parameters
+                ----------
+                *args : str
+                **kwargs : int
+                '''
+            """
+        )
+        expected = dedent(
+            """
+            def foo(*args: str, **kwargs: int) -> None: ...
+            """
+        )
+        transformer = Py2StubTransformer()
+        result = transformer.python_to_stub(source)
+        assert expected == result