From ac4bdcc80e986bdd5b9d10ab0bce35aabb790a3e Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Thu, 29 Oct 2015 08:15:50 +0200 Subject: [PATCH] Issue #25503: Fixed inspect.getdoc() for inherited docstrings of properties. Original patch by John Mark Vandenberg. --- Lib/inspect.py | 13 +++++++------ Lib/test/inspect_fodder.py | 7 ++++++- Lib/test/test_inspect.py | 4 ++-- Misc/ACKS | 1 + Misc/NEWS | 3 +++ 5 files changed, 19 insertions(+), 9 deletions(-) diff --git a/Lib/inspect.py b/Lib/inspect.py index bf4f87d5cfa..b65bec7adf6 100644 --- a/Lib/inspect.py +++ b/Lib/inspect.py @@ -527,17 +527,18 @@ def _finddoc(obj): cls = self else: cls = self.__class__ + # Should be tested before isdatadescriptor(). + elif isinstance(obj, property): + func = obj.fget + name = func.__name__ + cls = _findclass(func) + if cls is None or getattr(cls, name) is not obj: + return None elif ismethoddescriptor(obj) or isdatadescriptor(obj): name = obj.__name__ cls = obj.__objclass__ if getattr(cls, name) is not obj: return None - elif isinstance(obj, property): - func = f.fget - name = func.__name__ - cls = _findclass(func) - if cls is None or getattr(cls, name) is not obj: - return None else: return None diff --git a/Lib/test/inspect_fodder.py b/Lib/test/inspect_fodder.py index 068d8258b92..711badad849 100644 --- a/Lib/test/inspect_fodder.py +++ b/Lib/test/inspect_fodder.py @@ -45,14 +45,17 @@ class StupidGit: self.ex = sys.exc_info() self.tr = inspect.trace() + @property def contradiction(self): 'The automatic gainsaying.' pass -# line 48 +# line 53 class MalodorousPervert(StupidGit): def abuse(self, a, b, c): pass + + @property def contradiction(self): pass @@ -64,6 +67,8 @@ class ParrotDroppings: class FesteringGob(MalodorousPervert, ParrotDroppings): def abuse(self, a, b, c): pass + + @property def contradiction(self): pass diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py index 955b2adcb27..69ddb514d61 100644 --- a/Lib/test/test_inspect.py +++ b/Lib/test/test_inspect.py @@ -393,8 +393,8 @@ class TestRetrievingSourceCode(GetSourceBase): def test_getsource(self): self.assertSourceEqual(git.abuse, 29, 39) - self.assertSourceEqual(mod.StupidGit, 21, 50) - self.assertSourceEqual(mod.lobbest, 70, 71) + self.assertSourceEqual(mod.StupidGit, 21, 51) + self.assertSourceEqual(mod.lobbest, 75, 76) def test_getsourcefile(self): self.assertEqual(normcase(inspect.getsourcefile(mod.spam)), modfile) diff --git a/Misc/ACKS b/Misc/ACKS index f8fcccf6113..c7be8406c32 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -1480,6 +1480,7 @@ Lukas Vacek Ville Vainio Andi Vajda Case Van Horsen +John Mark Vandenberg Kyle VanderBeek Andrew Vant Atul Varma diff --git a/Misc/NEWS b/Misc/NEWS index 638964ec361..be859edcdcc 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -45,6 +45,9 @@ Core and Builtins Library ------- +- Issue #25503: Fixed inspect.getdoc() for inherited docstrings of properties. + Original patch by John Mark Vandenberg. + - Issue #21827: Fixed textwrap.dedent() for the case when largest common whitespace is a substring of smallest leading whitespace. Based on patch by Robert Li.