Fix function-valued arguments (#119)

pybind11_stubgen/parser/mixins/fix.py

@@ -107,6 +107,12 @@ def handle_type(self, type_: type) -> QualifiedName:
             self._add_import(result)
         return result
 
+    def handle_value(self, value: Any) -> Value:
+        result = super().handle_value(value)
+        if inspect.isroutine(value) and result.is_print_safe:
+            self._add_import(QualifiedName.from_str(result.repr))
+        return result
+
     def parse_annotation_str(
         self, annotation_str: str
     ) -> ResolvedType | InvalidExpression | Value:
@@ -237,6 +243,10 @@ def handle_type(self, type_: type) -> QualifiedName:
         if result[0] == "builtins":
             if result[1] == "NoneType":
                 return QualifiedName((Identifier("None"),))
+            if result[1] in ("function", "builtin_function_or_method"):
+                callable_t = self.parse_annotation_str("typing.Callable")
+                assert isinstance(callable_t, ResolvedType)
+                return callable_t.name
             return QualifiedName(result[1:])
 
         return result
@@ -363,6 +373,14 @@ def handle_type(self, type_: type) -> QualifiedName:
         result = super().handle_type(type_)
         return self._strip_current_module(result)
 
+    def handle_value(self, value: Any) -> Value:
+        result = super().handle_value(value)
+        if inspect.isroutine(value):
+            result.repr = str(
+                self._strip_current_module(QualifiedName.from_str(result.repr))
+            )
+        return result
+
     def parse_annotation_str(
         self, annotation_str: str
     ) -> ResolvedType | InvalidExpression | Value:

pybind11_stubgen/parser/mixins/parse.py

@@ -156,7 +156,7 @@ def _is_descriptor(self, member: Any) -> bool:
 
 
 class BaseParser(IParser):
-    def is_print_safe(self, value: Value) -> bool:
+    def is_print_safe(self, value: Any) -> bool:
         value_type = type(value)
         # Use exact type match, not `isinstance()` that allows inherited types pass
         if value is None or value_type in (int, str):
@@ -180,6 +180,14 @@ def is_print_safe(self, value: Value) -> bool:
                 if not self.is_print_safe(k) or not self.is_print_safe(v):
                     return False
             return True
+        if inspect.isfunction(value):
+            if (
+                (module_name := getattr(value, "__module__", None)) is not None
+                and "<" not in module_name
+                and (qual_name := getattr(value, "__qualname__", None)) is not None
+                and "<" not in qual_name
+            ):
+                return True
         if inspect.ismodule(value):
             return True
         return False

tests/py-demo/demo/__init__.py

@@ -1,6 +1,7 @@
 # Mock common layout library mixed of C/C++ core and pure python
 # C++-based modules are prefixed with underscore
 
+from . import pure_python
 from .core import *
 
 #

tests/py-demo/demo/pure_python/__init__.py

@@ -0,0 +1 @@
+from . import functions

tests/py-demo/demo/pure_python/functions.py

@@ -0,0 +1,43 @@
+class _Dummy:
+    @staticmethod
+    def foo():
+        return 42
+
+
+def search(a: int, b: list[int]) -> int:
+    ...
+
+
+def builtin_function_as_default_arg(func: type(len) = len):
+    ...
+
+
+def function_as_default_arg(func: type(search) = search):
+    ...
+
+
+def lambda_as_default_arg(callback=lambda val: 0):
+    ...
+
+
+def static_method_as_default_arg(callback=_Dummy.foo):
+    ...
+
+
+def arg_mix(
+    a: int,
+    b: float = 0.5,
+    /,
+    c: str = "",
+    *args: int,
+    x: int = 1,
+    y=search,
+    **kwargs: dict[int, str],
+):
+    """Mix of positional, kw and variadic args
+
+    Note:
+        The `inspect.getfullargspec` does not reflect presence
+        of pos-only args separator (/)
+    """
+    ...

tests/stubs/demo/__init__.pyi

@@ -17,7 +17,7 @@ from demo._bindings import (
     values,
 )
 
-from . import _bindings, core
+from . import _bindings, core, pure_python
 
 __all__ = [
     "aliases",
@@ -31,6 +31,7 @@ __all__ = [
     "methods",
     "numpy",
     "properties",
+    "pure_python",
     "stl",
     "stl_bind",
     "typing",

tests/stubs/demo/pure_python/__init__.pyi

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from . import functions
+
+__all__ = ["functions"]

tests/stubs/demo/pure_python/functions.pyi

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import typing
+
+__all__ = [
+    "arg_mix",
+    "builtin_function_as_default_arg",
+    "function_as_default_arg",
+    "lambda_as_default_arg",
+    "search",
+    "static_method_as_default_arg",
+]
+
+class _Dummy(object):
+    @staticmethod
+    def foo(): ...
+
+def arg_mix(
+    a: int,
+    b: float = 0.5,
+    c: str = "",
+    *args: int,
+    x: int = 1,
+    y=search,
+    **kwargs: dict[int, str],
+):
+    """
+    Mix of positional, kw and variadic args
+
+        Note:
+            The `inspect.getfullargspec` does not reflect presence
+            of pos-only args separator (/)
+
+    """
+
+def builtin_function_as_default_arg(func: typing.Callable = ...): ...
+def function_as_default_arg(func: typing.Callable = search): ...
+def lambda_as_default_arg(callback=...): ...
+def search(a: int, b: list[int]) -> int: ...
+def static_method_as_default_arg(callback=_Dummy.foo): ...