Support [list]-like annotations (#184)

Fix #183

Author: sizmailov

pybind11_stubgen/parser/mixins/fix.py

@@ -131,17 +131,18 @@ def parse_annotation_str(
         return result
 
     def _add_import(self, name: QualifiedName) -> None:
-        if len(name) > 0:
-            if hasattr(builtins, name[0]):
-                return
-            if self.__current_class is not None and hasattr(
-                self.__current_class, name[0]
-            ):
-                return
-            if self.__current_module is not None and hasattr(
-                self.__current_module, name[0]
-            ):
-                return
+        if len(name) == 0:
+            return
+        if len(name) == 1 and len(name[0]) == 0:
+            return
+        if hasattr(builtins, name[0]):
+            return
+        if self.__current_class is not None and hasattr(self.__current_class, name[0]):
+            return
+        if self.__current_module is not None and hasattr(
+            self.__current_module, name[0]
+        ):
+            return
         module_name = self._get_parent_module(name)
         if module_name is None:
             self.report_error(NameResolutionError(name))
@@ -495,6 +496,8 @@ class FixNumpyArrayDimAnnotation(IParser):
         )
     )
 
+    __DIM_VARS = ["n", "m"]
+
     def parse_annotation_str(
         self, annotation_str: str
     ) -> ResolvedType | InvalidExpression | Value:
