ENH: Show annotations for class properties (#175)

* Include annotations for class properties

* update

Author: postlund

pdoc/__init__.py

@@ -332,6 +332,23 @@ def _toposort(graph: Dict[T, Set[T]]) -> Generator[T, None, None]:
     assert not graph, "A cyclic dependency exists amongst %r" % graph
 
 
+def _return_annotation(name, module, obj, link=None):
+    try:
+        annot = typing.get_type_hints(obj).get('return', '')
+    except NameError as e:
+        warn("Error handling return annotation for {}: {}".format(name, e.args[0]))
+        annot = inspect.signature(inspect.unwrap(obj)).return_annotation
+        if annot == inspect.Parameter.empty:
+            annot = ''
+    if not annot:
+        return ''
+    s = inspect.formatannotation(annot).replace(' ', '\N{NBSP}')  # Better line breaks
+    if link:
+        from pdoc.html_helpers import _linkify
+        s = re.sub(r'[\w\.]+', partial(_linkify, link=link, module=module), s)
+    return s
+
+
 def link_inheritance(context: Context = None):
     """
     Link inheritance relationsships between `pdoc.Class` objects
@@ -1076,20 +1093,7 @@ def _is_async(self):
 
     def return_annotation(self, *, link=None):
         """Formatted function return type annotation or empty string if none."""
-        try:
-            annot = typing.get_type_hints(self.obj).get('return', '')
-        except NameError as e:
-            warn("Error handling return annotation for {}: {}".format(self.name, e.args[0]))
-            annot = inspect.signature(inspect.unwrap(self.obj)).return_annotation
-            if annot == inspect.Parameter.empty:
-                annot = ''
-        if not annot:
-            return ''
-        s = inspect.formatannotation(annot).replace(' ', '\N{NBSP}')  # Better line breaks
-        if link:
-            from pdoc.html_helpers import _linkify
-            s = re.sub(r'[\w\.]+', partial(_linkify, link=link, module=self.module), s)
-        return s
+        return _return_annotation(self.name, self.module, self.obj, link=link)
 
     def params(self, *, annotate: bool = False, link: Callable[[Doc], str] = None) -> List[str]:
         """
@@ -1235,6 +1239,10 @@ def qualname(self):
     def refname(self):
         return (self.cls.refname if self.cls else self.module.refname) + '.' + self.name
 
+    def type_annotation(self, *, link=None):
+        """Formatted variable type annotation or empty string if none."""
+        return _return_annotation(self.name, self.module, self.obj, link=link)
+
 
 class External(Doc):
     """

pdoc/templates/html.mako

@@ -224,7 +224,12 @@
           <h3>Instance variables</h3>
           <dl>
           % for v in inst_vars:
-              <dt id="${v.refname}"><code class="name">var ${ident(v.name)}</code></dt>
+              <%
+                  var_type = show_type_annotations and v.type_annotation(link=link) or ''
+                  if var_type:
+                      var_type = ' ->\N{NBSP}' + var_type
+              %>
+              <dt id="${v.refname}"><code class="name">var ${ident(v.name)}${var_type}</code></dt>
               <dd>${show_desc(v)}</dd>
           % endfor
           </dl>

pdoc/test/__init__.py

@@ -727,6 +727,19 @@ def f() -> typing.List[typing.Union[str, pdoc.Doc]]: pass
         func = pdoc.Function('f', pdoc.Module(pdoc), f)
         self.assertEqual(func.return_annotation(), 'List[Union[str,\N{NBSP}pdoc.Doc]]')
 
+    @ignore_warnings
+    def test_Variable_type_annotation(self):
+        import typing
+
+        class Foobar:
+            @property
+            def prop(self) -> typing.Optional[int]:
+                pass
+
+        cls = pdoc.Class('Foobar', pdoc.Module(pdoc), Foobar)
+        prop = cls.instance_variables()[0]
+        self.assertEqual(prop.type_annotation(), 'Union[int,\N{NBSP}NoneType]')
+
     @ignore_warnings
     def test_Class_docstring(self):
         class A: