Merge pull request #327 from machow/fix-alias-method-members

fix: do not exclude child methods on alias classes

Author: machow

quartodoc/builder/blueprint.py

@@ -376,9 +376,16 @@ def _fetch_members(self, el: Auto, obj: dc.Object | dc.Alias):
         if not el.include_private:
             options = {k: v for k, v in options.items() if not k.startswith("_")}
 
-        if not (el.include_imports or el.include_inherited):
+        if not el.include_imports and obj.is_module:
             options = {k: v for k, v in options.items() if not v.is_alias}
 
+        if not el.include_inherited and obj.is_class:
+            # aliases are kept only if their parent is the current obj
+            # i.e. they do not belong to a parent class
+            options = {
+                k: v for k, v in options.items() if (v.parent is obj or not v.is_alias)
+            }
+
         # resolve any remaining aliases ----
         # the reamining filters require attributes on the target object.
         for obj in options.values():

quartodoc/tests/example_alias_target.py

@@ -1,5 +1,6 @@
 from quartodoc.tests.example_alias_target__nested import (  # noqa: F401
     nested_alias_target,
+    NestedClass as ClassAlias,
     tabulate as external_alias,
 )
 

quartodoc/tests/example_alias_target__nested.py

@@ -7,3 +7,15 @@
 
 def nested_alias_target():
     """A nested alias target"""
+
+
+class Parent:
+    def parent_method(self):
+        """p1 method"""
+
+
+class NestedClass(Parent):
+    def f(self):
+        """a method"""
+
+    manually_attached = nested_alias_target

quartodoc/tests/test_builder_blueprint.py

@@ -97,6 +97,25 @@ def test_blueprint_visit_class(bp, dynamic):
     assert res.members[0].obj.path == path.replace(":", ".") + ".a_method"
 
 
+@pytest.mark.parametrize("dynamic", [False, True])
+def test_blueprint_visit_class_alias(bp, dynamic):
+    path = "quartodoc.tests.example_alias_target:ClassAlias"
+    auto = lo.Auto(name=path, dynamic=dynamic)
+    res = bp.visit(auto)
+
+    assert isinstance(res, lo.DocClass)
+
+    if not dynamic:
+        # currently, griffe doesn't know that the function manually attached
+        # to the class is a function, and not an attribute.
+        assert len(res.members) == 1
+        assert res.members[0].name == "f"
+    else:
+        assert len(res.members) == 2
+        assert res.members[0].name == "f"
+        assert res.members[1].name == "manually_attached"
+
+
 @pytest.mark.parametrize("dynamic", [False, True])
 def test_blueprint_visit_module(bp, dynamic):
     path = "quartodoc.tests.example"