Added more tests and versionchanged to Doc

python · serhiy-storchaka · Nov 12, 2025 · Mar 12, 2025 · Mar 12, 2025 · Mar 12, 2025
commit d61ab34248a43482b204c3e6ca4e102df3a3c50d
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
@@ -627,6 +627,9 @@ Retrieving source code
    .. versionchanged:: 3.5
       Documentation strings are now inherited if not overridden.
 
+   .. versionchanged:: next
+      Now correctly returns an inherited docstring on :class:`~functools.cached_property` objects if not overridden.
+
 
 .. function:: getcomments(object)
 

diff --git a/Lib/test/test_inspect/inspect_fodder3.py b/Lib/test/test_inspect/inspect_fodder3.py
@@ -1,12 +1,34 @@
 from functools import cached_property
 
-class Parent:
+# Docstring in parent, inherited in child
+class ParentInheritDoc:
     @cached_property
     def foo(self):
-        "this is the docstring for foo"
+        "docstring for foo defined in parent"
+
+class ChildInheritDoc(ParentInheritDoc):
+    @cached_property
+    def foo(self):
+        pass
+
+# Redine foo as something other than cached_property
-# Redine foo as something other than cached_property
+# redefine foo as something other than cached_property
-# Redine foo as something other than cached_property
+# redefine foo as something other than cached_property
+class ChildPropertyFoo(ParentInheritDoc):
+    @property
+    def foo(self):
+        "docstring for the property foo"
         pass
 
-class Child(Parent):
+class ChildMethodFoo(ParentInheritDoc):
+    def foo(self):
+        "docstring for the method foo"
+
+# Docstring in child but not parent
+class ParentNoDoc:
     @cached_property
     def foo(self):
         pass
+
+class ChildDefineDoc(ParentNoDoc):
+    @cached_property
+    def foo(self):
+        "docstring for foo defined in child"
diff --git a/Lib/test/test_inspect/test_inspect.py b/Lib/test/test_inspect/test_inspect.py
@@ -667,8 +667,18 @@ def test_getdoc_inherited(self):
                          'The automatic gainsaying.')
 
     def test_getdoc_inherited_cached_property(self):
-        self.assertEqual(inspect.getdoc(mod3.Parent.foo),
-                         inspect.getdoc(mod3.Child.foo))
+        self.assertEqual(inspect.getdoc(mod3.ChildInheritDoc.foo),
+                         'docstring for foo defined in parent')
+
+    def test_getdoc_redefine_cached_property_as_other(self):
+        self.assertEqual(inspect.getdoc(mod3.ChildPropertyFoo.foo),
+                         'docstring for the property foo')
+        self.assertEqual(inspect.getdoc(mod3.ChildMethodFoo.foo),
+                         'docstring for the method foo')
+
+    def test_getdoc_define_cached_property(self):
+        self.assertEqual(inspect.getdoc(mod3.ChildDefineDoc.foo),
+                         'docstring for foo defined in child')
 
     @unittest.skipIf(MISSING_C_DOCSTRINGS, "test requires docstrings")
     def test_finddoc(self):

diff --git a/Misc/NEWS.d/next/Library/2025-03-12-18-57-10.gh-issue-131116.uTpwXZ.rst b/Misc/NEWS.d/next/Library/2025-03-12-18-57-10.gh-issue-131116.uTpwXZ.rst
@@ -1 +1 @@
-inspect.getdoc(), if run on a cached_property that does not define a docstring but inherits from a class that did define a docstring, will now return the inherited docstring rather than None.
+:func:`inspect.getdoc` now correctly returns an inherited docstring on :class:`~functools.cached_property` objects if none is given in a subclass.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		inspect.getdoc(), if run on a cached_property that does not define a docstring but inherits from a class that did define a docstring, will now return the inherited docstring rather than None.
		:func:`inspect.getdoc` now correctly returns an inherited docstring on :class:`~functools.cached_property` objects if none is given in a subclass.
Comment thread serhiy-storchaka marked this conversation as resolved. Outdated