refactor: Use keyword only arguments

src/griffe/dataclasses.py

@@ -145,6 +145,7 @@ class Argument:
     def __init__(
         self,
         name: str,
+        *,
         annotation: str | None = None,
         kind: ParameterKind | None = None,
         default: str | None = None,

src/griffe/docstrings/dataclasses.py

@@ -56,7 +56,7 @@ class DocstringElement:
         description: The element description.
     """
 
-    def __init__(self, description: str, annotation: str | None = None) -> None:
+    def __init__(self, *, description: str, annotation: str | None = None) -> None:
         """Initialize the element.
 
         Arguments:
@@ -101,7 +101,7 @@ class DocstringNamedElement(DocstringElement):
         value: The element value, as a string, if any.
     """
 
-    def __init__(self, name: str, description: str, annotation: str | None = None, value: str | None = None) -> None:
+    def __init__(self, name: str, *, description: str, annotation: str | None = None, value: str | None = None) -> None:
         """Initialize the element.
 
         Arguments:
@@ -110,7 +110,7 @@ def __init__(self, name: str, description: str, annotation: str | None = None, v
             annotation: The element annotation, if any.
             value: The element value, as a string.
         """
-        super().__init__(description, annotation)
+        super().__init__(description=description, annotation=annotation)
         self.name: str = name
         self.value: str | None = value
 

src/griffe/docstrings/google.py

@@ -316,7 +316,7 @@ def read_raises_section(docstring: Docstring, offset: int) -> tuple[DocstringSec
         except ValueError:
             warn(docstring, index, f"Failed to get 'exception: description' pair from '{exception_line}'")
         else:
-            exceptions.append(DocstringException(annotation, description.lstrip(" ")))
+            exceptions.append(DocstringException(annotation=annotation, description=description.lstrip(" ")))
 
     if exceptions:
         return DocstringSection(DocstringSectionKind.raises, exceptions), index
@@ -361,7 +361,10 @@ def read_returns_section(docstring: Docstring, offset: int) -> tuple[DocstringSe
     if annotation is None:
         warn(docstring, index, "No return type/annotation in docstring/signature")
 
-    return DocstringSection(DocstringSectionKind.returns, DocstringReturn(annotation, description)), index
+    return (
+        DocstringSection(DocstringSectionKind.returns, DocstringReturn(annotation=annotation, description=description)),
+        index,
+    )
 
 
 def read_yields_section(docstring: Docstring, offset: int) -> tuple[DocstringSection | None, int]:
@@ -401,7 +404,10 @@ def read_yields_section(docstring: Docstring, offset: int) -> tuple[DocstringSec
     if annotation is None:
         warn(docstring, index, "No yield type/annotation in docstring/signature")
 
-    return DocstringSection(DocstringSectionKind.yields, DocstringYield(annotation, description)), index
+    return (
+        DocstringSection(DocstringSectionKind.yields, DocstringYield(annotation=annotation, description=description)),
+        index,
+    )
 
 
 def read_examples_section(docstring: Docstring, offset: int) -> tuple[DocstringSection | None, int]:  # noqa: WPS231

src/griffe/docstrings/rst.py

@@ -317,7 +317,7 @@ def _read_exception(docstring: Docstring, offset: int, parsed_values: ParsedValu
 
     if len(parsed_directive.directive_parts) == 2:
         ex_type = parsed_directive.directive_parts[1]
-        parsed_values.exceptions.append(DocstringException(ex_type, parsed_directive.value))
+        parsed_values.exceptions.append(DocstringException(annotation=ex_type, description=parsed_directive.value))
     else:
         warn(docstring, 0, f"Failed to parse exception directive from '{parsed_directive.line}'")
 
@@ -353,7 +353,7 @@ def _read_return(docstring: Docstring, offset: int, parsed_values: ParsedValues)
             warn(docstring, 0, f"No return type or annotation at '{parsed_directive.line}'")
             annotation = None
 
-    parsed_values.return_value = DocstringReturn(annotation, parsed_directive.value)
+    parsed_values.return_value = DocstringReturn(annotation=annotation, description=parsed_directive.value)
 
     return parsed_directive.next_index
 

src/griffe/visitor.py

@@ -204,11 +204,18 @@ def visit_FunctionDef(self, node) -> None:  # noqa: WPS231
         for (arg, kind), default in args_kinds_defaults:
             annotation = _get_annotation(arg.annotation)
             default = _get_argument_default(default, self.filepath)
-            arguments.add(Argument(arg.arg, annotation, kind, default))
+            arguments.add(Argument(arg.arg, annotation=annotation, kind=kind, default=default))
 
         if node.args.vararg:
             annotation = _get_annotation(node.args.vararg.annotation)
-            arguments.add(Argument(f"*{node.args.vararg.arg}", annotation, inspect.Parameter.VAR_POSITIONAL, None))
+            arguments.add(
+                Argument(
+                    f"*{node.args.vararg.arg}",
+                    annotation=annotation,
+                    kind=inspect.Parameter.VAR_POSITIONAL,
+                    default=None,
+                )
+            )
 
         # TODO: probably some optimisations to do here
         kwargs_defaults = reversed(
@@ -223,11 +230,17 @@ def visit_FunctionDef(self, node) -> None:  # noqa: WPS231
         for kwarg, default in kwargs_defaults:  # noqa: WPS440
             annotation = _get_annotation(kwarg.annotation)
             default = _get_argument_default(default, self.filepath)
-            arguments.add(Argument(kwarg.arg, annotation, inspect.Parameter.KEYWORD_ONLY, default))
+            arguments.add(
+                Argument(kwarg.arg, annotation=annotation, kind=inspect.Parameter.KEYWORD_ONLY, default=default)
+            )
 
         if node.args.kwarg:
             annotation = _get_annotation(node.args.kwarg.annotation)
-            arguments.add(Argument(f"**{node.args.kwarg.arg}", annotation, inspect.Parameter.VAR_KEYWORD, None))
+            arguments.add(
+                Argument(
+                    f"**{node.args.kwarg.arg}", annotation=annotation, kind=inspect.Parameter.VAR_KEYWORD, default=None
+                )
+            )
 
         function = Function(
             name=node.name,