Update: Support position only arguments in methods (#374)

Author: Andrej730

src/fake_bpy_module/analyzer/directives.py

@@ -51,13 +51,14 @@ def parse_function_def(content: str) -> str:
     content.strip()
 
     m = _ARG_LIST_FROM_FUNC_DEF_REGEX.search(content)
+    assert m
     name = m.group(1)
     params = split_string_by_comma(m.group(2))
 
     # (test=DirectivesTest.test_invalid_function_arg_order)
     # Handle case:
     #   function_1(arg_1, arg_2, arg_3='NONE', arg_4=True, arg_5): pass
-    fixed_params = []
+    fixed_params: list[str] = []
     required_named_argument = False
     for param in params:
         p = param.strip()
@@ -66,10 +67,13 @@ def parse_function_def(content: str) -> str:
         if len(sp) == 1:
             if required_named_argument:
                 if p == "*":
+                    # Argument without default values are allowed after *.
                     required_named_argument = False
-                if p.startswith("*"):
+                if p.startswith("*") or p == "/":
+                    # *args, **kwargs, /
                     fixed_params.append(p)
                 else:
+                    # Have to add default value to keep signature valid.
                     fixed_params.append(f"{p}=None")
             else:
                 fixed_params.append(p)
@@ -198,16 +202,23 @@ def build_function_node_from_def(fdef: str) -> FunctionNode:
 
     # Get function signature.
     arg_list_node = func_node.element(ArgumentListNode)
-    for i, arg in enumerate(func_def.args.args):
+    arguments = func_def.args
+
+    # Positional args.
+    pos_args = arguments.posonlyargs + arguments.args
+    pos_args_types = ("posonlyarg",) * len(arguments.posonlyargs)
+    pos_args_types += ("arg",) * len(arguments.args)
+    default_start = len(pos_args) - len(arguments.defaults)
+    args_iterator = enumerate(zip(pos_args_types, pos_args, strict=True))
+    for i, (arg_type, arg) in args_iterator:
         # Remove self argument which will be added later.
         if i == 0 and arg.arg == "self":
             continue
-        arg_node = ArgumentNode.create_template(argument_type="arg")
+        arg_node = ArgumentNode.create_template(argument_type=arg_type)
         arg_node.element(NameNode).add_text(arg.arg)
-        default_start = \
-            len(func_def.args.args) - len(func_def.args.defaults)
         if i >= default_start:
-            default = func_def.args.defaults[i - default_start]
+            default = arguments.defaults[i - default_start]
+
             default_value = parse_func_arg_default_value(default)
             if default_value is not None:
                 arg_node.element(DefaultValueNode).add_text(default_value)
@@ -514,7 +525,7 @@ def run(self) -> list[FunctionNode]:
             deprecated_str = func_name[index:]
             func_name = func_name[0:index]
 
-        func_defs = []
+        func_defs: list[str] = []
         fdef_str: str = ""
         for fdef in func_name.split("\n"):
             if fdef[-1] == "\\":

src/fake_bpy_module/analyzer/nodes.py

@@ -1,5 +1,5 @@
 import abc
-from typing import Self, TypeVar
+from typing import Literal, Self, TypeVar
 
 from docutils import nodes
 
@@ -20,7 +20,7 @@ def append_child(self, item: nodes.Node) -> None:
 class UniqueElementNode(NodeBase):
     # pylint: disable=W1113
     def __init__(self, rawsource: str = "", *children: nodes.Node,
-                 **attributes: dict) -> None:
+                 **attributes: str) -> None:
         super().__init__(rawsource, *children, **attributes)
 
         self.elements = {}
@@ -127,7 +127,7 @@ class DataNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -145,7 +145,7 @@ class AttributeNode(DataNode):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -171,12 +171,13 @@ class ArgumentListNode(ListNode):
 class ArgumentNode(UniqueElementNode, nodes.Part):
     tagname = "argument"
     child_text_separator = ""
+    ArgumentType = Literal["posonlyarg", "arg", "vararg", "kwonlyarg", "kwarg"]
 
     # pylint: disable=W1113
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -195,7 +196,7 @@ class FunctionReturnNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(DescriptionNode())
@@ -215,7 +216,7 @@ class FunctionNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -239,7 +240,7 @@ class BaseClassNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(DataTypeListNode())
@@ -255,7 +256,7 @@ class ClassNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -275,7 +276,7 @@ class ModuleNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -297,7 +298,7 @@ class EnumItemNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())
@@ -319,7 +320,7 @@ class EnumNode(UniqueElementNode, nodes.Part):
     @classmethod
     def create_template(
             cls, rawsource: str = "",
-            *children: nodes.Node, **attributes: dict) -> Self:
+            *children: nodes.Node, **attributes: str) -> Self:
         node = cls(rawsource, *children, **attributes)
 
         node.append_child(NameNode())