feat: add StubOverloadExtension to fix stub file overload issues

Author: wu-vincent

scripts/griffe2mdx/extension.py

@@ -0,0 +1,46 @@
+import ast
+
+from griffe import Class, Extension, Function, Inspector, Kind, ObjectNode, Visitor, typing_overload
+from typing import Any
+
+
+class StubOverloadExtension(Extension):
+    def on_function_instance(
+            self,
+            *,
+            node: ast.AST | ObjectNode,
+            func: Function,
+            agent: Visitor | Inspector,
+            **kwargs: Any,
+    ) -> None:
+        """
+        Fix overloads with implementations in stub files not detected
+        by adding a dummy function to class members
+
+        For original issue, please see: https://github.com/mkdocstrings/griffe/issues/116
+        """
+
+        if isinstance(node, ObjectNode):
+            return
+
+        if func.parent.kind != Kind.CLASS:
+            return
+
+        overload = False
+        for decorator in func.decorators:
+            overload |= decorator.callable_path in typing_overload
+
+        if not overload:
+            return
+
+        parent_class: Class = func.parent
+        try:
+            function = parent_class.members[func.name]
+        except KeyError:
+            function = Function(name=func.name)
+            parent_class.set_member(func.name, function)
+
+        if function.overloads is None:
+            function.overloads = []
+
+        function.overloads.append(func)

scripts/griffe2mdx/main.py

@@ -11,6 +11,7 @@
 from griffe2md import rendering
 from griffe2md.main import prepare_context, prepare_env
 from jinja2 import Environment, FileSystemLoader
+from extension import StubOverloadExtension
 
 sys.path.append(r"D:\Projects\CPP\endstone")
 
@@ -29,7 +30,7 @@ def render_object_docs(obj: Object, config: dict | None = None) -> str:
 def render_package_docs(package: str, config: dict | None = None) -> str:
     config = config or dict(rendering.default_config)
     parser = config["docstring_style"] and Parser(config["docstring_style"])
-    extensions = griffe.load_extensions("griffe_endstone")
+    extensions = griffe.load_extensions(StubOverloadExtension)
     loader = GriffeLoader(docstring_parser=parser, extensions=extensions)
     module = loader.load(package, find_stubs_package=True)
     loader.resolve_aliases(external=True)