pythonGH-96073: Fix wild replacement in inspect.formatannotation (pyt…

…hon#96074) Co-authored-by: Jelle Zijlstra <[email protected]>
/ · Oct 11, 2022 · 41b8172 · 41b8172
1 parent bd66031
commit 41b8172
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 1 deletion.
diff --git a/Lib/inspect.py b/Lib/inspect.py
@@ -1433,7 +1433,10 @@ def getargvalues(frame):
 
 def formatannotation(annotation, base_module=None):
     if getattr(annotation, '__module__', None) == 'typing':
-        return repr(annotation).replace('typing.', '')
+        def repl(match):
+            text = match.group()
+            return text.removeprefix('typing.')
+        return re.sub(r'[\w\.]+', repl, repr(annotation))
     if isinstance(annotation, types.GenericAlias):
         return str(annotation)
     if isinstance(annotation, type):

diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
@@ -1421,6 +1421,13 @@ def wrapper(a, b):
         self.assertEqual(inspect.get_annotations(isa.MyClassWithLocalAnnotations, eval_str=True), {'x': int})
 
 
+class TestFormatAnnotation(unittest.TestCase):
+    def test_typing_replacement(self):
+        from test.typinganndata.ann_module9 import ann, ann1
+        self.assertEqual(inspect.formatannotation(ann), 'Union[List[str], int]')
+        self.assertEqual(inspect.formatannotation(ann1), 'Union[List[testModule.typing.A], int]')
+
+
 class TestIsDataDescriptor(unittest.TestCase):
 
     def test_custom_descriptors(self):

diff --git a/Lib/test/typinganndata/__init__.py b/Lib/test/typinganndata/__init__.py
diff --git a/Lib/test/typinganndata/ann_module9.py b/Lib/test/typinganndata/ann_module9.py
@@ -0,0 +1,14 @@
+# Test ``inspect.formatannotation``
+# https://github.com/python/cpython/issues/96073
+
+from typing import Union, List
+
+ann = Union[List[str], int]
+
+# mock typing._type_repr behaviour
+class A: ...
+
+A.__module__ = 'testModule.typing'
+A.__qualname__ = 'A'
+
+ann1 = Union[List[A], int]
diff --git a/Misc/NEWS.d/next/Library/2022-08-29-12-35-28.gh-issue-96073.WaGstf.rst b/Misc/NEWS.d/next/Library/2022-08-29-12-35-28.gh-issue-96073.WaGstf.rst
@@ -0,0 +1 @@
+In :mod:`inspect`, fix overeager replacement of "`typing.`" in formatting annotations.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		In :mod:`inspect`, fix overeager replacement of "`typing.`" in formatting annotations.