@@ -518,12 +521,6 @@ def parse_annotation_str(
         if (
             not isinstance(scalar_with_dims, ResolvedType)
             or scalar_with_dims.name not in self.numpy_primitive_types
-            or (
-                scalar_with_dims.parameters is not None
-                and any(
-                    not isinstance(dim, Value) for dim in scalar_with_dims.parameters
-                )
-            )
         ):
             return result
 
@@ -540,38 +537,57 @@ def parse_annotation_str(
             scalar_with_dims.parameters is not None
             and len(scalar_with_dims.parameters) >= 0
         ):
-            result.parameters += [
-                self.handle_value(
-                    self._cook_dimension_parameters(scalar_with_dims.parameters)
-                )
-            ]
+            dims = self.__to_dims(scalar_with_dims.parameters)
+            if dims is not None and len(dims) > 0:
+                result.parameters += [
+                    self.handle_value(self.__wrap_with_size_helper(dims))
+                ]
 
         result.parameters += flags
 
         return result
 
-    def _cook_dimension_parameters(
-        self, dimensions: list[Value]
-    ) -> FixedSize | DynamicSize:
-        all_ints = True
-        new_params = []
-        for dim_param in dimensions:
-            try:
-                dim = int(dim_param.repr)
-            except ValueError:
-                dim = dim_param.repr
-                all_ints = False
-            new_params.append(dim)
-
-        if all_ints:
+    def __wrap_with_size_helper(self, dims: list[int | str]) -> FixedSize | DynamicSize:
+        if all(isinstance(d, int) for d in dims):
             return_t = FixedSize
         else:
             return_t = DynamicSize
 
         # TRICK: Use `self.handle_type` to make `FixedSize`/`DynamicSize`
         #        properly added to the list of imports
-        self.handle_type(FixedSize)
-        return return_t(*new_params)
+        self.handle_type(return_t)
+        return return_t(*dims)
+
+    def __to_dims(
+        self, dimensions: list[ResolvedType | Value | InvalidExpression]
+    ) -> list[int | str] | None:
+        result = []
+        for dim_param in dimensions:
+            if isinstance(dim_param, Value):
+                try:
+                    dim = int(dim_param.repr)
+                except ValueError:
+                    return None
+            elif isinstance(dim_param, ResolvedType):
+                dim = str(dim_param)
+                if dim not in self.__DIM_VARS:
+                    return None
+            else:
+                return None
+            result.append(dim)
+        return result
+
+    def report_error(self, error: ParserError) -> None:
+
+        if (
+            isinstance(error, NameResolutionError)
+            and len(error.name) == 1
+            and len(error.name[0]) == 1
+            and error.name[0] in self.__DIM_VARS
+        ):
+            # Ignores all unknown 'm' and 'n' regardless of the context
+            return
+        super().report_error(error)
 
 
 class FixNumpyArrayRemoveParameters(IParser):

pybind11_stubgen/parser/mixins/parse.py

@@ -581,7 +581,7 @@ def parse_type_str(
         self, annotation_str: str
     ) -> ResolvedType | InvalidExpression | Value:
         qname_regex = re.compile(
-            r"^\s*(?P<qual_name>[_A-Za-z]\w+(\s*\.\s*[_A-Za-z]\w+)*)"
+            r"^\s*(?P<qual_name>([_A-Za-z]\w*)?(\s*\.\s*[_A-Za-z]\w*)*)"
         )
         annotation_str = annotation_str.strip()
         match = qname_regex.match(annotation_str)

tests/demo.errors.stderr.txt

@@ -1,4 +1,10 @@
 pybind11_stubgen - [  ERROR] In demo._bindings.aliases.foreign_enum_default : Invalid expression '<ConsoleForegroundColor.Blue: 34>'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.dense_matrix_c : Can't find/import 'm'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.dense_matrix_c : Can't find/import 'n'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.dense_matrix_r : Can't find/import 'm'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.dense_matrix_r : Can't find/import 'n'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.four_col_matrix_r : Can't find/import 'm'
+pybind11_stubgen - [  ERROR] In demo._bindings.eigen.four_row_matrix_r : Can't find/import 'n'
 pybind11_stubgen - [  ERROR] In demo._bindings.enum.accept_defaulted_enum : Invalid expression '<ConsoleForegroundColor.None_: -1>'
 pybind11_stubgen - [  ERROR] In demo._bindings.flawed_bindings.accept_unbound_enum : Invalid expression '(anonymous namespace)::Enum'
 pybind11_stubgen - [  ERROR] In demo._bindings.flawed_bindings.accept_unbound_enum_defaulted : Invalid expression '<demo._bindings.flawed_bindings.Enum object at 0x1234abcd5678>'

tests/py-demo/bindings/src/modules/functions.cpp

@@ -1,10 +1,13 @@
 #include "modules.h"
 
 #if PYBIND11_VERSION_AT_LEAST(2, 12)
+
 #include <pybind11/typing.h>
+
 #endif
 
 #include <pybind11/stl.h>
+#include <pybind11/functional.h>
 
 #include <demo/sublibA/add.h>
 
@@ -93,4 +96,5 @@ void bind_functions_module(py::module &&m) {
     py::class_<Foo> pyFoo(m, "Foo");
     pyFoo.def(py::init<int>());
     m.def("default_custom_arg", [](Foo &foo) {}, py::arg_v("foo", Foo(5), "Foo(5)"));
+    m.def("pass_callback", [](std::function<Foo(Foo &)> &callback) { return Foo(13); });
 }

tests/stubs/python-3.12/pybind11-master/demo/_bindings/functions.pyi

@@ -19,6 +19,7 @@ __all__ = [
     "func_w_named_pos_args",
     "generic",
     "mul",
+    "pass_callback",
     "pos_kw_only_mix",
     "pos_kw_only_variadic_mix",
 ]
@@ -52,5 +53,6 @@ def mul(p: float, q: float) -> float:
     Multiply p and q (double)
     """
 
+def pass_callback(arg0: typing.Callable[[Foo], Foo]) -> Foo: ...
 def pos_kw_only_mix(i: int, /, j: int, *, k: int) -> tuple: ...
 def pos_kw_only_variadic_mix(i: int, /, j: int, *args, k: int, **kwargs) -> tuple: ...

tests/stubs/python-3.12/pybind11-v2.11/demo/_bindings/functions.pyi

@@ -18,6 +18,7 @@ __all__ = [
     "func_w_named_pos_args",
     "generic",
     "mul",
+    "pass_callback",
     "pos_kw_only_mix",
     "pos_kw_only_variadic_mix",
 ]
@@ -50,5 +51,6 @@ def mul(p: float, q: float) -> float:
     Multiply p and q (double)
     """
 
+def pass_callback(arg0: typing.Callable[[Foo], Foo]) -> Foo: ...
 def pos_kw_only_mix(i: int, /, j: int, *, k: int) -> tuple: ...
 def pos_kw_only_variadic_mix(i: int, /, j: int, *args, k: int, **kwargs) -> tuple: ...

tests/stubs/python-3.12/pybind11-v2.9/demo/_bindings/functions.pyi

@@ -17,6 +17,7 @@ __all__ = [
     "func_w_named_pos_args",
     "generic",
     "mul",
+    "pass_callback",
     "pos_kw_only_mix",
     "pos_kw_only_variadic_mix",
 ]
@@ -48,5 +49,6 @@ def mul(p: float, q: float) -> float:
     Multiply p and q (double)
     """
 
+def pass_callback(arg0: typing.Callable[[Foo], Foo]) -> Foo: ...
 def pos_kw_only_mix(i: int, /, j: int, *, k: int) -> tuple: ...
 def pos_kw_only_variadic_mix(i: int, /, j: int, *args, k: int, **kwargs) -> tuple: ...

tests/stubs/python-3.7/pybind11-master/demo/_bindings/functions.pyi

@@ -19,6 +19,7 @@ __all__ = [
     "func_w_named_pos_args",
     "generic",
     "mul",
+    "pass_callback",
     "pos_kw_only_mix",
     "pos_kw_only_variadic_mix",
 ]
@@ -52,5 +53,6 @@ def mul(p: float, q: float) -> float:
     Multiply p and q (double)
     """
 
+def pass_callback(arg0: typing.Callable[[Foo], Foo]) -> Foo: ...
 def pos_kw_only_mix(i: int, j: int, *, k: int) -> tuple: ...
 def pos_kw_only_variadic_mix(i: int, j: int, *args, k: int, **kwargs) -> tuple: ...

tests/stubs/python-3.8/pybind11-master/demo/_bindings/functions.pyi

@@ -19,6 +19,7 @@ __all__ = [
     "func_w_named_pos_args",
     "generic",
     "mul",
+    "pass_callback",
     "pos_kw_only_mix",
     "pos_kw_only_variadic_mix",
 ]
@@ -52,5 +53,6 @@ def mul(p: float, q: float) -> float:
     Multiply p and q (double)
     """
 
+def pass_callback(arg0: typing.Callable[[Foo], Foo]) -> Foo: ...
 def pos_kw_only_mix(i: int, /, j: int, *, k: int) -> tuple: ...
 def pos_kw_only_variadic_mix(i: int, /, j: int, *args, k: int, **kwargs) -> tuple: ...