Merge pull request #231 from machow/fix-dynamic-load

Fix dynamic load

Author: machow

quartodoc/autosummary.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import inspect
 import logging
 import warnings
 import yaml
@@ -276,18 +277,24 @@ def dynamic_alias(
         splits = object_path.split(".")
 
         canonical_path = None
-        parts = []
         crnt_part = mod
         for ii, attr_name in enumerate(splits):
             try:
                 crnt_part = getattr(crnt_part, attr_name)
                 if not isinstance(crnt_part, ModuleType) and not canonical_path:
-                    canonical_path = crnt_part.__module__ + ":" + ".".join(splits[ii:])
+                    if inspect.isclass(crnt_part) or inspect.isfunction(crnt_part):
+                        _mod = getattr(crnt_part, "__module__", None)
+
+                        if _mod is None:
+                            canonical_path = path
+                        else:
+                            canonical_path = _mod + ":" + ".".join(splits[ii:])
+                    else:
+                        canonical_path = path
                 elif isinstance(crnt_part, ModuleType) and ii == (len(splits) - 1):
                     # final object is module
                     canonical_path = crnt_part.__name__
 
-                parts.append(crnt_part)
             except AttributeError:
                 # Fetching the attribute can fail if it is purely a type hint,
                 # and has no value. This can be an issue if you have added a

quartodoc/tests/example_dynamic.py

@@ -29,10 +29,16 @@ def dynamic_doc(self, x):
 
 
 class InstanceAttrs:
+    """Some InstanceAttrs class"""
+
     z: int
     """The z attribute"""
 
     def __init__(self, a: int, b: str):
         self.a = a
         self.b = b
         """The b attribute"""
+
+
+some_instance = InstanceAttrs(1, 1)
+some_instance.__doc__ = "Dynamic instance doc"

quartodoc/tests/test_basic.py

@@ -79,7 +79,7 @@ def test_get_object_dynamic_class_method_doc():
     assert meth.docstring.value == "A dynamic method"
 
 
-def test_get_object_dynamic_class_method_doc():
+def test_get_object_dynamic_class_method_doc_partial():
     obj = get_object("quartodoc.tests.example_dynamic:AClass", dynamic=True)
 
     meth = obj.members["dynamic_create"]
@@ -92,7 +92,28 @@ def test_get_object_dynamic_class_instance_attr_doc():
     assert obj.members["b"].docstring.value == "The b attribute"
 
 
-def test_get_object_dynamic_class_instance_attr_doc():
+def test_get_object_dynamic_class_instance_attr_doc_class_attr_valueless():
     obj = get_object("quartodoc.tests.example_dynamic:InstanceAttrs", dynamic=True)
 
     assert obj.members["z"].docstring.value == "The z attribute"
+
+
+def test_get_object_dynamic_module_attr_str():
+    # a key behavior here is that it does not error attempting to look up
+    # str.__module__, which does not exist
+    obj = get_object("quartodoc.tests.example_dynamic:NOTE", dynamic=True)
+
+    assert obj.name == "NOTE"
+
+    # this case is weird, but we are dynamically looking up a string
+    # so our __doc__ is technically str.__doc__
+    assert obj.docstring.value == str.__doc__
+
+
+def test_get_object_dynamic_module_attr_class_instance():
+    # a key behavior here is that it does not error attempting to look up
+    # str.__module__, which does not exist
+    obj = get_object("quartodoc.tests.example_dynamic:some_instance", dynamic=True)
+
+    assert obj.path == "quartodoc.tests.example_dynamic.some_instance"
+    assert obj.docstring.value == "Dynamic instance doc"