Fix #4956: autodoc: Failed to extract document from a subclass of the class on mocked module

[tk0miya]

Feature or Bugfix

• Bugfix

Purpose

• see Classes inheriting from other classes, defined in mocked modules, are ignored #4956

[shimizukawa]

LGTM!

[shimizukawa]

confirmed.

[shimizukawa]

I've investigated for py2 error.

[shimizukawa]

not works with py2. Is super(M, cls) correct?

            return super(M, cls).__new__(cls)  # type: ignore

test.py

from __future__ import print_function

class M(object):
    def __new__(cls, *args, **kwargs):
        print('new =>', cls, args, kwargs)
        if len(args) == 3 and isinstance(args[1], tuple) and args[1][-1].__class__ is cls:
            # subclassing MockObject
            return type(args[0], (M,), args[2], **kwargs)  # type: ignore
        else:
            return super(M, cls).__new__(cls)  # type: ignore

t1 = 'm = M(1, b=2)'
print('exec:', t1); exec(t1)

print('subclassing M')
class F(M):
    def __init__(self, a, b=0):
        self.a = a
        self.b = b

t2 = 'f = F(1, b=2)'
print('exec:', t2); exec(t2)


print('subclassing m')
class X(m):
    def __init__(self, a, b=0):
        self.a = a
        self.b = b

t3 = 'x = X(1, b=2)'
print('exec:', t3); exec(t3)

run with py3

$ python3 test.py 
exec: m = M(1, b=2)
new => <class '__main__.M'> (1,) {'b': 2}
subclassing M
exec: f = F(1, b=2)
new => <class '__main__.F'> (1,) {'b': 2}
subclassing m
new => <class '__main__.M'> ('X', (<__main__.M object at 0x1013b4400>,), {'__module__': '__main__', '__qualname__': 'X', '__init__': <function X.__init__ at 0x1013a98c8>}) {}
exec: x = X(1, b=2)
new => <class '__main__.X'> (1,) {'b': 2}

run with py2

$ python2 test.py 
exec: m = M(1, b=2)
new => <class '__main__.M'> (1,) {'b': 2}
subclassing M
exec: f = F(1, b=2)
new => <class '__main__.F'> (1,) {'b': 2}
subclassing m
new => <class '__main__.M'> ('X', (<__main__.M object at 0x102132c50>,), {'__module__': '__main__', '__init__': <function __init__ at 0x102135b18>}) {}
exec: x = X(1, b=2)
new => <class '__main__.X'> (1,) {'b': 2}

[tk0miya]

Right. I'd forgotten the usage of super() in py2...

[codecov]

Codecov Report

Merging #4995 into 1.7 will increase coverage by 0.01%.
The diff coverage is 91.3%.

@@            Coverage Diff            @@
##              1.7   #4995      +/-   ##
=========================================
+ Coverage   81.99%     82%   +0.01%     
=========================================
  Files         282     288       +6     
  Lines       37681   38022     +341     
  Branches     5846    5901      +55     
=========================================
+ Hits        30895   31179     +284     
- Misses       5481    5529      +48     
- Partials     1305    1314       +9

Impacted Files	Coverage Δ
tests/test_ext_autodoc_importer.py	100% <100%> (ø)
sphinx/ext/autodoc/importer.py	87.76% <71.42%> (-0.21%)	⬇️
sphinx/apidoc.py	0% <0%> (ø)
sphinx/__init__.py	57.5% <0%> (ø)
sphinx/errors.py	68.42% <0%> (ø)
sphinx/quickstart.py	0% <0%> (ø)
sphinx/search/__init__.py	95.11% <0%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 713aa82...3080d24. Read the comment docs.

[tk0miya]

I added this method for https://www.python.org/dev/peps/pep-0560/

[shimizukawa]

LGTM!!

[tk0miya]

Thanks!