Wrap simple classes in a type/class

Make it easier to get the class' module and/or name.

Author: ghickman

src/classify/library.py

@@ -30,7 +30,7 @@
 @frozen
 class Attribute:
     name: str
-    defining_class: str
+    defining_class: "SimpleClass"
     value: Any
 
 
@@ -47,6 +47,19 @@ class Class:
     properties: list = Factory(list)
 
 
+@frozen
+class SimpleClass:
+    name: str
+    module: str
+
+    @staticmethod
+    def from_class(klass):
+        return SimpleClass(
+            name=klass.__name__,
+            module=klass.__module__,
+        )
+
+
 @frozen
 class Line:
     start: int
@@ -65,7 +78,7 @@ class Member[C]:
 class Method:
     name: str
     docstring: str
-    defining_class: str
+    defining_class: SimpleClass
     arguments: str
     code: str
     lines: Line
@@ -79,7 +92,7 @@ def build_attributes(members: list[Member]) -> Generator[Attribute, None, None]:
 
         yield Attribute(
             name=member.name,
-            defining_class=member.cls.__name__,
+            defining_class=SimpleClass.from_class(member.cls),
             value=member.obj,
         )
 
@@ -111,7 +124,7 @@ def build_methods(members: list[Member]) -> Generator[Method, None, None]:
         yield Method(
             name=member.name,
             docstring=pydoc.getdoc(member.obj),
-            defining_class=member.cls.__name__,
+            defining_class=SimpleClass.from_class(member.cls),
             arguments=arguments,
             code="".join(lines),
             lines=Line(start=start_line, total=len(lines)),
@@ -151,11 +164,13 @@ def classify[C](obj: type[C]) -> Class:
         for method in build_methods(instance_methods):
             methods[method.name].append(method)
 
+    ancestors = [SimpleClass.from_class(c) for c in mro[:-1]]
+
     return Class(
         name=obj.__name__,
         module=obj.__module__,
         docstring=pydoc.getdoc(obj),
-        ancestors=[k.__name__ for k in mro[:-1]],
+        ancestors=ancestors,
         parents=get_parents(obj),
         attributes=dict(sorted(attributes.items())),
         classes=sorted(classes),

src/classify/renderers/string.py

@@ -54,7 +54,7 @@ def methods(methods: dict[str, list[Method]], indent) -> str:
     for definitions in methods.values():
         for i, method in enumerate(definitions):
             if len(definitions) > 1 and i == 0:
-                content += f"{indent}# Defined on: {method.defining_class}\n"
+                content += f"{indent}# Defined on: {method.defining_class.name}\n"
             lines = method.code.split("\n")[:-1]
             for line in lines:
                 # TODO: dedent code at source so defined indent isn't tied to

src/classify/templates/class.html

@@ -31,7 +31,7 @@ <h2>Attributes</h2>
                 {{ name }} = {{ attribute.value|attribute }}
               </code>
             </td>
-            <td>{{ attribute.defining_class }}</td>
+            <td>{{ attribute.defining_class.name }}.{{ attribute.defining_class.name }}</td>
           </tr>
         {% endfor %}
       {% endfor %}
@@ -55,7 +55,7 @@ <h2>Methods</h2>
   {% for name, declarations in klass.methods.items() %}
     {% for declaration in declarations %}
       <div class="method">
-        <h3>def {{ name }}{{ declaration.arguments }}: [{{ declaration.defining_class }}]</h3>
+        <h3>def {{ name }}{{ declaration.arguments }}: [{{ declaration.defining_class.name }}]</h3>
         <p>{{ declaration.docstring|e }}</p>
         <p>Found on lines {{ declaration.lines.start }} to {{ declaration.lines.start+declaration.lines.total }} of {{ declaration.file }}</p>
         <pre>{{ declaration.code }}</pre>

tests/conftest.py

@@ -1,6 +1,6 @@
 import pytest
 
-from classify.library import Attribute, Class, Line, Method
+from classify.library import Attribute, Class, Line, Method, SimpleClass
 
 
 def inner_class(name):
@@ -14,7 +14,7 @@ def inner_class(name):
             "abc": [
                 Attribute(
                     name="abc",
-                    defining_class=name,
+                    defining_class=SimpleClass(name=name, module=""),
                     value="123",
                 )
             ]
@@ -25,10 +25,12 @@ def inner_class(name):
 
 
 def method(name, **kwargs):
+    defining_class = SimpleClass(name=kwargs.get("defining_class", ""), module="")
+
     return Method(
         name=name,
         docstring=kwargs.get("docstring", ""),
-        defining_class=kwargs.get("defining_class", ""),
+        defining_class=defining_class,
         arguments=kwargs.get("arguments", ""),
         code=kwargs.get("code", ""),
         lines=Line(start=42, total=7),
@@ -49,8 +51,10 @@ def dummy_class():
         ],
         methods={
             "one": [
-                method("one", defining_class="ParentClass"),
-                method("one", defining_class="MyClass"),
+                method(
+                    "one", defining_class=SimpleClass(name="ParentClass", module="")
+                ),
+                method("one", defining_class=SimpleClass(name="MyClass", module="")),
             ]
         },
     )

tests/renderers/test_string.py

@@ -1,6 +1,6 @@
 import pytest
 
-from classify.library import Attribute
+from classify.library import Attribute, SimpleClass
 from classify.renderers.string import attributes, docstring
 
 
@@ -12,15 +12,27 @@ class MyClass:
     ("attr", "expected"),
     [
         (
-            Attribute(name="my_var", defining_class="MyClass", value="test"),
+            Attribute(
+                name="my_var",
+                defining_class=SimpleClass(name="MyClass", module=""),
+                value="test",
+            ),
             'my_var = "test"\n',
         ),
         (
-            Attribute(name="my_var", defining_class="MyClass", value=MyClass),
+            Attribute(
+                name="my_var",
+                defining_class=SimpleClass(name="MyClass", module=""),
+                value=MyClass,
+            ),
             "my_var = MyClass\n",
         ),
         (
-            Attribute(name="my_var", defining_class="MyClass", value=7),
+            Attribute(
+                name="my_var",
+                defining_class=SimpleClass(name="MyClass", module=""),
+                value=7,
+            ),
             "my_var = 7\n",
         ),
     ],