[Python-checkins] cpython (3.5): Issue #27989: Tweak inspect.formatannotation() to improve pydoc rendering of

[guido.van.rossum]

https://hg.python.org/cpython/rev/dc030d15f80d
changeset:   104644:dc030d15f80d
branch:      3.5
parent:      104641:dc9ad44125de
user:        Guido van Rossum <guido at python.org>
date:        Sat Oct 22 07:55:18 2016 -0700
summary:
  Issue #27989: Tweak inspect.formatannotation() to improve pydoc rendering of function annotations. Ivan L.

files:
  Lib/inspect.py         |   2 ++
  Lib/test/test_pydoc.py |  13 +++++++++++++
  2 files changed, 15 insertions(+), 0 deletions(-)


diff --git a/Lib/inspect.py b/Lib/inspect.py
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -1152,6 +1152,8 @@
     return ArgInfo(args, varargs, varkw, frame.f_locals)
 
 def formatannotation(annotation, base_module=None):
+    if getattr(annotation, '__module__', None) == 'typing':
+        return repr(annotation).replace('typing.', '')
     if isinstance(annotation, type):
         if annotation.__module__ in ('builtins', base_module):
             return annotation.__qualname__
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -15,6 +15,7 @@
 import test.support
 import time
 import types
+import typing
 import unittest
 import urllib.parse
 import xml.etree
@@ -815,6 +816,18 @@
         expected = 'C in module %s object' % __name__
         self.assertIn(expected, pydoc.render_doc(c))
 
+    def test_typing_pydoc(self):
+        def foo(data: typing.List[typing.Any],
+                x: int) -> typing.Iterator[typing.Tuple[int, typing.Any]]:
+            ...
+        T = typing.TypeVar('T')
+        class C(typing.Generic[T], typing.Mapping[int, str]): ...
+        self.assertEqual(pydoc.render_doc(foo).splitlines()[-1],
+                         'f\x08fo\x08oo\x08o(data:List[Any], x:int)'
+                         ' -> Iterator[Tuple[int, Any]]')
+        self.assertEqual(pydoc.render_doc(C).splitlines()[2],
+                         'class C\x08C(typing.Mapping)')
+
     def test_builtin(self):
         for name in ('str', 'str.translate', 'builtins.str',
                      'builtins.str.translate'):

-- 
Repository URL: https://hg.python.org/cpython