From b1302abcc8a4be5f39b4d60a1ce28032b77655b3 Mon Sep 17 00:00:00 2001 From: Alex Waygood Date: Thu, 28 Oct 2021 08:48:02 +0100 Subject: bpo-44904: Fix classmethod property bug in doctest module (GH-28838) The doctest module raised an error if a docstring contained an example that attempted to access a classmethod property. (Stacking '@classmethod' on top of `@property` has been supported since Python 3.9; see https://docs.python.org/3/howto/descriptor.html#class-methods.) Co-authored-by: Serhiy Storchaka --- Lib/doctest.py | 6 ++---- Lib/test/test_doctest.py | 15 +++++++++++++++ Misc/ACKS | 1 + .../next/Library/2021-10-09-18-42-27.bpo-44904.RlW5h8.rst | 3 +++ 4 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2021-10-09-18-42-27.bpo-44904.RlW5h8.rst diff --git a/Lib/doctest.py b/Lib/doctest.py index ba898f6..b27cbdf 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -1034,10 +1034,8 @@ class DocTestFinder: if inspect.isclass(obj) and self._recurse: for valname, val in obj.__dict__.items(): # Special handling for staticmethod/classmethod. - if isinstance(val, staticmethod): - val = getattr(obj, valname) - if isinstance(val, classmethod): - val = getattr(obj, valname).__func__ + if isinstance(val, (staticmethod, classmethod)): + val = val.__func__ # Recurse to methods, properties, and nested classes. if ((inspect.isroutine(val) or inspect.isclass(val) or diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py index 8423caf..407a14c 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -96,6 +96,17 @@ class SampleClass: 22 """) + a_class_attribute = 42 + + @classmethod + @property + def a_classmethod_property(cls): + """ + >>> print(SampleClass.a_classmethod_property) + 42 + """ + return cls.a_class_attribute + class NestedClass: """ >>> x = SampleClass.NestedClass(5) @@ -501,6 +512,7 @@ methods, classmethods, staticmethods, properties, and nested classes. 1 SampleClass.NestedClass.__init__ 1 SampleClass.__init__ 2 SampleClass.a_classmethod + 1 SampleClass.a_classmethod_property 1 SampleClass.a_property 1 SampleClass.a_staticmethod 1 SampleClass.double @@ -556,6 +568,7 @@ functions, classes, and the `__test__` dictionary, if it exists: 1 some_module.SampleClass.NestedClass.__init__ 1 some_module.SampleClass.__init__ 2 some_module.SampleClass.a_classmethod + 1 some_module.SampleClass.a_classmethod_property 1 some_module.SampleClass.a_property 1 some_module.SampleClass.a_staticmethod 1 some_module.SampleClass.double @@ -597,6 +610,7 @@ By default, an object with no doctests doesn't create any tests: 1 SampleClass.NestedClass.__init__ 1 SampleClass.__init__ 2 SampleClass.a_classmethod + 1 SampleClass.a_classmethod_property 1 SampleClass.a_property 1 SampleClass.a_staticmethod 1 SampleClass.double @@ -617,6 +631,7 @@ displays. 0 SampleClass.NestedClass.square 1 SampleClass.__init__ 2 SampleClass.a_classmethod + 1 SampleClass.a_classmethod_property 1 SampleClass.a_property 1 SampleClass.a_staticmethod 1 SampleClass.double diff --git a/Misc/ACKS b/Misc/ACKS index 23c92ab..204293f 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -1885,6 +1885,7 @@ Bob Watson Colin Watson David Watson Aaron Watters +Alex Waygood Henrik Weber Leon Weber Steve Weber diff --git a/Misc/NEWS.d/next/Library/2021-10-09-18-42-27.bpo-44904.RlW5h8.rst b/Misc/NEWS.d/next/Library/2021-10-09-18-42-27.bpo-44904.RlW5h8.rst new file mode 100644 index 0000000..b02d499 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-10-09-18-42-27.bpo-44904.RlW5h8.rst @@ -0,0 +1,3 @@ +Fix bug in the :mod:`doctest` module that caused it to fail if a docstring +included an example with a ``classmethod`` ``property``. Patch by Alex +Waygood. -- cgit v0.12